Skip to content

Commit fe3a04b

Browse files
committed
docs: Rewrite 'nova-manage libvirt' docs
Change-Id: Ice641a8ce2658e0df4eea08f527fe7813617218f Signed-off-by: Stephen Finucane <[email protected]>
1 parent 5f6aae3 commit fe3a04b

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

doc/source/cli/nova-manage.rst

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1379,9 +1379,12 @@ libvirt get_machine_type
13791379
13801380
nova-manage libvirt get_machine_type [INSTANCE_UUID]
13811381
1382-
Fetch and display the recorded machine type of a libvirt instance.
1382+
Fetch and display the recorded machine type of a libvirt instance identified
1383+
by ``INSTANCE_UUID``.
13831384

1384-
**Return Codes**
1385+
.. versionadded:: 23.0.0 (Wallaby)
1386+
1387+
.. rubric:: Return codes
13851388

13861389
.. list-table::
13871390
:widths: 20 80
@@ -1408,14 +1411,15 @@ libvirt update_machine_type
14081411
nova-manage libvirt update_machine_type \
14091412
[INSTANCE_UUID] [MACHINE_TYPE] [--force]
14101413
1411-
Set or update the recorded machine type of an instance.
1414+
Set or update the recorded machine type of instance ``INSTANCE_UUID`` to
1415+
machine type ``MACHINE_TYPE``.
14121416

1413-
The following criteria must also be met when using this command:
1417+
The following criteria must be met when using this command:
14141418

14151419
* The instance must have a ``vm_state`` of ``STOPPED``, ``SHELVED`` or
14161420
``SHELVED_OFFLOADED``.
14171421

1418-
* The machine type is supported. The supported list includes alias and
1422+
* The machine type must be supported. The supported list includes alias and
14191423
versioned types of ``pc``, ``pc-i440fx``, ``pc-q35``, ``q35``, ``virt``
14201424
or ``s390-ccw-virtio``.
14211425

@@ -1430,7 +1434,15 @@ A ``--force`` flag is provided to skip the above checks but caution
14301434
should be taken as this could easily lead to the underlying ABI of the
14311435
instance changing when moving between machine types.
14321436

1433-
**Return Codes**
1437+
.. versionadded:: 23.0.0 (Wallaby)
1438+
1439+
.. rubric:: Options
1440+
1441+
.. option:: --force
1442+
1443+
Skip machine type compatability checks and force machine type update.
1444+
1445+
.. rubric:: Return codes
14341446

14351447
.. list-table::
14361448
:widths: 20 80
@@ -1445,7 +1457,7 @@ instance changing when moving between machine types.
14451457
* - 2
14461458
- Unable to find instance or instance mapping
14471459
* - 3
1448-
- The instance has an invalid vm_state
1460+
- The instance has an invalid ``vm_state``
14491461
* - 4
14501462
- The proposed update of the machine type is invalid
14511463
* - 5
@@ -1466,7 +1478,15 @@ This command is useful for operators attempting to determine when it is
14661478
safe to change the :oslo.config:option:`libvirt.hw_machine_type` option
14671479
within an environment.
14681480

1469-
**Return Codes**
1481+
.. versionadded:: 23.0.0 (Wallaby)
1482+
1483+
.. rubric:: Options
1484+
1485+
.. option:: --cell_uuid <cell_uuid>
1486+
1487+
The UUID of the cell to list instances from.
1488+
1489+
.. rubric:: Return codes
14701490

14711491
.. list-table::
14721492
:widths: 20 80
@@ -1475,13 +1495,14 @@ within an environment.
14751495
* - Return code
14761496
- Description
14771497
* - 0
1478-
- Completed successfully, no instances found without hw_machine_type
1498+
- Completed successfully, no instances found without ``hw_machine_type``
1499+
set
14791500
* - 1
14801501
- An unexpected error occurred
14811502
* - 2
14821503
- Unable to find cell mapping
14831504
* - 3
1484-
- Instances found without hw_machine_type set
1505+
- Instances found without ``hw_machine_type`` set
14851506

14861507

14871508
See Also

0 commit comments

Comments
 (0)