Get-NetworkControllerIpPool

This cmdlet retrieves the settings of an IP pool from the Network Controller.

Syntax

Get-NetworkControllerIpPool
   [-NetworkId] <String[]>
   [-SubnetId] <String[]>
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

This cmdlet retrieves the settings of an IP pool from the Network Controller. Specifically, it retrieves the start and end address of the pool, IP addresses in the pool that are being used for VIPs and the usage of IP addresses in the pool

Examples

Example 1

This example retrieves all the IP pools that are present in a subnet called Subnet1. Subnet1 is present in a network called ln1.

Get-NetworkControllerIpPool -ConnectionUri https://networkcontroller -NetworkId ln1 -SubnetId subnet1

Required Parameters

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NetworkId

Specifies the network where the IP pool belongs

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SubnetId

Specifies the subnet where the IP pool belongs

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-CertificateThumbprint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the unique identifier for the IP pool

Type:String[]
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Following properties are displayed by the cmdlet

  1. Start IP address of the pool
  2. End IP address of the pool
  3. IP addresses being used for load balancer VIPs
  4. Number of IP addresses in the pool that have been allocated