Skip to content

set_vm_metadata

Sets VM's metadata to make it easier for operators to categorize VMs when looking at the IaaS management console. For example AWS CPI uses tags to store metadata for operators to see in the AWS Console.

We recommend to set VM name based on sometimes provided name key.

Arguments

  • vm_cid [String]: Cloud ID of the VM to modify; returned from create_vm.
  • metadata [Hash]: Collection of key-value pairs. CPI should not rely on presence of specific keys.

Result

No return value

Examples

API Request

[
  "i-387459",
  {
    "director": "director-784430",
    "deployment": "redis",
    "name": "redis/ce7d2040-212e-4d5a-a62d-952a12c50741",
    "job": "redis",
    "id": "ce7d2040-212e-4d5a-a62d-952a12c50741",
    "index": "1"
  }
]

Implementations