Revoke-SCIPAddress
Returns an allocated IP address to the static IP address pool.
Syntax
Revoke-SCIPAddress
[-VMMServer <ServerConnection>]
[-AllocatedIPAddress] <AllocatedIPAddress>
[-ReturnToPool <Boolean>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[-Force]
[<CommonParameters>]Description
The Revoke-SCIPAddress cmdlet returns an allocated IP address to the static IP address pool.
Forced Removal: This is applicable only in a network controller managed environment. You can use the Force parameter with the Revoke-SCIPAddress cmdlet to return an allocated public IP address to the static IP address pool when the network controller is no longer online or accessible.
For information about allocating IP addresses, type Get-Help Grant-SCIPAddress -Detailed.
Examples
Example 1: Return an unassigned allocated IP address to the IP address pool
PS C:\> $IPAddressPool = Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24"
PS C:\> $IPAddress = Get-SCIPAddress -StaticIPAddressPool $IPAddressPool -Unassigned
PS C:\> Revoke-SCIPAddress -AllocatedIPAddress $IPAddress[0]The first command gets the static IP address pool object with the IPv4 subnet of 10.0.0.0/24 and stores the object in the $IPAddressPool variable.
The second command gets all unassigned allocated IP address objects for the static IP address pool stored in $IPAddressPool and stores the objects in the $IPAddress variable.
The last command revokes the first IP address stored in $IPAddress and returns the address to the IP address pool.
Parameters
-AllocatedIPAddress
Specifies an IP address that has been allocated from an IP address pool.
| Type: | AllocatedIPAddress |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
Forces the return of an allocated public IP address to the static IP address pool when the network controller is no longer online or accessible.
This parameter should be used only in a network controller managed environment.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUserRole
Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.
| Type: | UserRole |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnToPool
Indicates whether an IP address or MAC address is returned to its address pool. By default, this value is set to $True.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
CloudDRPairingInfoData
This cmdlet returns a CloudDRPairingInfoData object.