Skip to content

Get SdnSlbStateInformation

Adam Rudell edited this page May 21, 2025 · 6 revisions

Get-SdnSlbStateInformation

SYNOPSIS

Generates an aggregated report of Virtual IPs (VIPs) in the environment and their current status as reported by Software Load Balancer and MUXes.

SYNTAX

RestCredential (Default)

Get-SdnSlbStateInformation -NcUri <Uri> [-VirtualIPAddress <IPAddress>] [-NcRestCredential <PSCredential>]
 [-ExecutionTimeOut <Int32>] [-PollingInterval <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

RestCertificate

Get-SdnSlbStateInformation -NcUri <Uri> [-VirtualIPAddress <IPAddress>] -NcRestCertificate <X509Certificate>
 [-ExecutionTimeOut <Int32>] [-PollingInterval <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SdnSlbStateInformation -NcUri "https://nc.contoso.com"

EXAMPLE 2

Get-SdnSlbStateInformation -NcUri "https://nc.contoso.com" -VirtualIPAddress 41.40.40.1

EXAMPLE 3

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

EXAMPLE 4

Get-SdnSlbStateInformation -NcUri "https://nc.contoso.com" -ExecutionTimeout 1200

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

-VirtualIPAddress

Specifies the VIP address to return information for. If omitted, returns all VIPs.

Type: IPAddress
Parameter Sets: (All)
Aliases:

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

-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 timeout duration to wait before automatically terminated. If omitted, defaults to 600 seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-PollingInterval

Interval in which to query the state of the request to determine completion.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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