Revoke-VMConnectAccess

Module:

Hyper-V

Revokes access for one or more users to connect to a one or more virtual machines.

Syntax

Revoke-VMConnectAccess
      [-UserName] <String[]>
      [-Passthru]
      [-VMName] <String[]>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Revoke-VMConnectAccess
      [-UserName] <String[]>
      [-Passthru]
      [-VMId] <Guid[]>
      [-CimSession <CimSession[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Revoke-VMConnectAccess cmdlet revokes access for one or more users to connect to one or more virtual machines. 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:\> Revoke-VMConnectAccess -VMName VM1 -UserName Contoso\John

This command revokes the access of user Contoso\John to connect to virtual machine VM1.

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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ComputerName

Specifies one or more Hyper-V hosts on which this cmdlet operates. 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
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

-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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Passthru

Specifies that a VMConnectAce is to be passed through to the pipeline for each revocation of access.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserName

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

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 or machines to which connect access is to be revoked.

Type:	Guid[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Specifies the name or names of the virtual machine or machines to which access is being revoked.

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

Default

Microsoft.HyperV.PowerShell.VMConnectAce

If -PassThru is specified.