summaryrefslogtreecommitdiff
path: root/doc/source/cli
Commit message (Collapse)AuthorAgeFilesLines
* docs: Update docs to reflect deprecation statusStephen Finucane2022-04-061-6/+5
| | | | | Change-Id: I56b862305b31916cef143494050e5e08b1ac70b1 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Microversion 2.90 - Configurable hostnamesxena-em17.6.0Stephen Finucane2021-09-021-2/+24
| | | | | | Change-Id: Icd4362a07196e59bafcdfaff44323ce1386d4f55 Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Depends-On: https://review.opendev.org/c/openstack/nova/+/778550/
* Merge "[Trivial] FUP: Enhanced description for 'server list --config-drive' ↵Zuul2020-04-101-0/+2
|\ | | | | | | help"
| * [Trivial] FUP: Enhanced description for 'server list --config-drive' helpzhangbailin2020-04-101-0/+2
| | | | | | | | | | | | | | This commit mainly address comments in [1]. [1]https://review.opendev.org/#/c/718349/4/doc/source/cli/nova.rst@2321 Change-Id: I6010adbc895b4e2438f9f0729e3c89f37a69c8f8
* | FUP: Add volume-update CLI pre V285 testszhangbailin2020-04-101-1/+3
|/ | | | | | | | | This commit mainly to fix some comments from [1]. [1]https://review.opendev.org/#/c/712651/19/novaclient/tests/unit/v2/test_shell.py@4001 Blueprint: destroy-instance-with-datavolume Change-Id: Id809f22d0da2cdedf33a2c0df202f3953fd01673
* Microversion 2.85: Change volume-update CLIzhangbailin2020-04-091-8/+21
| | | | | | | | | | | | | This commit add a new CLI ``nova volume-update [--[no-]delete-on-termination] <server> <src_volume> <dest_volume>`` to update 'delete_on_termination' for an attached volume, that the user can decide whether to delete attached volumes when destroying the server. Depends-On: https://review.opendev.org/#/c/711194/ Change-Id: I1fc64fb6e6611c92c6b72265e1bf4b32e9c45f0a Blueprint: destroy-instance-with-datavolume
* Make 'server list --config-drive' a boolean optionStephen Finucane2020-04-081-5/+8
| | | | | | | | | | | | Instead of passing through whatever the user provides and exposing this bug in the REST API, simply make the opt a boolean one in expectation of a day where the API issues have been resolved. This also introduces machinery necessary to use more of these types of opts in the future. Change-Id: I9033540ac65ac0ee7337f16bdd002060652092ea Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Microversion 2.83 - Add more filters for the nova list commandVictor Coutellier2020-04-071-2/+35
| | | | | | | | | | | | | | | | | | | Add these new filters, admin-only until microversion 2.82: - availability-zone - config-drive - key-name - power-state - task-state - vm-state - progress Existing user filter will be available to non admin since microversion 2.83. Part of blueprint non-admin-filter-instance-by-az Change-Id: Id2b5e600c0a41790830823031b20983808cb5ace
* doc: Fix supported version descriptionsTakashi NATSUME2019-11-061-1/+6
| | | | | | | | Fix the version that the 'nova server-topology' command was added. Add some missing descriptions about supported versions. Change-Id: I32f9eca87c90211b0172b040649aad105298846b Closes-Bug: #1851443
* Add aggregate-cache-images command and client routinesDan Smith2019-10-181-0/+22
| | | | | | | | | | This adds the ability to request image precache support for an aggregate in support of the matching server feature. Related to blueprint image-precache-support Depends-On: https://review.opendev.org/#/c/687140 Change-Id: Id354ccfa99e500a598685e6b794c12160ea2a990
* Microversion 2.80: Add user_id/project_id to migration-list APIzhangbailin2019-10-161-0/+10
| | | | | | | | | | | | | | Add ``user_id`` and ``project_id`` to the ``GET /os-migrations`` API, and it can called ``--user-id <user_id>`` and/or ``--project-id <project_id>`` by ``nova migration-list`` CLI. Showing the ``user_id`` and ``project_id`` when using api_version>=2.80 with the server-migration-list or server-migration-show APIs. Depends-On: https://review.opendev.org/#/c/674243/ Part of blueprint add-user-id-field-to-the-migrations-table Change-Id: I11343ca265ab2b6b6f46877897d8223ef340c258
* Merge "Clarify --migration-type migration value as cold migration"Zuul2019-10-091-0/+3
|\
| * Clarify --migration-type migration value as cold migrationMatt Riedemann2019-08-261-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a follow up to a review discussion [1] where the "migration" value for the --migration-type option is for a cold migration. This change just updates docs and help strings. An alternative is changing "migration" as a valid value to "cold-migration" (or accept both) and under the covers treat "cold-migration" as "migration" for the actual API call. [1] https://review.opendev.org/#/c/675117/3/novaclient/v2/shell.py@5430 Related to blueprint more-migration-list-filters Change-Id: I6baa6af8731252e3c4976db06f0ca9cdfcb5e2f1
* | Remove cells v1 and extension commands and APIsTakashi NATSUME2019-10-041-55/+0
| | | | | | | | | | | | | | | | | | | | | | | | The following CLIs and their backing API bindings which have been deprecated since 20.0.0 Train release have now been removed. - list-extensions - cell-capacities - cell-show Change-Id: I8e6edf1e4c1bf12d51ed993363129b4f4c3aa36c
* | Add a check for --config-drive option on nova bootTakashi NATSUME2019-09-181-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | A value of the '--config-drive' option must be a boolean value on the 'nova boot' command because nova accepts a boolean value only for the 'config_drive' parameter. So add a check for the '--config-drive' option on the 'nova boot' command. Fix a description for 'config_drive' parameter in the 'create' method of the novaclient.v2.ServerManager class. Change-Id: Ic6e65139302fbb662fb6ba60e73633dad8ffb72e Closes-Bug: #1825061
* | doc: Add support microversions for optionsTakashi NATSUME2019-09-101-0/+2
| | | | | | | | | | | | | | | | | | Add descriptions of support microversions for the '--marker' option and the '--limit' option in the 'nova hypervisor-list' command in the CLI reference. Change-Id: Ie25e848b51fd0220e318393db123c97b4a642091 Closes-Bug: #1616450
* | Microversion 2.79: Add delete_on_termination to volume-attach API15.1.0zhangbailin2019-09-091-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Support add 'delete_on_termination' field to the voume attach API to support configuring whether to delete the data volume when the server is destroyed. * Updating the ``nova volume-attachments`` command to show the ``delete_on_termination`` value if 2.79 or greater is used. * The '--delete-on-termination' option is added to the `nova volume-attach` CLI. Depends-On: https://review.opendev.org/#/c/673133/ Part of blueprint support-delete-on-termination-in-server-attach-volume Change-Id: I8dcf2fd21a2fd99ca4e05bd953fbbe026be3a619
* | Microversion 2.78 - show server topologyYongli He2019-09-061-0/+23
| | | | | | | | | | | | | | | | | | | | | | Add support microversion 2.78 which adds server topology information in the output of the following new command: nova server-topology Depends-on: https://review.opendev.org/#/c/621476/ Change-Id: I6467d52d2528a37348458baf4842b571a97f3ed2 Implements: blueprint show-server-numa-topology
* | Merge "Microversion 2.77: Support Specifying AZ to unshelve"15.0.0Zuul2019-08-291-1/+7
|\ \ | |/ |/|
| * Microversion 2.77: Support Specifying AZ to unshelvezhangbailin2019-08-281-1/+7
| | | | | | | | | | | | | | | | | | | | | | This patch adds a new parameter ``--availability-zone`` to ``nova unshelve`` command. This can help users to specify an ``availability_zone`` to unshelve a shelve offloaded server from 2.77 microversion. Depends-On: https://review.opendev.org/#/c/663851/ Implements: blueprint support-specifying-az-when-restore-shelved-server Change-Id: I8bce8f430bc54f03bacc105e37fc8b3bbf2432c2
* | Add --migration-type and --source-compute to migration-listMatt Riedemann2019-08-081-3/+27
|/ | | | | | | | | | | | | | | | | | The GET /os-migrations API take a migration_type and source_compute filter parameter on the request since the v2.0 API. This adds support for specifying those parameters in the "nova migration-list" CLI and related MigrationManager.list() python API binding methods. A functional test is added which will cover the new options on all three of the decorated do_migration_list shell methods with lower bounds on 2.1, 2.59 and 2.66. Since the only type of migration we can safely generate in a single-node CI job is a resize the test does a resize. As such, _pick_alternate_flavor is moved into the base test class for re-use. Implements blueprint more-migration-list-filters Change-Id: I4be9a06df3e0d40d3990d067ce112247a81b45b4
* docs: clarify nova migration-list --host optionMatt Riedemann2019-08-071-1/+1
| | | | | | | | | | The GET /os-migrations API takes both a host and source_compute filter parameter. The former filters on either the source or destination compute, so this change clarifies that in the command help for the --host option. Change-Id: I078add63896c7455be7e3672b7172debb962a5e2
* Add host and hypervisor_hostname to create serverszhu.boxiang2019-07-081-0/+10
| | | | | | | | | | Adds the --host and --hypervisor-hostname options to the nova boot command and related python API bindings. Depends-On: https://review.opendev.org/#/c/645520/ Change-Id: If16d00b75f4d5f2b96aa6e3f32a973108049d928 Blueprint: add-host-and-hypervisor-hostname-flag-to-create-server
* Add a description of --on-shared-storageTakashi NATSUME2019-05-271-1/+5
| | | | | | | | Add a description of --on-shared-storage option in the 'nova evacuate' command in the CLI reference. Change-Id: I4069b804b434b70ee6d0098831af748e47913ce3 Closes-Bug: #1829932
* [Docs] Update client docs to add reason and locked optionsSurya Seetharaman2019-05-141-1/+16
| | | | | | | | | | This patch adds information about the ``locked`` filter/sorting key and the ``reason`` options that were added in https://review.opendev.org/#/c/648659/. Related to blueprint add-locked-reason Change-Id: I11cc4bd7cee0f03d4398f91bb3790c4c681061f4
* Add test for console-log and docs for bug 1746534Matt Riedemann2019-04-111-0/+27
| | | | | | | | | | | | | | | | | | | | | We had no unit test coverage for the console-log command so this adds a simple test. It unfortunately does not recreate the original UnicodeEncodeError bug though, but it gives us some test coverage anyway. This change also adds docs on how to resolve bug 1746534 by configuring the environment for UTF-8 as noted in the revert change Iaeec1e74262a35f3de3c81f7013835a6aa6f9029. The documentation added here is shamelessly copied from Click [1] which was found via the PEP 538 docs [2]. [1] https://click.palletsprojects.com/en/5.x/python3/#python-3-surrogate-handling [2] https://www.python.org/dev/peps/pep-0538/ Change-Id: Ic7059260dfc031ea1b08d2b8a7cec684bbe7dfa5 Related-Bug: #1823287 Related-Bug: #1746534
* Remove deprecated optionsTakashi NATSUME2019-03-211-8/+4
| | | | | | | | | Remove the following deprecated options. * --endpoint-override * --instance-name ('nova list' command) Change-Id: Ic6a78f04a98c1616750e6ecd6225f2750c214dd7
* Add support for microversion v2.7213.0.0Lajos Katona2019-03-061-0/+4
| | | | | | | | | | | | | This microversion in Nova is added to support Neutron ports having resource request during server create to guarantee minimum bandwidth QoS. This is a behavior-only change in the compute API, there are no changes to the server create request or response schema. Change-Id: I1a39390015acd8703e8bab55af13f5c75ae226db Depends-On: https://review.openstack.org/636360 Partial-Bug: #1578989 See-Also: https://review.openstack.org/502306 (nova spec) See-Also: https://review.openstack.org/508149 (neutron spec)
* Merge "Add a note in "nova service-delete" help about deleting computes"Zuul2019-02-261-0/+6
|\
| * Add a note in "nova service-delete" help about deleting computesMatt Riedemann2019-01-151-0/+6
| | | | | | | | | | | | | | | | | | This mirrors the note in the API reference from change I68f2074814c3ae890888a5c75fd2870bb99f0e08 to the service-delete CLI help and docs. Change-Id: I191f6e6a4b7c6c456afbd33b0256842b043c772e Related-Bug: #1646255
* | API microversion 2.69: Handles Down CellsSurya Seetharaman2019-02-201-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch explicitly points out the change needed while forming the detailed lists for embedded flavor information. In those cases where the server response for nova list has the flavor key missing for the instances in the down cell, the servers will be skipped. Depends-On: https://review.openstack.org/591657/ Related to blueprint handling-down-cell Change-Id: I007d9a68309b0d3aa85a4edf5026043154d4f42a
* | Microversion 2.68: Remove 'forced' live migrations, evacuationsStephen Finucane2019-02-131-4/+4
|/ | | | | | | | | | | Update the commands and Python API bindings to reflect the new microversion. The various evacuate microversion functions are DRY'd up along the way. Change-Id: Ibfc905292258ffde05800387e5d6bbad4823085c Signed-off-by: Stephen Finucane <sfinucan@redhat.com> Depends-On: https://review.openstack.org/#/c/634600/ Implements: blueprint remove-force-flag-from-live-migrate-and-evacuate
* Replace MB with MiBTakashi NATSUME2018-10-221-5/+5
| | | | Change-Id: Ie5bd325d8e0f7e9af76c1ddae1d679b0e797c84b
* Recommend against using --force for evacuate/live migration11.1.0Matt Riedemann2018-10-171-10/+32
| | | | | | | | | | | | | | This copies the same warnings from the API reference change I85e7c2677f4d5eccc1e7f349de06960b53ef148d to the CLI help for the various evacuate/live migrate commands. It also mentions that if a host is not specified, one is selected by the scheduler (which is what we really want people doing). Given blueprint remove-force-flag-from-live-migrate-and-evacuate we really want to discourage people from using the --force flag. Change-Id: I15ef933cc09947e2bb3fb7bf17b15735171a9bec
* Add support for microversion 2.67: BDMv2 volume_typeMatt Riedemann2018-10-141-3/+7
| | | | | | | | | | | | | This adds the nova boot command and python API binding support for creating a server with block device mappings defined using a specific volume type. Depends-On: https://review.openstack.org/606398/ Depends-On: https://review.openstack.org/#/c/610349/ Part of blueprint boot-instance-specific-storage-backend Change-Id: I484ee065119b5783db212ea64efa60e87c40338c
* doc: Start using openstackdoctheme's extlink extensionTakashi NATSUME2018-10-091-3/+2
| | | | | | | | This ensures we have version-specific references to other projects [1]. [1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper Change-Id: I3b9db8b71c082dd5f8d0564a9cdfdb2fa6dc5ed6
* Update the CLI referenceTakashi NATSUME2018-10-021-165/+199
| | | | | | | | | | | | | Update the CLI reference according to the latest CLIs. The CLI reference (doc/source/cli/nova.rst) has been imported from openstack-manuals since If19cfcafc90fddb930c124a5b9845d4eae1f6093. We can update the CLI reference synchronously with changing the CLIs currently. So remove the description of nova CLI version in the reference. Change-Id: Icb97def5e4d65a31add7c60c205d5f9f0dfc4520 Closes-Bug: #1795283
* Add support changes-before for microversion 2.66zhangbailin2018-09-241-7/+27
| | | | | | | | | | | | | | This adds the changes-before filter to the servers, os-instance-actions and os-migrations list for filtering resources which were last updated before or equal to the given time. The changes-before filter, like the changes-since filter, will return deleted server resources. Depends-On: https://review.openstack.org/599276/ Part of bp support-to-query-nova-resources-filter-by-changes-before Change-Id: I7c6ea00303374d605bda8ef1b62c5de1b4567696
* Improve the description of optional argumentsTakashi NATSUME2018-09-121-5/+5
| | | | | | | | | | This patch is a follow-up patch for Ib4ce831a5031459d350fa73601e878e7b319640f. Improve the description of optional arguments in the CLI reference and help text. Change-Id: I6313b8a584385daa7e9fbd558d431faa43015449
* Add missing options in CLI referenceTakashi NATSUME2018-09-111-2/+38
| | | | | | | | | | | | | | | | | Add the following missing options in the CLI reference. * nova instance-action-list - marker - limit - changes-since * nova migration-list - marker - limit - changes-since Change-Id: Ib4ce831a5031459d350fa73601e878e7b319640f Closes-Bug: #1791125
* Merge "Add support for microversion 2.65"Zuul2018-07-211-0/+4
|\
| * Add support for microversion 2.65Matt Riedemann2018-07-181-0/+4
| | | | | | | | | | | | | | | | | | | | | | There are no functional changes for this, just bumping the supported client-side version and updating docs. Depends-On: https://review.openstack.org/573136/ Part of blueprint abort-live-migration-in-queued-status Change-Id: Ie0777dbe4d82892ec75b353f6b13ee2d2c5db72c
* | Merge "Fix inconsistency"Zuul2018-07-191-2/+2
|\ \
| * | Fix inconsistencyChen2018-07-191-2/+2
| | | | | | | | | | | | | | | | | | Replace "of"s with "off"s to be consistent with the rest. Change-Id: I4a99e733f9ecdbc080f1158b8c90af888d619cdc
* | | Merge "Microversion 2.64 - Use new format policy in server group"Zuul2018-07-191-2/+10
|\ \ \ | | |/ | |/|
| * | Microversion 2.64 - Use new format policy in server groupYikun Jiang2018-07-181-2/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added support for microversion 2.64, which includes the following changes: - The ``--rule`` option is added to the ``nova server-group-create`` CLI that enables user to create server group with specific policy rules. - Remove ``metadata`` column in the output of ``nova server-group-create``, ``nova server-group-get``, ``nova server-group-list``. - Remove ``policies`` column, , add ``policy`` and ``rules`` columns in the output of ``nova server-group-create``, ``nova server-group-get``, ``nova server-group-list``. Depends-On: 3cd26f1e68b09ba7925e794ac8912566c239b6df blueprint: complex-anti-affinity-policies Change-Id: I903f4b5544806b9d3c8bac529448abbc9dd3cee9
* | | Rename --endpoint-override to --os-endpoint-overrideTakashi NATSUME2018-07-091-3/+3
|/ / | | | | | | | | | | | | | | | | | | | | | | The ``--endpoint-override`` command line argument has been deprecated. It is renamed to ``--os-endpoint-override`` to avoid misinterpreting command line arguments. It defaults to the ``OS_ENDPOINT_OVERRIDE`` environment variable. The deprecated ``--bypass-url`` command line argument has been removed. Change-Id: Ic8a6559cd62d46b837fa9c04b482a46ceba829db Closes-Bug: #1778536
* | Merge "Fix trusted-image-certificate-id help text"Zuul2018-06-221-1/+1
|\ \
| * | Fix trusted-image-certificate-id help textBrianna Poulos2018-06-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Fix the help text for nova boot to include that a parameter is expected for trusted-image-certificate-id. Also update the UnsupportedAttribute error to mention the env variable to reduce confusion. Change-Id: Ic5980b610e5fd97d3a858a2a513e2863657f36c2
* | | Fix help text in server-group-createChen2018-06-221-1/+1
|/ / | | | | | | | | | | | | Only one policy is allowed in server-group-create. Change-Id: Id9cb6f96a5f8bcece1bcda88a97c6fb5f8a58bba Related-Bug: #1767287
View Lorry Controller Status