Export (0) Print
Expand All
Expand Minimize

Grant-VMConnectAccess

Windows Server 2012 R2 and Windows 8.1

Updated: June 10, 2014

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

Grant-VMConnectAccess

Grants a user or users access to connect to a virtual machine or machines.

Syntax

Parameter Set: VMName
Grant-VMConnectAccess [-VMName] <String[]> [-UserName] <String[]> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMId
Grant-VMConnectAccess [-VMId] <Guid[]> [-UserName] <String[]> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Grant-VMConnectAccess [-VM] <VirtualMachine[]> [-UserName] <String[]> [-ComputerName <String[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Grant-VMConnectAccess cmdlet grants access to a user or users to connect to a virtual machine or machines. The 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.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which access to connect to a virtual machine is to be granted. 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

-Passthru

Specifies that a VMConnectAce object is to be passed through to the pipeline representing each grant of access.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String[]>

Specifies a user or users to whom access to connect to a virtual machine or machines is to be granted, 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?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

Specifies an array of virtual machine objects. The cmdlet grants users access to connect to 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 to which connect access is to be granted.


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 a virtual machine to which connect access is to be granted.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

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.

  • None by default; Microsoft.HyperV.PowerShell.VMConnectAce if –PassThru is specified.


Examples

Example 1

This command grants user Contoso\John access to connect to a virtual machine named VM1.


PS C:\> Grant-VMConnectAccess –VMName VM1 –UserName Contoso\John

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft