Skip to content

Invoke SdnResourceDump

Adam Rudell edited this page Oct 30, 2024 · 3 revisions

Invoke-SdnResourceDump

SYNOPSIS

Performs API request to all available northbound endpoints for NC and dumps out the resources to json file.

SYNTAX

RestCredential (Default)

Invoke-SdnResourceDump -NcUri <Uri> -OutputDirectory <FileInfo> [-NcRestCredential <PSCredential>]
 [<CommonParameters>]

RestCertificate

Invoke-SdnResourceDump -NcUri <Uri> -OutputDirectory <FileInfo> -NcRestCertificate <X509Certificate>
 [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Invoke-SdnResourceDump

EXAMPLE 2

Invoke-SdnResourceDump -NcUri "https://nc.contoso.com"

EXAMPLE 3

Invoke-SdnResourceDump -NcUri "https://nc.contoso.com" -NcRestCredential (Get-Credential)

PARAMETERS

-NcUri

Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller.

Type: Uri
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputDirectory

{{ Fill OutputDirectory Description }}

Type: FileInfo
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NcRestCertificate

Specifies the client certificate that is used for a secure web request. Enter a variable that contains a certificate or a command or expression that gets the certificate.

Type: X509Certificate
Parameter Sets: RestCertificate
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NcRestCredential

Specifies a user account that has permission to perform this action. The default is the current user.

Type: PSCredential
Parameter Sets: RestCredential
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Documentation

How To Guides:

Troubleshooting Guides

Learning

Functions

Clone this wiki locally