Friday, September 30, 2022

VRA ABX Action to set Deployment Lease

 Running vRealize Automation (VRA), I wanted to create a new catalog item in Service Broker that would basically self-destruct after a certain time. My intent is to allow our Windows engineers to quickly spin up a new machine in AWS with a lease applied to it. 

I could find a catalog template setting that allowed me to configure this, so I found that I could do this via a REST call to the VRA. So I decided to work on creating an extensibility action using Powershell. 

Note, once a lease is set, I don't think it's possible to remove the lease. 


  • Extensibility Actions on Prem integration server configured.
  • VRA refresh token defined. This will be used in step 0.
  • BlueprintID of a catalog template that will apply the lease to. We'll need this for step 2. The blueprint id can be captured easily from the URL when viewing it in the design menu. Copy everything after the %2F, for example (the bolded portion):;ash=%2Fblueprint%2Fedit%2F123456-7890123456-123456789
Step 0: setup Action Constant
  1. Inside VRA - Extensibility menu, select Actions on the sidebar. 
  2. Select Action Constants and add a + New Action Constant
  3. Enter the name of "refreshToken" and paste the refresh token string into the value field and select toggle to enable the Encrypt the action contact value
  4. Click SAVE.

Step 1: create the action 

  1. Extensibility menu, Actions on sidebar and click + New Action
  2. Define the new action Name "SetDeploymentLease" and select the VRA Project that this will run against then click Next.
  3. On the top, change the dropdown from PYTHON to POWERSHELL. 
  4. Copy the pastebin code below and paste it into the body of the action.
  5. Under Default Inputs, add two more input fields (for a total of 3). These fields will be used during the run-time of the action. 

    1. Default - LeasePeriod - Positive integer for the number of days to define the lease.
    2. Default - deploymentId - can be anything, this will be sent to the action from the subscription event defined in step 2. I copied the deployment id off an existing 'test' deployment directly from the URL. (like prerequisites, it's everything after the %2F). 
    3. Action Constant - refreshToken - this will pull the value from Step 0.
  6. SAVE the action
Step 2: create a subscription - The subscription will trigger after the blueprint is run.
  1. Extensibility menu, Subscriptions option on sidebar and click + NEW SUBSCRIPTION
  2. Give subscription name. 
  3. For Event Topic select "Deployment Resource Completed"
  4. Enable the Condition and enter a (case matters) single value of: == "value from pre-requisites"
  5. Action/Workflow: select the new action you created in Step 1.
  6. Projects: Select the project you specified in step 1, item 2.
  7. SAVE

  1. Option: If valid values are entered in step 1 part 5, the test button on the Action will run. 

  2. Option: Deploy a new machine using the catalog item defined in the prerequisites. Within a minute after the deployment completes the build, the lease should be applied via the subscription. 

No comments:

Post a Comment