Set-SCIPAddress

Modifies an allocated IP address by assigning the IP address to an object, or updating the IP address description.

Description

The Set-SCIPAddress cmdlet modifies an allocated IP address. You can use Set-SCIP address to assign an allocated IP address to an object using the GrantToObjectID parameter. 

For more information about Set-SCIPAddress, type: "Get-Help Set-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.

Description

Required? false
Accept Pipeline Input? false
Position? named 
States a description for the specified object.

GrantToObjectID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of an object to which an allocated IP address or MAC address will be assigned.

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.

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: Assign an allocated IP address to a load balancer virtual IP. 
PS C:\> $VIP = Get-SCLoadBalancerVIP -Name "LoadBalancerVIP01"
PS C:\> $IPAddressPool = Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24"
PS C:\> $IPAddress = Get-SCIPAddress -StaticIPAddressPool $IPAddressPool -Unassigned
PS C:\> Set-SCIPAddress -AllocatedIPAddress $IPAddress[0] -GrantToObjectID $VIP.ID

The first command gets the load balancer virtual IP object named LoadBalancerVIP01 and stores the object in the $VIP variable.

The second command gets the static IP address pool object with the specified IPv4 subnet and stores the object in the $IPAddressPool variable.

The third command gets the unassigned IP address objects for the static IP address pool stored in $IPAddressPool and stores the objects in the $IPAddress variable.

The last command assigns the first unassigned IP address from the addresses stored in $IPAddress to the virtual load balancer ID stored in $VIP.ID.

See Also