Update existing AWX integration endpoint URL with a new URL

Products

• VCF Operations/Automation (formerly VMware Aria Suite)

Issue/Introduction

• Steps to update an existing AWX integration endpoint URL with an update to the existing URL via public API's or a workflow package rather than creating a brand new integration from scratch, then manually updating existing deployments to reference the newly created AWX integration. 
  
  
• This process comes in handy when there are a high amount of deployments referencing the old URL and it would take significant time to manually update every single deployment. 

Environment

Aria Automation 8.x
Aria Orchestrator 8.x

Resolution

There are two methods you can take to perform this update task.

Option 1: Execute Public API calls below to update integration endpoint.

To perform the update via public API's perform the below steps:

• Run the below GET API to fetch the integration ID

GET https://vra-hostname/iaas/api/integrations?apiVersion=2021-07-15&$filter=name+eq+'IntegrationName'

• Take note of the integration Id value from Step above.
• Run below API to update the integration hostName and credentials:

API
PATCH https://vra-hostname/iaas/api/integrations/Integration-Id-from-step-2>?apiVersion=2021-07-15

Body
{
    "privateKey": "password",
    "privateKeyId": "admin",
    "integrationProperties": {
        "hostName": "<FQDN/IP>"
    }
}

Response
{
    "progress": 0,
    "status": "INPROGRESS",
    "name": "Integration creation/update",
    "id": "<UID>",
    "selfLink": "/iaas/api/request-tracker/<Request-ID>"
}

Validate Request

Uses the selfLink from above response to obtain request status

GET https://vra-hostname/iaas/api/request-tracker/<Request-ID>

 

Option 2: Execute the included vRO package workflow that is attached to this KB.

• Included in this KB is an Aria Orchestrator package. Log into Aria Orchestrator with administrative rights to load package "com.vmware.pve.UpdateIntegrationEndpoint.package".
• In the package, execute the workflow "Update Aria Integration Account". This workflow also can update the hostnames. 

Required Inputs:

1. Select the Aria Host that has Administrative rights
2. Select from the dropdown the Integration Name to update.
3. Hostname (IP/FQDN) type in the IP Address or FQDN of the new integration host. 
4. Username: Type in the username for the integration account.
5. Password: Type in the password for the username above. 

Click Run

Below is an example output from the above execution. You should see a status of finished. If the output shows failed, then correct the input values and try again.