Get-HypVMMacAddress
Retrieves a list the MAC addresses for the VMs in the specified connection.
Syntax
Get-HypVMMacAddress
[-LiteralPath] <String>
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Use this command to obtain a list of MAC addresses of all the virtual machines in the specified connection.
Examples
EXAMPLE 1
This command gets the MAC addresses for the connection called "MyConnection".
Get-HypVMMacAddress -LiteralPath XDHyp:\Connections\MyConnection
MacAddress VMId
---------- ----
52:b0:1c:ed:60:fa f3395d2a-a196-41c2-e37d-764acf871599
62:6f:f0:40:d5:af 5f4457b0-cc3c-f806-8ca7-5f57e4bdf2d1
4e:a5:9f:00:b2:0c 3115177b-85a9-d8ee-d0f9-0c7437483c09
EXAMPLE 2
This command gets the MAC addresses for the connection at the current directory. The dot (.) represents the current location (not its contents).
XDHyp:\Connections\MyConnection>Get-HypVMMacAddress -Path .
MacAddress VMId
---------- ----
52:b0:1c:ed:60:fa f3395d2a-a196-41c2-e37d-764acf871599
62:6f:f0:40:d5:af 5f4457b0-cc3c-f806-8ca7-5f57e4bdf2d1
4e:a5:9f:00:b2:0c 3115177b-85a9-d8ee-d0f9-0c7437483c09
EXAMPLE 3
This command gets the MAC addresses for the connection that has a ConnectionUid of 268c66db-9b8c-47f6-9265-42326dbff006.
Get-HypVMMacAddress -LiteralPath Xdhyp:\connections\"{268c66db-9b8c-47f6-9265-42326dbff006}"
Parameters
-LiteralPath
The path to a connection item in the hosting provider. Paths to anything other than a connection item will result in an error being returned. The path can be provided as either
\<drive\>:\connections\\\<Connection Name\>
or \<drive:\>\connections\{\<Connection Uid\>}
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
You can pipe a string that contains a path to Get-HypConfigurationDataForItem
Outputs
Citrix.Host.Sdk.HypervisorVMObject
Get-HypVMMacAddress returns an object containing the following properties.
MacAddress \<string\> - specifies the MAC address of the VM. VMId \<string\> - specifies the identifier for the VM as defined in the hypervisor hosting it.
Notes
The path must refer to a connection item. Hosting unit items are not valid.
In the case of failure, the following errors can result.
Error Codes
InputConnectionsPathInvalid
If the path is not provided in an expected format, an InputConnectionsPathInvalid error results.
HypervisorConnectionObjectNotFound
The hypervisor connection object specified cannot be found.
HypervisorInMaintenanceMode
The hypervisor for the connection is in maintenance mode.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for
various reasons.
CommunicationError
An error occurred while communicating with the service.
InvalidFilter
A filtering expression was supplied that could not be interpreted for this cmdlet.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.