NAME
Add-NtapDocsExtendedData
SYNOPSIS
Adds extended data to the formatted output (DataSet).
SYNTAX
Add-NtapDocsExtendedData [-InputObject] <Object[]> [-DataReplication] [-DataProtection] [-CustomScript <String[]>]
[<CommonParameters>]
DESCRIPTION
Processes the formatted DataSet and adds the additional data specified. The Format-Ntap*Data functions process the data for
each system individually and this function then
looks at the data for all the systems in order to generate the additional data.
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
-DataReplication [<SwitchParameter>]
If specified, additional ONTAP FlexVol data replication data will be added to the DataSet.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DataProtection [<SwitchParameter>]
If specified, additional ONTAP FlexVol data protection data will be added to the DataSet.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-CustomScript <String[]>
The path to a PowerShell script that customizes the DataSet for specific use cases. This is useful for adding additional
customer or report specific columns not present in the default output. For example, adding the SystemModel from the
NodeDetails table to the StorageDetails table so this data is in a single worksheet. The data required for the additional
columns must already exist in the DataSet and the additional columns will only be present in the Excel output. Sample
scripts can be found in the 'Resources/ExtendedDataScriptExamples' folder. (Note: Currently experimental)
Required? false
Position? named
Default value
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
OUTPUTS
System.Data.DataSet
NOTES
AUTHOR : Jason Cole
-------------------------- EXAMPLE 1 --------------------------
PS>Get-NtapClusterData -Name cluster1, cluster2 | Format-NtapClusterData | Add-NtapDocsExtendedData -DataProtection |
Out-NtapDocument -ExcelFile 'D:\clusters_extended.xlsx'
Collects and formats the data from 'cluster1' and 'cluster2', adds the extended 'DataProtection' data and writes the results
to the specified ExcelFile.
-------------------------- EXAMPLE 2 --------------------------
PS>Get-NtapClusterData -Name cluster1, cluster2 | Format-NtapClusterData | Add-NtapDocsExtendedData -CustomScript
'D:\AddCustomColumnsToDataSet.ps1' | Out-NtapDocument -ExcelFile 'D:\clusters_extended.xlsx'
Collects and formats the data from 'cluster1' and 'cluster2', processes the script specified to add additional custom columns
and writes the results to the specified ExcelFile.
RELATED LINKS
https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
Format-NtapClusterData
Format-NtapFilerData
Format-NtapVserverData
Out-NtapDocument