summaryrefslogtreecommitdiff
path: root/doc/source/cli
Commit message (Collapse)AuthorAgeFilesLines
* image: Add 'image stage' commandStephen Finucane2022-11-091-1/+1
| | | | | | | This is the equivalent of the 'image-stage' glanceclient command. Change-Id: I10b01ef145740a2f7ffe5a8c7ce0296df0ece0bd Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Merge "quota: Add 'quota show --usage' option"Zuul2022-10-121-1/+1
|\
| * quota: Add 'quota show --usage' optionStephen Finucane2022-09-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | Provide an more sane way to get usage information for a particular project's quotas. This requires using the 'Lister' command type since the 'ShowOne' command type only allows for simple key-value pair output. We also add a note indicating that the '<project>' argument is optional. Change-Id: Ic7342cf08f024cc690049414c5eef5b9a7594677 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "quota: Add support for detailed volume quotas"Zuul2022-10-071-1/+1
|\ \ | |/
| * quota: Add support for detailed volume quotasStephen Finucane2022-09-301-1/+1
| | | | | | | | | | | | | | | | We were stating that this was not supported. That is not true. Correct the oversight. Change-Id: Ib9d9db641a18e142be0a1eccff783e7cccdf2db5 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "quota: Add 'quota delete' command"Zuul2022-10-073-3/+3
|\ \ | |/
| * quota: Add 'quota delete' commandStephen Finucane2022-09-303-3/+3
| | | | | | | | | | | | | | | | | | We had previously indicated that people use 'quota set' for unsetting a project's quotas, however, there was nothing that actually allowed us to do this. Correct that oversight. Change-Id: I04057e766b8ccf94bf219972249b68dc2bb796d4 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "doc: Update cinder command mapping"Zuul2022-10-071-1/+1
|\ \ | |/
| * doc: Update cinder command mappingStephen Finucane2022-09-301-1/+1
| | | | | | | | | | | | | | | | | | I had incorrectly marked the 'api-version' command as WONTFIX. Turns out we already support this, albeit via keystone as opposed to a cinder-specific API. Change-Id: I804ef1ca5a0f4df844d8c2229688c4edbac45aa9 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "docs: Add missing command mappings"Zuul2022-09-302-6/+6
|\ \
| * | docs: Add missing command mappingsStephen Finucane2022-07-072-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The 'neutron tag-replace' command is equivalent to the 'openstack network set --no-tag --tag <tag> [--tag <tag> ...]' command. '--no-tag' will unset all tags while '--tag <tag>' will set a new tag and can be specified multiple times. The 'nova hypervisor-uptime' command is equivalent to the 'openstack hypervisor show' command. Before compute microversion 2.88, the nova command was using a different API that returned an almost identical output to 'nova hypervisor-show' except it included an 'uptime' field. Since 2.88, this field is returned in the standard call. OSC abstracts this detail away so the 'uptime' field is always present, removing the need for a separate command. The 'nova migration-list' command is implemented as 'openstack server migration list' (simply omit the '--server' filter). The 'nova volume-update' command is implemented as 'openstack server volume update'. The 'nova volume-attachments' command is actually available as 'openstack server volume list', though you can also use 'server show'. The 'nova aggregate-cache-images' corresponds to an internal API that only glance should be using. It doesn't need to be exposed via openstackclient. Change-Id: Icdbc42762230954f6f7f2064b6228416af41d45a Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "image: Add 'image task list' command"Zuul2022-09-301-2/+2
|\ \ \
| * | | image: Add 'image task list' commandStephen Finucane2022-09-211-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This replaces the 'glance task-list' command. $ openstack image task list We also indicate that the 'image task create' command will never be implemented. This is an admin-only API that isn't really intended to be used by humans thus it does not need an OSC command implementation. Change-Id: Id8a943a5443782fc70c0fbf3639f5aa17b9d30af
* | | | Merge "image: Add 'image task show' commands"Zuul2022-09-301-1/+1
|\ \ \ \ | |/ / / | | | / | |_|/ |/| |
| * | image: Add 'image task show' commandslsmman2022-09-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | This replaces and the 'glance task-show' command. For example: $ image task show <TASK_ID> Change-Id: I74cb23e436c373fe238804b903bbeb28f643d5af
* | | Adding missing command mapping in docszeze2022-09-163-3/+3
|/ / | | | | | | | | | | | | | | | | | | | | | | | | nova command: version-list openstack command: versions show --service compute cinder command: version-list openstack command: versions show --service block-storage glance command: member-list openstack command: image member list Change-Id: I3c68dbd47dc92ed190ae9abaa90dfcddef072728
* | Merge "Fix documents for replaced configuration name"Zuul2022-08-312-7/+7
|\ \
| * | Fix documents for replaced configuration nameSnow Kim2022-08-052-7/+7
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since 4.0, '--os-url' global option is no longer supported. And this option had been replaced to '--os-endpoint' - Refer Change-Id: I1b9fbb96e447889a41b705324725a2ffc8ecfd9f - Refer Docs: doc/source/cli/backwards-incompatible.rs I fixed in documents as below - OPTIONS: '--os-url' to '--os-endpoint' - ENVIRONMENT VARIABLES: 'OS_URL' to 'OS_ENDPOINT' - and relevant sentence Change-Id: Ibb0cddf34375df941678ee07a005d81399ec7195
* | Add router ndp proxy commandsYang JianFeng2022-08-261-0/+12
| | | | | | | | | | | | Depends-on: https://review.opendev.org/749036 Change-Id: I77e12cc2dfe4000bd5ae6511878c6591f52d9791 Related-Bug: #1877301
* | Update the Nova CLI Mapping GuideYoonsoo Lim2022-07-311-1/+1
|/ | | | | | | | | | Update missing command in Mapping Guide. List of updated command [Nova CLI / OSC] instance-action-list / server event list Change-Id: I1436a6c1bdd881890e015cf0f1829c38378b36fa
* volume: Add 'block storage resource filter list' commandStephen Finucane2022-05-133-1/+10
| | | | | | | | | | | | | | | | | | | | | These are based on the 'cinder list-filters' command, which accepts an optional '--resource {resource}' option to limit the listed filters to a single resource type. block storage resource filter list block storage resource filter show We used the 'block storage resource filter' terminology rather than simply 'resource filter' to highlight the fact that this is specific to the block storage service. Note that while this feature is a bit weird, good documentation can be found at [1]. [1] https://docs.openstack.org/cinder/latest/admin/generalized_filters.html Change-Id: I21e7c0ea427aef1f6665394d4b8e9a1f30d6dbb1 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* volume: Add 'block storage cluster *' commandsStephen Finucane2022-05-133-4/+13
| | | | | | | | | | | | | | | | | These mirror the 'cinder cluster-*' commands, with arguments copied across essentially verbatim. The only significant departure is the replacement of "tenant" terminology with "project". block storage cluster list block storage cluster set block storage cluster show We used the 'block storage' terminology rather than simply 'volume' to allow us to start distinguishing between the volume service and a volume resource. Change-Id: I9105a9e4a139af4929e3b1f3a6de6c9a53e0b598 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Merge "docs: Document additional 'server migration' commands"Zuul2022-02-091-1/+1
|\
| * docs: Document additional 'server migration' commandsStephen Finucane2022-02-081-1/+1
| | | | | | | | | | | | | | Only 'server migration list' was being documented. Change-Id: I038ff2bcf7bb852d619004bb00306d2d388135a7 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Add missing command mapping in nova"Zuul2022-02-091-1/+1
|\ \
| * | Add missing command mapping in novaJieonLee2021-11-211-1/+1
| | | | | | | | | | | | | | | | | | | | | nova command: instance-action openstack command: server event show Change-Id: I8e5dad90cfd28b1f0d65be688651918869f679e4
* | | Support Neutron Local IP CRUDNurmatov Mamatisa2022-01-282-0/+23
| |/ |/| | | | | | | | | | | | | | | Add support for Neutron Local IP CRUD operations. Partial-Bug: #1930200 Depends-On: https://review.opendev.org/c/openstack/neutron/+/804523 Depends-On: https://review.opendev.org/c/openstack/openstacksdk/+/804988 Change-Id: I1095100efb27b8559412469f0a9d07fc0a3db9d5
* | Temporarily drop aodhclient from doc buildDr. Jens Harbott2021-11-242-5/+4
|/ | | | | | | | | | Building plugin documentation is failing for aodhclient when running with latest pyparsing. Drop the plugin from docs for now until the issue can be fixed. Needed-By: https://review.opendev.org/c/openstack/requirements/+/818614/ Signed-off-by: Dr. Jens Harbott <harbott@osism.tech> Change-Id: I1cc1efd9ff2004dd711ed9da0b1d9e8be31175f4
* Merge "Update the Nova CLI docoder document"Zuul2021-10-211-4/+4
|\
| * Update the Nova CLI docoder documentJIHOJU2021-10-071-4/+4
| | | | | | | | | | | | | | | | There are several update in CLI decoder document. - Change flavor set/unset to flavor set/unset --property - Update the mapping with flavor-update, interface-attach, and interface-detach Change-Id: I1db50188b3643d3fe28689dc73b3f63806defd29
* | Update the Nova CLI decoder documentchoidoa-git2021-10-071-15/+15
|/ | | | | | | | | | | | | | | | | | | | | | | | In this patch, Update missing command in Mapping Guide. List of updated commands (Nova CLI / OSC) - server-migration-list / server migration list - server-migration-show / server migration show - live-migration-abort / server migration abort - live-migration-force-complete / server migration force complete - migration-list / server migration list - evacuate / server evacuate - flavor-access-add / flavor set --project - flavor-access-list / flavor show - flavor-access-remove / flavor unset - server-tag-add / server set --tag - server-tag-delete / server unset --tag - server-tag-delete-all / server unset --tag - server-tag-list / server list --tag - server-tag-set / server set --tag - quota-class-show / quota show --class Change-Id: Id1b4980fbc0f6e8e58bfae6f393f9336c6a7e3b1
* Merge "Update volume create documentation"Zuul2021-08-191-19/+0
|\
| * Update volume create documentationPierre Riteau2021-03-091-19/+0
| | | | | | | | | | | | Change I94aa7a9824e44f9585ffb45e5e7637b9588539b4 removed these options. Change-Id: I43d84b5532ae6570e1486867c03b8ebec81e38e4
* | Merge "volume: Add 'volume group snapshot *' commands"Zuul2021-06-213-4/+13
|\ \
| * | volume: Add 'volume group snapshot *' commandsStephen Finucane2021-06-103-4/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These mirror the 'cinder group-snapshot-*' commands, with arguments copied across essentially verbatim. The only significant departure is the replacement of "tenant" terminology with "project". volume group snapshot create volume group snapshot delete volume group snapshot list volume group snapshot show Change-Id: Ia5084749b7c1a5a936fd6d6e8d89b9b80969f68c Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "volume: Add 'volume group type *' commands"Zuul2021-06-213-8/+17
|\ \ \ | |/ /
| * | volume: Add 'volume group type *' commandsStephen Finucane2021-06-033-8/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These mirror the 'cinder group-type-*' commands, with arguments copied across essentially verbatim. The only significant departure is the merging of some commands, such as 'group-type-default' and 'group-type-list' into 'group type list', and 'group-type-update' and 'group-type-key' into 'group type set/unset'. volume group type create volume group type delete volume group type list volume group type show volume group type set volume group type unset Change-Id: Iee6ee2f1f276e6ef6f75a74f8f2980f14c0d5e2f Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "volume: Add 'volume group *' commands"Zuul2021-06-183-9/+33
|\ \ \ | |/ /
| * | volume: Add 'volume group *' commandsStephen Finucane2021-06-033-9/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These mirror the 'cinder group-*' commands, with arguments copied across essentially verbatim. The only significant departures are the replacement of "tenant" terminology with "project" and the merging of the various volume group replication action commands into the parent volume group (e.g. 'openstack volume group set --enable-replication' instead of 'cinder group enable-replication') volume group create volume group delete volume group list volume group show volume group set volume group failover Change-Id: I3b2c0cb92b8a53cc1c0cefa3313b80f59c9e5835 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "volume: Add missing 'volume backup *' options"Zuul2021-06-181-1/+1
|\ \ \ | |/ /
| * | volume: Add missing 'volume backup *' optionsStephen Finucane2021-06-031-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a couple of missing options to each command: volume backup create --no-incremental --property --availability-zone volume backup set --property Most of these are version dependent so we add the relevant version checks as part of this work. While we're here, we also make the formatting a little easier on the eye in places. Change-Id: I328d5c981cb32b2ee9a4b1bd43aa36b22347ff63 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "volume: Add 'volume message *' commands"Zuul2021-06-183-3/+12
|\ \ \ | |/ /
| * | volume: Add 'volume message *' commandsStephen Finucane2021-06-033-3/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch implements the necessary commands to utilize the Messages API introduced in Cinder API version 3.3. Version 3.5 built upon this by implementing pagination support for these commands which is present in this patch as well. volume message get volume message list volume message delete Change-Id: I64aa0b4a8d4468baa8c63e5e30ee31de68df999d
* | | Merge "volume: Add 'volume attachment *' commands"Zuul2021-06-183-9/+18
|\ \ \ | |/ /
| * | volume: Add 'volume attachment *' commandsStephen Finucane2021-06-033-9/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | These mirror the 'cinder attachment-*' commands, with arguments copied across essentially verbatim. The only significant departure is the replacement of "tenant" terminology with "project". volume attachment create volume attachment delete volume attachment list volume attachment complete volume attachment set volume attachment show Full support for filtering is deferred for now since that's a more complicated change that requires additional commands be added first. TODOs are included to this effect. Change-Id: If47c2b56fe65ee2cee07c000d6ae3688d5ef3b42 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "docs: Update neutronclient comparison doc"Zuul2021-06-161-8/+26
|\ \ \ | |/ /
| * | docs: Update neutronclient comparison docStephen Finucane2021-06-031-8/+26
| | | | | | | | | | | | | | | | | | | | | | | | Done manually by looking at the help text for the 'neutron' client (version 7.1.1) and identifying gaps. Change-Id: Ib029b2c236f79a0ca6f64834f069db2be4332ea8 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "docs: Update glanceclient comparison doc"Zuul2021-06-161-0/+36
|\ \ \ | |/ /
| * | docs: Update glanceclient comparison docStephen Finucane2021-06-031-0/+36
| | | | | | | | | | | | | | | | | | | | | | | | Done manually by looking at the help text for the 'glance' client (version 3.1.1) and identifying gaps. Change-Id: Ic46bbdef7182e5f707cd5083868886ce60c7eb47 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | | Merge "docs: Update novaclient comparison doc"Zuul2021-06-161-26/+11
|\ \ \ | |/ /
View Lorry Controller Status