virtomate volume-list¶

Name¶

virtomate volume-list - List all volumes in a storage pool.

Synopsis¶

virtomate volume-list [options] pool

Description¶

virtomate volume-list lists all volumes in the storage pool named pool.

The returned JSON message is a list of virtomate.volume.VolumeDescriptor:

class virtomate.volume.VolumeDescriptor¶

Descriptor of a libvirt storage volume.

allocation: int | None¶: How much of the capacity of the storage volume is already being used, expressed in bytes.

backing_store: BackingStoreDescriptor | None¶: Descriptor of the backing store of this storage volume, if any.

capacity: int | None¶: Total capacity of the storage volume in bytes.

key: str¶: Key that identifies this storage volume.

name: str¶: Name of the storage volume

physical: int | None¶: How much physical space the volume currently occupies, expressed in bytes.

target: TargetDescriptor¶: Target descriptor of the storage volume.

type: str | None¶: Type of storage volume

class virtomate.volume.TargetDescriptor¶

Descriptor of the target (“physical manifestation”) of a storage volume.

format_type: str | None¶: Disk format of the storage volume, for example, qcow2.

path: str¶: Path of the storage volume

class virtomate.volume.BackingStoreDescriptor¶

Descriptor of the backing store of a storage volume.

format_type: str | None¶: Disk format of the backing storage, for example, raw.

path: str | None¶: Path of the backing store

Options¶

-h, --help¶: Display usage summary of this command and exit.

Versions¶

Added in version 0.1.0.

Examples¶

List all storage pools:

$ virtomate -p pool-list
[
  {
    "active": true,
    "allocation": 42042183680,
    "available": 1956635947008,
    "capacity": 1998678130688,
    "name": "default",
    "number_of_volumes": 4,
    "persistent": true,
    "state": "running",
    "uuid": "b3f4da29-2fdb-4ca6-a59d-c66f3c9737de"
  }
]