top of page
My photo


  • Writer's pictureAdmin

Updating Deployment in vRA 8.x

How to Update Deployment Name and Description in vRA 8.x Using vRo?

If you're managing many deployments in your vRealize Automation (vRA) 8.x environment, it's essential to keep them organized and well-documented. One way to achieve this is by updating the deployment name and adding a description. In this blog post, we'll show you how to do this using vRo. Here are some specific use cases:

Consistent Naming Conventions:

If you have a large number of deployments in your vRA environment, it can be challenging to keep track of them all. By updating the deployment name to a consistent format (e.g., "Environment-Application-Component"), you can easily identify and manage your deployments. This helps the user to search the vms/deployment with the value which mentioned in the details.

Clear Documentation:

Adding a description to your deployments can help to document important information about the environment or application. For example, you might include details about the deployment's purpose, architecture, or configuration. This can be especially helpful for new team members who are unfamiliar with the environment.


If you are using vRA to manage your infrastructure and applications, you can automate the process of updating deployment names and descriptions using scripts like the one below. This can save time and reduce the risk of human error.


In some industries, compliance regulations require that deployments be named and documented in a certain way. By using scripts to enforce these requirements, you can ensure that your deployments are compliant and avoid potential penalties or fines.


If you are integrating vRA with other tools or systems, updating deployment names and descriptions can help to ensure consistency across your environment. For example, if you are using a service desk tool to manage IT requests, you might update the deployment name to include the ticket number or other relevant information.

Step 1: Declare the input variables.

Step 2: Get the vRA authentication token.

Step 3: Get the Deployment ID by searching the server’s name.

Step 4: Update the deployment name.

Step 5: Update the deployment description.

Before creating this workflow, you need to create a RESTHost in vRo, this is required as an input. You can create this by running the “add REST host” workflow in library.

After adding it will come in the inventory.

//Declare the Input Variables

//Login Object

//Get the authentication token

//Get the deployment ID of the of a respective VM

// Note – If you have multiple VMs in a single deployment then this needs to modify the below section, I am assuming one server present in one deployment.

//Update the Deployment Name

//Update the Deployment Description


In summary, updating the deployment name and adding a description in vRA 8.x can help you keep your deployments organized and well-documented. By using JavaScript to automate the process, you can save time and reduce the risk of errors. Additionally, using consistent naming conventions and clear documentation can help with compliance and integration with other tools and systems.


Thanks for visiting 



  • Linkedin
  • Wix Facebook page
  • Wix Twitter page
Subscribe to get exclusive updates
bottom of page