ITS Private Cloud API v3.8.1 🎉

We are pleased to announce we released the ITS Cloud API v3.8.1 with the following improvements and bug fixes:

Improvements

HA Group migration from UUID to Moref (#1313) 

Endpoints

  • /v2/vm/<vm-id>/vss/ha-group (GET, PUT, PATCH)

Description

We were using UUIDs as VM identifier which were taking too much space to store in the annotation field (24 chars each). If you have multiple VMs within a single HA Group, let's say 5, there's going to be 5x24 chars of space used. Also, UUIDs cannot be accessed within the vSphere client. Meaning that if you cut and paste a single UUID, and paste into the vSphere Client URL, it won't be accessible. 

In order to mitigate above described situation, we have replaced the use of UUIDs in HA Groups with Managed Object Reference IDs (Morefs). Morefs are VM identifiers as well and widely used by vCenter API, vSphere client, etc. Morefs are more user friendly structured as vm-NNNN. In the Virtual machine annotation field (where we store VM's metadata aka `/vss`), will change:

From: 

UTvssHAGroup: 5012db5c-57a0-7bd2-49a5-665d3b406670,5012f72a-f9c7-366f-5cf0-e1ac6afe4466,50120c23-4c9a-ab78-af30-8f74768ed011

To:

UTvssHAGroup: vm-12086,vm-12077,vm-12085

With this change we have optimized the space in the annotation field and have provided a reference accessible from the vSphere client. For instance by just replacing the <VM-MOREF> variable in the following link, you will be able to quickly identify the vm that belongs to an ha-group:

https://vctr5-1.dcb.eis.utoronto.ca/ui/#?extensionId=vsphere.core.vm.summary&objectId=urn:vmomi:VirtualMachine:<VM-MOREF>:<VC-ID>&navigator=vsphere.core.viTree.vmsAndTemplatesView

Although we have migrated all the current VMs with ha-groups, the VSS API has a resource to perform migrations which will update the vm in question and all members of the HA Group:

PATCH /v2/vm/<vm-id>/vss/ha-group

HA Group creation using UUIDs still works but morefs will be stored in the annotation field


Add moref to Inventory resource (#1323)

Endpoints

  • /v2/inventory

Description

Inventory files will include moref as well as uuid as default virtual machine identifiers.

Get VM info to provide moref in response (#1320)

Endpoints

  • /v2/vm/<vm-id>

Description

Adds moref to response payload.


Store vm_moref in Virtual Machine related requests (#1315)

Endpoints

  • /v2/request/<request-type>

  • /v2/request/<request-type>/<request-id>

Description

Adds moref to response payload.

Bug Fixes

HA Group resource cache clearing (#1322)

Endpoints

  • /vm/<vm-id>/vss/ha-group (PUT, DELETE, PATCH)

Description

HA group application cache resource was not cleared after task completed.

University of Toronto - Since 1827