vRealize CloudClient

vRealize CloudClient is a command-line utility that provides verb-based access with a unified interface across vRealize Automation APIs.

Use Case Highlights

  • Browse the catalog and submit a request
  • Approve a catalog request
  • Manage provisioned machines
  • Create tenants and groups
  • Configure IaaS, including endpoints, data collection, and reservations
  • Manage catalog services and entitlements
  • Import and export blueprints and other content to human-readable format
  • Submit authenticated vRealize Automation API calls from the command line
  • Automate updates to VM reservations following SRM failover
  • Execute vRealize Orchestrator workflows

Features and Benefits

  • Standardized command-line interface that remains stable as underlying APIs evolve
  • Auto login for scripting (password and keyfiles)
  • JSON, CSV, and tabular formatting
  • File export
  • Sample scripts to demonstrate common scenarios
  • Plugin model enables extensibility to additional use cases

What's New in 4.4

vRealize CloudClient 4.4 introduces the following enhancements:

  • The vra deployment action execute command now supports scale in and scale out for deployments.
  • The vra service add and vra service update commands have a new --owner parameter that enables you to add or update owners for a service.
  • If the tenant parameter is not provided in the vra login userpass command, you are prompted for the tenant.
  • The vra businessgroup update command has two new parameters, --addsharedaccessusers and --removesharedaccessusers, that enable you to assign or unassign users to the Shared Access User Role for the business group.
  • With the release of vRealize Automation version 7.3, the endpoint configuration commands have been updated.
  • In addition, several documentation and usability enhancements have been made.

For additional details, refer to the release notes.

What Was New in 4.3

vRealize CloudClient 4.3 introduces the following enhancements:

  • The vra entitlement principal assign command has a new --allUsers parameter that enables you to assign all users and groups belonging to business group as principals to an entitlement (requires vRealize Automation 7.2).
  • The new vra entitlement remove command enables you to delete unwanted entitlements (requires vRealize Automation 7.2).
  • The new vra catalogitem service unassign enables you to remove a service from a catalog item.
  • CloudClient's truststore password can now be set by the user. As a result of this update, users may be prompted to accept certificates that were previously accepted in earlier versions of CloudClient. 
  • CloudClient 4.3 runs on Java version 1.8. Java 1.7 is no longer supported.

What Was New in 4.2

vRealize CloudClient 4.2 introduces the following enhancements:

  • The vra login commands now take an optional port number as part of the --server parameter. 
  • Keyfile-based authentication is supported for IaaS login.
  • A new vco logout command has been introduced to close active vRealize Orchestrator sessions.
  • Two new options have been added to the cloudclient.config file to disable auto-completion when CloudClient is used for scripting, and to bypass certificate checks the first time CloudClient communicates with a server.
  • New vra icon commands are available to manage the catalog icons. System administrators can use these commands to update the default system icons (requires vRealize Automation 7.1 or later).
  • Disaster recovery scenarios with Site Recovery Manager for machines provisioned through XaaS are supported through CloudClient (requires vRealize Automation 7.1 or later).

What Was New in 4.1

vRealize CloudClient 4.1 introduces the following enhancements:

  • The vra catalog request submit command supports the --leasedays option.
  • Machine provisioning and reconfigure requests validate that specified memory MB values are divisible by 4.
  • CloudClient supports Delete Snapshot and Revert Snapshot operations.
  • CloudClient documentation provides comprehensive information about valid values for command parameters.
  • CloudClient handles session expiration gracefully. vRealize Automation sessions expire on the server side rather than on the CloudClient side. If you launch CloudClient after a session expires, CloudClient automatically attempts to log in using the credentials found in CloudClient.properties or environment variables.
  • Log in procedure requires CloudClient to accept the vRealize Automation appliance and IaaS certificates. When you use CloudClient to log in to vRealize Automation for the first time, you are prompted to accept the relevant certificates.

What Was New in 4.0

vRealize CloudClient 4.0 introduced the following enhancements:

  • Support for importing and exporting blueprints, software components, property groups, property definitions, and XaaS (formerly Advanced Service Designer) content
  • Updates to CloudClient commands for compatibility with vRealize Automation 7.0
  • Contextual auto-completion of command options
  • New commands for making authenticated vRealize Automation API calls from the command line
  • Support for removing a machine from management by vRealize Automation and removing inactive compute resources
  • Support for Site Recovery Manager 6


For information about CloudClient compatibility with VMware products, refer to the VMware Product Interoperability Matrix.


By downloading, installing or using the software you agree to be bound by the terms of Broadcom's Software Development Kit License Agreement unless there is a different license provided in or specifically referenced by dowloaded file or package. If you disagree with any terms of the agreement then do not use the software.

Name Version Size MD5
VMware vRealize CloudClient 4.4.0 4.4.0 51.17 MB 18576ab53e55c58c0fce8b459750e5eb
VMware vRealize CloudClient 4.4.0 Documentation 4.4.0 1.97 MB 74cc74dac3dc95088cc8bb5a00264597
VMware vRealize CloudClient 4.4.0 Samples 4.4.0 12.38 KB 7121458b1ddfd92b285def9a548d4532

Documentation and Reference

Name Size
Open Source Software Related
VMware vRealize CloudClient 4.3.0 Open Source Disclosure 18.13 MB
VMware vRealize CloudClient 4.3.0 Open Source License 416.68 KB
VMware vRealize CloudClient 4.4.0 Open Source Disclosure 18.13 MB
VMware vRealize CloudClient 4.4.0 Open Source License 413.39 KB