Share via

Get-SCIPAddress

  • Reference
Module:
VirtualMachineManager

Gets allocated static and virtual IP addresses.

Syntax

Get-SCIPAddress
   [-VMMServer <ServerConnection>]
   [-All]
   [-UnAssigned]
   [-Assigned]
   [-IsMulticast]
   [-Duplicate]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCIPAddress
   [-VMMServer <ServerConnection>]
   -StaticIPAddressPool <StaticIPAddressPool>
   [-UnAssigned]
   [-Assigned]
   [-IsMulticast]
   [-Duplicate]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCIPAddress
   [-VMMServer <ServerConnection>]
   -ID <Guid>
   [-UnAssigned]
   [-Assigned]
   [-IsMulticast]
   [-Duplicate]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCIPAddress
   [-VMMServer <ServerConnection>]
   -GrantToObjectID <Guid>
   [-UnAssigned]
   [-Assigned]
   [-IsMulticast]
   [-Duplicate]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCIPAddress
   [-VMMServer <ServerConnection>]
   -IPAddress <String>
   [-UnAssigned]
   [-Assigned]
   [-IsMulticast]
   [-Duplicate]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCIPAddress
   [-VMMServer <ServerConnection>]
   [-PublicIPAddress]
   [-UnAssigned]
   [-Assigned]
   [-IsMulticast]
   [-Duplicate]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCIPAddress cmdlet gets allocated static IP and virtual IP addresses.

Examples

Example 1: Get all allocated IP addresses for a specific IP address pool

PS C:\> $IPAddressPool = Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24"
PS C:\> Get-SCIPAddress -StaticIPAddressPool $IPAddressPool

The first command gets the IP address pool object with the subnet of 10.0.0.0/24 and stores it in the $IPAddressPool variable.

The second command returns all allocated IP addresses for the IP address pool stored in $IPAddressPool.

Parameters

-All

Indicates that this cmdlet gets all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

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

-Assigned

Indicates that this cmdlet gets IP addresses or MAC addresses that have been allocated from an address pool and assigned to a resource.

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

-Duplicate

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

-GrantToObjectID

Specifies the ID of an object to which an allocated IP address or MAC address is assigned.

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

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

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:True
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

-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

-PublicIPAddress

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

-StaticIPAddressPool

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

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

-UnAssigned

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

-VMMServer

Specifies a Virtual Machine Manager (VMM) server object.

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

Outputs

CloudDRPairingInfoData

This cmdlet returns a CloudDRPairingInfoData object.