Revoke-SCIPAddress

Returns an allocated IP address to the static IP address pool.

Description

The Revoke-SCIPAddress cmdlet returns an allocated IP address to the static IP address pool. 

For information about allocating IP addresses, type: "Get-Help Grant-SCIPAddress -detailed".

For more information about Revoke-SCIPAddress, type: "Get-Help Revoke-SCIPAddress -online".

Parameters

AllocatedIPAddress

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0 
Specifies an IP address that has been allocated from an IP address pool.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

ReturnToPool

Required? false
Accept Pipeline Input? false
Position? named 
Indicates whether an IP address or MAC address is returned to its address pool. By default, this value is set to True.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

Examples

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.

See Also