Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Writing metadata will overwrite ALL existing metadata, so the first step is to to obtain a base object to modify, retrieve the existing metadata in the appropriate format. Abiquo recommends JSON format. Then add new metadata keys and values as required. 

Note: Do not use a conversion tool to convert between JSON and XML format because this may produce an incompatible data transfer object.


Excerpt

For the metadata attribute /or object, Abiquo has the reserved keys that are described in the following table.

Metadata typeReserved KeysDescription
Chef
  • chef
  • Users enter Chef recipe attributes as JSON in the UI, in the VM dialog on the Chef / Attributes tab 
  • Abiquo stores the recipe attributes that you enter in JSON format as an escaped string under the chef key
Bootstrap script
  • startup-script
  • Cloud-config for use by cloud-init
  • Users enter Startup script in the UI, on the VM dialog on the Bootstrap script tab
Metrics
  • monitoring-metrics
  • Names of the metrics available for the VM – useful for accessing metrics via API
Custom 
  • Append custom metadata to the existing metadata
  • Do not use the Abiquo reserved metadata keys


...

  • A VM that is not deployed (or powered off)
    • This tutorial shows a VM that is not deployed
  • User with privileges to work with VMs and Manage virtual machine backup configuration (because VAPP_MANAGE_BACKUP) because backups previously used metadata) – VAPP_MANAGE_BACKUP
  • Optional: a monitoring server and a user with the privileges to Manage virtual machine metrics – USERSmetrics (USERS_ENABLE_DISABLE_VM_METRICS)

To get started, use the a query to retrieve all of your VMs from the cloud and select the desired VM. Here we are filtering the VMs using the "has" parameter to select the one that has "ABQ_2fade" as part of the name, which is an easy way to find a VM that you have located in the UI.

...