Get VM properties via Aria Operations/VCF Operations API

Products

• VCF Operations/Automation (formerly VMware Aria Suite)

Issue/Introduction

• When using Aria Operations/VCF Operations, you may need to programmatically retrieve specific virtual machine (VM) properties. This includes details such as VM name, IP address, total memory, vCPUs, and storage, as well as hierarchical metadata like the parent vCenter, Data Center, and Folder.

Environment

• Aria Operations 8.x

• VCF Operations 9.x

Resolution

You can retrieve detailed VM properties by using the Aria Operations/VCF Operations Suite API. Follow these steps to execute the call via the Swagger UI:

1. Navigate to the Aria Operations/VCF Operations Swagger API page at https://<AriaOpsFQDN>/suite-api.

2. Locate the Resources section.

3. Find and expand the following GET call: GET /api/resources/{id}/properties

4. Click on the Lock icon and enter the credentials and click Try it out.

5. Enter the Resource ID (UUID) for the VM you wish to query in the id field.

   • Note: If you do not have the ID, you can find it by using the GET /api/resources call and filtering by the VM name.

6. Click Execute.

7. The response body will contain the properties for the VM, including:

   • Hardware configuration (CPU, Memory, Storage)

   • Network information (IP addresses)

   • Inventory Path (vCenter, Data Center, Cluster, Folder)

Additional Information

• VM Properties via VMware Aria Operations API