Share via

Get-SCStaticIPAddressPool

  • Reference
Module:
VirtualMachineManager

Gets static IP address pools.

Syntax

Get-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-IPAddress <String>]
   [-IPv4]
   [-IPv6]
   [[-Name] <String>]
   [-IsMulticast]
   [-Subnet <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-IPAddress <String>]
   [-IPv4]
   [-IPv6]
   -VMSubnet <VMSubnet>
   [[-Name] <String>]
   [-IsMulticast]
   [-Subnet <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-IPAddress <String>]
   [-IPv4]
   [-IPv6]
   [[-Name] <String>]
   [-IsMulticast]
   [-Subnet <String>]
   -VMHostGroup <HostGroup>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-IPAddress <String>]
   [-IPv4]
   [-IPv6]
   -LogicalNetworkDefinition <LogicalNetworkDefinition>
   [[-Name] <String>]
   [-IsMulticast]
   [-Subnet <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-IPAddress <String>]
   [[-Name] <String>]
   [-IsMulticast]
   [-Subnet <String>]
   -Cloud <Cloud>
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCStaticIPAddressPool
   [-VMMServer <ServerConnection>]
   [-IPAddress <String>]
   [[-Name] <String>]
   [-IsMulticast]
   [-Subnet <String>]
   -ID <Guid>
   [-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.

Type:Cloud
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ID

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

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IPAddress

Specifies an IPv4 or IPv6 address.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IPv4

Indicates that an IPv4 address is needed.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IPv6

Indicates that an IPv6 address is needed.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:LogicalNetworkDefinition
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUser

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:UserRole
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMHostGroup

Specifies a virtual machine host group object.

Type:HostGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMSubnet

Specifies a virtual machine subnet.

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

Type:VMSubnet
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

StaticIPAddressPool

This cmdlet returns a StaticIPAddressPool object.