NAME
New-NtapClusterBuildDocument
SYNOPSIS
Generates an ONTAP build document by collecting the data from a live system.
SYNTAX
New-NtapClusterBuildDocument [-Name] <String[]> [-Credential <PSCredential>] [-ExcelFile <String>] [-WordFile <String>]
[-CustomerName <String>] [-CustomerLocation <String>] [-Locale <String>] [<CommonParameters>]
DESCRIPTION
Generates an ONTAP build document by collecting the data from a live system. This function calls the three
necessary PowerShell functions to generate a build document and is provided to help reduce the complexity of the PowerShell
pipeline. As such, only the basic parameters are supported and if more advanced parameters are necessary then the three
functions will need to be called separately.
PARAMETERS
-Name <String[]>
The system name or IP address of the storage system to gather the data from.
Required? true
Position? 1
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
-ExcelFile <String>
The path to the output Excel document.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WordFile <String>
The path to the output Word document.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomerName <String>
The customer name to add to the documentation.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomerLocation <String>
The customer location to add to the documentation.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Locale <String>
Specifies the locale for the default templates.
Required? false
Position? named
Default value en-US
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
None
OUTPUTS
None
NOTES
AUTHOR : Jason Cole
-------------------------- EXAMPLE 1 --------------------------
PS>New-NtapClusterBuildDocument -Name den-cdot -Credential (Get-Credential) -ExcelFile 'D:\den-cdot.xlsx' -WordFile
'D:\den-cdot.docx' -CustomerName 'NetApp' -CustomerLocation 'Denver Lab'
Captures the data from for the specified storage system (prompts for admin credentials) and outputs the specified Word and
Excel documents (includes customer name and customer location on the cover pages).
RELATED LINKS
https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
Get-NtapClusterData
Format-NtapClusterData
Out-NtapDocument