Get-SCIPAddress
Get-SCIPAddress
Gets allocated static and virtual IP addresses.
Syntax
Parameter Set: All
Get-SCIPAddress [-All] [-Assigned] [-Duplicate] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-UnAssigned] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByAllocatedToObjectID
Get-SCIPAddress -GrantToObjectID <Guid> [-Assigned] [-Duplicate] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-UnAssigned] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByID
Get-SCIPAddress -ID <Guid> [-Assigned] [-Duplicate] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-UnAssigned] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByIPAddress
Get-SCIPAddress -IPAddress <String> [-Assigned] [-Duplicate] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-UnAssigned] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByPool
Get-SCIPAddress -StaticIPAddressPool <StaticIPAddressPool> [-Assigned] [-Duplicate] [-IsMulticast] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-UnAssigned] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCIPAddress cmdlet gets allocated static IP and virtual IP addresses.
Parameters
-All
Indicates that this cmdlet retrieves a full list of all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All
retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Assigned
Indicates that this cmdlet retrieves IP addresses or MAC addresses that have been allocated from an address pool and assigned to a resource.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Duplicate
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GrantToObjectID<Guid>
Specifies the ID of an object to which an allocated IP address or MAC address will be assigned.
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? |
true |
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 |
-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 |
-StaticIPAddressPool<StaticIPAddressPool>
Specifies an IP address pool from which you can assign static IP addresses.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-UnAssigned
Retrieves IP addresses or MAC addresses that have been allocated from an address pool but not assigned to a resource.
Aliases |
none |
Required? |
false |
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 |
<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.
- CloudDRPairingInfoData
Examples
Example Example 1: Get all allocated IP addresses for a specific IP address pool.
The first command gets the IP address pool object that has the subnet value 10.0.0.0/24, and then stores the object in the $IPAddressPool variable.
The second command returns all allocated IP addresses for the IP address pool stored in $IPAddressPool.
PS C:\> $IPAddressPool = Get-SCStaticIPAddressPool -IPv4 -Subnet "10.0.0.0/24"
PS C:\> Get-SCIPAddress -StaticIPAddressPool $IPAddressPool