vRA Deployment Names

With SovLabs Property Toolkit for vRealize Automation (vRA), define vRA Deployment Names with custom properties and/or SovLabs Custom Naming module.

Using VMware’s vRealize Automation’s Approval Policies, we are able to update the vRA Deployment Name.


Compatibility

VMware vRealize Automation (vRA) 7.3, 7.4. 7.5 and 7.6
VMware vRealize Orchestrator (vRO) 7.3, 7.4. 7.5 and 7.6
Minimum SovLabs Plug-in 2019.10.0

Highlights

  • Manage Active vRA Approval Policies with SovLabs Property Toolkit
  • Set the vRA Deployment Name with SovLabs Custom Naming
  • Use SovLabs Property Toolkit to set the vRA Deployment Name
  • Use vRA Deployment Properties to influence the vRA Deployment Name (Custom Properties from the vRA Business Group, Property Groups and vRA Deployment for the vRA Blueprint)

Known Behavior

vRA Approval Policies

  • Multiple vRA Approval Policies with the same name can exist
  • Once the Status field is set to Active and the Approval Policy is saved, the user will not be able to edit the policy
    • In order to edit the Approval Policy, will have to Copy/Clone

vRA Deployment Properties

  • Able to obtain vRA Custom Properties from:
    • vRA Business Group
    • vRA Property Groups
    • vRA Deployment for the vRA Blueprint
  • Unable to obtain vRA Custom Properties from:
    • vRA Reservation
    • vRA Compute Resource
    • vRA Endpoint
    • Machines/Components on the vRA Blueprint
  • If utilizing SovLabs Property Toolkit (e.g. SovLabs_CreateProperties_ and/or SVL_), vRA Deployment properties are rendered 3 times

vRA Deployment Name

  • Multiple vRA Deployments with the same name can exist
  • If the user defined both Naming Standard and Template, the SovLabs Naming Standard will take precedence
    • e.g. both vRA custom properties exist: SovLabs_vRADeployment_NamingStandard and SovLabs_vRADeployment_Template
  • If the user attempts to use a Naming Standard, but the SovLabs Custom Naming module is not licensed:
    • The vRA Deployment Name will not get set
    • The Approval Policy will approve the deployment request
  • If the user has an Approval Policy with a SovLabs Property Toolkit level but the expected vRA custom property is not defined:
    • The vRA Deployment Name will not get set
    • The Approval Policy will approve the deployment request
  • If using a SovLabs Naming Standard:
    • If the Naming Sequence reaches/exceeds the max limit, the Deployment will fail
    • It will determine if a deployment name already exists for the tenant (pending/active) and increment the sequence
  • If multiple deployments are requested in a single deployment request, vRA will append a sub-sequence number (starting from 2) to the end of the generated vRA Deployment Name
    • For example, when “Deployments” is set to 5:
      • First provisioned vRA Deployment will be named “xxx-003-0342”
      • Subsequent provisioned vRA Deployments will be named “xxx-003-0342-2”, “xxx-003-0342-3”, “xxx-003-0342-4”, “xxx-003-0342-5”

Prerequisites

  1. (Optional) Customers can have and use existing vRA Approval Policies to update vRA Deployment Names.
  2. An Approval Policy with Type: Service Catalog - Catalog Item Request
  3. Successful vRA Blueprint
  4. All properties necessary to affect the vRA Deployment Names set at the 1) vRA Business Group, 2) vRA Property Groups and/or 3) vRA Deployment for the vRA Blueprint
  5. If using SovLabs Custom Naming, set up SovLabs Naming Sequence(s) and a SovLabs Naming Standard

Setup

  1. Use the Manage Property Toolkit Approval Policies - SovLabs Modules vRA Catalog Request to create or update an Approval Policy
  2. Attach the Approval Policy to the vRA Blueprint(s) in order to affect the vRA Deployment Names
    • Administration > Catalog Management > Entitlements
    • Click {tenant}
    • Click Items & Approvals
      • Click +Entitled Items
        • Select the desired vRA Blueprints
        • Apply this policy to selected items: Select desired Approval Policy created/updated with the SovLabs Property Toolkit level
        • Click Ok
      • Click Finish

Usage

Select the desired method to update the vRA Deployment Name:

  1. SovLabs Custom Naming
    • Set a custom property on one of the following: vRA Business Group of the blueprint or on the Deployment Level Properties of the vRA Blueprint
    • Name: SovLabs_vRADeployment_NamingStandard
    • Value: Configuration label of the desired SovLabs Naming Standard (can use SovLabs Property Toolkit to set the value)
  2. SovLabs Property Toolkit
    • Set a custom property on one of the following: vRA Business Group of the blueprint or on the Deployment Level Properties of the vRA Blueprint
    • Name: SovLabs_vRADeployment_Template
    • Value:

*NOTE: Can use SovLabs_CreateProperties_ and SVL_ to set the Name/Value to update the vRA Deployment Name


Manage Property Toolkit Approval Policies - SovLabs Modules

Perform the below in vRA > Catalog > Manage Property Toolkit Approval Policies - SovLabs Modules

Create

Create vRA Approval Policies with Policy Type: Service Catalog - Catalog Item Request

  • Creates a vRA Approval Policy with Policy Type: Service Catalog - Catalog Item Request
  • Creates a SovLabs Property Toolkit level in the Pre Approval Phase
    • The level is set at Order 1
    • The level has a _deploymentName Custom Property that enables the vRA Deployment Name to be updated
    • The level calls the vRA EBS: Property Toolkit Pre Approval Policy - Catalog Item Request
      • The level automatically approves this level
  • This option is recommended for customers who do not rely on vRA Approval Policies but would like to update vRA Deployment Names

View

View vRA Approval Policies with Policy Type: Service Catalog - Catalog Item Request

  • View selected vRA Approval Policies
    • Details field will list all Pre Approval levels for the Approval Policy
    • Submitting the form will not make any changes to the Approval Policy

Update

Update vRA Approval Policies with Policy Type: Service Catalog - Catalog Item Request

  • Updates selected vRA Approval Policies, regardless of state/status (e.g. Active/Inactive)
  • Add a SovLabs Property Toolkit level in the Pre Approval Phase
    • The level is set at Order 1
    • The level has a _deploymentName Custom Property that enables the vRA Deployment Name to be updated
    • The level calls the vRA EBS: Property Toolkit Pre Approval Policy - Catalog Item Request
      • The level automatically approves this level
    • If the SovLabs Property Toolkit level already exists, it will skip adding it to the Approval Policy. The Details field will notate the skip.
    • Remove a SovLabs Property Toolkit level in the Pre Approval Phase
      • The SovLabs Property Toolkit level in the Pre Approval Phase is removed
      • All subsequent levels are shifted up a level (e.g. Level 2 becomes Level 1)
      • If the SovLabs Property Toolkit level is the only level that exists, it will skip removing it from the Approval Policy. The Details field will notate the skip.
        • At least 1 level must exist for an Active Approval Policy
      • If the SovLabs Property Toolkit level does not exist, it will skip removing it from the Approval Policy. The Details field will notate the skip.
        • The Remove action only removes a SovLabs Property Toolkit level

Delete

Delete vRA Approval Policies with Policy Type: Service Catalog - Catalog Item Request

  • Deletes a vRA Approval Policy
  • Confirm checkbox must be checked in order to submit form since this is a destructive action and cannot be undone