diff options
Diffstat (limited to 'doc/source/cli/nova-manage.rst')
| -rw-r--r-- | doc/source/cli/nova-manage.rst | 101 |
1 files changed, 96 insertions, 5 deletions
diff --git a/doc/source/cli/nova-manage.rst b/doc/source/cli/nova-manage.rst index a13289b2e8..53152a0a6f 100644 --- a/doc/source/cli/nova-manage.rst +++ b/doc/source/cli/nova-manage.rst @@ -258,17 +258,17 @@ stopping at 0, or use the :option:`--until-complete` option. ``YYYY-MM-DD[HH:mm:ss]``. For example:: # Purge shadow table rows older than a specific date - nova-manage db archive --before 2015-10-21 + nova-manage db archive_deleted_rows --before 2015-10-21 # or - nova-manage db archive --before "Oct 21 2015" + nova-manage db archive_deleted_rows --before "Oct 21 2015" # Times are also accepted - nova-manage db archive --before "2015-10-21 12:00" + nova-manage db archive_deleted_rows --before "2015-10-21 12:00" Note that relative dates (such as ``yesterday``) are not supported natively. The ``date`` command can be helpful here:: # Archive deleted rows more than one month old - nova-manage db archive --before "$(date -d 'now - 1 month')" + nova-manage db archive_deleted_rows --before "$(date -d 'now - 1 month')" .. option:: --verbose @@ -521,6 +521,7 @@ This command should be run before ``nova-manage db sync``. .. _man-page-cells-v2: + Cells v2 Commands ================= @@ -1144,6 +1145,7 @@ Delete a host by the given host name and the given cell UUID. * - 4 - The host with the specified name has instances (host not empty). + Placement Commands ================== @@ -1531,6 +1533,7 @@ command. * - 6 - Instance is not attached to volume + Libvirt Commands ================ @@ -1604,7 +1607,7 @@ instance changing when moving between machine types. .. option:: --force - Skip machine type compatability checks and force machine type update. + Skip machine type compatibility checks and force machine type update. .. rubric:: Return codes @@ -1669,12 +1672,100 @@ within an environment. - Instances found without ``hw_machine_type`` set +Image Property Commands +======================= + +image_property show +------------------- + +.. program:: nova-manage image_property show + +.. code-block:: shell + + nova-manage image_property show [INSTANCE_UUID] [IMAGE_PROPERTY] + +Fetch and display the recorded image property ``IMAGE_PROPERTY`` of an +instance identified by ``INSTANCE_UUID``. + +.. versionadded:: 25.0.0 (Yoga) + +.. rubric:: Return codes + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Return code + - Description + * - 0 + - Successfully completed + * - 1 + - An unexpected error occurred + * - 2 + - Unable to find instance or instance mapping + * - 3 + - No image property found for instance + +image_property set +------------------ + +.. program:: nova-manage image_property set + +.. code-block:: shell + + nova-manage image_property set \ + [INSTANCE_UUID] [--property] [IMAGE_PROPERTY]=[VALUE] + +Set or update the recorded image property ``IMAGE_PROPERTY`` of instance +``INSTANCE_UUID`` to value ``VALUE``. + +The following criteria must be met when using this command: + +* The instance must have a ``vm_state`` of ``STOPPED``, ``SHELVED`` or + ``SHELVED_OFFLOADED``. + +This command is useful for operators who need to update stored instance image +properties that have become invalidated by a change of instance machine type, +for example. + +.. versionadded:: 25.0.0 (Yoga) + +.. rubric:: Options + +.. option:: --property + + Image property to set using the format name=value. For example: + ``--property hw_disk_bus=virtio --property hw_cdrom_bus=sata``. + +.. rubric:: Return codes + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Return code + - Description + * - 0 + - Update completed successfully + * - 1 + - An unexpected error occurred + * - 2 + - Unable to find instance or instance mapping + * - 3 + - The instance has an invalid ``vm_state`` + * - 4 + - The provided image property name is invalid + * - 5 + - The provided image property value is invalid + + See Also ======== :doc:`nova-policy(1) <nova-policy>`, :doc:`nova-status(1) <nova-status>` + Bugs ==== |