LinuxCommandLibrary

virsh-pool-list

List storage pools defined on hypervisor

TLDR

List the name, state, and whether autostart is enabled or disabled for active storage pools

$ virsh pool-list
copy

List information for active and inactive or just inactive storage pools
$ virsh pool-list --[all|inactive]
copy

List extended information about persistence, capacity, allocation, and available space for active storage pools
$ virsh pool-list --details
copy

List information for active storage pools with either autostart enabled or disabled
$ virsh pool-list --[autostart|no-autostart]
copy

List information for active storage pools that are either persistent or transient
$ virsh pool-list --[persistent|transient]
copy

List the name and UUID of active storage pools
$ virsh pool-list --name --uuid
copy

SYNOPSIS

virsh pool-list [options]

PARAMETERS

--all
    List all storage pools, including both active and inactive ones.

--active
    Display only active storage pools.

--inactive
    Display only inactive storage pools.

--persistent
    Show only persistent storage pools (those defined permanently).

--transient
    Show only transient storage pools (those defined temporarily and lost on host reboot).

--autostart
    List only storage pools configured to autostart with the libvirt daemon.

--no-autostart
    List only storage pools not configured to autostart.

--details
    Provide more detailed information about each listed pool, such as path, type, and capacity.

--tree
    Display pools in a tree-like format, useful for visualizing hierarchical relationships (less common for basic listing).

--uuid
    Output only the UUIDs of the storage pools.

--name
    Output only the names of the storage pools.

DESCRIPTION

The command virsh pool-list is a subcommand of the virsh utility, which is the main management interface for the libvirt virtualization management system. While virsh-pool-list itself is not a standalone command, it is commonly used to refer to virsh pool-list, which provides a way to list and query the status of configured storage pools.

Storage pools are abstract containers for physical storage devices (like directories, LVM volumes, iSCSI targets, etc.) that libvirt uses to manage virtual disk images for guests. This command helps administrators quickly ascertain which storage pools are defined, their current state (active or inactive), and other properties like autostart settings. It's crucial for monitoring the storage infrastructure supporting your virtual machines.

CAVEATS

The literal command virsh-pool-list does not exist as a standalone executable; users typically mean virsh pool-list.
To execute this command, you typically need root privileges or be a member of the libvirt user group, as it interacts directly with the libvirt daemon.

OUTPUT COLUMNS

When executed without specific formatting options, virsh pool-list typically outputs information in columns:
Name: The user-defined name of the storage pool.
State: Indicates whether the pool is active or inactive.
Autostart: Shows if the pool is configured to autostart (yes or no) with the libvirt daemon.
Persistent: Indicates if the pool definition is permanent (yes) or transient (no).

HISTORY

The virsh command-line utility has been the standard interface for managing libvirt-based virtualization environments since its early inception. Storage pool management, including listing pools, has been a fundamental feature of libvirt and virsh from the beginning, evolving alongside the various storage backends supported by the system. The pool-list subcommand has been a stable and essential tool for administrators to monitor their virtual machine storage infrastructure.

SEE ALSO

virsh(1), Related subcommands:, virsh pool-define (define a new storage pool), virsh pool-start (activate a storage pool), virsh pool-destroy (deactivate a storage pool), virsh pool-delete (delete a storage pool from disk), virsh pool-info (display information about a specific storage pool)

Copied to clipboard