Share via


Get-SCIPAddress

Gets allocated static and virtual IP addresses.

Syntax

All (Default)

Get-SCIPAddress
    [-VMMServer <ServerConnection>]
    [-All]
    [-UnAssigned]
    [-Assigned]
    [-IsMulticast]
    [-Duplicate]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByPool

Get-SCIPAddress
    -StaticIPAddressPool <StaticIPAddressPool>
    [-VMMServer <ServerConnection>]
    [-UnAssigned]
    [-Assigned]
    [-IsMulticast]
    [-Duplicate]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByID

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

ByAllocatedToObjectID

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

ByIPAddress

Get-SCIPAddress
    -IPAddress <String>
    [-VMMServer <ServerConnection>]
    [-UnAssigned]
    [-Assigned]
    [-IsMulticast]
    [-Duplicate]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

PublicIPAddress

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.

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

-Assigned

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

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

-Duplicate

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

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

-GrantToObjectID

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

Parameter properties

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

Parameter sets

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

-ID

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

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

ByIPAddress
Position:Named
Mandatory:True
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

-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

-PublicIPAddress

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

Parameter properties

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

Parameter sets

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

-StaticIPAddressPool

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

Parameter properties

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

Parameter sets

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

-UnAssigned

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

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

-VMMServer

Specifies a Virtual Machine Manager (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

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

CloudDRPairingInfoData

This cmdlet returns a CloudDRPairingInfoData object.