NAME
Get-NtapFSxOntapData
SYNOPSIS
Collects SVM specific data from AWS FSx for ONTAP storage instances.
SYNTAX
Get-NtapFSxOntapData [-ClusterName] <String> [-Name <String[]>] [-Credential <PSCredential>] [-Port <UInt16>] [-Timeout
<Int32>] [-ForceSecure] [-DisableLifCheck] [-DisablePingCheck] [<CommonParameters>]
Get-NtapFSxOntapData [-AbstractController] <AbstractController> [-Name <String[]>] [-Timeout <Int32>] [-DisableLifCheck]
[-DisablePingCheck] [<CommonParameters>]
DESCRIPTION
Uses the NetApp ONTAP PowerShell Toolkit to gather as much SVM configuration information as possible. This
data can be used to automate build docs. It can also be used for historical configuration information. It
will gather information about each data SVM, or specific SVMs with the -Name parameter.
PARAMETERS
-ClusterName <String>
The system name or IP address of the cluster admin SVM to gather the data from.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-AbstractController <AbstractController>
A NetApp ONTAP PowerShell Toolkit controller object (NcController).
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String[]>
A list of data SVMs to gather the data for. If blank, the information for all data SVMs will be returned.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies explicit credentials to connect to the storage system. (Alias: Cred)
Required? false
Position? named
Default value [pscredential]::Empty
Accept pipeline input? false
Accept wildcard characters? false
-Port <UInt16>
The port on which to connect to the storage system. If not set, it defaults to 80 for HTTP and 443 for HTTPS.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
Connection timeout in milliseconds. Defaults to 60000 milliseconds.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ForceSecure [<SwitchParameter>]
Forces the use of HTTPS instead of HTTP for the connection to the storage system.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisableLifCheck [<SwitchParameter>]
During the initial connection to the storage system, this switch disables a check that is performed to ensure that the LIF
being used for the connection is a cluster mgmt or a node mgmt port. This should only be used for a very specific scenario
where port forwarding is configured on the host connecting to the storage system.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisablePingCheck [<SwitchParameter>]
Disables the ping test prior to connecting to the storage system (useful in the event ICMP is being blocked). (Deprecated)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
NetApp.Ontapi.AbstractController
System.String
OUTPUTS
System.Management.Automation.PSCustomObject
NOTES
AUTHOR : Jason Cole
-------------------------- EXAMPLE 1 --------------------------
PS>Get-NtapFSxOntapData -ClusterName cluster1 | Export-Clixml -Path 'D:\Output\cluster1_AllSVMs.xml'
Collects the configuration information for each data SVM from the cluster 'cluster1' and saves the results
to a .xml file for further processing.
-------------------------- EXAMPLE 2 --------------------------
PS>Get-NtapFSxOntapData -ClusterName cluster1 -Credential (Get-Credential) | Export-Clixml -Path
'D:\Output\cluster1_AllSVMs.xml'
Collects the configuration information for each data SVM from the cluster 'cluster1' using alternate
credentials, and saves the results to a .xml file for further processing. The Add-NcCredential cmdlet may be
used to cache credentials for the cluster to be accessed.
-------------------------- EXAMPLE 3 --------------------------
PS>Get-NtapFSxOntapData -Name vs_nfs, vs_cifs, vs_san -ClusterName cluster1 | Export-Clixml -Path
'D:\Output\cluster1_SVMs.xml'
Collects the configuration information for the specified data SVMs from the cluster 'cluster1' and saves the
results to a .xml file for further processing.
-------------------------- EXAMPLE 4 --------------------------
PS>Get-NtapFSxOntapData -ClusterName cluster1 | Format-NtapVserverData | Out-NtapDocument -WordFile
'D:\Output\cluster1_AllSVMs.xlsx' -WordFile 'D:\Output\cluster1_AllSVMs.xlsx'
Collects the configuration information for all data SVMs in cluster 'cluster1' and produces the specified
Word and Excel documents.
RELATED LINKS
https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
Format-NtapFSxOntapData