Get-VMConnectAccess
Gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts.
Syntax
Get-VMConnectAccess
[[-VMName] <String[]>]
[-ComputerName <String[]>]
[-UserName <String[]>]
Get-VMConnectAccess
[-VMId] <Guid[]>
[-ComputerName <String[]>]
[-UserName <String[]>]
Description
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 Virtual Machine Connection. Examples of such applications are Virtual Machine Manager.
Examples
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.
Parameters
-ComputerName
Specifies one or more virtual machine hosts on which connect access entries are being sought. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly.
Type: | String[] |
Position: | Named |
Default value: | . |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserName
Specifies the user or users for whom connect access entries are being sought, in one of the following forms:
Local User Account: john ComputerName\john
Domain User Account: CONTOSO\john Contoso.com\john
User Principal Name (UPN): john@contoso.com
Security Identifier: S-1-5-21-3165297888-301567370-576410423-1103
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMId
Specifies the unique identifier of a virtual machine for which connect access entries are being sought.
Type: | Guid[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine for which connect access entries are being sought.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Outputs
Microsoft.Virtualization.Powershell.VMConnectAce
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for