Revoke-SCIPAddress

Applies To: System Center 2012 - Virtual Machine Manager

Revoke-SCIPAddress

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

Syntax

Parameter Set: Default
Revoke-SCIPAddress [-AllocatedIPAddress] <AllocatedIPAddress> [-JobVariable <String> ] [-PROTipID <Guid> ] [-ReturnToPool <Boolean> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed 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<AllocatedIPAddress>

Specifies an IP address that has been allocated from an IP address pool.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReturnToPool<Boolean>

Indicates whether an IP address or MAC address is returned to its address pool. By default, this value is set to True.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • AllocatedIPAddress

Examples

1: Return an unassigned allocated IP address to the IP address pool.

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.

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]

Get-SCIPAddress

Grant-SCIPAddress

Set-SCIPAddress