.. _Managing Volumes:

Managing Volumes
----------------

.. _vinfra service compute volume create:

vinfra service compute volume create
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Create a new compute volume:

:: 

   usage: vinfra service compute volume create [--description <description>]
                                               [--network-install <network_install>]
                                               [--image <image>] --storage-policy
                                               <storage_policy> --size <size-gb>
                                               <volume-name>

``--description <description>``
   Volume description

``--network-install <network_install>``
   Perform network install (``true`` or ``false``)

``--image <image>``
   Source compute image ID or name

``--storage-policy <storage_policy>``
   Storage policy ID or name

``--size <size-gb>``
   Volume size, in gigabytes

``<volume-name>``
   Volume name

Example:

::

   # vinfra service compute volume create myvolume --storage-policy default --size 8
   +--------------------------------+--------------------------------------+
   | Field                          | Value                                |
   +--------------------------------+--------------------------------------+
   | attachments                    | []                                   |
   | availability_zone              | nova                                 |
   | bootable                       | False                                |
   | consistencygroup_id            |                                      |
   | created_at                     | 2018-09-12T12:30:12.665916           |
   | description                    |                                      |
   | encrypted                      | False                                |
   | id                             | c9c0e9e7-ce7a-4566-99d5-d7e40f2987ab |
   | imageRef                       |                                      |
   | migration_status               |                                      |
   | multiattach                    | False                                |
   | name                           | myvolume                             |
   | network_install                | False                                |
   | os-vol-host-attr:host          |                                      |
   | os-vol-mig-status-attr:migstat |                                      |
   | os-vol-mig-status-attr:name_id |                                      |
   | project_id                     | 72a5db3a033c403a86756021e601ef34     |
   | replication_status             |                                      |
   | size                           | 8                                    |
   | snapshot_id                    |                                      |
   | source_volid                   |                                      |
   | status                         | creating                             |
   | storage_policy_name            | default                              |
   | updated_at                     |                                      |
   | user_id                        | 98bf389983c24c07af9677b931783143     |
   | volume_image_metadata          |                                      |
   +--------------------------------+--------------------------------------+

This command creates a volume ``myvolume`` sized 8 GB and chooses the default storage policy for it.

.. _vinfra service compute volume list:

vinfra service compute volume list
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

List compute volumes:

:: 

   usage: vinfra service compute volume list

Example:

::

   # vinfra service compute volume list -c id -c name -c size -c status
   +--------------------------------------+----------+------+-----------+
   | id                                   | name     | size | status    |
   +--------------------------------------+----------+------+-----------+
   | c9c0e9e7-ce7a-4566-99d5-d7e40f2987ab | myvolume |    8 | available |
   +--------------------------------------+----------+------+-----------+

This command lists volumes available to the compute cluster. (The output is abridged to fit on page.)

.. _vinfra service compute volume show:

vinfra service compute volume show
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Display compute volume details:

:: 

   usage: vinfra service compute volume show <volume>

``<volume>``
   Volume ID or name

Example:

::

   # vinfra service compute volume show myvolume
   +--------------------------------+-----------------------------------------------------+
   | Field                          | Value                                               |
   +--------------------------------+-----------------------------------------------------+
   | attachments                    | []                                                  |
   | availability_zone              | nova                                                |
   | bootable                       | False                                               |
   | consistencygroup_id            |                                                     |
   | created_at                     | 2018-09-12T12:30:12.665916                          |
   | description                    |                                                     |
   | encrypted                      | False                                               |
   | id                             | c9c0e9e7-ce7a-4566-99d5-d7e40f2987ab                |
   | imageRef                       |                                                     |
   | migration_status               |                                                     |
   | multiattach                    | False                                               |
   | name                           | myvolume                                            |
   | network_install                | False                                               |
   | os-vol-host-attr:host          | stor-1.example.com.vstoragedomain@vstorage#vstorage |
   | os-vol-mig-status-attr:migstat |                                                     |
   | os-vol-mig-status-attr:name_id |                                                     |
   | project_id                     | 72a5db3a033c403a86756021e601ef34                    |
   | replication_status             |                                                     |
   | size                           | 8                                                   |
   | snapshot_id                    |                                                     |
   | source_volid                   |                                                     |
   | status                         | available                                           |
   | storage_policy_name            | default                                             |
   | updated_at                     | 2018-09-12T12:30:33.167654                          |
   | user_id                        | 98bf389983c24c07af9677b931783143                    |
   | volume_image_metadata          |                                                     |
   +--------------------------------+-----------------------------------------------------+

This command shows the details for the volume ``myvolume``.

.. _vinfra service compute volume set:

vinfra service compute volume set
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Modify volume parameters:

:: 

   usage: vinfra service compute volume set [--description <description>]
                                            [--network-install <network_install>]
                                            [--storage-policy <storage_policy>]
                                            [--bootable <bootable>]
                                            [--name <name>] <volume>

``--description <description>``
   Volume description

``--network-install <network_install>``
   Perform network install (``true`` or ``false``)

``--storage-policy <storage_policy>``
   Storage policy ID or name

``--bootable <bootable>``
   Make bootable (``true`` or ``false``)

``--name <name>``
   A new name for the volume

``<volume>``
   Volume ID or name

Example:

::

   # vinfra service compute volume set myvolume --storage-policy mystorpolicy
   +--------------------------------+-----------------------------------------------------+
   | Field                          | Value                                               |
   +--------------------------------+-----------------------------------------------------+
   | attachments                    | []                                                  |
   | availability_zone              | nova                                                |
   | bootable                       | False                                               |
   | consistencygroup_id            |                                                     |
   | created_at                     | 2018-09-12T12:30:12.665916                          |
   | description                    |                                                     |
   | encrypted                      | False                                               |
   | id                             | c9c0e9e7-ce7a-4566-99d5-d7e40f2987ab                |
   | imageRef                       |                                                     |
   | migration_status               |                                                     |
   | multiattach                    | False                                               |
   | name                           | myvolume                                            |
   | network_install                | False                                               |
   | os-vol-host-attr:host          | stor-1.example.com.vstoragedomain@vstorage#vstorage |
   | os-vol-mig-status-attr:migstat |                                                     |
   | os-vol-mig-status-attr:name_id |                                                     |
   | project_id                     | 72a5db3a033c403a86756021e601ef34                    |
   | replication_status             |                                                     |
   | size                           | 8                                                   |
   | snapshot_id                    |                                                     |
   | source_volid                   |                                                     |
   | status                         | available                                           |
   | storage_policy_name            | mystorpolicy                                        |
   | updated_at                     | 2018-09-12T12:55:29.298717                          |
   | user_id                        | 98bf389983c24c07af9677b931783143                    |
   | volume_image_metadata          |                                                     |
   +--------------------------------+-----------------------------------------------------+

This command changes the storage policy of the volume ``myvolume`` to ``mystorpolicy``.

.. _vinfra service compute volume extend:

vinfra service compute volume extend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Extend a compute volume:

:: 

   usage: vinfra service compute volume extend --size <size_gb> <volume>

``<volume>``
   Volume ID or name

Example:

::

   # vinfra service compute volume extend myvolume --size 16
   Operation successful

This command extends the volume ``myvolume`` to 16 GB.

.. _vinfra service compute server volume attach:

vinfra service compute server volume attach
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Attach a volume to a compute server:

:: 

   usage: vinfra service compute server volume attach --server <server> <volume>

``--server <server>``
   Compute server ID or name

``<volume>``
   Volume ID or name

Example:

::

   # vinfra service compute server volume attach e4cb5363-1fb2-41f5-b24b-18f98a388cba \
   --server 871fef54-519b-4111-b18d-d2039e2410a8
   +--------+--------------------------------------+
   | Field  | Value                                |
   +--------+--------------------------------------+
   | device | /dev/vdb                             |
   | id     | e4cb5363-1fb2-41f5-b24b-18f98a388cba |
   +--------+--------------------------------------+

This command attaches the available volume with the ID ``e4cb5363-1fb2-41f5-b24b-18f98a388cba`` to the VM with the ID ``871fef54-519b-4111-b18d-d2039e2410a8``.

.. _vinfra service compute server volume detach:

vinfra service compute server volume detach
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Detach a volume from a compute server:

:: 

   usage: vinfra service compute server volume detach --server <server> <volume>

``--server <server>``
   Compute server ID or name

``<volume>``
   Volume ID or name

Example:

::

   # vinfra service compute server volume detach e4cb5363-1fb2-41f5-b24b-18f98a388cba \
   --server 871fef54-519b-4111-b18d-d2039e2410a8
   Operation successful

This command detaches the volume with the ID ``e4cb5363-1fb2-41f5-b24b-18f98a388cba`` from the VM with the ID ``871fef54-519b-4111-b18d-d2039e2410a8``.

.. _vinfra service compute volume delete:

vinfra service compute volume delete
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Delete a compute volume:

:: 

   usage: vinfra service compute volume delete <volume>

``<volume>``
   Volume ID or name

Example:

::

   # vinfra service compute volume delete myvolume2
   Operation successful

This command deletes the volume ``myvolume2``.