virtomate pool-list¶

Name¶

virtomate pool-list - List all storage pools.

Synopsis¶

virtomate pool-list [options]

Description¶

virtomate pool-list lists all storage pools.

The returned JSON message is a list of virtomate.pool.PoolDescriptor:

class virtomate.pool.PoolDescriptor¶

Descriptor of a libvirt storage pool.

active: bool¶: Whether the storage pool is currently active.

allocation: int¶: How much space (in bytes) has been allocated to storage volumes.

available: int¶: How much free space (in bytes) there is left in the storage pool.

capacity: int¶: Total capacity of the storage pool in bytes.

name: str¶: Name of the storage pool

number_of_volumes: int | None¶: Number of volumes in the storage pool. This value is only populated if the storage pool is running.

persistent: bool¶: Whether the storage pool is persistent (True) or transient (False).

state: str¶: Current state of the storage pool. Possible values: inactive, building, running, degraded, inaccessible.

uuid: str¶: UUID of the storage pool

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"
  }
]