From 882067d933b3bdedb1e9729d1c4743c2e56581f3 Mon Sep 17 00:00:00 2001 From: Adam Herst Date: Thu, 27 May 2021 15:21:39 -0400 Subject: [PATCH] virsh-pool-*: add pages --- pages/common/virsh-pool-autostart.md | 13 +++++++++++++ pages/common/virsh-pool-build.md | 9 +++++++++ pages/common/virsh-pool-define-as.md | 9 +++++++++ pages/common/virsh-pool-delete.md | 9 +++++++++ pages/common/virsh-pool-destroy.md | 9 +++++++++ pages/common/virsh-pool-info.md | 9 +++++++++ pages/common/virsh-pool-list.md | 29 ++++++++++++++++++++++++++++ pages/common/virsh-pool-start.md | 9 +++++++++ pages/common/virsh-pool-undefine.md | 9 +++++++++ 9 files changed, 105 insertions(+) create mode 100644 pages/common/virsh-pool-autostart.md create mode 100644 pages/common/virsh-pool-build.md create mode 100644 pages/common/virsh-pool-define-as.md create mode 100644 pages/common/virsh-pool-delete.md create mode 100644 pages/common/virsh-pool-destroy.md create mode 100644 pages/common/virsh-pool-info.md create mode 100644 pages/common/virsh-pool-list.md create mode 100644 pages/common/virsh-pool-start.md create mode 100644 pages/common/virsh-pool-undefine.md diff --git a/pages/common/virsh-pool-autostart.md b/pages/common/virsh-pool-autostart.md new file mode 100644 index 000000000..0c6e6e63e --- /dev/null +++ b/pages/common/virsh-pool-autostart.md @@ -0,0 +1,13 @@ +# virsh-pool-autostart + +> Enable or disable autostart for a virtual machine storage pool. +> See also: `virsh`. +> More information: . + +- Enable autostart for the storage pool specified by name or UUID (determine the name or UUID using `virsh pool-list`): + +`virsh pool-autostart --pool {{name|uuid}}` + +- Disable autostart for the storage pool specified by name or UUID: + +`virsh pool-autostart --pool {{name|uuid}} --disable` diff --git a/pages/common/virsh-pool-build.md b/pages/common/virsh-pool-build.md new file mode 100644 index 000000000..cce424e67 --- /dev/null +++ b/pages/common/virsh-pool-build.md @@ -0,0 +1,9 @@ +# virsh-pool-build + +> Build the underlying storage system for a virtual machine storage pool as defined in it's configuration file (create a configuration file using `virsh pool-define-as`). +> See also: `virsh`. +> More information: . + +- Build the storage pool specified by name or UUID (determine the name or UUID using `virsh pool-list` and start the pool once built using `virsh pool-start`): + +`virsh pool-build --pool {{name|uuid}}` diff --git a/pages/common/virsh-pool-define-as.md b/pages/common/virsh-pool-define-as.md new file mode 100644 index 000000000..ab1b76f67 --- /dev/null +++ b/pages/common/virsh-pool-define-as.md @@ -0,0 +1,9 @@ +# virsh-pool-define-as + +> Create a configuration file in `/etc/libvirt/storage` for a persistent virtual machine storage pool from the provided arguments. +> See also: `virsh`. +> More information: . + +- Create the configuration file for a storage pool called pool_name using `/var/vms` as the underlying storage system (use `virsh pool-build` to create the underlying storage system if it doesn't exist and use `virsh pool-start` to start the inactive pool): + +`virsh pool-define-as --name {{pool_name}} --type {{dir}} --target {{/var/vms}}` diff --git a/pages/common/virsh-pool-delete.md b/pages/common/virsh-pool-delete.md new file mode 100644 index 000000000..bf8994992 --- /dev/null +++ b/pages/common/virsh-pool-delete.md @@ -0,0 +1,9 @@ +# virsh-pool-delete + +> Delete the underlying storage system of an inactive virtual machine storage pool (stop a storage pool with `virsh pool-destroy` and delete the storage pool configuration file with `virsh pool-undefine`). +> See also: `virsh`. +> More information: . + +- Delete the underlying storage system for the storage pool specified by name or UUID (determine the name or UUID using `virsh pool-list`): + +`virsh pool-delete --pool {{name|uuid}}` diff --git a/pages/common/virsh-pool-destroy.md b/pages/common/virsh-pool-destroy.md new file mode 100644 index 000000000..71f22718e --- /dev/null +++ b/pages/common/virsh-pool-destroy.md @@ -0,0 +1,9 @@ +# virsh-pool-destroy + +> Stop an active virtual machine storage pool (delete a stopped storage pool using `virsh pool-delete`). +> See also: `virsh`. +> More information: . + +- Stop a storage pool specified by name or UUID (determine the name or UUID using `virsh pool-list`): + +`virsh pool-destroy --pool {{name|uuid}}` diff --git a/pages/common/virsh-pool-info.md b/pages/common/virsh-pool-info.md new file mode 100644 index 000000000..ea66bff76 --- /dev/null +++ b/pages/common/virsh-pool-info.md @@ -0,0 +1,9 @@ +# virsh-pool-info + +> List information about a virtual machine storage pool. +> See also: `virsh`. +> More information: . + +- List the name, UUID, state, persistence type, autostart status, capacity, space allocated, and space available for the storage pool specified by name or UUID (determine the name or UUID using `virsh pool-list`): + +`virsh pool-info --pool {{name|uuid}}` diff --git a/pages/common/virsh-pool-list.md b/pages/common/virsh-pool-list.md new file mode 100644 index 000000000..6d56d0008 --- /dev/null +++ b/pages/common/virsh-pool-list.md @@ -0,0 +1,29 @@ +# virsh-pool-list + +> List information about virtual machine storage pools (create a storage pool with `virsh pool-define-as`). +> See also: `virsh`. +> More information: . + +- List the name, state, and whether autostart is enabled or disabled for active storage pools: + +`virsh pool-list` + +- List information for active and inactive or just inactive storage pools: + +`virsh pool-list --{{all|inactive}}` + +- List extended information about persistence, capacity, allocation, and available space for active storage pools: + +`virsh pool-list --details` + +- List information for active storage pools with either autostart enabled or disabled (enable or disable autostart with `virsh pool-autostart`): + +`virsh pool-list --{{autostart|no-autostart}}` + +- List information for active storage pools that are either persistent or transient: + +`virsh pool-list --{{persistent|transient}}` + +- List the name and UUID of active storage pools: + +`virsh pool-list --name --uuid` diff --git a/pages/common/virsh-pool-start.md b/pages/common/virsh-pool-start.md new file mode 100644 index 000000000..4a3f24d4b --- /dev/null +++ b/pages/common/virsh-pool-start.md @@ -0,0 +1,9 @@ +# virsh-pool-start + +> Start a previously configured but inactive virtual machine storage pool (configure a pool with `virsh pool-define-as` and stop a pool with `virsh pool-destroy`). +> See also: `virsh`. +> More information: . + +- Start the storage pool specified by name or UUID (determine the name or UUID using `virsh pool-list`) and create the underlying storage system if it doesn't exist: + +`virsh pool-start --pool {{name|uuid}} --build` diff --git a/pages/common/virsh-pool-undefine.md b/pages/common/virsh-pool-undefine.md new file mode 100644 index 000000000..0892b9ec6 --- /dev/null +++ b/pages/common/virsh-pool-undefine.md @@ -0,0 +1,9 @@ +# virsh-pool-undefine + +> Delete the configuration file in `/etc/libvirt/storage` for a stopped virtual machine storage pool (stop a pool using `virsh pool-destroy`). +> See also: `virsh`. +> More information: . + +- Delete the configuration for the storage pool specified name or UUID (determine the name or UUID using `virsh pool-list`): + +`virsh pool-undefine --pool {{name|uuid}}`