NetAppDocs PowerShell Module

New-NtapFilerAsupBuildDocument


NAME
    New-NtapFilerAsupBuildDocument

SYNOPSIS
    Generates a Data ONTAP 7-Mode build document by collecting the data from the most recent set of ASUPs.


SYNTAX
    New-NtapFilerAsupBuildDocument [-System] <String[]> [-AsupSubject <String>] [-ExcelFile <String>] [-WordFile <String>]
    [-CustomerName <String>] [-CustomerLocation <String>] [-Locale <String>] [<CommonParameters>]

    New-NtapFilerAsupBuildDocument [-AsupId] <String[]> [-ExcelFile <String>] [-WordFile <String>] [-CustomerName <String>]
    [-CustomerLocation <String>] [-Locale <String>] [<CommonParameters>]


DESCRIPTION
    Generates a Data ONTAP 7-Mode build document by collecting the data from the most recent set of ASUPS. This function calls
    the three necessary PowerShell functions to generate the 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
    -System <String[]>
        The system information to search for (e.g., HA pair: 'Node1Hostname:Node1SerialNumber!Node2Hostname:Node2SerialNumber'
        and stand-alone: 'NodeName:NodeSerialNumber').

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -AsupId <String[]>
        The ASUPID(s) to search for. An ASUPID from each node in the HA pair is required. Each node's ASUPID must be
        separated by an exclamation point (e.g., 2015012500120554!2015012423440127). Sets of ASUPIDs from multiple
        HA pairs must be comma separated (e.g., 2015012500120554!2015012423440127, 2015062302150043!2015062302150041).

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -AsupSubject <String>
        The type of ASUP to search for (weekly or user_triggered). (Default: weekly)

        Required?                    false
        Position?                    named
        Default value                weekly
        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
        REQUIRES : Internal connection to NetApp

    -------------------------- EXAMPLE 1 --------------------------

    PS>New-NtapFilerAsupBuildDocument -System 'mtharvard:30020945!mtmassive:30020946' -ExcelFile 'D:\den-cdot.xlsx' -WordFile
    'D:\den-cdot.docx' -CustomerName 'NetApp' -CustomerLocation 'Denver Lab'

    Captures the data from the most recent weekly ASUPs for the specified storage systems and outputs the specified Word and
    Excel documents (includes customer name and customer location on the cover pages).




    -------------------------- EXAMPLE 2 --------------------------

    PS>New-NtapFilerAsupBuildDocument -System 'mtharvard:30020945!mtmassive:30020946' -AsupSubject user_triggered -ExcelFile
    'D:\den-cdot.xlsx' -WordFile 'D:\den-cdot.docx' -CustomerName 'NetApp' -CustomerLocation 'Denver Lab'

    Captures the data from the most recent user_triggered ASUPs for the specified storage systems 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-NtapFilerAsupData
    Format-NtapFilerData
    Out-NtapDocument