Skip to content

Get SdnNetworkControllerState

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

Get-SdnNetworkControllerState

SYNOPSIS

Gathers the Network Controller State dump files (IMOS) from each of the Network Controllers

SYNTAX

RestCredential (Default)

Get-SdnNetworkControllerState -NetworkController <String> -OutputDirectory <FileInfo>
 [-Credential <PSCredential>] [-NcRestCredential <PSCredential>] [-ExecutionTimeOut <Int32>]
 [<CommonParameters>]

RestCertificate

Get-SdnNetworkControllerState -NetworkController <String> -OutputDirectory <FileInfo>
 [-Credential <PSCredential>] -NcRestCertificate <X509Certificate> [-ExecutionTimeOut <Int32>]
 [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SdnNetworkControllerState -NetworkController 'Contoso-NC01' -OutputDirectory "C:\Temp\CSS_SDN"

PARAMETERS

-NetworkController

The computer name of the Network Controller used to retrieve Infrastructure Info and trigger IMOS generation.

Type: String
Parameter Sets: (All)
Aliases:

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

-OutputDirectory

Directory location to save results. By default it will create a new sub-folder called NetworkControllerState that the files will be copied to

Type: FileInfo
Parameter Sets: (All)
Aliases:

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

-Credential

Specifies a user account that has permission to Network Controller. The default is the current user.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-NcRestCredential

Specifies a user account that has permission to perform this action against the Network Controller REST API. 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

-NcRestCertificate

Specifies the client certificate that is used for a secure web request to Network Controller REST API. 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

-ExecutionTimeOut

Specify the execution timeout (seconds) on how long you want to wait for operation to complete before cancelling operation. If omitted, defaults to 300 seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 300
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