NAME
Out-NtapDocument
SYNOPSIS
Writes output documentation using the output from the Format-Ntap* functions.
SYNTAX
Out-NtapDocument [-InputObject] <Object[]> [-XmlFile <String>] [-ExcelFile <String>] [-ExcelTemplate <String>] [-WordFile
<String>] [-WordTemplate <String>] [-PaperSize <String>] [-VisioFile <String>] [-SaveWordDocAsPdf] [-CustomerName <String>]
[-CustomerLocation <String>] [-ProjectName <String>] [-AuthorName <String>] [-Locale <String>] [<CommonParameters>]
DESCRIPTION
Outputs documentation files containing parsed configuration information gathered by the Get-Ntap* functions
and formatted by the Format-Ntap* functions. Also accepts pipeline input from the Format-Ntap* functions.
PARAMETERS
-InputObject <Object[]>
A DataSet or an XML file created by the Format-Ntap* functions (might be *.xml.gz).
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-XmlFile <String>
The path to the parsed output XML file.
Required? false
Position? named
Default value
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
-ExcelTemplate <String>
The path to the output Excel template.
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
-WordTemplate <String>
The path to the output Word template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PaperSize <String>
The output document paper size. Currently, only Letter, A4 and P4 are supported. (Default: Letter)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VisioFile <String>
The path to an existing Visio file to copy drawings from.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SaveWordDocAsPdf [<SwitchParameter>]
Saves the Word document to a PDF file.
Required? false
Position? named
Default value False
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
-ProjectName <String>
The project name to add to the documentation.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthorName <String>
The author name 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
System.Data.DataSet
System.IO.FileInfo
System.String
OUTPUTS
None
NOTES
AUTHOR : Jason Cole
-------------------------- EXAMPLE 1 --------------------------
PS>Out-NtapDocument -InputObject 'D:\Site.xml' -ExcelFile 'D:\Output\Site.xlsx'
Outputs the data contained in D:\site.xml and produces an Excel document.
-------------------------- EXAMPLE 2 --------------------------
PS>Out-NtapDocument -InputObject 'D:\Site.xml' -WordTemplate 'D:\template.dotx' -WordFile 'D:\Output\Site.docx' -CustomerName
'NetAppDocs Customer' -CustomerLocation 'Seattle, WA'
Outputs the data contained in D:\site.xml and produces a Word document based on a custom template. To create a
custom template, copy the template found in the NetAppDocs module 'Templates' folder. The most common uses for
creating a custom template are to modify the 'Overview' section and add an 'Appendix' section for customer
specific static information.
-------------------------- EXAMPLE 3 --------------------------
PS>Out-NtapDocument -InputObject 'D:\Site.xml' -WordFile 'D:\Output\Site.docx' -VisioFile 'D:\Output\Site.vsd' -CustomerName
"NetAppDocs Customer" -CustomerLocation "Seattle, WA" -SaveWordDocAsPdf
Outputs the data contained in D:\site.xml and produces a Word document.
-------------------------- EXAMPLE 4 --------------------------
PS>Get-ChildItem -Path 'D:\Data' -Filter "*-parsed.xml" | Out-NtapDocument -WordFile 'D:\Output\Site.docx' -ExcelFile
'D:\Output\Site.xlsx' -CustomerName "NetAppDocs Customer" -CustomerLocation "Seattle, WA"
This will gather all the parsed XML files previously output from this function (using only the -XmlFile
parameter). A Word document and an Excel document will be created and the cover page of the Word document will
be updated with the customer name and location.
RELATED LINKS
https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
Update-NtapDocument