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.

Examples

Example 1

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

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

Required Parameters

-UserName

Specifies a user or users to whom access to connect to a virtual machine or machines is to be granted.

Type:

String[]

Aliases:

UserId, Sid

Position:

1

Default value:

None

Accept pipeline input:

True (ByPropertyName)

Accept wildcard characters:

False

-VMId

Specifies the unique identifier of a virtual machine to which connect access is to be granted.

Type:

Guid[]

Position:

0

Default value:

None

Accept pipeline input:

True (ByPropertyName, ByValue)

Accept wildcard characters:

False

-VMName

Specifies the name of a virtual machine to which connect access is to be granted.

Type:

String[]

Position:

0

Default value:

None

Accept pipeline input:

True (ByValue)

Accept wildcard characters:

False

Optional Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer.
Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet.
The default is the current session on the local computer.

Type:

CimSession[]

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

-ComputerName

Specifies one or more Hyper-v hosts which run this cmdlet.
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:

None

Accept pipeline input:

False

Accept wildcard characters:

False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:

SwitchParameter

Aliases:

cf

Position:

Named

Default value:

False

Accept pipeline input:

False

Accept wildcard characters:

False

-Credential

Specifies one or more user accounts that have permission to perform this action.
The default is the current user.

Type:

PSCredential[]

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

-Passthru

Indicates that this cmdlet returns a Microsoft.HyperV.PowerShell.VMConnectAce object.
By default, this cmdlet does not return any output.

Type:

SwitchParameter

Position:

Named

Default value:

None

Accept pipeline input:

False

Accept wildcard characters:

False

-WhatIf

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

Type:

SwitchParameter

Aliases:

wi

Position:

Named

Default value:

False

Accept pipeline input:

False

Accept wildcard characters:

False

Outputs

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

Feedback

We'd love to hear your thoughts. Choose the type you'd like to provide: