openstack/python-openstackclient
Code Issues Proposed changes

docs: Add missing command mappings

Browse Source 
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>
This commit is contained in:
Stephen Finucane
2022-07-07 13:39:00 +01:00
parent 366e164738
commit 722d3216a4
2 changed files with 6 additions and 6 deletions
doc/source/cli/data
neutron.csvnova.csv

2
doc/source/cli/data/neutron.csv

@ -230,7 +230,7 @@ subnetpool-show,subnet pool show,Show information of a given subnetpool.
subnetpool-update,subnet pool set / subnet pool unset,Update subnetpool's information.
tag-add,network set --tag,Add a tag into the resource.
tag-remove,network unset --tag,Remove a tag on the resource.
tag-replace,,Replace all tags on the resource.
tag-replace,network set --no-tag --tag,Replace all tags on the resource.
vpn-endpoint-group-create,,Create a VPN endpoint group.
vpn-endpoint-group-delete,,Delete a given VPN endpoint group.
vpn-endpoint-group-list,,List VPN endpoint groups that belong to a given tenant.

1 address-scope-create address scope create Create an address scope for a given tenant.
230 subnetpool-update subnet pool set / subnet pool unset Update subnetpool's information.
231 tag-add network set --tag Add a tag into the resource.
232 tag-remove network unset --tag Remove a tag on the resource.
233 tag-replace network set --no-tag --tag Replace all tags on the resource.
234 vpn-endpoint-group-create Create a VPN endpoint group.
235 vpn-endpoint-group-delete Delete a given VPN endpoint group.
236 vpn-endpoint-group-list List VPN endpoint groups that belong to a given tenant.

10
doc/source/cli/data/nova.csv

@ -4,7 +4,7 @@ agent-delete,compute agent delete,Delete existing agent build.
agent-list,compute agent list,List all builds.
agent-modify,compute agent set,Modify existing agent build.
aggregate-add-host,aggregate add host,Add the host to the specified aggregate.
aggregate-cache-images,,Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version]
aggregate-cache-images,WONTFIX,Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version]
aggregate-create,aggregate create,Create a new aggregate with the specified details.
aggregate-delete,aggregate delete,Delete the aggregate.
aggregate-list,aggregate list,Print a list of all aggregates.
@ -44,7 +44,7 @@ hypervisor-list,hypervisor list,List hypervisors. (Supported by API versions '2.
hypervisor-servers,,List servers belonging to specific hypervisors.
hypervisor-show,hypervisor show,Display the details of the specified hypervisor.
hypervisor-stats,hypervisor stats show,Get hypervisor statistics over all compute nodes.
hypervisor-uptime,,Display the uptime of the specified hypervisor.
hypervisor-uptime,hypervisor show,Display the uptime of the specified hypervisor.
image-create,server image create,Create a new image by taking a snapshot of a running server.
instance-action,server event show,Show an action.
instance-action-list,,List actions on a server.
@ -65,7 +65,7 @@ live-migration-force-comp,server migration force complete,Force on-going live mi
lock,server lock,Lock a server.
meta,server set --property / unset,Set or delete metadata on a server.
migrate,server migrate,Migrate a server. The new host will be selected by the scheduler.
migration-list,,Print a list of migrations.
migration-list,server migration list,Print a list of migrations.
pause,server pause,Pause a server.
quota-class-show,quota show --class,List the quotas for a quota class.
quota-class-update,quota set --class,Update the quotas for a quota class.
@ -120,8 +120,8 @@ usage,usage show,Show usage data for a single tenant.
usage-list,usage list,List usage data for all tenants.
version-list,,List all API versions.
volume-attach,server add volume,Attach a volume to a server.
volume-attachments,server show,List all the volumes attached to a server.
volume-attachments,server volume list,List all the volumes attached to a server.
volume-detach,server remove volume,Detach a volume from a server.
volume-update,,Update volume attachment.
volume-update,server volume update,Update volume attachment.
bash-completion,complete,Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them.
help,help,Display help about this program or one of its subcommands.

1 add-secgroup server add security group Add a Security Group to a server.
4 agent-list compute agent list List all builds.
5 agent-modify compute agent set Modify existing agent build.
6 aggregate-add-host aggregate add host Add the host to the specified aggregate.
7 aggregate-cache-images WONTFIX Request images be cached. (Supported by API versions '2.81' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version]
8 aggregate-create aggregate create Create a new aggregate with the specified details.
9 aggregate-delete aggregate delete Delete the aggregate.
10 aggregate-list aggregate list Print a list of all aggregates.
44 hypervisor-servers List servers belonging to specific hypervisors.
45 hypervisor-show hypervisor show Display the details of the specified hypervisor.
46 hypervisor-stats hypervisor stats show Get hypervisor statistics over all compute nodes.
47 hypervisor-uptime hypervisor show Display the uptime of the specified hypervisor.
48 image-create server image create Create a new image by taking a snapshot of a running server.
49 instance-action server event show Show an action.
50 instance-action-list List actions on a server.
65 lock server lock Lock a server.
66 meta server set --property / unset Set or delete metadata on a server.
67 migrate server migrate Migrate a server. The new host will be selected by the scheduler.
68 migration-list server migration list Print a list of migrations.
69 pause server pause Pause a server.
70 quota-class-show quota show --class List the quotas for a quota class.
71 quota-class-update quota set --class Update the quotas for a quota class.
120 usage-list usage list List usage data for all tenants.
121 version-list List all API versions.
122 volume-attach server add volume Attach a volume to a server.
123 volume-attachments server show server volume list List all the volumes attached to a server.
124 volume-detach server remove volume Detach a volume from a server.
125 volume-update server volume update Update volume attachment.
126 bash-completion complete Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them.
127 help help Display help about this program or one of its subcommands.