Set-SCStaticIPAddressPool

Applies To: System Center 2012 - Virtual Machine Manager

Set-SCStaticIPAddressPool

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

Syntax

Parameter Set: Default
Set-SCStaticIPAddressPool [-StaticIPAddressPool] <StaticIPAddressPool> [-DefaultGateway <DefaultGateway[]> ] [-Description <String> ] [-DNSSearchSuffix <String[]> ] [-DNSServer <String[]> ] [-DNSSuffix <String> ] [-EnableNetBIOS <Boolean> ] [-IPAddressRangeEnd <String> ] [-IPAddressRangeStart <String> ] [-IPAddressReservedSet <String> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-VIPAddressSet <String> ] [-VMMServer <ServerConnection> ] [-WINSServer <String[]> ] [ <CommonParameters>]

Detailed 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

-DefaultGateway<DefaultGateway[]>

Specifies a default gateway object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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

-DNSSearchSuffix<String[]>

Specifies one or more strings that are appended to a host name to resolve a DNS address.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DNSServer<String[]>

Specifies the IP address of one or more DNS servers. Valid formats: IPv4 or IPv6 address.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DNSSuffix<String>

Specifies the default DNS suffix associated with a NIC.

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EnableNetBIOS<Boolean>

Indicates whether NetBIOS over TCP/IP is enabled for a NIC.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IPAddressRangeEnd<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IPAddressRangeStart<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IPAddressReservedSet<String>

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

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

-Name<String>

Specifies the name of a VMM object.

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

-StaticIPAddressPool<StaticIPAddressPool>

Specifies an IP address pool from which you can assign static IP addresses.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-VIPAddressSet<String>

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

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

-WINSServer<String[]>

Specifies the IP address of one or more WINS servers. Valid formats: IPv4 or IPv6 address.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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.

• StaticIPAddressPool

Examples

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

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.

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

Related topics

Get-SCStaticIPAddressPool

New-SCStaticIPAddressPool

Remove-SCStaticIPAddressPool