Skip to content

set_disk_metadata

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

Disk metadata is written when the disk is attached to a VM. Metadata is not removed when disk is detached or VM is deleted.

Note

This method is called by BOSH v262+.

Arguments

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

Result

No return value

Examples

API Request

[
  "vol-3475945",
  {
    "director": "director-784430",
    "deployment": "redis",
    "instance_id": "ce7d2040-212e-4d5a-a62d-952a12c50741",
    "job": "redis",
    "instance_index": "1",
    "instance_name": "redis/ce7d2040-212e-4d5a-a62d-952a12c50741",
    "attached_at": "2017-08-10T12:03:32Z"
  }
]

Implementations