Share via

Set-SCIPAddress

  • Reference
Module:
VirtualMachineManager

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

Syntax

Set-SCIPAddress
   [-UserRole <UserRole>]
   [-VMMServer <ServerConnection>]
   [-AllocatedIPAddress] <AllocatedIPAddress>
   [-GrantToObjectID <Guid>]
   [-Description <String>]
   [-Owner <String>]
   [-ExplicitRevokeRequired <Boolean>]
   [-DisableReconcile <Boolean>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

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

Examples

Example 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.

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

-Description

Specifies a description for the IP address.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableReconcile

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExplicitRevokeRequired

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GrantToObjectID

Specifies the ID of an object to which an allocated IP address or MAC address is assigned.

Type:Guid
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

-Owner

Specifies the owner of a VMM object in the form of a valid domain user account.

  • Example format: -Owner "Contoso\PattiFuller"
  • Example format: -Owner "PattiFuller@Contoso"
Type:String
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

-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

-UserRole

Type:UserRole
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.