Share via


Get-SCStaticIPAddressPool

Gets static IP address pools.

Syntax

All (Default)

Get-SCStaticIPAddressPool
    [[-Name] <String>]
    [-VMMServer <ServerConnection>]
    [-IPAddress <String>]
    [-IPv4]
    [-IPv6]
    [-IsMulticast]
    [-Subnet <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByVMSubnet

Get-SCStaticIPAddressPool
    [[-Name] <String>]
    -VMSubnet <VMSubnet>
    [-VMMServer <ServerConnection>]
    [-IPAddress <String>]
    [-IPv4]
    [-IPv6]
    [-IsMulticast]
    [-Subnet <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByHostGroup

Get-SCStaticIPAddressPool
    [[-Name] <String>]
    -VMHostGroup <HostGroup>
    [-VMMServer <ServerConnection>]
    [-IPAddress <String>]
    [-IPv4]
    [-IPv6]
    [-IsMulticast]
    [-Subnet <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByLogicalNetworkDefinition

Get-SCStaticIPAddressPool
    [[-Name] <String>]
    -LogicalNetworkDefinition <LogicalNetworkDefinition>
    [-VMMServer <ServerConnection>]
    [-IPAddress <String>]
    [-IPv4]
    [-IPv6]
    [-IsMulticast]
    [-Subnet <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByCloud

Get-SCStaticIPAddressPool
    [[-Name] <String>]
    -Cloud <Cloud>
    [-VMMServer <ServerConnection>]
    [-IPAddress <String>]
    [-IsMulticast]
    [-Subnet <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ById

Get-SCStaticIPAddressPool
    [[-Name] <String>]
    -ID <Guid>
    [-VMMServer <ServerConnection>]
    [-IPAddress <String>]
    [-IsMulticast]
    [-Subnet <String>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

Description

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

Examples

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

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

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

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

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

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

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

Parameters

-Cloud

Specifies a private cloud object in which this cmdlet gets address pools.

Parameter properties

Type:Cloud
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByCloud
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ID

Specifies the unique ID for an address pool that this cmdlet gets.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ById
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPAddress

Specifies an IPv4 or IPv6 address.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv4

Indicates that an IPv4 address is needed.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

All
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByVMSubnet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByHostGroup
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByLogicalNetworkDefinition
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IPv6

Indicates that an IPv6 address is needed.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

All
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByVMSubnet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByHostGroup
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByLogicalNetworkDefinition
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsMulticast

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogicalNetworkDefinition

Specifies a logical network definition that contains the subnet that the IP address pool serves as specified by the Subnet parameter. A logical network definition is also referred to as a network site.

Parameter properties

Type:LogicalNetworkDefinition
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByLogicalNetworkDefinition
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the address pool that this cmdlet gets.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnBehalfOfUser

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UserRole
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Subnet

Specifies an IP subnet in Classless Inter-Domain Routing (CIDR) notation. You can specify either IPv4 or IPv6 addresses.

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMHostGroup

Specifies a virtual machine host group object.

Parameter properties

Type:HostGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByHostGroup
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:ServerConnection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMSubnet

Specifies a virtual machine subnet.

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

Parameter properties

Type:VMSubnet
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByVMSubnet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

StaticIPAddressPool

This cmdlet returns a StaticIPAddressPool object.