Using the vRealize Orchestrator scripting API to create and update configurations or resources can lead to incorrect or missing version history

Products

• VMware Aria Suite

Issue/Introduction

 

 

 

Symptoms:
Changes made to configuration and resource elements through the vRealize Orchestrator scripting API without explicitly calling the saveToVersionRepository method does not generate version history for those elements.

Environment

VMware vRealize Orchestrator 8.x
VMware vRealize Automation 8.1.x

Cause

When you create or update resource and configuration elements using the vRO scripting API, they are not saved to version history unless you explicitly call the saveToVersionRepository method. This means that elements without version history cannot be tracked. If, at some point after upgrading to 8.2 Patch 1, you add an external Git repository, this can lead to the repository storing only the original versions of such elements instead of the latest modifications that are made using the vRO scripting API.

 

 

 

 

 

 

 

 

 

Resolution

Before upgrading to vRealize Orchestrator 8.2 Patch 1, ensure you save all configuration and resource elements to version history. You can do this in one of 2 ways.

• Manually save configuration and resource elements created or updated through the vRO scripting API.

OR

• Create a package and add all configuration and resource elements to it. Save the package. Click Increment Version and select patch version.

This will ensure that the version history for configurations or resources that were created or modified through the scripting API can be tracked in the vRealize Orchestrator Client and in an external Git repository.

As of vRO 8.2 Patch 1, all new changes to configuration and resource elements made with the vRealize Orchestrator scripting API without the saveToVersionRepository method will appear as notifications on the Version History tab in the respective configuration or resource.

 

 

 

Additional Information

Impact/Risks:
Untracked changes made without the saveToVersionRepository method in combination with an external Git repository can lead to the repository storing only the original version for such content, and not the latest changes made through the scripting API.

You will NOT be affected if:

• You create or update resource and configuration elements manually in the vRO Client or through the vRO REST API.
• You do not use the scripting API to create or modify configuration or resource elements.
• You use the scripting API to create or modify configuration or resource elements and explicitly call the saveToVersionRepository method.