Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-VMConnectAccess

Windows Server 2012 R2 and Windows 8.1

Updated: March 3, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-VMConnectAccess

Gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts.

Syntax

Parameter Set: VMName
Get-VMConnectAccess [[-VMName] <String[]> ] [-ComputerName <String[]> ] [-UserName <String[]> ] [ <CommonParameters>]

Parameter Set: VMId
Get-VMConnectAccess [-VMId] <Guid[]> [-ComputerName <String[]> ] [-UserName <String[]> ] [ <CommonParameters>]

Parameter Set: VMObject
Get-VMConnectAccess [-VM] <VirtualMachine[]> [-ComputerName <String[]> ] [-UserName <String[]> ] [ <CommonParameters>]




Detailed 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 the Virtual Machine Connection protocol. Examples of such applications are Virtual Machine Manager.

Parameters

-ComputerName<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String[]>

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


Aliases

UserId,Sid

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

Specifies an array of virtual machine objects. The cmdlet gets the connect access entries for the virtual machines that you specify. To obtain a virtual machine object, use the Get-VM cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMId<Guid[]>

Specifies the unique identifier of a virtual machine for which connect access entries are being sought.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-VMName<String[]>

Specifies the name of the virtual machine for which connect access entries are being sought.


Aliases

none

Required?

false

Position?

1

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.

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.

  • Microsoft.HyperV.PowerShell.VMConnectAce

Examples

Example 1

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.


PS C:\> Get-VMConnectAccess

Example 2

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.


PS C:\> Get-VMConnectAccess –VMName VM1

Example 3

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.


PS C:\> Get-VMConnectAccess –UserName CONTOSO\John

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.