Share via

Set-SCStaticIPAddressPool

  • Reference
Module:
VirtualMachineManager

Modifies a static IP address pool that is associated with one or more hostgroups.

Syntax

Set-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-StaticIPAddressPool] <StaticIPAddressPool>
   [-Name <String>]
   [-Description <String>]
   [-DNSSearchSuffix <String[]>]
   [-DNSServer <String[]>]
   [-PxeServerAddress <String[]>]
   [-DNSSuffix <String>]
   [-IPAddressRangeStart <String>]
   [-IPAddressRangeEnd <String>]
   [-IPAddressReservedSet <String>]
   [-VIPAddressSet <String>]
   [-EnableNetBIOS <Boolean>]
   [-DefaultGateway <DefaultGateway[]>]
   [-NetworkRoute <SubnetNetworkRoute[]>]
   [-WINSServer <String[]>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Set-SCStaticIPAddressPool cmdlet modifies a Virtual Machine Manager (VMM) static IP address pool. A static IP address pool can be associated with one or more logical network definitions.

Examples

Example 1: Add DNS Servers to a static IP address pool

PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
PS C:\> $IPPool = Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24" -VMHostGroup $HostGroup -Name "Production IP Address Pool"
PS C:\> $DNSServerIPAddress = $IPPool.DNSServers
PS C:\> $DNSServerIPAddress += "10.0.0.1"
PS C:\> Set-SCStaticIPAddressPool -StaticIPAddressPool $IPPool -DNSServer $DNSServerIPAddress

The first command gets the host group that has the path All Hosts\HostGroup02\Production, and stores that group in the $HostGroup variable.

The second command gets the static address pool named Production IP Address Pool for the host group stored in $HostGroup, using the IPv4 address for the specified subnet. The command stores the pool in the $IPPool variable.

The third command gets the DNS server for the IP address pool stored in $IPPool, and then the fourth command adds an address to the address array stored in the $DNSServerIPAddress variable.

The last command updates the IP address pool stored in $IPPool with the address array stored in $DNSServerIPAddress.

Parameters

-DefaultGateway

Specifies an array of default gateway objects.

Type:DefaultGateway[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the address pool.

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

-DNSSearchSuffix

Specifies an array of strings that are appended to a host name to resolve a DNS address.

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

-DNSServer

Specifies an array of IP addresses of DNS servers. Valid formats are: IPv4 and IPv6 addresses.

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

-DNSSuffix

Specifies the default DNS suffix associated with an adapter.

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

-EnableNetBIOS

Indicates whether to enable NetBIOS over TCP/IP for an adapter.

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

-IPAddressRangeEnd

Specifies the last IP address in a range of IP addresses. Use with the IPAddressRangeStart parameter.

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

-IPAddressRangeStart

Specifies the first IP address in a range of IP addresses. Use with the IPAddressRangeEnd parameter.

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

-IPAddressReservedSet

Specifies a set of IP addresses in an IP subnet that is reserved for other use.

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

-JobVariable

Specifies a variable in which job progress is tracked and stored.

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

-Name

Specifies the name for the address pool.

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

-NetworkRoute

Specifies an array of network routes.

Type:SubnetNetworkRoute[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

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

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

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

-PxeServerAddress

Specifies an array of PXE Server IP addresses.

Type:String[]
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

-StaticIPAddressPool

Specifies the static IP address pool that this cmdlet modifies.

Type:StaticIPAddressPool
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VIPAddressSet

Specifies a set of IP addresses in an IP subnet that is reserved for configuring virtual IPs (VIPs) in load balancers.

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

-WINSServer

Specifies an array of IP addresses of Windows Internet Name Service (WINS) servers. Valid formats are: IPv4 and IPv6 addresses.

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

Outputs

StaticIPAddressPool

This cmdlet returns a StaticIPAddressPool object.