Connecting to the vRA CloudClient 4.1

The vRealize Automation (vRA) CloudClient is a vRA command line utility that allows users to perform various vRA and vRealize Orchestrator (vRO) administrative tasks. The CloudClient is most often used to export and import blueprint content. For example, via the CloudClient users can export a blueprint in YAML format for editing simplifying the sharing of standardized application builds across an organization.

In order to connect to the CloudClient follow the below instructions.

NOTE: These instructions are for the CloudClient 4.1. The command for login in to vRA via CloudClient 4.3 is different.

I. Download and extract the CloudClient directory form here

II. Open an CLI (terminal, CMD, PowerShell etc) and navigate to the CloudClient directory you just extracted

III. Run the cloudclient.bat (Windows), cloudclient.sh (Linux/Mac) located inside of the bin folder

IV. Once you see the CloudClient logo use the below command to login to your vRA Instance

• vra login userpass –user USERNAME –tenant TENANT –server VRA-APPLIANCE-URL –password PASSOWRD

• NOTE: The dashes above are really double dashes. Good ole html.

For your convenience, I’ve included a list of CloudClient commands as of CloudClient4.1

* ! – Allows execution of operating system (OS) commands

* // – Inline comment markers (start of line only)

* ; – Inline comment markers (start of line only)

* clear – Clears the console

* cls – Clears the console

* date – Displays the local date and time

* exit – Exits the shell

* help – List all commands usage

* login autologinfile – Generate AutoLogin file – CloudClient.properties

* login keyfile – Generate Key to secure credentials

* quit – Exits the shell

* script – Parses the specified resource file and executes its commands

* srm protected vra vms register – Register new host / host reservation for vra vms protected by specifed srm protection plan

* srm protected vra vms start datacollection – start datacollection on the vra hosts for srm protection plan

* srm protected vra vms stop datacollection – stop datacollection on the vra hosts for srm protection plan

* srm test connection – Test connection to the given SRM server

* srm vra failover machine – Register machine into the vRA Inventory

* system properties – Shows the shell’s properties

* vco login isauthenticated – Check VCO authentication

* vco login keyfile – Login to VCO with Username and Keyfile

* vco login userpass – Login to VCO with Username and Password

* vco workflow detail – Get details about a workflow

* vco workflow http get – VCO Http GET Request

* vco workflow list – List all workflows

* vco workflow request – Start a Workflow

* version – Displays shell version

* vra approvalpolicy add – Add Approval Policy

* vra approvalpolicy detail – Get Approval Policy Details

* vra approvalpolicy list – List Approval Policies

* vra approvalpolicy remove – Remove Approval Policy

* vra asd import – Import Advanced Service Items from a zip file

* vra asd validate – Validate Advanced Service Items from a zip file

* vra blueprint add vsphere – Add VSphere Infrastucture Blueprint & Catalog Item

* vra blueprint detail – Get vSphere Blueprint

* vra blueprint list – List Blueprints

* vra blueprint remove – Delete vSphere Blueprint

* vra blueprint vsphere importalltemplates – Import All vSphere templates into Blueprints

* vra businessgroup add – Add Business Groups

* vra businessgroup detail – Get Business Group Detail

* vra businessgroup list – List Business Groups

* vra businessgroup remove – Remove Business Group

* vra businessgroup update – Update Business Group

* vra catalog detail – CatalogItem Details

* vra catalogitem icon assign – Assign Icon to CatalogItem

* vra catalogitem service assign – Assign Service to CatalogItem

* vra catalogitem unassigned detail – Unassigned catalogitem details

* vra catalogitem unassigned list – List unassigned catalog items

* vra catalog list – List CatalogItems optionally filtered by type.

* vra catalog request generate template – Generate a catalog request template in the form of a JSON file

* vra catalog request submit – Make a new Request from a given CatalogItem

* vra componentregistry endpoint list – List Component Registry Endpoints

* vra componentregistry endpoint update – Update Component Registry Endpoint Url

* vra componentregistry service list – List of available services from the component registry

* vra computeresource datacollection start – Start datacollection on the specified cluster

* vra computeresource datacollection stop – Stop datacollection on the specified cluster

* vra computeresource inactive list – Lists all compute resources (aka: hosts) that have no active reservations against them

* vra computeresource inactive remove – Removes compute resources (aka: hosts) that have no active reservations against them

* vra computeresource list – List Compute Resources

* vra content detail – Content details

* vra content export – Exports content as a zip file using an internal identifier or a combination of public content id and type

* vra content import – Import content(s) from a zip file

* vra content list – List all content

* vra content simple export – Export content without dependencies using an internal identifier or a combination of public content id and type

* vra content simple import – Import single content file. NOTE: This only supports non zip files like *.yaml

* vra credential add – Create a new set of credentials

* vra credential delete – Delete IaaS credentials

* vra credential list – List credentials

* vra credential update – Update IaaS credentials

* vra deployment action execute – Perform action on a Deployment

* vra deployment action form – Get the action form

* vra deployment action list – Get the list of the actions for a specified Deployment

* vra deployment component list – Lists the components of a deployment.

* vra deployment detail – Deployment Details

* vra deployment list – List Deployments

* vra emailserver inbound add – Add new Inbound Email Provider

* vra emailserver list – Add new Inbound list

* vra emailserver outbound add – Add new Outbound Email Provider

* vra emailserver remove – Remove Email Provider

* vra endpoint add vcloud – Add vCloud endpoint

* vra endpoint add vsphere – Add vsphere endpoint

* vra endpoint datacollection start – Start datacollection on the specified endpoint

* vra endpoint detail – Get endpoints detail

* vra endpoint list – List endpoints optionally filtered by type

* vra endpoint remove – Remove endpoint

* vra endpoint update – Update endpoint

* vra entitlement action assign – Add Entitlement Action

* vra entitlement action assignall – Add All Operation to Entitlement

* vra entitlement action list – List Entitlement Actions

* vra entitlement add – Add new Entitlement

* vra entitlement catalogitem assign – Assign Catalog Item

* vra entitlement detail – Entitlement Details

* vra entitlement list – List Entitlements

* vra entitlement principal assign – Add Entitlement Principal

* vra entitlement service assign – Assign Entitlement Service

* vra entitlement update – Update Entitlement

* vra fabricgroup add – Add Fabric Groups

* vra fabricgroup detail – Get Fabric Group Detail

* vra fabricgroup list – List Fabric Groups

* vra fabricgroup remove – Remove Fabric Group

* vra fabricgroup update – Update Fabric Group

* vra iaas machinetemplate list – List Machine Templates

* vra iaas networkprofile detail – Gets the Network Profile detail.

* vra iaas networkprofile list – Lists all the Network Profiles

* vra login iaas – Login to ODATA IaaS Service with NTLM credentials

* vra login isauthenticated all – Displays detailed information about current login and persistent session (if being used).

* vra login isauthenticated catalog – Check to see if vRA Catalog Services have been authenticated

* vra login isauthenticated iaas – Check to see if vRA IaaS Services have been authenticated

* vra login keyfile – Login to the vRA Server with username and keyfile

* vra login userpass – Login to the vRA Server  with username and password

* vra logout – Logout and optionally delete the persistent session if being used currently.

* vra logs recentevents – List IaaS User Logs

* vra machineprefix add – Create Machine Prefix

* vra machineprefix list – List Machine Prefixes

* vra machineprefix remove – Remove Machine Prefix

* vra machineprefix update – Create Machine Prefix

* vra machines action execute – Perform action on a machine (Actions on snapshots i.e. Create/Revert/Delete should be executed with a gap of few minutes between two consecutive actions to allow completion of previous action)

* vra machines action form – Get the action form

* vra machines action list – Get the list of the actions for a specified Machine

* vra machines change reservation – Change the reservation of a provisioned item.

* vra machines detail – Cloud Machine Details

* vra machines forceunregister – Unregisters an existing machine from vRA management/inventory (but doesn’t destroy the machine on the vSphere endpoint)

* vra machines list – List Machines

* vra machines unmanaged list – List all Unmanaged Machines (not in the vRA Inventory)

* vra machines unmanaged register – Register machine into the vRA Inventory

* vra package content add – Add content to package

* vra package content list – List content for a given package

* vra package content remove – Remove content from a package

* vra package create – Create a new package

* vra package delete – Delete existing package

* vra package detail – Package details

* vra package export – Export an existing package of contents

* vra package list – List all package

* vra package update – Update an existing package

* vra provisioningworkflows list – List Blueprint Provisioning Workflows

* vra request approve – Approve Requests

* vra request detail – Request Details

* vra request list – List Requests

* vra request reject – Reject Requests

* vra reservation add – Add a new reservation.

* vra reservation detail – Reservation details

* vra reservation field values – Get the permissible values for a reservation schema field

* vra reservation generate template – Create a reservation request template with all permissible values for the requested reservation type

* vra reservation list – List all reservations

* vra reservation policy add – Add a new reservation policy

* vra reservation policy detail – Reservation policy details

* vra reservation policy list – List all reservation policies

* vra reservation policy remove – Remove an existing reservation policy

* vra reservation policy update – Update an existing reservation policy

* vra reservation remove – Remove an existing reservation.

* vra reservation schema – Get the reservation schema for the requested reservation type and save it to a file in json format.

* vra reservation update – Update an existing reservation

* vra rest delete – Invoke a DELETE http request

* vra rest get – Invoke a GET http request

* vra rest post – Invoke a POST http request

* vra rest put – Invoke a PUT http request

* vra service add – Add new Service

* vra service list – List Services

* vra service remove – Remove Service

* vra tenant add – Add New Tenant

* vra tenant admin list – List Tenant/Infrastructure Admins

* vra tenant admin update – Update Tenant/Infrastructure Admins

* vra tenant identitystore add – Add New Tenant Identity store

* vra tenant identitystore list – List Tenant Identity store

* vra tenant identitystore remove – Remove Tenant Identity store

* vra tenant list – List Tenants

* vra tenant remove – vra tenant remove

* vra version – Returns version of vRA