Get-NetworkControllerIpReservation
Gets the IP reservation for a subset in Network Controller.
Syntax
Get-NetworkControllerIpReservation
[-NetworkId] <String[]>
[-SubnetId] <String[]>
[[-ResourceId] <String[]>]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[<CommonParameters>]
Description
The Get-NetworkControllerIpReservation cmdlet gets the IP reservation for a subset in Network Controller.
Examples
Example 1: Get an IP reservation
Get-NetworkControllerIpReservation -SubnetId ContosoSubnet -ConnectionUri https://networkcontroller
This command gets the IP reservation for the specified subnet.
Parameters
-CertificateThumbprint
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionUri
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 |
Position: | Named |
Default value: | None |
Required: | True |
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.
Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NetworkId
Specifies the network of the IP reservation.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassInnerException
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: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Specifies the IDs of the IP reservations to get.
Type: | String[] |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubnetId
Specifies the IDs of the subnets for which this cmdlet gets IP reservations.
Type: | String[] |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
String[]