This is the built-in help made by Microsoft for the command 'Get-VMConnectAccess', in PowerShell version 5 - as retrieved from
Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts.
Get-VMConnectAccess [[-VMName] <String[]>] [-ComputerName <String[]>] [-UserName <String[]>] [<CommonParameters>]
Get-VMConnectAccess [-VM] <VirtualMachine[]> [-ComputerName <String[]>] [-UserName <String[]>] [<CommonParameters>]
Get-VMConnectAccess [-VMId] <Guid[]> [-ComputerName <String[]>] [-UserName <String[]>] [<CommonParameters>]
The Get-VMConnectAccess cmdlet gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts. This cmdlet is intended for use in
providing other applications with the appropriate permissions required to initiate a session with the Virtual Machine Connection protocol. Examples of such applications are
Virtual Machine Manager.
<
Online Version: http://go.microsoft.com/fwlink/?LinkID=306848
<
Example 1
PS C:\> Get-VMConnectAccess
This command gets a list of all the users who have access to connect to any virtual machine on the local computer. The example assumes that the Grant-VMConnectAccess has
been run previously for at least one user account.
Example 2
PS C:\> Get-VMConnectAccess –VMName VM1
This command gets a list of all the users who have access to connect to virtual machine VM1. The example assumes that the Grant-VMConnectAccess has been run previously for
at least one user account for virtual machine VM1.
Example 3
PS C:\> Get-VMConnectAccess –UserName CONTOSO\John
This command gets a list of all the virtual machines on the local computer that user Contoso\John has access to connect to. The example assumes that the
Grant-VMConnectAccess has been run previously to grant access to Contoso\John.