Set-SCStaticIPAddressPool

Modifies a static IP address pool. Edits a IP address pool that's associated with one or more hostgroups

Description

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

For more information about Set-SCStaticIPAddressPool, type: "Get-Help Set-SCStaticIPAddressPool -online".

Parameters

StaticIPAddressPool

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies an IP address pool from which you can assign static IP addresses.

DefaultGateway

Required? false
Accept Pipeline Input? false
Position? named
Specifies a default gateway object.

Description

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

DNSSearchSuffix

Required? false
Accept Pipeline Input? false
Position? named
Specifies one or more strings that are appended to a host name to resolve a DNS address.

DNSServer

Required? false
Accept Pipeline Input? false
Position? named
Specifies the IP address of one or more DNS servers. Valid formats: IPv4 or IPv6 address.

DNSSuffix

Required? false
Accept Pipeline Input? false
Position? named
Specifies the default DNS suffix associated with a NIC. 

Example format: -DNSSuffix "Domain01.Contoso.com"

EnableNetBIOS

Required? false
Accept Pipeline Input? false
Position? named
Indicates whether NetBIOS over TCP/IP is enabled for a NIC.

IPAddressRangeEnd

Required? false
Accept Pipeline Input? false
Position? named
Specifies the last IP address in a range of IP addresses. Use with IPAddressRangeStart.

IPAddressRangeStart

Required? false
Accept Pipeline Input? false
Position? named
Specifies the first IP address in a range of IP addresses. Use with IPAddressRangeEnd.

IPAddressReservedSet

Required? false
Accept Pipeline Input? false
Position? named
Specifies a set of IP addresses within an IP subnet that is reserved for other use.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

Name

Required? false
Accept Pipeline Input? false
Position? named
Specifies the name of a VMM object.

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. 

VIPAddressSet

Required? false
Accept Pipeline Input? false
Position? named
Specifies a set of IP addresses within an IP subnet that is reserved for configuring virtual IPs (VIPs) in load balancers.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a VMM server object.

WINSServer

Required? false
Accept Pipeline Input? false
Position? named
Specifies the IP address of one or more WINS servers. Valid formats: IPv4 or IPv6 address.

Examples

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 with the path of All Hosts\HostGroup02\Production and stores it in the $HostGroup variable.

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

The third command gets the DNSServer for the IP address pool stored in the $IPPool variable, and then the fifth 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.

See Also