VRA LOGIN Commands


DescriptionCommand
Login to the vRA Server via OAuth2 Authorization Code flow     vra login authzcode
Login to ODATA IaaS Service with NTLM credentials     vra login iaas
Displays detailed information about current login and persistent session (if being used).     vra login isauthenticated all
Check to see if vRA Catalog Services have been authenticated     vra login isauthenticated catalog
Check to see if vRA IaaS Services have been authenticated     vra login isauthenticated iaas
Login to the vRA Server with username and keyfile     vra login keyfile
Login to the vRA Server using a refresh token     vra login refreshtoken
Login to the vRA Server with username and password     vra login userpass


Login to the vRA Server via OAuth2 Authorization Code flow

vra login authzcode

Parameter--server (Server Name. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--tenant (Tenant (Organisation Name) default is vsphere.local)
Mandatoryfalse

Parameter--oauth2clientid (OAuth2 Client identifier. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--oauth2clientsecret (OAuth2 Client secret. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--port (Redirect url port number. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--iaasUser (vRA IaaS User)
Mandatoryfalse

Parameter--iaasPassword (vRA IaaS Password. Use --promptForIaasCreds to enter securely)
Mandatoryfalse

Parameter--promptForIaasCreds (Prompt to enter IaaS credentials securely [Yes or No]. NOTE: IaaS credentials not needed for most commands.)
Mandatoryfalse

Parameter--iaasServer (vRA IaaS Server, if left empty dynamically find it from vCAC)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Login to ODATA IaaS Service with NTLM credentials

vra login iaas

Parameter--server (Enter IaaS Server Name)
Mandatorytrue

Parameter--domain (Enter Windows Domain, default is local server name)
Mandatoryfalse

Parameter--user (Enter User Name)
Mandatorytrue

Parameter--password (Enter Password)
Mandatoryfalse

Parameter--keyfile (Provide the encrypted keyfile for iaas password)
Mandatoryfalse


Displays detailed information about current login and persistent session (if being used).

vra login isauthenticated all

Parameter--export (Provide a file to export all results)
Mandatoryfalse


Check to see if vRA Catalog Services have been authenticated

vra login isauthenticated catalog

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Check to see if vRA IaaS Services have been authenticated

vra login isauthenticated iaas

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Login to the vRA Server with username and keyfile

vra login keyfile

Parameter--server (Server Name)
Mandatoryfalse

Parameter--tenant (Tenant (Organisation Name) default is vsphere.local)
Mandatoryfalse

Parameter--user (User)
Mandatoryfalse

Parameter--keyfile (Provide the encrypted keyfile for password)
Mandatorytrue

Parameter--iaasServer (vRA IaaS Server, if left empty dynamically will find it from vCAC)
Mandatoryfalse

Parameter--iaasUser (vRA IaaS User)
Mandatoryfalse

Parameter--iaasKeyfile (Provide the encrypted keyfile for iaas password)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Login to the vRA Server using a refresh token

vra login refreshtoken

Parameter--server (Server Name. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--tenant (Tenant (Organisation Name) default is vsphere.local)
Mandatoryfalse

Parameter--oauth2clientid (OAuth2 Client identifier. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--oauth2clientsecret (OAuth2 Client secret. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--refreshtoken (OAuth2 refresh token. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--iaasUser (vRA IaaS User)
Mandatoryfalse

Parameter--iaasPassword (vRA IaaS Password. Use --promptForIaasCreds to enter securely)
Mandatoryfalse

Parameter--promptForIaasCreds (Prompt to enter IaaS credentials securely [Yes or No]. NOTE: IaaS credentials not needed for most commands.)
Mandatoryfalse

Parameter--iaasServer (vRA IaaS Server, if left empty dynamically find it from vCAC)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Login to the vRA Server with username and password

vra login userpass

Parameter--server (Server Name. If unspecified, you will be prompted to enter it.)
Mandatoryfalse

Parameter--tenant (Tenant (Organisation Name) default is vsphere.local)
Mandatoryfalse

Parameter--user (Username, including the full domain (user@org.company.com). Using domain aliases are not currently supported. If left unspecified, you will be prompted to enter it securely)
Mandatoryfalse

Parameter--password (Cleartext CAFE password. If left unspecified, you will be prompted to enter it securely)
Mandatoryfalse

Parameter--iaasUser (vRA IaaS User)
Mandatoryfalse

Parameter--iaasPassword (vRA IaaS Password. Use --promptForIaasCreds to enter securely)
Mandatoryfalse

Parameter--promptForIaasCreds (Prompt to enter IaaS credentials securely [Yes or No]. NOTE: IaaS credentials not needed for most commands.)
Mandatoryfalse

Parameter--iaasServer (vRA IaaS Server, if left empty dynamically find it from vCAC)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Copyright 2016 VMware, Inc. All rights reserved.