Skip to content

Get SdnPublicIPPoolUsageSummary

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

Get-SdnPublicIPPoolUsageSummary

SYNOPSIS

Returns back the IP addresses associated with the public logical subnet IP pools within the Network Controller environment.

SYNTAX

RestCredential (Default)

Get-SdnPublicIPPoolUsageSummary -NcUri <Uri> [-NcRestCredential <PSCredential>] [<CommonParameters>]

RestCertificate

Get-SdnPublicIPPoolUsageSummary -NcUri <Uri> -NcRestCertificate <X509Certificate> [<CommonParameters>]

DESCRIPTION

This function returns back a list of IP addresses that are consumed by the PublicIPAddresses and LoadBalancer resources that are derived from the public IP pools. This helps operators quickly locate which resources are associated with a public IP address, in addition to identify available vs non-available IP addresses.

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

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

-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

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