NetAppDocs PowerShell Module

Release History


[4.1.0]

Notes

This release requires Windows PowerShell 5.1 or PowerShell version 7.2+ (versions 7.0 and 7.1 are no longer supported).

An installation script has been added to the ZIP file and is the recommend installation method. The Windows Installer (MSI) file is now deprecated as the method required administrative rights to the client machine. While the ZIP file contains the installation scripts, those that previously used the ZIP file to manually copy the module files to a specific location can continue to use this method (Note: The file structure within the ZIP file has changed slightly).

If you have previously used the MSI installer package on your Windows clients, it is recommended to remove all previous versions using the 'Apps & features' or the 'Add or remove programs' application in the System Settings area.

Major Features

  • Added support for AWS FSx for ONTAP storage instances.
  • Added new functions to support updates (notifications and auto-updating files).

Enhancements

  • Added a new installer option using an install script contained in the ZIP file (now the preferred method).
  • Added support for admin user domain authentication (using the SSH application instead of the console application -- console still preferred due to potential timeout issues).

Content Changes

  • None.

New Tables

ONTAP ONTAP ASUP SVM SVM ASUP 7-Mode 7-Mode ASUP

New Columns in Existing Tables

ONTAP ONTAP ASUP SVM SVM ASUP
SizeVolumeProvisioned (AggregateSpaceDetails) SizeVolumeProvisioned (AggregateSpaceDetails)
PercentVolumeProvisioned (AggregateSpaceDetails) PercentVolumeProvisioned (AggregateSpaceDetails)
8 x VolBlocksFootprint Columns (InGb / InBytes) 8 x VolBlocksFootprint Columns (InGb / InBytes)
PasswordHashAlgorithm (ClusterAdministrativeUsers)
PasswordHashAlgorithm (SvmAdministrativeUsers) PasswordHashAlgorithm (SvmAdministrativeUsers)
CapacityTierUsed (AggrObjectStores) CapacityTierUsed (AggrObjectStores)
30 x Sizing Columns (FlexVolDataProtectionDetails) 30 x Sizing Columns (FlexVolDataProtectionDetails)
MinimiumRecommendedOntapVersion (ClusterDetails) MinimiumRecommendedOntapVersion (ClusterDetails)
MinimiumRecommendedOntapVersion (NodeDetails) MinimiumRecommendedOntapVersion (NodeDetails)
DestinationEndpointUuid (SnapmirrorRelationships) DestinationEndpointUuid (SnapmirrorRelationships) DestinationEndpointUuid (SnapmirrorRelationships) DestinationEndpointUuid (SnapmirrorRelationships)

Fixes

  • [ONTAP_ASUP] Minor fix to ASUP Aggr RaidGroup name sorting (regression in 4.0.0).
  • [ONTAP] ClusterStorageSummary table efficiency savings columns were not populating.
  • [ONTAP] SystemTimeSettings table was not showing any entries.
  • [ONTAP] SecurityConfiguration table was not showing any entries.
  • [ONTAP] Added a workaround for an ONTAP BURT reporting invalid PowerOnInterval numbers.
  • [Internal] Differences reports were not outputting any changes in 4.0.
  • [Internal] Fixed issue parsing some ZAPI XML output (introduced in 4.0).
  • [ONTAP_ASUP] Fixed ASUP parsing issue when a duplicate restricted root aggr is present on a system.
  • Other minor fixes.

Notes

  • None.

[4.0.0]

Major Features

  • Added support for MAC/Linux clients.

Enhancements

  • Added support for the new IDaaS authentication method (for ASUP data collection).
  • Added support for the new ASUP object endpoints.
  • Updated to the new cross-platform NetApp.ONTAP PowerShell module.
  • Removed unnecessary statistics properties.

Content Changes

  • Added new tables and new columns to existing tables (see tables below).

New Tables

ONTAP ONTAP ASUP SVM SVM ASUP 7-Mode 7-Mode ASUP
ShelfDrawerDetails ShelfDrawerDetails
SnmpUsers SnmpUsers
ServicePolicyEntries ServicePolicyEntries ServicePolicyEntries ServicePolicyEntries
SecuritySessionLimits SecuritySessionLimits

New Columns in Existing Tables

ONTAP ONTAP ASUP SVM SVM ASUP 7-Mode 7-Mode ASUP
TotalVolumeNominalCapacity (InGb/InBytes) (ClusterStorageSummary) TotalVolumeNominalCapacity (InGb/InBytes) (ClusterStorageSummary)
TotalVolumeNominalCapacity (InGb/InBytes) (SvmStorageSummary) TotalVolumeNominalCapacity (InGb/InBytes) (SvmStorageSummary) TotalVolumeNominalCapacity (InGb/InBytes) (SvmStorageSummary) TotalVolumeNominalCapacity (InGb/InBytes) (SvmStorageSummary)
14 x RaidOption Columns (NodeOptions) 14 x RaidOption Columns (NodeOptions)
Drawer (DriveDetails) Drawer (DriveDetails)
DrawerSlot (DriveDetails) DrawerSlot (DriveDetails)
MarketingCapacityInBytes (DriveDetails) MarketingCapacityInBytes (DriveDetails)
PhysicalCapacityInBytes (DriveDetails) PhysicalCapacityInBytes (DriveDetails)
RightSizedCapacityInBytes (DriveDetails) RightSizedCapacityInBytes (DriveDetails)
PartitionSizeInBytes (PartitionDetails) PartitionSizeInBytes (PartitionDetails)
SnapSizeUsed (InGb/InBytes) (AggregateSpaceDetails) SnapSizeUsed (InGb/InBytes) (AggregateSpaceDetails)
SnapSizeTotal (InGb/InBytes) (AggregateSpaceDetails) SnapSizeTotal (InGb/InBytes) (AggregateSpaceDetails)
AgeInDays (VolumeSnapshotDetails) AgeInDays (VolumeSnapshotDetails) AgeInDays (VolumeSnapshotDetails) AgeInDays (VolumeSnapshotDetails)
IsAuthenticationEnabled/KeyId (SystemTimeSettings)
ServicePolicy (NetworkLifSettings) ServicePolicy (NetworkLifSettings) ServicePolicy (NetworkLifSettings) ServicePolicy (NetworkLifSettings)
IsScanMandatory (VscanOnAccessPolicies) IsScanMandatory (VscanOnAccessPolicies) IsScanMandatory (VscanOnAccessPolicies) IsScanMandatory (VscanOnAccessPolicies)
State (LunConfiguration) State (LunConfiguration) State (LunConfiguration) State (LunConfiguration)
LastTransferSize (SnapmirrorRelationships) LastTransferSize (SnapmirrorRelationships) LastTransferSize (SnapmirrorRelationships) LastTransferSize (SnapmirrorRelationships)
LastTransferDuration (SnapmirrorRelationships) LastTransferDuration (SnapmirrorRelationships) LastTransferDuration (SnapmirrorRelationships) LastTransferDuration (SnapmirrorRelationships)
LastTransferThroughput (SnapmirrorRelationships) LastTransferThroughput (SnapmirrorRelationships) LastTransferThroughput (SnapmirrorRelationships) LastTransferThroughput (SnapmirrorRelationships)
SnapshotMaxAgeInDays (FlexVolDataProtectionDetails) SnapshotMaxAgeInDays (FlexVolDataProtectionDetails)
TakeoverState (ClusterHaConfigurationDetails) TakeoverState (ClusterHaConfigurationDetails)
TakeoverReason (ClusterHaConfigurationDetails) TakeoverReason (ClusterHaConfigurationDetails)
CertName (SecurityCertificates) CertName (SecurityCertificates) CertName (SecurityCertificates) CertName (SecurityCertificates)

Fixes

  • [ALL] Excel cover page print area was incorrect (thanks TMAC).
  • [ONTAP_ASUP] DiskPartition data collection was missing entries.
  • [ONTAP/ONTAP_ASUP/SVM/SVM_ASUP] UnixGroups table throwing duplicate row errors (thanks Jeff).
  • Other minor fixes.

Notes

  • Visio drawing support on Linux/MAC clients may throw errors (or warnings) during document generation. If you encounter this you may need to manually add the drawings into the Word document.

[3.7.0]

Major Features

  • Added support for ONTAP 9.8.

Enhancements

  • Updated the NetApp DataONTAP PowerShell module to version 9.8.0.
  • Very slight speed improvements within the Format functions (using functions to filter instead of Where-Object on large collections).
  • Added a new -DataReplication switch to the Add-NtapDocsExtendedData function.
    • The previous -DataProtection switch now produces a new report that includes Snapshot related summary data (repurposed FlexVolDataProtection table).
    • The new -DataReplication switch generates the same report that the -DataProtection switch previously created (now called FlexVolDataReplicationDetails table).
  • Added a new -Terse switch parameter to the Format functions to exclude a pre-defined set of tables that can take an extended amount of time to process. See the FAQ entry for more information.
  • Updated all document templates and HTML help files to the latest NetApp branding standards.
  • Other internal improvements.

Content Changes

  • [ONTAP/SVM] Updated the CifsShareAcls tables (now using the separate API instead of parsing the .Acl property string on the share). Renamed 3 columns to match the API output (ShareName to Share, UserOrUnixGroupName to UserOrGroup, and AccessRights to Permission) and added the UserGroupType property.
  • [ONTAP] Renamed the FlexVolDataProtectionDetails (extended data) table to FlexVolDataReplicationDetails and repurposed the FlexVolDataProtectionDetails table for Snapshot related data (see Enhancements section above for additional information).
  • [ONTAP_ASUP] Removed ClusterContactDetails table. This information will be masked in the ASUP payload per PII regulations and no longer useful.
  • [ONTAP/ONTAP_ASUP] Added AvailableFirmwareRevision columns to NodeDetails, ShelfDetails, DriveDetails and ServiceProcessorDevices (these columns still remain in the FirmwareDetails table also).
  • [ALL] Added missing size columns '*In Gb' to tables where corresponding '*In Bytes' columns exists. This was partially done awhile ago but was incomplete.
  • [ONTAP/ONTAP_ASUP/SVM/SVM_ASUP] Moved FilesTotal and FilesUsed columns to the FlexVolSpaceDetails table.
  • [ONTAP/ONTAP_ASUP] Renamed the column 'MissingOrInvalidOwnerDiskCount' to 'UnassignedDiskCount' in the DriveAllocationDetails tables.
  • [ONTAP/ONTAP_ASUP] Renamed the column 'MissingOrInvalidOwnerDiskCount' to 'MissingDiskCount' and added the 'InvalidOwnerDiskCount' column in the ShelfDetails tables (split those calculations into separate columns).
  • Added new tables and new properties to existing tables (see tables below).

New Tables

ONTAP ONTAP ASUP SVM SVM ASUP 7-Mode 7-Mode ASUP
ClusterLogForwardDestinations ClusterLogForwardDestinations
FlexVolDataReplicationDetails (ExtendedData) FlexVolDataReplicationDetails (ExtendedData)
VolumeSnapshotDetails VolumeSnapshotDetails VolumeSnapshotDetails VolumeSnapshotDetails

New Columns in Existing Tables

ONTAP ONTAP ASUP SVM SVM ASUP 7-Mode 7-Mode ASUP
TieringMinimumCoolingDays (FlexVolConfiguration) TieringMinimumCoolingDays (FlexVolConfiguration) TieringMinimumCoolingDays (FlexVolConfiguration) TieringMinimumCoolingDays (FlexVolConfiguration)
8 x VolumeFootprint Sizing Properties (FlexVolSpaceDetails) 8 x VolumeFootprint Sizing Properties (FlexVolSpaceDetails) 8 x VolumeFootprint Sizing Properties (FlexVolSpaceDetails) 8 x VolumeFootprint Sizing Properties (FlexVolSpaceDetails)
UserGroupType (CifsShareAcls) UserGroupType (CifsShareAcls) UserGroupType (CifsShareAcls) UserGroupType (CifsShareAcls)
MacAddress (NetworkPortSettings) MacAddress (NetworkPortSettings)
MacAddress (NetworkPortVlanSettings) MacAddress (NetworkPortVlanSettings)
IsSmb31Enabled (CifsOptions) IsSmb31Enabled (CifsOptions) IsSmb31Enabled (CifsOptions) IsSmb31Enabled (CifsOptions)
PortUpdateStatusCombined (NetworkPortBroadcastDomains)
SecurityConfigRebootNeeded (NodeDetails)
SupportedCipherSuites (SecurityConfiguration)
AvailableFirmwareRevision (NodeDetails) AvailableFirmwareRevision (NodeDetails)
AvailableFirmwareRevision (ShelfDetails) AvailableFirmwareRevision (ShelfDetails)
AvailableFirmwareRevision (DriveDetails) AvailableFirmwareRevision (DriveDetails)
AvailableFirmwareRevision (ServiceProcessorDevices) AvailableFirmwareRevision (ServiceProcessorDevices)
IsPrefailed (DriveDetails) IsPrefailed (DriveDetails)
PartitioningType (DriveDetails) PartitioningType (DriveDetails)

Fixes

  • [ONTAP/SVM] Fixed duplicate row error in SvmAdministrativeUsers table (diag user).
  • [ONTAP] New error message handled properly for the Get-NcSecurityKeyManager cmdlet.
  • [ONTAP_ASUP] Fixed VolSpace parsing (sysconfig -v format has changed slightly in 9.8+)
  • [ONTAP/SVM] Worked around ZAPI issue with the QuotaTarget being returned in the wrong format (/vol/volume/qtree is invalid).
  • [ONTAP_ASUP] Fixed an issue when collecting ASUP data for a single node cluster.
  • [ONTAP/ONTAP_ASUP] Fixed some drive counts in the DriveAllocationDetails and ShelfDetails tables.
  • [SVM] Fixed an error when calling Get-NcFlexcache in Vserver context (ONTAP issue).
  • [ONTAP/SVM] Now suppressing warnings from the Get-NcLun/Get-NcLunMap cmdlets when encountering offline volumes.
  • Other minor fixes.

Notes

  • Removed support for OneCollect in this release. Support may be added back in a future release.

[3.6.0]

Major Features

  • ASUP authentication updated to support the new OAuth requirement.

Enhancements

  • Updated DataONTAP module (9.7.1) and all external libraries.

Content Changes

  • [ONTAP] Added 3 missing properties to the AggregateStorageEfficiency tables (DataReduction properties).
  • [ONTAP] Added Rev and DateCode information to AdapterCardDetails table.
  • [ONTAP/ONTAP_ASUP] Added Root and Data Home/Owner properties to DriveDetails tables.
  • [ONTAP/ONTAP_ASUP] Updated MetroCluster section in Word template.

New Columns in Existing Tables

Cluster Cluster ASUP Vserver Vserver ASUP 7-Mode 7-Mode ASUP
IsEncrypted (AggregateConfiguration) IsEncrypted (AggregateConfiguration)
IsInactiveDataReportingEnabled (AggregateConfiguration) IsInactiveDataReportingEnabled (AggregateConfiguration)
ContainingAggregateName (FlexVolSpaceDetails) ContainingAggregateName (FlexVolSpaceDetails) ContainingAggregateName (FlexVolSpaceDetails) ContainingAggregateName (FlexVolSpaceDetails)
PerformanceTierInactiveUserData (FlexVolSpaceDetails) PerformanceTierInactiveUserData (FlexVolSpaceDetails) PerformanceTierInactiveUserData (FlexVolSpaceDetails) PerformanceTierInactiveUserData (FlexVolSpaceDetails)
ContainingAggregateName (VolumeEfficiencySettings) ContainingAggregateName (VolumeEfficiencySettings) ContainingAggregateName (VolumeEfficiencySettings) ContainingAggregateName (VolumeEfficiencySettings)
ShelfDetails (ShelfStatus) ShelfDetails (ShelfStatus)

Fixes

  • [ONTAP_ASUP] Fixed RotationScheduleDescription code in FileServiceAuditionConfiguration tables.
  • [ONTAP] Fixed issues found in FlexCloneVolumeDetails tables.
  • [SVM] DataProtectionMirrors table not present in output.
  • [ONTAP_ASUP] Fixed errors in FlexVolSpaceDetails table.
  • [ONTAP_ASUP] Fixed errors in DebugVreport tables.
  • [ONTAP/ONTAP_ASUP] Fixed null property errors in MetroclusterIcMirrors tables. (thanks Eric)
  • [ONTAP] Fixed invalid boolean error on PartitionDetails table (when owning drive is offline). (thanks Michael)
  • [ONTAP/ONTAP_ASUP] Fixed Excel error when cell contents greater than max allowed (FpolicyScopeConfiguration table only). (thanks Andreas)
  • [ONTAP/ONTAP_ASUP] Fixed null errors in VirtualMachineInstances tables (ZAPI change).
  • [ONTAP/ONTAP_ASUP] Fixed duplicate row errors and improved the accuracy of the drive/partition tables.
  • [ONTAP] The command 'system cluster-switch show' can hang in certain environments. Changed to 'system cluster-switch show-all'. (thanks TMAC)
  • [ONTAP_ASUP] Find-NtapAsupSystemInfo wasn't returning any info for systems only sending in user_triggered ASUPs.
  • [Internal] Other minor fixes.

[3.5.1]

Major Features

  • None.

Enhancements

  • [All] Speed improvements to the table sort routine.

Content Changes

  • [ONTAP] ClusterSwitchDetails and ClusterSwitchInterfaceDetails tables now include cluster-network and management-network switches (NetworkSwitchDetails contains all other switches discovered).

New Columns in Existing Tables

Cluster Cluster ASUP Vserver Vserver ASUP 7-Mode 7-Mode ASUP
VmdiskHypervisorFileName (DriveDetails) VmdiskHypervisorFileName (DriveDetails)
SwitchType (ClusterSwitchInterfaceDetails) SwitchType (ClusterSwitchInterfaceDetails)

Removed Tables

Cluster Cluster ASUP Vserver Vserver ASUP 7-Mode 7-Mode ASUP
VirtualMachineSystemDisks VirtualMachineSystemDisks
NetworkSwitchInterfaceDetails

Fixes

  • [ONTAP] Fixed errors in aggregate tables when object stores in use.
  • [ONTAP] Fixed error in OneCollect data when an option is missing from the input file.
  • [ONTAP] Fixed issue with incorrect firmware version listed for switches of type 'OTHER' (now shows 'UTD').
  • [ASUP] Data collection speed improvements.
  • [ONTAP] More OneCollect fixes.
  • [Internal] Other minor fixes.

[3.5.0]

Notes

  • The next major version will include a better method of updating the Hardware-*.xml files. Currently, the files are posted to the community site and the files have to be copied into an installation subfolder. This requires admin privileges, since the default installation location is in C:\Program Files, and can be an issue in some environments. We ran out of time to get this changed for this release.

Major Features

  • ONTAP 9.5 support.

Enhancements

  • Minor internal enhancements.

Content Changes

  • [ONTAP/SVM] Renamed current FlexCacheVolumeConfiguration table to FlexCacheVolumeConfiguration82 and added new table in place for 9.5+ related data.

New Tables

Cluster Cluster ASUP Vserver Vserver ASUP 7-Mode 7-Mode ASUP
NodeOptions NodeOptions
ClusterSwitchInterfaceDetails
AutosupportBudgets AutosupportBudgets
AutosupportTriggers AutosupportTriggers
AggregateSpaceDetails AggregateSpaceDetails
FlexCloneVolumeDetails FlexCloneVolumeDetails
DiskEncryptionDetails
EventFilters EventFilters
EventNotifications EventNotifications
FlexCacheVolumeConfiguration82 FlexCacheVolumeConfiguration82 FlexCacheVolumeConfiguration82 FlexCacheVolumeConfiguration82
NvmeLifSettings NvmeLifSettings NvmeLifSettings NvmeLifSettings
NvmeServiceConfiguration NvmeServiceConfiguration NvmeServiceConfiguration NvmeServiceConfiguration
NvmeNamespaces NvmeNamespaces
NvmeSubsystems NvmeSubsystems NvmeSubsystems NvmeSubsystems
NvmeSubsystemHosts NvmeSubsystemHosts NvmeSubsystemHosts NvmeSubsystemHosts
NvmeSubsystemMaps NvmeSubsystemMaps NvmeSubsystemMaps NvmeSubsystemMaps

New Columns in Existing Tables

Cluster Cluster ASUP Vserver Vserver ASUP 7-Mode 7-Mode ASUP
ClusterDetails ClusterDetails
ClusterContactDetails ClusterContactDetails
NodeDetails NodeDetails
FlexVolConfiguration FlexVolConfiguration FlexVolConfiguration FlexVolConfiguration
FlexVolSpaceDetails FlexVolSpaceDetails FlexVolSpaceDetails FlexVolSpaceDetails
VolumeEfficiencySettings VolumeEfficiencySettings VolumeEfficiencySettings VolumeEfficiencySettings
SvmNdmpSettings SvmNdmpSettings SvmNdmpSettings SvmNdmpSettings
NfsServiceConfiguration NfsServiceConfiguration NfsServiceConfiguration NfsServiceConfiguration
CifsOptions CifsOptions CifsOptions CifsOptions
MetroClusterIcMirrors MetroClusterIcMirrors

Fixes

  • Fixed an issue with the Get-NtapVserverData function when using an alias for the -ClusterName parameter (such as an IP address).
  • Fixed data sanitization routines when cell contains newline separated entries.
  • Fixed an Out of Memory error when copying Visio drawings into Word document (updated Aspose libraries).
  • Invoking ASUP data collection functions from the PowerShell ISE would cause it to hang.
  • Fixed some error handling issues when running under a non en-US locale.
  • Other minor fixes.

Internal Changes

  • Minor code formatting and internal build updates.

[3.4.0]

Major Features

  • ONTAP 9.4 Support.

Enhancements

  • Added a new function (Add-NtapDocsExtendedData) that populates the FlexVolDataProtectionDetails table and expands the count of data protection properties in other tables. - This new function is run after the data for all systems has been formatted. More information is available in the help file for this function. - There is also an experimental -CustomScript parameter for running your own scripts to customize the DataSet prior to writing to the Excel files. A sample script is provided for review, but this feature will be more fully documented in the future.
  • You can now pipe the output from the Find-NtapAsupSystemInfo function into the Find-NtapClusterAsup or Find-NtapFilerAsup functions. If multiple systems are found during the initial search, a warning will be shown, and the system information will be written to the console for review and not piped to the subsequent functions.
  • The minimum access rights necessary to collect from a live ONTAP or 7-Mode system has been documented (see the FAQ entry for more details).

More information on the use of new parameters and functions may be found in their respective help files.

Content Changes

  • [ONTAP] Removed the StorageConfiguration table. - ClusterHaConfigured property moved to ClusterDetails table. - Added ShelfConnectivityDetails table (StorageConfiguration / ShelfAcpConnectivity properties). - Moved the other properties to a new ClusterHaConfigurationDetails table (which includes some additional properties).
  • [ONTAP] Added the cluster switch entries back into the NetworkSwitchDetails table. (thanks Chris)
  • [ONTAP/SVM] Added NetworkFailoverGroupTargets table (Excel Only). - Each failover target on its own row. - NetworkFailoverGroups table is now a Word only table.
  • [ONTAP/SVM] Additional properties added to the CifsSecuritySettings table.
  • [ONTAP/SVM] Moved all FlexVol sizing properties to the new FlexVolSpaceDetails (the configuration tables still display SizeNominal).
  • [ONTAP] Added PowerOnDuration to DriveDetails table.
  • [ONTAP] Added TotalShelves and TotalDrives to the ClusterStorageSummary table.

New Tables

Cluster Cluster ASUP Vserver Vserver ASUP 7-Mode 7-Mode ASUP
FlexVolSpaceDetails FlexVolSpaceDetails FlexVolSpaceDetails FlexVolSpaceDetails
NetworkFailoverGroupTargets NetworkFailoverGroupTargets NetworkFailoverGroupTargets NetworkFailoverGroupTargets
FlexVolDataProtectionDetails FlexVolDataProtectionDetails FlexVolDataProtectionDetails FlexVolDataProtectionDetails
ShelfConnectivityDetails ShelfConnectivityDetails
ClusterHaConfigurationDetails ClusterHaConfigurationDetails
NetworkSwitchInterfaceDetails

Fixes

  • Word document list/headings numbering was calculating incorrectly. (thanks tmac)
  • OneCollect parsing would fail with some input files. (thanks tmac)
  • Fixes some ASUP drive calculations when the drives are unowned (these will show up with DiskType of 'UNKNOWN' but will be properly accounted for). (thanks Doug)
  • Data sanitization fixes.
  • Miscellaneous fixes and updates.

Internal Changes

  • Re-organized project structure (moved from GitHub to VSTS).