Share via


New-SCStaticIPAddressPool

Applies To: System Center 2012 - Virtual Machine Manager

New-SCStaticIPAddressPool

Creates a static IP address pool.

Syntax

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

Detailed Description

The New-SCStaticIPAddressPool cmdlet creates a System Center Virtual Machine Manager static IP address pool. A static IP address pool can be associated with one or more host groups.

For more information about New-SCStaticIPAddressPool, type: "Get-Help New-StaticIPAddressPool -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

-LogicalNetworkDefinition<LogicalNetworkDefinition>

Specifies a logical network definition (also called a network site) that contains the subnet that the IP address pool serves as specified by the Subnet parameter.

Aliases

none

Required?

true

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?

true

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

-Subnet<String>

Specifies an IP subnet (IPv4 or IPv6) in Classless Inter-Domain Routing (CIDR) notation.

Example format for an IPv4 subnet: 192.168.0.1/24

Example format for an IPv6 subnet: FD4A:29CD:184F:3A2C::/64

NOTE: An IP subnet cannot overlap with any other subnet in a host group or child host groups.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

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.

Examples

1: Create 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 logical network named LogicalNetwork01 and saves it in the $LogNet variable.

The third command gets the logical network definition named Logical Network Definition 01 for the host group stored in the $HostGroup variable.

The fourth command creates a new default gateway and stores it in the $DefaultGateway variable.

The last command creates a new static IP address pool with the specified values.

PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
PS C:\> $LogNet = Get-SCLogicalNetwork -Name "LogicalNetwork01"
PS C:\> $LogNetDef = Get-SCLogicalNetworkDefinition -VMHostGroup $HostGroup -LogicalNetwork $LogNet -Name "Logical Network Definition 01"
PS C:\> $DefaultGateway = New-SCDefaultGateway -IPAddress "10.0.0.1" -Metric 10
PS C:\> New-SCStaticIPAddressPool -LogicalNetworkDefinition $LogNetDef -Name "Production IP Address Pool" -Description "This IP address pool is used for LOB Apps in production" -Subnet "10.0.0.0/24" -IPAddressRangeStart "10.0.0.10" -IPAddressRangeEnd "10.0.0.99" -IPAddressReservedSet "10.0.0.25-10.0.0.35, 10.0.0.38" -VIPAddressSet "10.0.0.95-10.0.0.99" -DNSSuffix "domain.contoso.com" -DNSSearchSuffix domain1.contoso.com, domain2.contoso.com -DNSServer "10.0.0.1", "10.0.0.2" -WINSServer "10.0.0.1", "10.0.0.2" -DefaultGateway $DefaultGateway -EnableNetBIOS $True

Get-SCLogicalNetwork

Get-SCLogicalNetworkDefinition

Get-SCStaticIPAddressPool

Get-SCVMHostGroup

Remove-SCStaticIPAddressPool

Set-SCStaticIPAddressPool