Skip to content

Get SdnInfrastructureInfo

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

Get-SdnInfrastructureInfo

SYNOPSIS

Get the SDN infrastructure information from network controller. The function will update the $Global:SdnDiagnostics.EnvironmentInfo variable.

SYNTAX

RestCredential (Default)

Get-SdnInfrastructureInfo [-NetworkController <String>] [-Credential <PSCredential>] [-NcUri <Uri>]
 [-NcRestCredential <PSCredential>] [-Force] [<CommonParameters>]

RestCertificate

Get-SdnInfrastructureInfo [-NetworkController <String>] [-Credential <PSCredential>] [-NcUri <Uri>]
 -NcRestCertificate <X509Certificate> [-Force] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SdnInfrastructureInfo

EXAMPLE 2

Get-SdnInfrastructureInfo -NetworkController 'NC01' -Credential (Get-Credential) -NcRestCredential (Get-Credential)

PARAMETERS

-NetworkController

Specifies the name or IP address of the network controller node on which this cmdlet operates. The parameter is optional if running on network controller node.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $env:COMPUTERNAME
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

-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: False
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 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

-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

-Force

Switch parameter to force a refresh of the environment cache details

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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