Revoke-SCMACAddress
Revoke-SCMACAddress
Returns an allocated MAC address to the MAC address pool.
Syntax
Parameter Set: Default
Revoke-SCMACAddress [-AllocatedMACAddress] <AllocatedMACAddress> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-ReturnToPool <Boolean]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Revoke-SCMACAddress cmdlet returns an allocated MAC address to the MAC address pool.
For information about granting MAC addresses, type Get-Help Grant-SCMACAddress -detailed.
Parameters
-AllocatedMACAddress<AllocatedMACAddress>
Specifies a Media Access Control (MAC) address that has been allocated from a MAC address pool.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ReturnToPool<Boolean]>
Indicates whether an IP address or MAC address is returned to its address pool. By default, this value is set to True.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
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.
- CloudPairing[]
Examples
Example 1: Return an allocated MAC address to the MAC address pool
The first command gets the host group object at path All Hosts\HostGroup02\Production, and then stores the object in the $HostGroup variable.
The second command gets the MAC address pools for the host group stored in $HostGroup, and then stores the objects in the $MACAddressPool array.
The third command gets the allocated MAC addresses from the first MAC address pool stored in $MACAddressPool, and then stores the objects in $MACAddress.
The last command revokes the first MAC address stored in $MACAddress.
PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
PS C:\> $MACAddressPool = Get-SCMACAddressPool -VMHostGroup $HostGroup
PS C:\> $MACAddress = Get-SCMACAddress -MACAddressPool $MACAddressPool[0]
PS C:\> Revoke-SCMACAddress $MACAddress[0]