Grant-VMConnectAccess
Grants a user or users access to connect to a virtual machine or machines.
Syntax
Grant-VMConnectAccess
[-VMName] <String[]>
[-UserName] <String[]>
[-Passthru]
[-ComputerName <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Grant-VMConnectAccess
[-VMId] <Guid[]>
[-UserName] <String[]>
[-Passthru]
[-ComputerName <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Parameters
-ComputerName
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.
Type: | String[] |
Position: | Named |
Default value: | . |
Required: | False |
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 |
Required: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserName
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
Type: | String[] |
Aliases: | UserId, Sid |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | True |
Accept pipeline input: | True |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
None by default; Microsoft.HyperV.PowerShell.VMConnectAce if -PassThru is specified.