Export (0) Print
Expand All
Expand Minimize

Revoke-VMConnectAccess

Published: August 15, 2012

Updated: September 5, 2013

Applies To: Windows Server 2012

Revoke-VMConnectAccess

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

Syntax

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

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




Detailed 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.

Parameters

-ComputerName<String[]>

Specifies one or more virtual machine hosts on which access to connect to a virtual machine or machines is to be revoked. 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 is to be passed through to the pipeline for each revocation of access.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String[]>

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

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-VMId<Guid[]>

Specifies the unique identifier of a virtual machine or machines to which connect access is to be revoked.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-VMName<String[]>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

true

<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.Virtualization.Powershell.VMConnectAce if –PassThru is specified.


Examples

Example 1

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


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

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