User Guide
NetAppDocs
PowerShell Module
Jason Cole, NetApp
December 2021
Abstract
This guide is intended to provide an overview of the NetAppDocs PowerShell Module and
highlight some usage examples.
TABLE OF CONTENTS
Overview ...................................................................................................................................................... 4
Available Functions .................................................................................................................................................4
Features ....................................................................................................................................................... 5
Installation ................................................................................................................................................... 6
System Requirements .............................................................................................................................................6
Installation Procedure ..............................................................................................................................................7
Initial PowerShell Session Prerequisites ...............................................................................................................10
Getting Started .......................................................................................................................................... 11
Importing the module .............................................................................................................................................11
Accessing the Built-In Help ....................................................................................................................................11
Usage Examples ....................................................................................................................................... 12
Live Data Collection...............................................................................................................................................12
ASUP Data Collection ...........................................................................................................................................14
Creating Differences Reports ................................................................................................................................16
Data Sanitization ...................................................................................................................................................16
Using Alternate Credentials ...................................................................................................................................17
Adding Extended Data...........................................................................................................................................18
Frequently Asked Questions ................................................................................................................... 18
AutoSupport Missing Data ....................................................................................................................... 23
ONTAP ..................................................................................................................................................................23
ONTAP – SVM ......................................................................................................................................................25
Data ONTAP 7-Mode ............................................................................................................................................26
Data ONTAP 7-Mode (Transition) .........................................................................................................................27
Statistics Upload ....................................................................................................................................... 28
Troubleshooting ........................................................................................................................................ 29
Known Issues ............................................................................................................................................ 29
Support ...................................................................................................................................................... 29
Download ................................................................................................................................................... 29
Appendix .................................................................................................................................................... 31
APIs / CLI Commands / ASUP Sections Collected ................................................................................................31
Version History ......................................................................................................................................... 44
2
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
LIST OF TABLES
Table 1) NetAppDocs PowerShell module functions. .....................................................................................................4
Table 2) NetAppDocs-Lite PowerShell module functions. ..............................................................................................5
Table 3) Data sanitization options. ...............................................................................................................................16
Table 4) Terse tables excluded. ...................................................................................................................................22
Table 5) ONTAP ASUP missing tables. .......................................................................................................................23
Table 6) ONTAP ASUP missing columns. ....................................................................................................................23
Table 7) ONTAP SVM ASUP missing tables. ...............................................................................................................25
Table 8) ONTAP SVM ASUP missing columns. ...........................................................................................................25
Table 9) Data ONTAP 7-Mode ASUP missing tables. ..................................................................................................26
Table 10) Data ONTAP 7-Mode ASUP missing columns. ............................................................................................27
Table 11) Data ONTAP 7-Mode ASUP (Transition) missing tables. .............................................................................27
Table 12) Data ONTAP 7-Mode ASUP (Transition) missing columns. .........................................................................28
Table 13) Statistics properties. .....................................................................................................................................28
Table 14) ONTAP API (Cluster). ..................................................................................................................................31
Table 15) ONTAP CLI (Cluster). ...................................................................................................................................33
Table 16) ONTAP ASUP (Cluster). ..............................................................................................................................34
Table 17) ONTAP API (SVM). ......................................................................................................................................37
Table 18) ONTAP CLI (SVM). ......................................................................................................................................39
Table 19) ONTAP ASUP (SVM). ..................................................................................................................................39
Table 20) ONTAP API (7-Mode). ..................................................................................................................................40
Table 21) ONTAP CLI (7-Mode). ..................................................................................................................................42
Table 22) ONTAP ASUP (7-Mode) ...............................................................................................................................42
LIST OF FIGURES
No table of figures entries found.
3
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Overview
The NetAppDocs tool is written as a PowerShell module and contains a set of functions that automate the
creation of NetApp® site design documentation. NetAppDocs can generate Excel, Word and PDF
document types. The data contained in the output documents can be sanitized for use in sites where the
data may be sensitive.
Available Functions
The following functions are available with the NetAppDocs PowerShell module.
Table 1) NetAppDocs PowerShell module functions.
System Type
Function Name
Description
ONTAP
Get-NtapClusterData
Collects data from ONTAP storage systems.
Get-NtapClusterAsupData
Collects data for ONTAP storage systems using
ASUPs.
Format-NtapClusterData
Parses the raw data from the GetNtapClusterData / Get-NtapClusterAsupData
functions and optionally sanitizes the data for
secure environments.
Find-NtapClusterAsup
Finds a specific ASUP set for an ONTAP
storage system.
New-NtapClusterBuildDocument
Generates an ONTAP build document by
collecting the data from a live system.
New-NtapFilerAsupBuildDocument
Generates a Data ONTAP 7-Mode build
document by collecting the data from the most
recent set of ASUPs.
New-NtapClusterAsupDiffReport
Generates an ONTAP differences report from
two ASUP sets.
Get-NtapVserverData
Collects SVM specific data from ONTAP storage
systems.
Get-NtapVserverAsupData
Collects SVM specific data for ONTAP storage
systems using ASUPs.
ConvertTo-NtapVserverData
Converts ONTAP data from the GetNtapClusterData function to SVM specific data.
Format-NtapVserverData
Parses the raw data from the GetNtapVserverData / ConvertTo-NtapVserverData
functions and optionally sanitizes the data for
secure environments.
Get-NtapFilerData
Collects data from Data ONTAP 7-Mode storage
systems.
Get-NtapFilerAsupData
Collects data for Data ONTAP 7-Mode storage
systems using ASUPs.
Format-NtapFilerData
Parses the raw data from the Get-NtapFilerData
/ Get-NtapFilerAsupData functions and
optionally sanitizes the data for secure
environments.
Find-NtapFilerAsup
Finds a specific ASUP set for a Data ONTAP 7Mode storage system.
ONTAP (SVM)
7-Mode
4
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
System Type
Common
Function Name
Description
New-NtapFilerBuildDocument
Generates a Data ONTAP 7-Mode build
document by collecting the data from a live
system.
New-NtapFilerAsupBuildDocument
Generates a Data ONTAP 7-Mode build
document by collecting the data from the most
recent set of ASUPs.
New-NtapFilerAsupDiffReport
Generates a Data ONTAP 7-Mode differences
report from two ASUP sets.
Show-NtapDocsHelp
Displays the NetAppDocs documentation in a
browser.
Get-NtapDocsVersion
Displays the NetAppDocs version.
Add-NtapDocsExtendedData
Adds extended data to the formatted output
(DataSet).
Find-NtapAsupSystemInfo
Finds the system information for a given NetApp
ONTAP storage system from the ASUP Data
Warehouse.
Compare-NtapDocsData
Creates a differences report from two outputs
generated using the Format-Ntap*Data functions
(using the -XmlFile parameter with the OutNtapDocument function).
Merge-NtapDocsData
Merges two or more DataSets generated using
the Format-Ntap* functions and output using the
-XmlFile parameter with the Out-NtapDocument
function.
Export-CompressedClixml
Compresses the raw data output from the GetNtap* functions (as an alternative to the
uncompressed Export-Clixml function).
Out-NtapDocument
Writes output documentation using the output
from the Format-Ntap* functions.
Update-NtapDocument
Used to update an existing Word or Excel
document generated by the Out-NtapDocument
function.
Invoke-SsoLogin
Queries the user for SSO login credentials and
caches the results (required for ASUP access).
The following functions are available with the NetAppDocs-Lite PowerShell module.
Table 2) NetAppDocs-Lite PowerShell module functions.
System Type
Function Name
Description
ONTAP
Get-NtapClusterData
Collects data from ONTAP storage systems.
ONTAP (SVM)
Get-NtapVserverData
Collects SVM specific data from ONTAP storage systems.
7-Mode
Get-NtapFilerData
Collects data from Data ONTAP 7-Mode storage systems.
Common
Export-CompressedClixml
Compresses the raw data output from the Get-Ntap*
functions (as an alternative to the uncompressed ExportClixml function).
Features
The features available with the NetAppDocs PowerShell module are listed below.
5
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
•
Supported Systems
•
−
Data ONTAP 7-Mode 7.2.x, 7.3.x, 8.0.x, 8.1.x, 8.2.x.
−
Clustered Data ONTAP 8.1.x, 8.2.x, 8.3.x.
−
ONTAP 9.x.
Creates NetApp site design documentation
•
−
Creates detailed inventory reports in Word, Excel and PDF formats.
−
Provides a current ‘snapshot’ of the state of the storage system.
−
Creates a summary of objects (e.g., aggregates, volumes, LUNs, etc.).
−
Can include existing Visio drawings in the Word/PDF output.
AutoSupport (ASUP)
−
Captures the data for a storage system from the ASUP database.
Note:
•
ASUP data is not as complete as the data captured from a live system.
Differences report
−
•
A differences report can be generated using the formatted output produced at two different times
(for config management purposes).
SVM-specific documentation (SMT / Co-Lo type facilities)
−
•
SVM-specific documentation can be generated and delivered to the SVM owner, without
compromising the data for the other SVMs in the cluster.
Localized templates
−
•
The framework for localized templates is in place. Additional locales are being worked on and will
be available soon.
Transition planning and assessment (7-Mode)
−
•
Used by Professional Services resources performing 7-Mode to ONTAP transitions.
Data sanitization
−
•
The output data can be sanitized for use in secure sites (e.g., data such as IP addresses,
hostnames, volume names, etc.). A ‘mappings’ file can be generated, which provides a reference
back to the original string.
NetAppDocs-Lite package available for live data collection only
−
The NetAppDocs-Lite package, which only supports the data collection functions, can be used by
the customer if directed by the PS representative (for instance, if a site visit is not possible). The
data collected can then be sent to the PS representative for document generation.
Installation
The MSI installer package is the recommended method for installing this module at this time.
System Requirements
•
Microsoft Windows
•
−
Windows PowerShell 5.1+ or PowerShell 7.0.3+.
−
Microsoft .NET Framework 4.5 or higher.
MAC/Linux:
•
−
PowerShell 7.0.3+ and 7.1+ (7.2+ support coming soon).
−
Libgdiplus and libc6-dev packages.
NetApp Data ONTAP PowerShell Toolkit (included in the zip file or install package).
6
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
•
Internal NetApp connection and SSO login required for ASUP data collection.
Installation Procedure
Note:
The installation procedure for the NetAppDocs-Lite package is identical to the main installation,
except for the installer file.
1. If necessary, download and install Windows PowerShell and the .Net Framework.
Note:
PowerShell is installed by default in most recent Windows versions.
2. Download the latest NetAppDocs installer file (.msi).
3. Double-click on the installer file (.msi) and follow the installation screens to complete the installation.
4. Click Next.
5. Accept the license agreement and click Next.
7
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
6. Choose the installation path (default path is recommended). Click Next.
7. Click Install.
8
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
8. Accept any additional UAC dialog boxes and click ‘Finish’ to complete the installation (optionally
display the release notes).
9
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Initial PowerShell Session Prerequisites
Setting up the PowerShell Execution Policy
After installing the module, the default PowerShell execution policy must be modified to anything other
than the default of ‘Restricted’.
Note:
Setting the PowerShell execution policy only needs to be done once per system.
1. Open PowerShell window. Click Start -> All Programs -> Accessories -> Windows PowerShell Folder.
Right click on Windows PowerShell executable and select ‘Run as administrator’ as shown below.
2. Set the PowerShell execution policy and verify:
Windows PowerShell
Copyright (C) 2014 Microsoft Corporation. All rights reserved.
PS> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
Execution Policy Change
The execution policy helps protect you from scripts that you do not trust.
Changing the execution policy might expose you to the security risks
described in the about_Execution_Policies help topic at
http://go.microsoft.com/fwlink/?LinkID=135170. Do you want to change the
execution policy?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
PS>
PS> Get-ExecutionPolicy
RemoteSigned
PS>
3. Close the PowerShell session.
10
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Getting Started
Importing the module
The module only needs to be imported once per session.
•
Import the module. Verify the module is loaded (optional):
PS> Import-Module NetAppDocs
PS> Get-Module -Name NetAppDocs
ModuleType Version
---------- ------Script
4.0.0
Connect-NaController,
Name
---NetAppDocs
Connect-NcController...}
ExportedCommands
---------------{Add-NaCredential, Add-NcCredential,
Accessing the Built-In Help
The module is fully documented using the PowerShell help subsystem. Once the module is imported, you
can invoke the Show-NtapDocsHelp function. This will open a web browser to the HTML help files.
You can also utilize the native PowerShell functions for accessing help information. To show all the
available functions:
PS> Show-NtapDocsHelp
PS> Get-Command -Module NetAppDocs
CommandType
----------Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Function
Name
---Add-NtapDocsExtendedData
Compare-NtapDocsData
ConvertTo-NtapVserverData
Export-CompressedClixml
Find-NtapAsupSystemInfo
Find-NtapClusterAsup
Find-NtapFilerAsup
Format-NtapClusterData
Format-NtapFilerData
Format-NtapVserverData
Get-NtapClusterAsupData
Get-NtapClusterData
Get-NtapDocsVersion
Get-NtapFilerAsupData
Get-NtapFilerData
Get-NtapVserverAsupData
Get-NtapVserverData
Invoke-SsoLogin
Merge-NtapDocsData
New-NtapClusterAsupBuildDocument
New-NtapClusterAsupDiffReport
New-NtapClusterBuildDocument
New-NtapFilerAsupBuildDocument
New-NtapFilerAsupDiffReport
New-NtapFilerBuildDocument
Out-NtapDocument
Show-NtapDocsHelp
Update-NtapDocument
Version
------4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
4.0.0
Source
-----NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
NetAppDocs
More detailed information on any function can be shown using the Get-Help cmdlet. To display the full
help for a function, use the -Full parameter with the Get-Help function.
PS> Get-Help -Name Get-NtapClusterData
NAME
Get-NtapClusterData
11
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
SYNOPSIS
Collects data from ONTAP storage systems.
SYNTAX
Get-NtapClusterData [-Name] <String[]> [-Credential <PSCredential>] [-Port <Int32>] [-Timeout
<Int32>] [-ForceSecure] [-DisablePingCheck] [-DisableAsupInvoke] [-InvokeAsup]
[<CommonParameters>]
Get-NtapClusterData [-AbstractController] <AbstractController[]> [-Timeout <Int32>] [DisablePingCheck] [-DisableAsupInvoke] [-InvokeAsup] [<CommonParameters>]
DESCRIPTION
Uses the NetApp ONTAP PowerShell toolkit to gather as much configuration information as
possible. This
data can be used to automate build docs and health checks. It can also be used for historical
configuration information.
RELATED LINKS
https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
Format-NtapClusterData
REMARKS
To see the examples, type: "get-help Get-NtapClusterData -examples".
For more information, type: "get-help Get-NtapClusterData -detailed".
For technical information, type: "get-help Get-NtapClusterData -full".
For online help, type: "get-help Get-NtapClusterData -online"
Additional Notes
By default, no progress or output is shown on the screen while the functions are running (errors will
always be displayed). To enable additional status output, use the -Verbose parameter on any of the
functions. As an example:
PS> Get-NtapClusterData -Name den-cdot -Verbose | Format-NtapClusterData -Verbose | OutNtapDocument -ExcelFile X:\den-cdot.xlsx –Verbose
Usage Examples
Live Data Collection
ONTAP (Cluster View)
Perform Collection and Documentation Generation in a Single Step
This example shows how to gather the data from a single cluster and output the documents in a single
step.
PS> Get-NtapClusterData -Name 'cluster1' | Format-NtapClusterData | Out-NtapDocument -WordFile
'D:\Output\cluster1.Docx' -ExcelFile 'D:\Output\cluster1.xlsx'
Collect in One Step and Generate Documentation in a Second Step
This example is useful if you need to quickly gather the data from the storage system(s) and then
generate the documentation at a later time.
•
Collect from a single storage system:
PS> Get-NtapClusterData -Name cluster1 | Export-Clixml -Path 'D:\Output\cluster1_raw.xml'
•
Collect from multiple storage systems:
12
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
PS> 'cluster1', 'cluster2' | ForEach-Object { $_ | Get-NtapClusterData | Export-Clixml -Path
"D:\Output\$($_)_raw.xml" }
•
Generate documentation:
PS> Get-ChildItem -Path 'D:\Output' -Filter *_raw.xml | Format-NtapClusterData | Out-NtapDocument
-WordFile 'D:\Output\Site.Docx' -ExcelFile 'D:\Output\Site.xlsx'
ONTAP (SVM View)
Perform Collection and Documentation Generation in a Single Step for all SVMs
This example gathers the SVM data for all SVMs directly from an ONTAP storage system and generates
the documents required.
PS> Get-NtapVserverData -ClusterName 'cluster1' | Format-NtapVserverData | Out-NtapDocument WordFile 'D:\Output\All_SVMs.docx' -ExcelFile 'D:\Output\All_SVMs.xlsx'
Perform Collection and Documentation Generation in a Single Step for Specific SVMs
This example gathers the SVM data for specific SVMs directly from an ONTAP storage system and
generates the documents required.
PS> Get-NtapVserverData -Name 'vs_nfs', 'vs_cifs' -ClusterName 'cluster1' | FormatNtapVserverData | Out-NtapDocument -WordFile 'D:\Output\Nas_SVMs.docx' -ExcelFile
'D:\Output\Nas_SVMs.xlsx'
Create SVM Specific Documentation from Data Created by Get-NtapClusterData
This example shows how to gather the data one time from the cluster and provide both cluster
documentation and the SVM-specific data.
•
Gather the raw data:
PS> Get-NtapClusterData -Name 'cluster1' | Export-Clixml -Path 'D:\cluster1_raw.xml'
•
Create the cluster specific documentation:
PS> Get-ChildItem -Path 'D:\cluster1_raw.xml' | Format-NtapClusterData | Out-NtapDocument ExcelFile 'D:\Output\cluster1_data.xlsx'
•
Create the SVM specific documentation:
PS> Get-ChildItem -Path 'D:\cluster1_raw.xml' | ConvertTo-NtapVserverData | FormatNtapVserverData | Out-NtapDocument -ExcelFile 'D:\Output\All_SVMs-from_ClusterData.xlsx'
7-Mode
Perform Collection and Documentation Generation in a Single Step
This example shows how to gather the data from two controllers and output the documents in a single
step.
PS> Get-NtapFilerData -Name 'controller1', 'controller2' | Format-NtapFilerData | OutNtapDocument -WordFile 'D:\Output\Site.Docx' -ExcelFile 'D:\Output\Site.xlsx'
Collect in One Step (Raw XML Output) and Generate Documentation in a Second Step
This example is useful if you need to quickly gather the data from the storage system(s) and then
generate the documentation at a later time.
•
Collect from multiple storage systems:
13
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
PS> Get-NtapFilerData -Name 'controller1', 'controller2' | Export-Clixml -Path 'D:\Output\7ModeControllers_raw.xml'
•
Generate documentation:
PS> Get-ChildItem -Path 'D:\Output\7Mode-Controllers_raw.xml' | Format-NtapFilerData | OutNtapDocument -WordFile 'D:\Output\Site.Docx' -ExcelFile 'D:\Output\Site.xlsx'
ASUP Data Collection
By default, the Get-NtapClusterAsupData and Get-NtapFilerAsupData functions will search for the latest
weekly ASUP set. You can also search for the latest 'user_triggered' ASUP set using the -AsupSubject
user_triggered parameter. To locate an ASUP set other than the latest you must either use the FindNtapClusterAsup/Find-NtapFilerAsup functions, or supply the actual ASUPID's (these can be found using
NTSTP/SmartSolve).
Note:
SSO login credentials are required for ASUP access (as of version 3.1). You will be prompted for
these credentials (once per PowerShell session) prior to using any of the ASUP Find-*/Get-*
functions. You can also cache the credentials manually by using the Invoke-SsoLogin function.
ONTAP
Perform Collection and Documentation Generation in a Single Step
This example shows how to gather the data from a single cluster and output the documents in a single
step.
PS> Get-NtapClusterAsupData -Cluster 'den-cdot:394e82bf-485c-11e2-86b3-123478563412' | FormatNtapClusterData | Out-NtapDocument -WordFile 'D:\Output\den-cdot_Asup.Docx' -ExcelFile
'D:\Output\den-cdot_Asup.xlsx'
Collect in One Step (Raw XML Output) and Generate Documentation in a Second Step
This example is useful if you need to quickly gather the data from the storage system(s) and then
generate the documentation at a later time.
•
Collect from a single storage system:
PS> Get-NtapClusterAsupData -Cluster 'den-cdot:394e82bf-485c-11e2-86b3-123478563412' | ExportClixml -Path 'D:\Output\den-cdot_Asup-raw.xml'
•
Collect from multiple storage systems:
PS> 'cluster1:394e82bf-485c-11e2-86b3-123478563412', 'cluster2:dc1505b8-b993-11e3-9ee7123478563412' | ForEach-Object { $_ | Get-NtapClusterAsupData | Export-Clixml -Path
"D:\Output\$(($_ -split ':')[0])_Asup-raw.xml" }
•
Generate documentation:
PS> Get-ChildItem -Path 'D:\Output' -Filter *_Asup-raw.xml | Format-NtapClusterData | OutNtapDocument -WordFile 'D:\Output\Site_Asup.Docx' -ExcelFile 'D:\Output\Site_Asup.xlsx'
Find the Cluster Identifier and Perform the Data Collection
If you don't know the Cluster Identifier (UUID) you will need to search the ASUP database for it using the
serial number from one of the nodes in the cluster. You can then gather the data as in the previous
examples.
•
Search for the Cluster UUID:
PS> Find-NtapAsupSystemInfo -ClusterName den-cdot -NodeSerialNumber 700000454908
cluster_name
: den-cdot
cluster_identifier : 394e82bf-485c-11e2-86b3-123478563412
sys_serial_no
: 700000454908
sys_model
: FAS6080
14
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
sys_operating_mode : Cluster-Mode
sys_version
: 8.2.2P2
•
Collect from the storage system using the cluster_identifer:
PS> Get-NtapClusterAsupData -Cluster 'den-cdot:394e82bf-485c-11e2-86b3-123478563412' | ExportClixml -Path 'D:\Output\den-cdot-Asup_raw.xml'
Find the First Validated Weekly ASUP set Using Specific Dates and Perform the Data
Collection
This example highlights how to search the ASUP database using specific dates and performing the data
collection.
PS> Find-NtapClusterAsup -Cluster 'den-cdot:394e82bf-485c-11e2-86b3-123478563412' -StartDate
2014-12-01 -EndDate 2014-12-15 | Get-NtapClusterAsupData | Export-Clixml -Path 'D:\Output\dencdot-Asup_raw.xml'
Perform the Data Collection Using Specific ASUPIDs
This example performs the data collection using the specified ASUPIDs.
Get-NtapClusterAsupData -AsupId 2015012500120554!2015012423440127 | Export-Clixml 'D:\Output\dencdot-Asup_raw.xml'
7-Mode
Perform Collection and Documentation Generation in a Single Step
This example shows how to gather the data from 2 controllers and output the documents in a single step.
PS> Get-NtapFilerAsupData -System 'mtharvard:30020945!mtmassive:30020946' | Format-NtapFilerData
| Out-NtapDocument -WordFile 'D:\Output\mtharvard-mtmassive_Asup.Docx' -ExcelFile
'D:\Output\mtharvard-mtmassive_Asup.xlsx'
Collect in One Step (Raw XML Output) and Generate Documentation in a Second Step
This example is useful if you need to quickly gather the data from the storage system(s) and then
generate the documentation at a later time.
•
Collect from multiple storage systems:
PS> Get-NtapFilerAsupData -System 'mtharvard:30020945!mtmassive:30020946' | Export-Clixml -Path
'D:\Output\mtharvard-mtmassive_Asup-raw.xml'
•
Generate documentation:
PS> Get-ChildItem -Path 'D:\Output\mtharvard-mtmassive_Asup-raw.xml' | Format-NtapFilerData |
Out-NtapDocument -WordFile 'D:\Output\mtharvard-mtmassive_Asup.docx' -ExcelFile
'D:\Output\mtharvard-mtmassive_Asup.xlsx'
Find the First Validated Weekly ASUP Set using Specific Dates and perform the Data
Collection
PS> Find-NtapFilerAsup -System 'mtharvard:30020945!mtmassive:30020946' -StartDate 10-15-2014 EndDate 11-15-2014 | Get-NtapFilerAsupData | Export-Clixml 'D:\Output\mtharvard-mtmassive_Asupraw.xml'
Perform the Data Collection Using Specific ASUPIDs
This example performs the data collection using the specified ASUPIDs.
15
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
C:\PS> Get-NtapFilerAsupData -AsupId 2015011716380597!2015011716330550 | Export-Clixml
'D:\Output\mtmassive_mtharvard-Asup_raw.xml'
Creating Differences Reports
To create diff reports, the data from the Format-Ntap*Data functions must be saved as .XML files through
the Out-NtapDocument function using the -XmlFile parameter. This functionality is only available starting
with NetAppDocs v2.6.0.
Note:
As of NetAppDocs 3.2P1, both sets of data to be passed to the Compare-NtapDocsData function
must have been formatted by at least NetAppDocs v3.2. This was due to all the table naming
changes between 3.1P1 and 3.2. Please see the FAQ entry for more information.
PS> Get-NtapClusterData -Name 'den-cdot' | Format-NtapClusterData | Out-NtapDocument -XmlFile
X:\den-cdot_01-2014.xml
PS> Get-NtapClusterData -Name 'den-cdot' | Format-NtapClusterData | Out-NtapDocument -XmlFile
X:\den-cdot_02-2014.xml
PS> Compare-NtapDocsData -XmlFile1 X:\den-cdot_01-2014.xml -XmlFile2 X:\den-cdot_02-2014.xml |
Out-NtapDocument -XlxsFile X:\den-cdot_DiffReport.xlsx
Data Sanitization
Each of the Format-Ntap*Data functions support a -SanitizeLevel parameter, allowing the use of
NetAppDocs within secure sites. The sanitization options are different depending on the system type and
are shown in the table below.
Table 3) Data sanitization options.
System Type
Numeric
Value
7-Mode
1
2
4
8
16
32
64
128
256
512
1024
2048
4096
8192
16384
ONTAP
1
2
4
8
16
32
64
128
256
512
16
NetAppDocs User Guide
Sanitization Option
IP Address
MAC Address
Controller Name
DNS Domain Name
Vfiler Name
License Code
Aggregate Name
Volume Name
Qtree Name
LUN Name
LUN Initiator Group Name
Other Servers
SNMP Community String
CIFS Share Name
Active Directory NetBIOS Name
IP Address
MAC Address
Node Name
DNS Domain Name
SVM Name
License Code
Aggregate Name
Volume Name
Qtree Name
LUN Name
© 2021 NetApp, Inc. All Rights Reserved.
System Type
Numeric
Value
1024
2048
4096
8192
16384
32768
ONTAP (SVM)
Note:
•
1
2
8
16
128
256
512
1024
2048
4096
8192
16384
Sanitization Option
LUN Initiator Group Name
Other Servers
SNMP Community String
CIFS Share Name
Active Directory NetBIOS Name
Data ONTAP Cluster Name
IP Address
MAC Address
DNS Domain Name
SVM Name
Volume Name
Qtree Name
LUN Name
LUN Initiator Group Name
Other Servers
SNMP Community String
CIFS Share Name
Active Directory NetBIOS Name
To sanitize multiple entries, simply add up the numbers.
7-Mode (sanitize IP Addresses and Controller Names: 1 + 4):
PS> Get-NtapFilerData -Name mtmassive, mtharvard | Format-NtapFilerData -SanitizeLevel 5 | OutNtapDocument -ExcelFile X:\7-Mode_sanitized.xlsx
•
ONTAP (sanitize IP Address, Node Name and SVM Name: 1 + 4 + 16):
PS> Get-NtapClusterData -Name den-cdot | Format-NtapClusterData -SanitizeLevel 21 | OutNtapDocument -ExcelFile X:\den-cdot_sanitized.xlsx
Using Alternate Credentials
All of the previous examples assume that the user account running the commands has administrative
access to the controllers. If that is not the case, Get-NtapFilerData, Get-NtapClusterData and GetNtapVserverData will accept alternate credentials through the -Credential parameter.
If the user account credentials will be the same across all controllers or clusters (for instance, 'root'), then
you can prompt for the credentials once and those credentials will be used for each connection.
•
7-Mode
PS> $Credential = Get-Credential
PS> Get-NtapFilerData -Name 'controller1', 'controller2' -Credential $Credential | ...
•
ONTAP
PS> $Credential = Get-Credential
PS> Get-NtapClusterData -Name 'cluster1', 'cluster2' -Credential $Credential | ...
•
ONTAP (SVM)
PS> $Credential = Get-Credential
PS> Get-NtapVserverData -ClusterName 'cluster1' -Credential $Credential | ...
If, however, each controller or cluster has different credentials, there is a mechanism within the NetApp
Data ONTAP PowerShell Toolkit for caching those credentials. It is possible to save the credential for the
current user or for all users (-SystemScope parameter). Upon connection to a controller, the credentials
cache will be queried for an entry to the controller specified.
17
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
•
7-Mode
PS> Add-NaCredential -Controller 'controller1' -Credential (Get-Credential)
•
ONTAP
PS> Add-NcCredential -Controller 'cluster1' -Credential (Get-Credential)
Note:
More help on Add-NaCredential, Get-NaCredential and Remove-NaCredential (or the equivalent
Add-NcCredential, Get-NcCredential and Remove-NcCredential for ONTAP) can be found within
the help files for the Data ONTAP module. (Import-Module DataONTAP; Show-NaHelp)
Adding Extended Data
The Add-NtapDocsExtendedData function will process the formatted data (DataSet) and add additional
information that is only available once the data from all the systems has been formatted. This currently
includes additional data protection information (such as cascade SnapMirrors) via the -DataProtection
switch parameter. More functionality will be available in future releases. However, you can also specify a
custom script to add any other information required (via the -CustomScript parameter). An example script
is provided in the 'Resources/ExtendedDataScriptExamples' folder. Note that any additional output will be
output only to Excel documents.
•
Adding the DataProtection extended data
PS> Get-NtapClusterData -Name cluster1, cluster2 | Format-NtapClusterData | AddNtapDocsExtendedData -DataProtection | Out-NtapDocument -ExcelFile 'D:\cluster1_extended.xlsx'
•
Using a custom script to add extended data
PS> Get-NtapClusterData -Name cluster1, cluster2 | Format-NtapClusterData | AddNtapDocsExtendedData -CustomScript 'D:\AddCustomColumnsToDataSet.ps1' | Out-NtapDocument ExcelFile 'D:\cluster1_extended.xlsx'
Frequently Asked Questions
Why do I need to modify the PowerShell Execution Policy?
Answer: By default, the PowerShell Execution Policy is set to 'Restricted'. This means that no scripts can
be run and that PowerShell can be used only in interactive mode. These scripts are digitally signed so the
policy can be set to either 'Unrestricted', 'RemoteSigned' or 'Allsigned'.
Why does it seem like nothing is happening when I invoke the scripts (no status output shown)?
Answer: By default, no status output is written to the screen. As this is a PowerShell module, the best
practice is not to use Write-Host for status. My plan, moving forward, is to include a GUI front end for this
module that will provide that status output. But, in the meantime, you can specify a -Verbose to all of the
functions and you will see detailed status information.
For example:
PS> Get-NtapClusterData -Name cluster1 -Verbose
Alternatively, within your PowerShell session you can just set the $VerbosePreference to 'Continue' and
this will turn on -Verbose for every command invoked within that session.
PS> $VerbosePreference = 'Continue'
18
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
I just got a warning when I imported the module that stated the "Hardware-ONTAP.xml file is out
of date." What does this mean?
Answer: The Hardware-ONTAP.xml file contains the latest OS and firmware versions for the hardware
components such as controllers, shelves and disks. This file gets generated whenever a new version of
the NetAppDocs package is released or at least once a month. The latest version can always be found at
the same location where the NetAppDocs packages are found. If you see this warning you can go to the
site, download the file and overwrite the existing file located in the Resources folder underneath the
NetAppDocs installation folder.
Using Windows 10, I am unable to connect to a Data ONTAP 7-Mode storage system using HTTPS.
What is the issue?
Answer: By default, the key length used when generating SSL certificates using secureadmin setup ssl in
7-Mode is 512 bits. Windows 10 no longer accepts a certificate with this key length so the HTTPS
connection fails. If using HTTP is not possible, then you must generate a new certificate using a key
length of at least 1024 bits. This shouldn't affect ONTAP, since the default key length in cDOT is 2048
bits. However, it is possible to generate a 512 bit key in cDOT so this same issue could be encountered.
I just got a warning that said the version of NetAppDocs being used to generate the
documentation is older than the version used to collect the data from the systems. Why is this a
problem? Or, I'm sure I'm using the same versions but it tells me that I am not. How can this be
possible?
Answer: Between releases, I may add to or modify the object that is created when the data is gathered off
of the systems. I try my best to be backwards compatible with previous changes but when I change the
structure during the data gathering then older versions may not be able to parse that data properly, hence
the warning message.
If you are certain you have the same versions installed, then it may be that you have another copy of an
older release somewhere else in your path that is getting imported instead of the release that you intend
to be using. To identify which version is importing and where it is installed, run the following:
PS> Import-Module -Name NetAppDocs
PS> Get-Module -Name NetAppDocs | Select-Object -Property Name, Version, ModuleBase
If the version is outdated, you can remove it from the path shown and start over with a fresh PowerShell
session.
I just got an error on the screen stating that 'An unexpected error occurred...' and then the
execution was halted. What do I do now?
Answer: We added some error handling within the code to catch any errors that are outside the Data
ONTAP PowerShell toolkit errors or any problems with the systems themselves (those types of errors are
handled specifically and, hopefully, gracefully). This typically shows up when we are performing an action
and the value is null or empty. An error is thrown and the script is terminated. These are, most definitely,
unexpected errors and we would very much appreciate you sending an email to the support staff. Usually
the fix is simple and the error message should be descriptive enough to help me identify the issue, but
only if we hear about it!
I just got a warning message stating 'Empty DataSet found so document generation not possible.
Answer: This indicates that an issue was encountered either during the data collection or during the
formatting of the data. We try to capture and display any errors that would result in no data being
processed. If no error was not presented on the screen it may be containined within the $Error variable.
You can see the contents of this variable by simply running:
PS> $Error
19
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
If it is still unclear as to what the issue is you can contact us using the community site or the e-mail
address to help troubleshoot. We will most likely want the screen shot of the -Verbose output as well as
any error messages.
I just got a warning message stating 'document parameters were not specified'. What does this
mean?
Answer: The Out-NtapDocument function accepts four parameters (CustomerName, CustomerLocation,
ProjectName and AuthorName) that, when specified, will be shown on the cover page of the output
document (Excel or Word output). If you omit these parameters, the default values will be present on the
cover page and should remind you to manually fill those in. However, the proper method for manually
updating these values will depend on which type of document (Excel or Word).
The preferred way to update these documents is to simply use the Update-NtapDocument function
with the appropriate parameters.
•
Word Document
To update the Word document you must modify the custom document properties (Author: File ->
Properties -> Advanced Properties / Others: File -> Properties -> Advanced Properties -> Custom).
Once updated, highlight the four relevant lines on the cover page and press the 'F9' key.
•
Excel Document
Since it is not possible to use the document properties in the Excel document itself (without using
VBA code), you must modify the value directly in the cover page (replace the ' <Customer Name>'
text, for example). You may also update the document property the same way you modify it in Word.
However, this is only set in the Excel document for consistency with the Word document and you'll
still have to update the cover page directly.
When trying to generate a differences report with the Compare-NtapDocsData function I get an
error stating that the DataSets need to be formatted using at least v3.2.0 of NetAppDocs. What
does this mean?
Answer: During development for v3.2.0, many changes were made to the DataSet schemas that have
made generating differences reports against the older versions difficult. We had to make the decision to
no longer support any formatted data prior to v3.2.0. We do apologize for this inconvenience and in an
upcoming release we will be making the necessary changes in the difference report generation code to
allow for processing data from different NetAppDocs versions (still v3.2.0+ though).
Please send us a quick email to NetAppDocs Support and let us know that you have been affected by this
scenario. We have not seen significant adoption of this feature and are unsure how often a difference
report is generated over greater periods of time.
Is there really nothing I can do to get this differences report generated?
If you still have the raw files used to generate the earlier formatted data, you can use the latest
NetAppDocs version to format those files again and generate an updated formatted XML file. We added a
new -ForceOrder parameter to the Compare-NtapDocsData function for this scenario (where the 'older'
data was formatted after the most recent data was formatted). This -ForceOrder parameter would be
necessary since, by default, the function uses the timestamps the data was formatted to identify the
oldest and the newest formatted DataSets. In this scenario, the older DataSet would have the later
timestamp and so the Compare-NtapDocsData function would sort them incorrectly. You specify the
oldest DataSet using the -DataSet1 parameter, the newest DataSet using the -DataSet2 parameter and
the -ForceOrder parameter will force the sort order properly.
20
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
During the Format function, I get an error stating "A null value was not expected (table:
<TableName>)". What does this mean?
Answer: When adding support for differences reports (the Compare-NtapDocsData function) each table
needed to have unique ID columns added. These are typically 'UUID' fields. Once these columns are set
as PrimaryKeys for the table, the value for these columns can not be null. This error means that, for
whatever reason, a value for a column defined as a PrimaryKey was null. To make sure that the data is
still present in the table we remove the PrimaryKeys and set this column to AllowDbNull. The only effect
this has on the table is that if the data is used as input to the Compare-NtapDocsData function for
generating a differences report in the future, this table will be excluded from those differences
calculations.
As the error message suggests, please contact us to let us know that you have run into this scenario. In
some cases, we must calculate these UUID fields and knowing about these errors will help us code these
calculations more accurately.
What are the minimum rights necessary to collect data from a NetApp storage system?
Answer: If the admin user (or a user with the role of admin) is not available for use within the
environment, a more restricted user and role can be created using the following commands:
ONTAP:
CLI
security login role create -role netappdocsrole -vserver <ClusterName> -cmddirname DEFAULT access readonly
security login role create -role netappdocsrole -vserver <ClusterName> -cmddirname set -access
all
security login role create -role netappdocsrole -vserver <ClusterName> -cmddirname "system node
run" -access all
security login create -user-or-group-name netappdocs -vserver <ClusterName> -authenticationmethod password -role netappdocsrole -application ontapi
security login create -user-or-group-name netappdocs -vserver <ClusterName> -authenticationmethod password -role netappdocsrole -application console
security login password -vserver <ClusterName> -username netappdocs
PowerShell
New-NcRole -Role netappdocsrole -Vserver <ClusterName> -CommandDirectory DEFAULT -AccessLevel
readonly
New-NcRole -Role netappdocsrole -Vserver <ClusterName> -CommandDirectory set -AccessLevel all
New-NcRole -Role netappdocsrole -Vserver <ClusterName> -CommandDirectory 'system node run' AccessLevel all
New-NcUser -UserName netappdocs -Vserver <ClusterName> -AuthMethod password -Role netappdocsrole
-Application ontapi
New-NcUser -UserName netappdocs -Vserver <ClusterName> -AuthMethod password -Role netappdocsrole
-Application console
Set-NcUserPassword -UserName netappdocs -VserverContext <clustername> -Password <password>
7-Mode:
CLI
21
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
useradmin role add netappdocsrole -a login-http-admin,api-*,cli-*,security-api-vfiler,securitypriv-advanced
useradmin group add netappdocsgroup -r netappdocsrole
useradmin user add netappdocs -g netappdocsgroup
PowerShell
New-NaRole -Role netappdocsrole -Capabilities login-http-admin,api-*,cli-*,security-apivfiler,security-priv-advanced
New-NaGroup -Group netappdocsgroup -Roles netappdocsrole
New-NaUser -User netappdocs -Groups netappdocsgroup -Password <Password>
What is the purpose of the -Terse parameter on the Format-Ntap*Data functions?
Answer: There are a number of tables known to take a large amount of time to process. This is typically
due to large quantities of rows in the tables (Snapshots, CIFS shares, etc). The -Terse switch parameter
excludes these tables to speed up the processing.
If you need to include one or more of these pre-defined tables but continue to exclude the others, you
must not use the -Terse switch parameter. Instead, use the -ExcludeTable parameter with the commaseparated list of table names to exclude.
You can exclude additional tables by combining the -Terse switch with the -ExcludeTable parameter.
The following table shows the default table names that will be excluded from processing when using the Terse switch parameter.
Table 4) Terse tables excluded.
System Type
Table Names
ONTAP
AutosupportTriggers, CifsShareAcls, CifsShares, DriveDetails,
ExportPolicyRules, PartitionDetails, QtreeConfiguration, QuotaPolicyRules,
SvmAdministrativeRoles, VolumeSnapshotDetails
ONTAP ASUP
AutosupportTriggers, CifsShareAcls, CifsShares, DriveDetails,
ExportPolicyRules, PartitionDetails, QtreeConfiguration, QuotaPolicyRules,
VolumeSnapshotDetails
SVM
CifsShareAcls, CifsShares, ExportPolicyRules, QuotaPolicyRules,
SvmAdministrativeRoles, VolumeSnapshotDetails, QtreeConfiguration
SVM ASUP
CifsShareAcls, CifsShares, ExportPolicyRules, QtreeConfiguration,
QuotaPolicyRules, VolumeSnapshotDetails
7-Mode
CifsShareAcls, CifsShares, DriveDetails, NfsExportRules,
QtreeConfiguration, QuotaConfiguration
7-Mode ASUP
CifsShareAcls, CifsShares, DriveDetails, NfsExportRules,
QtreeConfiguration, QuotaConfiguration
I use the data sanitization functionality and when I generate a differences report I am seeing many
more changes than I would expect. What can I do about this?
Answer: In some tables, the columns used to uniquely identify the row is also set to be sanitized
(depending on the SanitizeLevel specified). This is necessary for some entities when they don't have a
unique UUID that can be used and we have to use the 'Name' property (for instance). Take, for example,
a volume named 'MyVolume' (this is just an example as volumes have unique UUID fields and should not
fall under this scenario). The data sanitization routines will change 'MyVolume' to a generic 'vol0001'
string to mask the actual name. In one run, however, this might be 'vol0001' and in another it might be
22
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
'vol2105'. In this case, when the differences report is generated, it will see these as two different volumes
and will show both an add and a delete entry for these.
There are two ways to work around this. The first method is to reduce the fields you are sanitizing (by
manipulating the -SanitizeLevel). If this isn't possible, however, then the other option is to use the SanitizeMappingsXmlFile parameter on the Format-Ntap*Data functions. This parameter will save the
SecureString to SanitizedString mappings to an XML file. If you specify this parameter each time you
generate NetAppDocs data then the volume name 'MyVolume' will get sanitized to the same string each
time and will therefore be evaluated to be the same during the differences report generation. If the file
already exists then the current mappings will be used, with new entries added as necessary. If the file
does not exist then a new file will be created with the current mappings.
Why is PowerShell 7.2+ not supported on MAC/Linux clients at this time?
Answer: The Aspose library that is used to generate the MS Office documentation has yet to support
.NET 6 (which is the version that PowerShell 7.2 supports). We are tracking that item with Aspose and will
update any code necessary once that is complete on their end.
AutoSupport Missing Data
AutoSupport data is not as complete as capturing the data from a live system. The following tables show
the tables and properties that are missing from the ASUP data.
ONTAP
The following table contains the table names that are not present in the output documentation.
Table 5) ONTAP ASUP missing tables.
Table Names
CifsBranchCacheConfiguration
CifsLocalGroupMembers
CifsLocalGroups
CifsLocalUsers
ClusterAdministrativeRoles
ClusterAdministrativeUsers
ClusterAdminRoleConfigs
FileDirSecurityPolicyTasks
FirewallPoliciesPre83
IscsiTargetPortalGroups
LoginBannerAndMotdSettings
ManagementTemplateParameters
ManagementTemplates
NetgroupsFileConfiguration
NtpServerStatus
NvmeNamespaces
SasShelfConnections
SecurityKeyManagerStatus
ServiceProcessorImageDetails
SnmpUsers
StorageQosReadAheadSettings
SvmAdministrativeRoles
SvmAdministrativeUsers
SvmAdminRoleConfigs
SystemTimeSettings
SystemTimeSettingsPre83
The following table contains the column names that are missing from the specified tables.
Table 6) ONTAP ASUP missing columns.
Table Name
Property Names
AggregateConfiguration
SnapshotCount
AggregateObjectStoreConfigs
AccessKey, LicenseUsedPercent, ObjectStoreUuid, Port, UsedSpace
AggregateObjectStores
LicenseUsedPercent, ObjectStoreAvailability, ObjectStoreUuid,
UsedSpace
AutosupportSettings
PeriodicTxWindow
AutosupportTriggers
BasicAdditional, TroubleshootingAdditional
ClusterDetails
CliSessionTimeout
23
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Table Name
Property Names
ClusterHaConfigurationDetails
BypassTakeoverOptimization, KeepAliveStatus, SendHomeAuto,
TakeoverByPartnerPossible
ClusterLogForwardDestinations
Force
ClusterPeerRelationships
ActiveAddresses
ClusterSwitchDetails
VersionSource
DriveDetails
IsOffline, IsZeroed
DynamicDnsUpdateConfiguration
SkipFqdnValidation
EventFilters
SnmpTrapType
EventNotificationDestinations
CertificateAuthority, CertificateSerial, CertificateValid
FcpAdapterConfiguration
Speed
FcpLifSettings
NodeName
FlexcacheVolumeConfiguration
AggrList, OriginVserverUuid
FlexcacheVolumeConfiguration82
CacheAggregate, CacheAvailable, CacheAvailableInBytes,
CacheAvailableInGb, CachePercentUsed, CacheSize,
CacheSizeInBytes, CacheSizeInGb, CacheState, OriginAggregate,
OriginState, OriginVolume, OriginVolumeUuid
FlexCloneVolumeDetails
QosPolicyGroupName, VserverDrProtection
FlexGroupVolumeConfiguration
FlexGroupAggregateList, FlexGroupNodes, IsProtocolAccessFenced
FlexVolConfiguration
VaultSnapmirrorDestinationCount, XdpSnapmirrorDestinationCount
FlexVolSpaceDetails
TotalFootprint, TotalFootprintInBytes, TotalFootprintInGb,
TotalFootprintPercent, VolumeBlocksFootprint,
VolumeBlocksFootprintBin0, VolumeBlocksFootprintBin0InBytes,
VolumeBlocksFootprintBin0InGb, VolumeBlocksFootprintBin0Percent,
VolumeBlocksFootprintBin1, VolumeBlocksFootprintBin1InBytes,
VolumeBlocksFootprintBin1InGb, VolumeBlocksFootprintBin1Percent,
VolumeBlocksFootprintInBytes, VolumeBlocksFootprintInGb,
VolumeBlocksFootprintPercent
HaInterconnectConfiguration
InterfaceType
HaInterconnectConnectionStatus
NvlogRdma
IscsiLifSettings
IpPort, IsInterfaceEnabled, TpgroupName
KerberosConfiguration
ServicePrincipalName
KerberosRealmConfiguration
PermittedEncTypes
LdapClientConfiguration
IsOwner
LdapClientSchema
IsOwner
LunConfiguration
QosPolicyGroup, ReadOnly
MetroClusterIcAdapters
RemoteAdapterPortName
NetworkIPspaces
Vservers
NetwokPortBroadcastDomains
PortUpdateStatusCombined
NetworkRoutes
AddressFamily, LifNames
NodeDetails
IsCacheMirrorEnabled, NodeAssetTag, NvramBatteryStatus,
SecurityConfigRebootNeeded
NodeNdmpSettings
UserId
NodeOptions
FlexscaleEnable, FlexscaleFlashPoolCaching,
SisIDedupAllowNonAffHya, SisMaxActiveOps
24
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Table Name
Property Names
NvmeLifSettings
Comment, FcWwnn, PhysicalProtocol, TransportAddress,
TransportProtocols
NvmeSubsystemMaps
Path
OnboardFcPortConfiguration
PendingFcType
OpticalTransceiverDetails
IsSfpDiagnosticsInternallyCalibrated, IsSfpOpticalTransceiverValid,
IsSfpRxPowerInRange, IsSfpTxPowerInRange, SfpConnector,
SfpDateCode, SfpEncoding, SfpFormfactor, SfpRev, SfpRxPower,
SfpTxPower, SfpVendorOui, SfpWavelength
PartitionDetails
IsOffline, IsZeroed
SecurityConfiguration
SupportedCipherSuites
ServiceProcessorDevices
AllowedAddresses
ShelfCablingDetails
ModuleState
SnapmirrorDestinations
IsConstituent, PolicyType, RelationshipGroupType
SnapmirrorPolicies
Owner
SnapshotPolicies
Comment, PolicyOwner
SnmpSettings
IsSnmpV3Enabled
StoragePoolDiskDetails
DiskTotalSize, DiskType
StorageQosAdaptivePolicyGroups
VserverName, VserverUuid
StorageQosPolicyGroups
VserverName, VserverUuid
SvmConfiguration
IsDomainAuthTunnel, QosPolicyGroup
SvmDefaultPolicies
QosPolicyGroup
SvmStorageSummary
TotalQosPolicyGroups
VolumeSnapshotDetails
Busy, Comment, CompressionType, CumulativeTotal,
CumulativeTotalInBytes, CumulativeTotalInGb, ExpiryTime,
Is7ModeSnapshot, PercentageOfTotalBlocks,
PercentageOfUsedBlocks, SnapmirrorLabel, State
ONTAP – SVM
The following table contains the table names that are not present in the output documentation.
Table 7) ONTAP SVM ASUP missing tables.
Table Names
CifsBranchCacheConfiguration
CifsLocalGroupMembers
CifsLocalGroups
CifsLocalUsers
FileDirSecurityPolicyTasks
IscsiTargetPortalGroups
JobDefinitions
LoginBannerAndMotdSettings
NetgroupsFileConfiguration
NvmeNamespaces
SnmpUsers
StorageQosPolicyGroups
StorageQosWorkloads
SvmAdministrativeRoles
SvmAdministrativeUsers
SvmAdminRoleConfigs
The following table contains the column names that are missing from the specified tables.
Table 8) ONTAP SVM ASUP missing columns.
Table Name
Property Names
DynamicDnsUpdateConfiguration
SkipFqdnValidation
FcpLifSettings
NodeName
25
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Table Name
Property Names
FlexCacheVolumeConfiguration
AggrList, OriginVserverUuid
FlexCacheVolumeConfiguration82
CacheAggregate, CacheAvailable, CacheAvailableInBytes,
CacheAvailableInGb, CachePercentUsed, CacheSize,
CacheSizeInBytes, CacheSizeInGb, CacheState, OriginAggregate,
OriginState, OriginVolume, OriginVolumeUuid
FlexCloneVolumeDetails
QosPolicyGroupName, VserverDrProtection
FlexGroupVolumeConfiguration
FlexGroupAggregateList, FlexGroupNodes, IsProtocolAccessFenced
FlexVolConfiguration
VaultSnapmirrorDestinationCount, XdpSnapmirrorDestinationCount
FlexVolSpaceDetails
TotalFootprint, TotalFootprintInBytes, TotalFootprintInGb,
TotalFootprintPercent, VolumeBlocksFootprint,
VolumeBlocksFootprintBin0, VolumeBlocksFootprintBin0InBytes,
VolumeBlocksFootprintBin0InGb, VolumeBlocksFootprintBin0Percent,
VolumeBlocksFootprintBin1, VolumeBlocksFootprintBin1InBytes,
VolumeBlocksFootprintBin1InGb, VolumeBlocksFootprintBin1Percent,
VolumeBlocksFootprintInBytes, VolumeBlocksFootprintInGb,
VolumeBlocksFootprintPercent
IscsiLifSettings
IpPort, IsInterfaceEnabled, TpgroupName
KerberosConfiguration
ServicePrincipalName
KerberosRealmConfiguration
PermittedEncTypes
LdapClientConfiguration
IsOwner
LdapClientSchema
IsOwner
LunConfiguration
QosPolicyGroup, ReadOnly
NetworkRoutes
AddressFamily, LifNames
NvmeLifSettings
Comment, FcWwnn, PhysicalProtocol, TransportAddress,
TransportProtocols
NvmeSubystemMaps
Path
SnapmirrorDestinations
IsConstituent, PolicyType, RelationshipGroupType
SnapmirrorPolicies
Owner
SnapshotPolicies
Comment, PolicyOwner
SvmConfiguration
IsDomainAuthTunnel, QosPolicyGroup
SvmDefaultPolicies
QosPolicyGroup
SvmStorageSummary
TotalQosPolicyGroups
VolumeSnapshotDetails
Busy, Comment, CompressionType, CumulativeTotal,
CumulativeTotalInBytes, CumulativeTotalInGb, ExpiryTime,
Is7ModeSnapshot, PercentageOfTotalBlocks,
PercentageOfUsedBlocks, SnapmirrorLabel, State
Data ONTAP 7-Mode
The following table contains the table names that are not present in the output documentation.
Table 9) Data ONTAP 7-Mode ASUP missing tables.
Table Names
FpolicyConfiguration
LicenseV1Details
LicenseV2Details
26
NetAppDocs User Guide
LocalGroups
LocalUsers
NfsNetgroupsFileConfiguration
SasShelfConnections
SnapmirrorMultipathEntries
UserRoles
© 2021 NetApp, Inc. All Rights Reserved.
The following table contains the column names that are missing from the specified tables.
Table 10) Data ONTAP 7-Mode ASUP missing columns.
Table Name
Property Names
CifsConfiguration
PreferredAddress
CifsShares
ShareProperties
DeviceDetails
NodeUptime, SystemOntapiVersion
DriveDetails
ContainerType, IsOffline
FcpAdapterConfiguration
Speed
IscsiConfiguration
DefaultAuthOutboundUserName
IscsiTargetPortalGroup
TpgroupAluaPreferred, TpgroupAluaState
NetworkConnectivity
IpspaceName
NetworkInterfaceSettings
IsNfoEnabled, IsTrusted
NfsExportRules
IsPersistent
OnboardFcPortConfiguration
AdapterState, PendingFcType
Options
ClusterConstraint
QuotaConfiguration
Status
ShelfCablingDetails
ModuleState, ShelfState
ShelfDetails
ShelfState
SnapmirrorRelationships
Schedule
SnapmirrorSettings
PreferredInterface
SnapvaultSchedules
PreserveSnapshots, WarnAtCount
SnmpTrapSettings
Communities
StorageConfiguration
IsClusterHaEnabled, IsInterconnectUp
StorageSummary
TotalLunUsedCapacity, TotalLunUsedCapacityInBytes
VfilerConfiguration
Vfnets, Vfstores
VolumeConfiguration
OptionEffectiveGuarantee, OptionFreeSpaceRealloc
VolumeSpaceManagementSettings
GrowThresholdPercent, IncrementSize, MaximumSize, MinimumSize,
ShrinkThresholdPercent
VscanConfiguration
ExtensionCount, Scanner
Data ONTAP 7-Mode (Transition)
The following table contains the table names that are not present in the output documentation.
Table 11) Data ONTAP 7-Mode ASUP (Transition) missing tables.
Table Names
DomainUsers
FpolicyConfiguration
LdapClientSchema
LdapConfiguration
LicenseV1Details
LicenseV2Details
LocalGroups
LocalUsers
NameMappings
NfsNetgroupsFileConfiguration
SasShelfConnections
SnapmirrorMultipathEntries
SnapmirrorSchedules
UnixUsers
UserRoles
VfilerDns
VfilerInterfaces
VfilerStores
The following table contains the column names that are missing from the specified tables.
27
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Table 12) Data ONTAP 7-Mode ASUP (Transition) missing columns.
Table Name
Property Names
CifsConfiguration
PreferredAddress
CifsShares
Caching, ForceGroup, IsAccessBasedEnum, IsBrowse,
IsNamespaceCachingAllowed, IsSymlinkStrictSecurity, IsVscan,
IsVscanread, IsWideLink, MaxUsers
DriveDetails
ContainerType, IsOffline
LunMappings
VSA
NetworkInterfaces
IfgrpPolicy, IfgrpType, IpspaceName
NfsExportRules
IsPersistent
Options
ClusterConstraint
QuotaConfiguration
Status
ShelfDetails
ShelfState
SnapvaultSchedules
PreserveSnapshots, WarnAtCount
StorageConfiguration
IsClusterHaEnabled, IsInterconnectUp
StorageObjects
IsInHomeDirSearchPath, IsSnaplock, LunPrefixSize, LunSuffixSize,
VolAutosizeIncrementSize, VolAutoSizeMaximumSize
StorageSummary
NodeUptime, TotalLunUsedCapacity, TotalLunUsedCapacityInBytes,
TotalLunUsedCapacityInGb, TotalNonPersistentNfsExports
VfilerConfiguration
TotalLuns, TotalQtrees, TotalVolumes
Statistics Upload
By default, NetAppDocs will submit statistics back to a database for us to track usage and to help drive
future development efforts. No user information is collected. The following table lists the properties that
are sent back to the database.
Table 13) Statistics properties.
Module/Function Info
Client Details
Target Details
ModuleName
MachineGuid
SystemUid
ModuleVersion
OSCaption
SystemType
ModuleSessionGuid
OSVersion
SystemVersion
PipelineSessionGuid
OSArchitecture
CallingFunctionName
PowerShellVersion
FunctionName
CountryCode
CallDate
ElapsedTicks
PipelinePosition
PipelineLength
ParameterNames
ParameterValues
While we request that you leave the statistics uploading enabled to help us with future development, if
you do need to disable this functionality you may do so by setting a variable within the PowerShell
session. To make this permanent you can add this variable into your PowerShell profile.
28
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
PS> Set-Variable -Name NetAppDocs_SkipStatsUpload -Value 1 -Scope Global
Troubleshooting
If the execution policy is not set correctly, an error such as the one below will be generated. To overcome
this issue, follow the steps outlined in Setting up the PowerShell Execution Policy section.
Known Issues
•
(ONTAP/7-Mode) The ShelfDetails table may show MisassignedDrives. This is due to a ZAPI issue
where the shelf bay information returns duplicate DiskUids. A more accurate method of calculating
this information in those instances is yet to be obtained. This issue has been identified on only one
system.
•
(All) The Visio drawings may get added to the Word document in a different order than what is shown
in the Visio file. This is due to an unresolved issue within the Aspose.Diagram product.
•
(ONTAP/Vserver) CIFS Shares: If a CIFS server is status-admin down then ZAPI may or may not
return the shares for that SVM. There is no pattern to this and similar behavior is seen at the CLI. (cifs
share show returns the data, but cifs share show -instance does not).
•
(ONTAP/Vserver) In the SnapMirrorRelationships table, intercluster LIFs may be missing from the
Get-NtapVserverData function whereas they will be shown if using Get-NtapClusterData | ConvertToNtapVserverData. It is not clear if this is a ZAPI burt or if it is desired behavior (where the IC
SnapMirror relationships are not returned when the ZAPI is called from a Vserver context).
•
(7-Mode) An error may be reported against a single node system if the cluster (cf) license is present,
or cf is disabled for an HA pair (or a more serious node-down issue). Depending on the version of
ONTAP, ZAPI may report a generic 'Internal Error'. When this happens there is no way of knowing if it
is a valid scenario where this error can be safely ignored or not. So, if you encounter this just know
that there may be valid situations where this error does not apply and can be safely ignored.
•
(ONTAP/7-Mode) IPv6 sanitization might not be fully correct. The documentation only prefix
'2001:DB8::/32' was used to generate the sanitized string, yet to obtain IPv6 enabled systems to test
with. It is not clear if it is working as desired.
Support
For any additional support issues or enhancement requests, please visit the communities site
(NetAppDocs Community) or send an email to ng-NetAppDocs-support.
Download
The Windows installer (MSI) package is the recommended method for installing the module. However, a
ZIP file is also available for download.
29
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
The latest packages are available either via the NetAppDocs Community or the NetApp Software
Downloads.
30
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Appendix
APIs / CLI Commands / ASUP Sections Collected
ONTAP API (Cluster)
The following table contains the ONTAP APIs called for an ONTAP data collection.
Table 14) ONTAP API (Cluster).
ONTAP API (Cluster)
aggr-autobalance-config-get
igroup-get-iter
quota-status-iter
aggr-efficiency-get-iter
interim-license-list-get
security-certificate-get-iter
aggr-get-iter
iscsi-initiator-get-iter
security-config-get
aggr-object-store-config-get
iscsi-interface-get-iter
security-key-manager-get-iter
aggr-object-store-get-iter
iscsi-service-get-iter
security-login-get-iter
aggr-options-list-info
iscsi-tpgroup-get-iter
security-login-role-get-iter
aggr-space-get-iter
job-completed-get-iter
security-protocol-get
autosupport-budget-get-iter
job-get-iter
security-protocol-ssh-get
autosupport-config-get-iter
job-schedule-get-iter
security-session-limit-application-get-iter
autosupport-history-get-iter
kerberos-config-get-iter
security-session-limit-location-get-iter
autosupport-trigger-get-iter
kerberos-realm-get-iter
security-session-limit-request-get-iter
cf-hwassist-status
ldap-client-get-iter
security-session-limit-user-get-iter
cf-status
ldap-client-schema-get-iter
security-session-limit-vserver-get-iter
cifs-branchcache-get-iter
ldap-config-get-iter
security-ssh-get-iter
cifs-domain-preferred-dc-get-iter
license-v2-list-info
service-processor-get
cifs-domain-server-discovery-mode-get-iter
lun-get-iter
service-processor-image-get
cifs-home-directory-get-iter
lun-map-get-iter
service-processor-network-get
cifs-home-directory-search-path-get-iter
metrocluster-get
service-processor-ssh-get
cifs-local-group-get-iter
metrocluster-interconnect-adapter-get-iter
sis-get-iter
cifs-local-group-members-get-iter
metrocluster-interconnect-mirror-get-iter
sis-policy-get-iter
31
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP API (Cluster)
cifs-local-user-get-iter
metrocluster-node-get-iter
snapmirror-get-destination-iter
cifs-options-get-iter
metrocluster-vserver-get-iter
snapmirror-get-iter
cifs-privilege-get-iter
name-mapping-get-iter
snapmirror-policy-get-iter
cifs-security-get-iter
name-mapping-unix-group-get-iter
snapshot-get-iter
cifs-server-get-iter
name-mapping-unix-user-get-iter
snapshot-policy-get-iter
cifs-share-access-control-get-iter
nameservice-nsswitch-get-iter
snmp-status
cifs-share-get-iter
net-ddns-get-iter
storage-adapter-get-adapter-info
cifs-symlink-get-iter
net-device-discovery-get-iter
storage-adapter-get-adapter-list
clock-get-clock
net-dns-get-iter
storage-array-get-config-summary
clock-get-timezone
net-failover-group-get-iter
storage-array-list-info
cluster-contact-get
net-firewall-policy-get-iter
storage-bridge-get-iter
cluster-ha-get
net-hosts-get-iter
storage-disk-get-iter
cluster-identity-get
net-interface-get-iter
storage-pool-aggregate-get-iter
cluster-log-forward-get-iter
net-interface-service-policy-entry-get-iter
storage-pool-disk-get-iter
cluster-peer-get-iter
net-interface-service-policy-get-iter
storage-pool-get-iter
config-backup-info-get-iter
net-ipspaces-get-iter
storage-shelf-acp-module-get-iter
config-backup-settings-get
net-options-get
storage-shelf-bay-list-info
diagnosis-alert-get-iter
net-port-broadcast-domain-get-iter
storage-shelf-drawer-get-iter
disk-encrypt-get-iter
net-port-get-iter
storage-shelf-environment-list-info
ems-destination-get-iter
net-port-ifgrp-get
storage-shelf-info-get-iter
ems-event-filter-get-iter
net-routes-get-iter
storage-shelf-list-info
ems-event-notification-destination-get-iter
net-routes-lifs-get-iter
storage-switch-get-iter
ems-event-notification-get-iter
net-routing-group-route-get-iter
system-cache-mirror-get-iter
ems-message-get-iter
net-subnet-get-iter
system-get-node-info-iter
export-policy-get-iter
net-vlan-get-iter
system-get-ontapi-version
export-rule-get-iter
netgroups-file-get-iter
system-get-version
fc-config-list-info
nfs-service-get
system-image-get-iter
fcp-adapter-get-iter
nfs-service-get-iter
system-node-discovery-get-iter
fcp-initiator-get-iter
nis-get-iter
system-node-get-iter
32
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP API (Cluster)
fcp-interface-get-iter
ntp-server-get-iter
system-services-web-get
fcp-service-get-iter
ntp-server-status-get-iter
system-services-web-node-get
feature-usage-summary-get-iter
nvme-get-iter
tape-mc-get-iter
file-directory-security-policy-task-get-iter
nvme-interface-get-iter
template-management-template-get
fileservice-audit-config-get-iter
nvme-namespace-get-iter
ucm-adapter-get-iter
flash-device-get-iter
nvme-subsystem-get-iter
virtual-machine-get-info
flexcache-cache-policy-get-iter
nvme-subsystem-host-get-iter
volume-clone-get-iter
flexcache-get-iter
nvme-subsystem-map-get-iter
volume-footprint-get-iter
fpolicy-policy-event-get-iter
options-get-iter
volume-get-iter
fpolicy-policy-external-engine-get-iter
portset-get-iter
volume-space-get-iter
fpolicy-policy-get-iter
qos-adaptive-policy-group-get
vscan-connection-status-all-get-iter
fpolicy-policy-scope-get-iter
qos-policy-group-get-iter
vscan-on-access-policy-get-iter
fpolicy-server-status-get-iter
qos-policy-read-ahead-get-iter
vscan-scanner-pool-get-iter
gpo-get-iter
qos-settings-read-ahead-get-iter
vscan-status-get-iter
group-mapping-get-iter
qos-workload-get-iter
vserver-get-iter
ha-interconnect-config-details-get-iter
qtree-list-iter
vserver-login-banner-get-iter
ha-interconnect-connection-status-get-iter
quota-list-entries-iter
vserver-motd-get-iter
ONTAP CLI (Cluster)
The following table contains the ONTAP CLIs called for an ONTAP data collection.
Table 15) ONTAP CLI (Cluster).
ONTAP CLI (Cluster)
cluster ha show (priv advanced
system node run -node * -command bmc status
cluster kernel-service show (priv diag
system node run -node * -command options $additionalOption
cluster ring show (priv advanced
system node run -node * -command rlm status
cluster show (priv advanced
system node run -node * -command snap list -A
debug kenv show (priv diag
system node run -node * -command snap sched -A
debug vreport show (priv diag
system node run -node * -command sp status
33
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP CLI (Cluster)
fcp stats
system node run -node * -command sysconfig
lun igroup show -fields init-details (priv diag
system node run -node * -command sysconfig -ac
network interface failover-groups show
system node run -node * -command sysconfig -v
network interface show -failover
system node virtual-machine hypervisor show (Node: $( $node.Node
network interface show (priv advanced
system services firewall policy show
network routing-groups show
system services ndmp node-scope-mode status
security config status show (priv diag
system services ndmp show
security login domain-tunnel show
system services ntp config show (priv diag
security login role config show (priv diag
system services ntp server show
security snmpusers
system services web node show
storage aggregate efficiency show
system services web show
storage disk option show
system snmp show -fields snmpv3-enable
storage disk partition show (priv diag
system timeout show
system cluster-switch interface show (priv diag
template parameter show
system cluster-switch show-all (priv advanced
vol show -fields vserver, vserver-uuid, instance-uuid, tiering-minimumcooling-days
system health cluster-switch interface show (priv diag
volume snaplock show
system health cluster-switch show
vserver services ldap show
system node external-cache show
vserver services ndmp show
ONTAP ASUP (Cluster)
The following table contains the ASUP sections read for an ONTAP data collection.
Table 16) ONTAP ASUP (Cluster).
ONTAP ASUP (Cluster)
AGGR-BIN.XML
FPOLICY-EXT-ENGINE.XML
SECURITY-CONFIG.XML
AGGR-EFFICIENCY-CONFIG.XML
FPOLICY-POLICY.XML
SECURITY-PROTOCOL-SSH.XML
AGGR-EFFICIENCY.XML
FPOLICY-SCOPE.XML
SECURITY-PROTOCOL.XML
AGGR-INFO.XML
FPOLICY-SERVER-STATUS.XML
SESSION-APPLICATION-LIMITS.XML
AGGREGATE
GROUP-MAPPINGS.XML
SESSION-LOCATION-LIMITS.XML
34
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP ASUP (Cluster)
AGGREGATE-AUTOBALANCEINFO.XML
HA-INTERCONNECT-CONFIG.XML
SESSION-REQUEST-LIMITS.XML
AGGRTABLE.XML
HA-INTERCONNECT-INFO.XML
SESSION-USER-LIMITS.XML
ARRAY-CONFIG.XML
HA-INTERCONNECT-STATUS.XML
SESSION-VSERVER-LIMITS.XML
ARRAY-PROFILE-DB.XML
HOSTS.XML
SHELF
AUTOSUPPORT-BUDGET.XML
IFGRPS.XML
SHELF_ENVIRONMENT_INFO
AUTOSUPPORT-HISTORY.XML
IGROUP.XML
SHELF_MODULE
AUTOSUPPORT-TRIGGERS.XML
INITIATOR_SESSION
SIS-CONFIG.XML
AUTOSUPPORT.XML
INTERFACE
SIS-POLICY-UI.XML
BCOMD-BOOTTIME.XML
IPSPACES.XML
SIS-STAT-L.XML
BCOMD-BRINGUP-INFO.XML
ISCSI-SESSION-BRIEF.XML
SIS-STATUS-L.XML
BROADCAST-DOMAIN.XML
ISCSI.XML
SNAPLOCK-VOLUME.XML
CERTIFICATE.XML
JM-CLUSTER-BACKUP.XML
SNAPMIRROR-DESTINATION.XML
CIFS-DC-DISCOVERY-MODE.XML
JM-SCHED.XML
SNAPMIRROR-POLICY.XML
CIFS-DOMAIN-PREFERREDDC.XML
KENV
SNAPMIRROR.XML
CIFS-GPO-DB.XML
KERBEROS-IFCONFIG-BYNAME.XML
SNAPSHOT-POLICY.XML
CIFS-HOMEDIRSEARCHPATH.XML
KERBREALM.XML
SNAPSHOT.XML
CIFS-HOMEDIR.XML
LDAP-CLIENT-CONFIG.XML
SNMP-CONFIG.XML
CIFS-SERVER-BYNAME.XML
LDAP-CLIENT-SCHEMA.XML
SOFTWARE-IMAGE.XML
CIFS-SERVER-OPTION.XML
LDAP-CONFIG.XML
SP-INFO.XML
CIFS-SERVER-SECURITY.XML
LICENSES.XML
SP-NETWORK-INFO.XML
CIFS-SHARE-ACL.XML
LOG-FORWARDING.XML
SSH.XML
CIFS-SHARE-BYNAME.XML
LUN-MAPS.XML
STORAGE-ACP-MODULE.XML
CIFS-SYMLINKPATHMAPPING.XML
LUN.XML
STORAGE-BRIDGE-VIEW.XML
CLAM-NODE-STATUS.XML
MANAGED-FEATURE-USAGE-SUMMARY.XML
STORAGE-DISK
CLUSTER
MANIFEST.XML
STORAGE-DISK-VIRTUAL-MACHINE.XML
CLUSTER_LIF
METROCLUSTER-INTERCONNECT-ADAPTER.XML
STORAGE-DISK.XML
35
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP ASUP (Cluster)
CLUSTER-HA.XML
METROCLUSTER-INTERCONNECT.XML
STORAGE-ENCRYPTION-DISK.XML
CLUSTER-INFO.XML
METROCLUSTER-NODES.XML
STORAGE-FAILOVER.XML
CLUSTER-LICENSES.XML
METROCLUSTER-VSERVER.XML
STORAGE-POOL-AGGR.XML
CLUSTER-RING.XML
METROCLUSTER.XML
STORAGE-POOL-DISK.XML
CLUSTER-SWITCHINTERFACE.XML
MOTHERBOARD
STORAGE-POOL.XML
CLUSTERPEER-ITABLE.XML
NAMEMAPPINGS-BYNAME.XML
STORAGE-SHELF-DRAWER.XML
CONFIG-BACKUP-INFO.XML
NDMP-NODE-PROPERTIES.XML
STORAGE-SHELF.XML
CONFIG-BACKUP-SETTINGS.XML
NDMP-NODE-SCOPE-MODE-STATUS
STORAGE-SWITCH-VIEW.XML
CONTACT-INFO-VIEW.XML
NDMP-VSERVER-PROPERTIES.XML
STORAGE-TAPE-MC.XML
CSHM-SWITCH-CONFIG.XML
NETOPTS-SWITCHLESS-CLUSTER.XML
SUBNET.XML
DATA-OBJECT-STORECONFIG.XML
NETWORK-PORTS.XML
SYSCONFIG-A
DDNS.XML
NETWORK-ROUTES.XML
SYSCONFIG-AC
DEVICE
NETWORK-ROUTING-GROUPS.XML
SYSTEM
DEVICE-DISCOVERY.XML
NETWORK-SERVICE-POLICY-ENTRY.XML
SYSTEM-HEALTH-ALERT.XML
DISK-PARTITION-OWNERSHIP
NETWORK-SERVICE-POLICY.XML
UNASSIGNED-DISKS.XML
DISK-PATHS.XML
NFS-SERVERS-BYNAME.XML
UNIFIED-CONNECT.XML
DNS.XML
NIS-DOMAINS-BYNAME.XML
UNIX-GROUPS-BYNAME.XML
DQP_DETAILS
NSSWITCH-BYNAME.XML
UNIX-USERS-BYNAME.XML
EFFECTIVE-CLUSTERVERSION.XML
NVMF-SERVICE.XML
VLANS.XML
EMS-DESTINATION.XML
NVMF-SUBSYSTEM-HOST.XML
VM-HYPERVISOR-INFO.XML
EVENT-FILTER.XML
NVMF-SUBSYSTEM-MAP.XML
VM-INSTANCE-INFO.XML
EVENT-NOTIFICATIONDESTINATION.XML
NVMF-SUBSYSTEM.XML
VOLUME
EVENT-NOTIFICATION.XML
PARTITION_DISK
VOLUME-CLONE-SHOW.XML
EXPORT-RULE-TABLE.XML
PEER_CLUSTER
VOLUME-QUOTA.XML
EXPORT-RULESET-UI-TABLE.XML
PEER_CLUSTER_NODE
VOLUME.XML
EXTERNAL-CACHE-OPTIONS.XML
PLATFORM-SENSORS.XML
VREPORT.XML
36
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP ASUP (Cluster)
FAILOVER-GROUPS.XML
PLEX
VS-FAILOVER-GROUPS.XML
FCP-INITIATOR.XML
PORTSET.XML
VS-FIREWALL-POLICIES.XML
FCP.XML
QOS-ADAPTIVE-POLICY-GROUP.XML
VSCAN-CONNECTION-STATUS-ALL.XML
FILE-SERVICES-AUDIT.XML
QOS-POLICY-GROUP.XML
VSCAN-ON-ACCESS-POLICY.XML
FLASH-CACHE-INFO.XML
QOS-WORKLOAD.XML
VSCAN-SCANNER-POOL.XML
FLEXCACHE-CACHE-POLICY.XML
QTREE.XML
VSCAN-STATUS.XML
FLEXCACHE-RELATIONS.XML
QUOTA-RULES.XML
VSERVER-INFO.XML
FLEXCACHE-VOLUME.XML
RAID_GROUP
VSERVER-PEER.XML
FMM_DATA
RDB-DUMP
WEB-SERVER.XML
FPOLICY-EVENT.XML
REPOSITORY-CONSTITUENTS.XML
ONTAP API (SVM)
The following table contains the ONTAP APIs called for an ONTAP SVM data collection.
Table 17) ONTAP API (SVM).
ONTAP API (Vserver)
cf-status
iscsi-initiator-get-iter
nvme-subsystem-get-iter
cifs-branchcache-get-iter
iscsi-interface-get-iter
nvme-subsystem-host-get-iter
cifs-domain-preferred-dc-get-iter
iscsi-service-get-iter
nvme-subsystem-map-get-iter
cifs-domain-server-discovery-mode-get-iter
iscsi-tpgroup-get-iter
options-get-iter
cifs-home-directory-get-iter
job-completed-get-iter
portset-get-iter
cifs-home-directory-search-path-get-iter
job-get-iter
qos-policy-group-get-iter
cifs-local-group-get-iter
job-schedule-get-iter
qos-workload-get-iter
cifs-local-group-members-get-iter
kerberos-config-get-iter
qtree-list-iter
cifs-local-user-get-iter
kerberos-realm-get-iter
quota-list-entries-iter
cifs-options-get-iter
ldap-client-get-iter
quota-status-iter
cifs-privilege-get-iter
ldap-client-schema-get-iter
security-certificate-get-iter
cifs-security-get-iter
ldap-config-get-iter
security-login-get-iter
cifs-server-get-iter
lun-get-iter
security-login-role-get-iter
37
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP API (Vserver)
cifs-share-access-control-get-iter
lun-map-get-iter
security-ssh-get-iter
cifs-share-get-iter
name-mapping-get-iter
sis-get-iter
cifs-symlink-get-iter
name-mapping-unix-group-get-iter
sis-policy-get-iter
clock-get-clock
name-mapping-unix-user-get-iter
snapmirror-get-destination-iter
clock-get-timezone
nameservice-nsswitch-get-iter
snapmirror-get-iter
cluster-identity-get
net-ddns-get-iter
snapmirror-policy-get-iter
export-policy-get-iter
net-dns-get-iter
snapshot-get-iter
export-rule-get-iter
net-failover-group-get-iter
snapshot-policy-get-iter
fcp-initiator-get-iter
net-firewall-policy-get-iter
system-get-ontapi-version
fcp-interface-get-iter
net-hosts-get-iter
system-get-version
fcp-service-get-iter
net-interface-get-iter
system-node-discovery-get-iter
file-directory-security-policy-task-get-iter
net-interface-service-policy-entry-get-iter
system-node-get-iter
fileservice-audit-config-get-iter
net-interface-service-policy-get-iter
volume-clone-get-iter
flexcache-cache-policy-get-iter
net-routes-get-iter
volume-footprint-get-iter
flexcache-get-iter
net-routes-lifs-get-iter
volume-get-iter
fpolicy-policy-event-get-iter
net-routing-group-route-get-iter
volume-space-get-iter
fpolicy-policy-external-engine-get-iter
netgroups-file-get-iter
vscan-on-access-policy-get-iter
fpolicy-policy-get-iter
nfs-service-get
vscan-scanner-pool-get-iter
fpolicy-policy-scope-get-iter
nfs-service-get-iter
vscan-status-get-iter
fpolicy-server-status-get-iter
nis-get-iter
vserver-get-iter
gpo-get-iter
nvme-get-iter
vserver-login-banner-get-iter
group-mapping-get-iter
nvme-interface-get-iter
vserver-motd-get-iter
igroup-get-iter
nvme-namespace-get-iter
ONTAP CLI (SVM)
The following table contains the ONTAP CLIs called for an ONTAP SVM data collection.
38
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Table 18) ONTAP CLI (SVM).
ONTAP CLI (Vserver)
lun igroup show -fields init-details (priv diag
security login role config show (priv diag
network interface show -failover
security snmpusers
network interface show (priv advanced
vol show -fields vserver, vserver-uuid, instance-uuid, tiering-minimumcooling-days
network routing-groups show
volume snaplock show
ONTAP ASUP (SVM)
The following table contains the ASUP sections read for an ONTAP SVM data collection.
Table 19) ONTAP ASUP (SVM).
ONTAP ASUP (SVM)
CERTIFICATE.XML
FPOLICY-SERVER-STATUS.XML
PORTSET.XML
CIFS-DC-DISCOVERY-MODE.XML
HOSTS.XML
QTREE.XML
CIFS-DOMAIN-PREFERREDDC.XML
IGROUP.XML
QUOTA-RULES.XML
CIFS-GPO-DB.XML
INITIATOR_SESSION
REPOSITORY-CONSTITUENTS.XML
CIFS-HOMEDIRSEARCHPATH.XML
ISCSI-SESSION-BRIEF.XML
SIS-CONFIG.XML
CIFS-HOMEDIR.XML
ISCSI.XML
SIS-POLICY-UI.XML
CIFS-SERVER-BYNAME.XML
JM-SCHED.XML
SIS-STAT-L.XML
CIFS-SERVER-OPTION.XML
KERBEROS-IFCONFIG-BYNAME.XML
SIS-STATUS-L.XML
CIFS-SERVER-SECURITY.XML
KERBREALM.XML
SNAPLOCK-VOLUME.XML
CIFS-SHARE-ACL.XML
LDAP-CLIENT-CONFIG.XML
SNAPMIRROR-DESTINATION.XML
CIFS-SHARE-BYNAME.XML
LDAP-CLIENT-SCHEMA.XML
SNAPMIRROR-POLICY.XML
CIFS-SYMLINKPATHMAPPING.XML
LDAP-CONFIG.XML
SNAPMIRROR.XML
CLUSTER
LUN-MAPS.XML
SNAPSHOT-POLICY.XML
CLUSTER_LIF
LUN.XML
SNAPSHOT.XML
CLUSTER-INFO.XML
MANIFEST.XML
SSH.XML
39
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP ASUP (SVM)
CLUSTER-RING.XML
MOTHERBOARD
SYSTEM
DDNS.XML
MOTHERBOARD-INFO.XML
SYSTEM-INFO.XML
DNS.XML
NAMEMAPPINGS-BYNAME.XML
UNIX-GROUPS-BYNAME.XML
EFFECTIVE-CLUSTERVERSION.XML
NDMP-NODE-SCOPE-MODE-STATUS
UNIX-USERS-BYNAME.XML
EXPORT-RULE-TABLE.XML
NDMP-VSERVER-PROPERTIES.XML
VOLUME
EXPORT-RULESET-UI-TABLE.XML
NETWORK-ROUTES.XML
VOLUME-CLONE-SHOW.XML
FAILOVER-GROUPS.XML
NETWORK-ROUTING-GROUPS.XML
VOLUME-QUOTA.XML
FCP-INITIATOR.XML
NETWORK-SERVICE-POLICY-ENTRY.XML
VOLUME.XML
FCP.XML
NETWORK-SERVICE-POLICY.XML
VS-FAILOVER-GROUPS.XML
FILE-SERVICES-AUDIT.XML
NFS-SERVERS-BYNAME.XML
VS-FIREWALL-POLICIES.XML
FLEXCACHE-CACHE-POLICY.XML
NIS-DOMAINS-BYNAME.XML
VSCAN-ON-ACCESS-POLICY.XML
FLEXCACHE-RELATIONS.XML
NSSWITCH-BYNAME.XML
VSCAN-SCANNER-POOL.XML
FLEXCACHE-VOLUME.XML
NVMF-SERVICE.XML
VSCAN-STATUS.XML
FPOLICY-EVENT.XML
NVMF-SUBSYSTEM-HOST.XML
VSERVER-INFO.XML
FPOLICY-EXT-ENGINE.XML
NVMF-SUBSYSTEM-MAP.XML
VSERVER-PEER.XML
FPOLICY-POLICY.XML
NVMF-SUBSYSTEM.XML
FPOLICY-SCOPE.XML
PEER_CLUSTER
ONTAP API (7-Mode)
The following table contains the ONTAP APIs called for a Data ONTAP 7-Mode data collection.
Table 20) ONTAP API (7-Mode).
ONTAP API (7-Mode)
aggr-get-root-name
net-config-get-persistent
snapvault-secondary-relationship-status-list-iter-end
aggr-list-info
net-ifconfig-get
snapvault-secondary-relationship-status-list-iter-next
aggr-options-list-info
net-ipspace-list
snapvault-secondary-relationship-status-list-iter-start
aggr-space-list-info
nfs-exportfs-list-rules-2
snapvault-secondary-snapshot-schedule-list-info
cf-status
options
snmp-status
cifs-homedir-path-get-for-user
options-get
storage-adapter-get-adapter-info
40
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP API (7-Mode)
cifs-homedir-paths-get
options-list-info
storage-adapter-get-adapter-list
cifs-list-config
perf-object-get-instances-iter-end
storage-disk-get-iter
cifs-share-acl-list-iter-end
perf-object-get-instances-iter-next
storage-shelf-bay-list-info
cifs-share-acl-list-iter-next
perf-object-get-instances-iter-start
storage-shelf-environment-list-info
cifs-share-acl-list-iter-start
qtree-list
storage-shelf-list-info
cifs-share-list-iter-end
qtree-list-iter-end
sysconfig
cifs-share-list-iter-next
qtree-list-iter-next
system-cli
cifs-share-list-iter-start
qtree-list-iter-start
system-get-info
clock-get-clock
quota-list-entries-iter-end
system-get-ontapi-version
clock-get-timezone
quota-list-entries-iter-next
system-get-version
disk-list-info
quota-list-entries-iter-start
ucm-adapter-list-info
disk-sanown-list-info
quota-status
useradmin-domainuser-list
fc-config-list-iter-end
reallocate-list-info
useradmin-group-list
fc-config-list-iter-next
sis-status
useradmin-role-list
fc-config-list-iter-start
snapmirror-get-status
useradmin-user-list
fcp-adapter-list-info
snapmirror-list-connections
vfiler-get-allowed-protocols
feature-status-list-info
snapmirror-list-destinations
vfiler-get-disallowed-protocols
flash-device-list-info
snapmirror-list-schedule
vfiler-list-info
fpolicy-extensions-list-info
snapmirror-list-sync-schedule
volume-footprint-list-info-iter-end
fpolicy-list-info
snapshot-get-reserve
volume-footprint-list-info-iter-next
igroup-list-info
snapshot-get-schedule
volume-footprint-list-info-iter-start
iscsi-initiator-get-default-auth
snapshot-list-info
volume-get-language
iscsi-interface-list-info
snapvault-primary-destinations-list-info
volume-list-info
iscsi-isns-get-info
snapvault-primary-get-relationship-status
volume-list-info-iter-end
iscsi-node-get-name
snapvault-primary-relationship-status-list-iter-end
volume-list-info-iter-next
iscsi-target-alias-get-alias
snapvault-primary-relationship-status-list-iter-next
volume-list-info-iter-start
iscsi-tpgroup-list-info
snapvault-primary-relationship-status-list-iter-start
volume-options-list-info
license-list-info
snapvault-primary-snapshot-schedule-list-info
volume-space-list-info-iter-end
license-v2-list-info
snapvault-secondary-configuration-list-info
volume-space-list-info-iter-next
41
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP API (7-Mode)
lun-list-info
snapvault-secondary-destinations-list-info
volume-space-list-info-iter-start
lun-map-list-info
snapvault-secondary-get-configuration
vscan
net-config-get-active
snapvault-secondary-get-relationship-status
ONTAP CLI (7-Mode)
The following table contains the ONTAP CLIs called for a Data ONTAP 7-Mode data collection.
Table 21) ONTAP CLI (7-Mode).
ONTAP CLI (7-Mode)
bmc status
sysconfig -ac
cifs shares
sysconfig -v
rlm status
vfiler allow
sp status
vfiler disallow
storage show
vscan options
storage show shelf
ONTAP ASUP (7-Mode)
The following table contains the ASUP sections read for an ONTAP 7-Mode data collection.
Table 22) ONTAP ASUP (7-Mode)
ONTAP ASUP (7-Mode)
AGGREGATE
LUN
SHELF_MODULE
CIFS_DOMAIN_INFO
LUN_INITIATOR_GROUP
SM_SV_DESTINATION
CIFS_SHARE
MANIFEST.XML
SM_SV_RELATIONS
CIFS_SHARE_ACL
MOTHERBOARD
SNAPSHOT
DEDUPE_STATUS
MOTHERBOARD-INFO.XML
SNAPVAULT_SCHEDULE
DEVICE
OPTIONS
SNMP
EXPORTS
PLEX
SOFTWARE-LICENSES
HA_GROUP
PORTSETS
SOFTWARE-LICENSES.XML
INITIATOR_GROUP
QTREE
SYSCONFIG-A
42
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
ONTAP ASUP (7-Mode)
INITIATOR_PATH
QUOTAS
SYSCONFIG-AC
INTERFACE
QUOTAS.GZ
SYSTEM
IP
RAID_GROUP
SYSTEM-INFO.XML
ISCSI-ALIAS
RC
VFILER
ISCSI-INTERFACE
RC.GZ
VFILER_SERVICE
ISCSI-NODENAME
RESOLV-CONF
VOLUME
ISCSI-SECURITY
RESOLV-CONF.GZ
VSCAN
ISCSI-TARGET-PORTAL-GROUPS
SERVICE
LICENSES.XML
SHELF
43
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Version History
Version
Date
Document Version History
Version 1.0
Apr 2015
Initial version.
Version 1.1
Aug 2015
Updated for 2.6.1 release. Added FAQ section.
Version 1.2
Feb 2016
Updated for 3.1 release. Added ASUP Missing Data section.
Version 1.3
October 2017
Updated for 3.2 release. Added API/CLI usage section.
Version 1.4
January 2018
Updated for 3.2P1 release. Updated FAQs and Diff Report
section.
Version 1.5
February 2018
Updated for 3.3 release.
Version 1.6
September 2018
Updated for 3.4 release.
Version 1.7
April 2019
July 2019
Updated for 3.5 release.
Updated for 3.5.1 release (no changes).
Version 1.8
September 2019
Added Statistics Upload section.
Version 1.9
June 2020
Updated for 3.6.0 release.
Version 1.10
February 2021
Updated for 3.7.0 release.
Version 1.11
December 2021
Updated for 4.0.0 release.
44
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.
Refer to the Interoperability Matrix Tool (IMT) on the NetApp Support site to validate that the exact
product and feature versions described in this document are supported for your specific environment. The
NetApp IMT defines the product components and versions that can be used to construct configurations
that are supported by NetApp. Specific results depend on each customer’s installation in accordance with
published specifications.
Copyright Information
Copyright © 2021 NetApp, Inc. All Rights Reserved. Printed in the U.S. No part of this document covered
by copyright may be reproduced in any form or by any means—graphic, electronic, or mechanical,
including photocopying, recording, taping, or storage in an electronic retrieval system—without prior
written permission of the copyright owner.
Software derived from copyrighted NetApp material is subject to the following license and disclaimer:
THIS SOFTWARE IS PROVIDED BY NETAPP “AS IS” AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY
DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
NetApp reserves the right to change any products described herein at any time, and without notice.
NetApp assumes no responsibility or liability arising from the use of products described herein, except as
expressly agreed to in writing by NetApp. The use or purchase of this product does not convey a license
under any patent rights, trademark rights, or any other intellectual property rights of NetApp.
The product described in this manual may be protected by one or more U.S. patents, foreign patents, or
pending applications.
Data contained herein pertains to a commercial item (as defined in FAR 2.101) and is proprietary to
NetApp, Inc. The U.S. Government has a non-exclusive, non-transferrable, non-sublicensable, worldwide,
limited irrevocable license to use the Data only in connection with and in support of the U.S. Government
contract under which the Data was delivered. Except as provided herein, the Data may not be used,
disclosed, reproduced, modified, performed, or displayed without the prior written approval of NetApp,
Inc. United States Government license rights for the Department of Defense are limited to those rights
identified in DFARS clause 252.227-7015(b).
Trademark Information
NETAPP, the NETAPP logo, and the marks listed at http://www.netapp.com/TM are trademarks of
NetApp, Inc. Other company and product names may be trademarks of their respective owners.
45
NetAppDocs User Guide
© 2021 NetApp, Inc. All Rights Reserved.