Export (0) Print
Expand All
Expand Minimize

Set-SCIPAddress

Updated: April 29, 2014

Applies To: System Center 2012 R2 Virtual Machine Manager

Set-SCIPAddress

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

Syntax

Parameter Set: Default
Set-SCIPAddress [-AllocatedIPAddress] <AllocatedIPAddress> [-Description <String> ] [-GrantToObjectID <Guid> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]




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

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

-Description<String>

States a description for the specified object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-GrantToObjectID<Guid>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

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

  • CloudDRPairingInfoData

Examples

Example 1: Assign an allocated IP address to a load balancer virtual IP

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

The second command gets the static IP address pool object with the specified IPv4 subnet, and then 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 then 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.


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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft