Share via

Get-SCStaticIPAddressPool

  • Article

Get-SCStaticIPAddressPool

Gets a static IP address pool.

Syntax

Parameter Set: All
Get-SCStaticIPAddressPool [[-Name] <String> ] [-IPAddress <String> ] [-IPv4] [-IPv6] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Subnet <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ByCloud
Get-SCStaticIPAddressPool [[-Name] <String> ] -Cloud <Cloud> [-IPAddress <String> ] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Subnet <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ByHostGroup
Get-SCStaticIPAddressPool [[-Name] <String> ] -VMHostGroup <HostGroup> [-IPAddress <String> ] [-IPv4] [-IPv6] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Subnet <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ById
Get-SCStaticIPAddressPool [[-Name] <String> ] -ID <Guid> [-IPAddress <String> ] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Subnet <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ByLogicalNetworkDefinition
Get-SCStaticIPAddressPool [[-Name] <String> ] -LogicalNetworkDefinition <LogicalNetworkDefinition> [-IPAddress <String> ] [-IPv4] [-IPv6] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Subnet <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ByVMSubnet
Get-SCStaticIPAddressPool [[-Name] <String> ] -VMSubnet <VMSubnet> [-IPAddress <String> ] [-IPv4] [-IPv6] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-Subnet <String> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Get-SCStaticIPAddressPool cmdlet gets one or more Virtual Machine Manager (VMM) static IP address pools.

Parameters

-Cloud<Cloud>

Specifies a private cloud object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ID<Guid>

Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPAddress<String>

Specifies an IPv4 or IPv6 address.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv4

Indicates that an IPv4 address is needed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IPv6

Indicates that an IPv6 address is needed.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IsMulticast

Indicates that the IP address is a multicast address or that the IP address pool contains a multicast IP address range.

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?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OnBehalfOfUser<System.String>

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

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?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHostGroup<HostGroup>

Specifies a virtual machine host group object.

Aliases

none

Required?

true

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

-VMSubnet<VMSubnet>

Specifies a VM subnet object.

To obtain a VM subnet object, use the Get-SCVMSubnet cmdlet.

Aliases

none

Required?

true

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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

Example 1: Get all available IPv4 IP address pools for a specified subnet

This command gets the static IP address pool for the specified IPv4 subnet address.

PS C:\> Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24"

Example Example 2: Get all IPv4 IP address pools for a specified host group.

The first command gets the host group with the path of All Hosts\HostGroup02\Production, and then stores it in the $HostGroup variable.

The second command gets the static IPv4 IP address pools for the host group stored in $HostGroup.

PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
PS C:\> Get-SCStaticIPAddressPool -IPv4 -VMHostGroup $HostGroup

Get-SCVMHostGroup

Get-SCVMSubnet

New-SCStaticIPAddressPool

Remove-SCStaticIPAddressPool

Set-SCStaticIPAddressPool