N-central Help

Grant Connect Access

Grants access to a user or users to connect to a virtual machine or machines. Intended for use in providing other applications with the appropriate permissions required to initiate a session with Virtual Machine Connection. An example of such an application is Virtual Machine Manager.

Input Parameters

Name Type Required Description
VM Name String Yes Specifies the name of a virtual machine to which connect access is to be granted.
User Name String Yes Specifies a user or users to whom access to connect to a virtual machine or machines is to be granted.

Output Parameters

Name Type Description
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
VM Name String Yes Guest001
Resource Pool Type String Yes

User name must be in the form of:

  • Local User Account: john or ComputerName\john
  • Domain User Account: CONTOSO\john or Contoso.com\john
  • User Principal Name (UPN): john@contoso.com
  • Security Identifier: S-1-5-21-3165297888-301567370-576410423-1103