openstack/python-openstackclient
Code Issues Proposed changes

add swift and nova to osc mapping

Browse Source 
Change-Id: If3ab811868aaf8c9391a2190ff0af63b0e0ea559
This commit is contained in:
Steve Martinelli 2017-02-20 16:33:29 -05:00
parent 1e3faf9f64
commit 3a48183c01
4 changed files with 175 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
doc/source/data/nova.csv Normal file
View File

@ -0,0 +1,140 @@
add-fixed-ip,server add fixed ip,Add new IP address on a network to server.
add-secgroup,server add security group,Add a Security Group to a server.
agent-create,compute agent create,Create new agent build.
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-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.
aggregate-remove-host,aggregate remove host,Remove the specified host from the specified aggregate.
aggregate-set-metadata,aggregate set / unset,Update the metadata associated with the aggregate.
aggregate-show,aggregate show,Show details of the specified aggregate.
aggregate-update,aggregate set / unset,Update the aggregate's name and optionally availability zone.
availability-zone-list,availability zone list,List all the availability zones.
backup,server backup create,Backup a server by creating a 'backup' type snapshot.
boot,server create,Boot a new server.
cell-capacities,,Get cell capacities for all cells or a given cell.
cell-show,,Show details of a given cell.
clear-password,server set --root-password,Clear the admin password for a server from the metadata server.
cloudpipe-configure,WONTFIX,Update the VPN IP/port of a cloudpipe instance.
cloudpipe-create,WONTFIX,Create a cloudpipe instance for the given project.
cloudpipe-list,WONTFIX,Print a list of all cloudpipe instances.
console-log,console log show,Get console log output of a server.
delete,server delete,Immediately shut down and delete specified server(s).
diagnostics,openstack server show --diagnostics,Retrieve server diagnostics.
evacuate,,Evacuate server from failed host.
flavor-access-add,,Add flavor access for the given tenant.
flavor-access-list,,Print access information about the given flavor.
flavor-access-remove,,Remove flavor access for the given tenant.
flavor-create,flavor create,Create a new flavor.
flavor-delete,flavor delete,Delete a specific flavor
flavor-key,flavor set / unset,Set or unset extra_spec for a flavor.
flavor-list,flavor list,Print a list of available 'flavors'
flavor-show,flavor show,Show details about the given flavor.
floating-ip-associate,server add floating ip,Associate a floating IP address to a server.
floating-ip-disassociate,server remove floating ip,Disassociate a floating IP address from a server.
force-delete,server delete,Force delete a server.
get-mks-console,console url show --mks,Get an MKS console to a server.
get-password,WONTFIX,Get the admin password for a server.
get-rdp-console,console url show --rdp,Get a rdp console to a server.
get-serial-console,console url show --serial,Get a serial console to a server.
get-spice-console,console url show --spice,Get a spice console to a server.
get-vnc-console,console url show --novnc | --xvpvnc,Get a vnc console to a server.
host-action,,Perform a power action on a host.
host-describe,host show,Describe a specific host.
host-evacuate,,Evacuate all instances from failed host.
host-evacuate-live,,Live migrate all instances of the specified host to other available hosts.
host-list,host list,List all hosts by service.
host-meta,host set / unset,Set or Delete metadata on all instances of a host.
host-servers-migrate,,Cold migrate all instances off the specified host to other available hosts.
host-update,host set,Update host settings.
hypervisor-list,hypervisor list,List hypervisors.
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.
image-create,server image create,Create a new image by taking a snapshot of a running server.
instance-action,,Show an action.
instance-action-list,,List actions on a server.
interface-attach,,Attach a network interface to a server.
interface-detach,,Detach a network interface from a server.
interface-list,,List interfaces attached to a server.
keypair-add,keypair create,Create a new key pair for use with servers.
keypair-delete,keypair delete,Delete keypair given by its name.
keypair-list,keypair list,Print a list of keypairs for a user
keypair-show,keypair show,Show details about the given keypair.
limits,limits show,Print rate and absolute limits.
list,server list,List active servers.
list-extensions,extension list,List all the os-api extensions that are available.
list-secgroup,security group list,List Security Group(s) of a server.
live-migration,,Migrate running server to a new machine.
live-migration-abort,,Abort an on-going live migration.
live-migration-force-comp,,Force on-going live migration to complete.
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.
pause,server pause,Pause a server.
quota-class-show,,List the quotas for a quota class.
quota-class-update,quota set --class,Update the quotas for a quota class.
quota-defaults,quota list,List the default quotas for a tenant.
quota-delete,quota set,Delete quota for a tenant/user so their quota will Revert back to default.
quota-show,quota show,List the quotas for a tenant/user.
quota-update,quota set,Update the quotas for a tenant/user.
reboot,server reboot,Reboot a server.
rebuild,server rebuild,"Shutdown, re-image, and re-boot a server."
refresh-network,WONTFIX,Refresh server network information.
remove-fixed-ip,server remove fixed ip,Remove an IP address from a server.
remove-secgroup,server remove security group,Remove a Security Group from a server.
rescue,server rescue,Reboots a server into rescue mode.
reset-network,WONTFIX,Reset network of a server.
reset-state,server set --state,Reset the state of a server.
resize,server resize,Resize a server.
resize-confirm,server resize --confirm,Confirm a previous resize.
resize-revert,server resize --revert,Revert a previous resize.
restore,server restore,Restore a soft-deleted server.
resume,server resume,Resume a server.
server-group-create,server group create,Create a new server group with the specified details.
server-group-delete,server group delete,Delete specific server group(s).
server-group-get,server group show,Get a specific server group.
server-group-list,server group list,Print a list of all server groups.
server-migration-list,,Get the migrations list of specified server.
server-migration-show,,Get the migration of specified server.
server-tag-add,,Add one or more tags to a server.
server-tag-delete,,Delete one or more tags from a server.
server-tag-delete-all,,Delete all tags from a server.
server-tag-list,,Get list of tags from a server.
server-tag-set,,Set list of tags to a server.
service-delete,compute service delete,Delete the service.
service-disable,compute service set --disable,Disable the service.
service-enable,compute service set --enable,Enable the service.
service-force-down,compute service set --force,Force service to down.
service-list,compute service list,Show a list of all running services.
set-password,server set --root-password,Change the admin password for a server.
shelve,server shelve,Shelve a server.
shelve-offload,,Remove a shelved server from the compute node.
show,server show,Show details about the given server.
ssh,server ssh,SSH into a server.
start,server start,Start the server(s).
stop,server stop,Stop the server(s).
suspend,server suspend,Suspend a server.
trigger-crash-dump,server dump create,Trigger crash dump in an instance.
unlock,server unlock,Unlock a server.
unpause,server unpause,Unpause a server.
unrescue,server unrescue,Restart the server from normal boot disk again.
unshelve,server unshelve,Unshelve a server.
update,server set / unset,Update the name or the description for a server.
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.
virtual-interface-list,,Show virtual interface info about the given server.
volume-attach,server add volume,Attach a volume to a server.
volume-attachments,server show,List all the volumes attached to a server.
volume-detach,server remove volume,Detach a volume from a server.
volume-update,,Update volume attachment.
x509-create-cert,WONTFIX,Create x509 cert for a user in tenant.
x509-get-root-cert,WONTFIX,Fetch the x509 root cert.
bash-completion,complete,Prints all of the commands and options to
help,help,Display help about this program or one of its subcommands.
1 add-fixed-ip server add fixed ip Add new IP address on a network to server.
2 add-secgroup server add security group Add a Security Group to a server.
3 agent-create compute agent create Create new agent build.
4 agent-delete compute agent delete Delete existing agent build.
5 agent-list compute agent list List all builds.
6 agent-modify compute agent set Modify existing agent build.
7 aggregate-add-host aggregate add host Add the host to the specified aggregate.
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.
11 aggregate-remove-host aggregate remove host Remove the specified host from the specified aggregate.
12 aggregate-set-metadata aggregate set / unset Update the metadata associated with the aggregate.
13 aggregate-show aggregate show Show details of the specified aggregate.
14 aggregate-update aggregate set / unset Update the aggregate's name and optionally availability zone.
15 availability-zone-list availability zone list List all the availability zones.
16 backup server backup create Backup a server by creating a 'backup' type snapshot.
17 boot server create Boot a new server.
18 cell-capacities Get cell capacities for all cells or a given cell.
19 cell-show Show details of a given cell.
20 clear-password server set --root-password Clear the admin password for a server from the metadata server.
21 cloudpipe-configure WONTFIX Update the VPN IP/port of a cloudpipe instance.
22 cloudpipe-create WONTFIX Create a cloudpipe instance for the given project.
23 cloudpipe-list WONTFIX Print a list of all cloudpipe instances.
24 console-log console log show Get console log output of a server.
25 delete server delete Immediately shut down and delete specified server(s).
26 diagnostics openstack server show --diagnostics Retrieve server diagnostics.
27 evacuate Evacuate server from failed host.
28 flavor-access-add Add flavor access for the given tenant.
29 flavor-access-list Print access information about the given flavor.
30 flavor-access-remove Remove flavor access for the given tenant.
31 flavor-create flavor create Create a new flavor.
32 flavor-delete flavor delete Delete a specific flavor
33 flavor-key flavor set / unset Set or unset extra_spec for a flavor.
34 flavor-list flavor list Print a list of available 'flavors'
35 flavor-show flavor show Show details about the given flavor.
36 floating-ip-associate server add floating ip Associate a floating IP address to a server.
37 floating-ip-disassociate server remove floating ip Disassociate a floating IP address from a server.
38 force-delete server delete Force delete a server.
39 get-mks-console console url show --mks Get an MKS console to a server.
40 get-password WONTFIX Get the admin password for a server.
41 get-rdp-console console url show --rdp Get a rdp console to a server.
42 get-serial-console console url show --serial Get a serial console to a server.
43 get-spice-console console url show --spice Get a spice console to a server.
44 get-vnc-console console url show --novnc | --xvpvnc Get a vnc console to a server.
45 host-action Perform a power action on a host.
46 host-describe host show Describe a specific host.
47 host-evacuate Evacuate all instances from failed host.
48 host-evacuate-live Live migrate all instances of the specified host to other available hosts.
49 host-list host list List all hosts by service.
50 host-meta host set / unset Set or Delete metadata on all instances of a host.
51 host-servers-migrate Cold migrate all instances off the specified host to other available hosts.
52 host-update host set Update host settings.
53 hypervisor-list hypervisor list List hypervisors.
54 hypervisor-servers List servers belonging to specific hypervisors.
55 hypervisor-show hypervisor show Display the details of the specified hypervisor.
56 hypervisor-stats hypervisor stats show Get hypervisor statistics over all compute nodes.
57 hypervisor-uptime Display the uptime of the specified hypervisor.
58 image-create server image create Create a new image by taking a snapshot of a running server.
59 instance-action Show an action.
60 instance-action-list List actions on a server.
61 interface-attach Attach a network interface to a server.
62 interface-detach Detach a network interface from a server.
63 interface-list List interfaces attached to a server.
64 keypair-add keypair create Create a new key pair for use with servers.
65 keypair-delete keypair delete Delete keypair given by its name.
66 keypair-list keypair list Print a list of keypairs for a user
67 keypair-show keypair show Show details about the given keypair.
68 limits limits show Print rate and absolute limits.
69 list server list List active servers.
70 list-extensions extension list List all the os-api extensions that are available.
71 list-secgroup security group list List Security Group(s) of a server.
72 live-migration Migrate running server to a new machine.
73 live-migration-abort Abort an on-going live migration.
74 live-migration-force-comp Force on-going live migration to complete.
75 lock server lock Lock a server.
76 meta server set --property / unset Set or delete metadata on a server.
77 migrate server migrate Migrate a server. The new host will be selected by the scheduler.
78 migration-list Print a list of migrations.
79 pause server pause Pause a server.
80 quota-class-show List the quotas for a quota class.
81 quota-class-update quota set --class Update the quotas for a quota class.
82 quota-defaults quota list List the default quotas for a tenant.
83 quota-delete quota set Delete quota for a tenant/user so their quota will Revert back to default.
84 quota-show quota show List the quotas for a tenant/user.
85 quota-update quota set Update the quotas for a tenant/user.
86 reboot server reboot Reboot a server.
87 rebuild server rebuild Shutdown, re-image, and re-boot a server.
88 refresh-network WONTFIX Refresh server network information.
89 remove-fixed-ip server remove fixed ip Remove an IP address from a server.
90 remove-secgroup server remove security group Remove a Security Group from a server.
91 rescue server rescue Reboots a server into rescue mode.
92 reset-network WONTFIX Reset network of a server.
93 reset-state server set --state Reset the state of a server.
94 resize server resize Resize a server.
95 resize-confirm server resize --confirm Confirm a previous resize.
96 resize-revert server resize --revert Revert a previous resize.
97 restore server restore Restore a soft-deleted server.
98 resume server resume Resume a server.
99 server-group-create server group create Create a new server group with the specified details.
100 server-group-delete server group delete Delete specific server group(s).
101 server-group-get server group show Get a specific server group.
102 server-group-list server group list Print a list of all server groups.
103 server-migration-list Get the migrations list of specified server.
104 server-migration-show Get the migration of specified server.
105 server-tag-add Add one or more tags to a server.
106 server-tag-delete Delete one or more tags from a server.
107 server-tag-delete-all Delete all tags from a server.
108 server-tag-list Get list of tags from a server.
109 server-tag-set Set list of tags to a server.
110 service-delete compute service delete Delete the service.
111 service-disable compute service set --disable Disable the service.
112 service-enable compute service set --enable Enable the service.
113 service-force-down compute service set --force Force service to down.
114 service-list compute service list Show a list of all running services.
115 set-password server set --root-password Change the admin password for a server.
116 shelve server shelve Shelve a server.
117 shelve-offload Remove a shelved server from the compute node.
118 show server show Show details about the given server.
119 ssh server ssh SSH into a server.
120 start server start Start the server(s).
121 stop server stop Stop the server(s).
122 suspend server suspend Suspend a server.
123 trigger-crash-dump server dump create Trigger crash dump in an instance.
124 unlock server unlock Unlock a server.
125 unpause server unpause Unpause a server.
126 unrescue server unrescue Restart the server from normal boot disk again.
127 unshelve server unshelve Unshelve a server.
128 update server set / unset Update the name or the description for a server.
129 usage usage show Show usage data for a single tenant.
130 usage-list usage list List usage data for all tenants.
131 version-list List all API versions.
132 virtual-interface-list Show virtual interface info about the given server.
133 volume-attach server add volume Attach a volume to a server.
134 volume-attachments server show List all the volumes attached to a server.
135 volume-detach server remove volume Detach a volume from a server.
136 volume-update Update volume attachment.
137 x509-create-cert WONTFIX Create x509 cert for a user in tenant.
138 x509-get-root-cert WONTFIX Fetch the x509 root cert.
139 bash-completion complete Prints all of the commands and options to
140 help help Display help about this program or one of its subcommands.

10
doc/source/data/swift.csv Normal file
View File

@ -0,0 +1,10 @@
delete,object delete / container delete,Delete a container or objects within a container.
download,object save / container save,Download objects from containers.
list,object list / container list,Lists the containers for the account or the objects for a container.
post,container create / object set / container set / object store account set,"Updates meta information for the account, container, or object."
copy,,"Copies object, optionally adds meta."
stat,object show / container show / object store account show,"Displays information for the account, container, or object."
upload,object create,Uploads files or directories to the given container.
capabilities,,List cluster capabilities.
tempurl,,Create a temporary URL.
auth,WONTFIX,Display auth related environment variables.
1 delete object delete / container delete Delete a container or objects within a container.
2 download object save / container save Download objects from containers.
3 list object list / container list Lists the containers for the account or the objects for a container.
4 post container create / object set / container set / object store account set Updates meta information for the account, container, or object.
5 copy Copies object, optionally adds meta.
6 stat object show / container show / object store account show Displays information for the account, container, or object.
7 upload object create Uploads files or directories to the given container.
8 capabilities List cluster capabilities.
9 tempurl Create a temporary URL.
10 auth WONTFIX Display auth related environment variables.

24
doc/source/decoder.rst Normal file
View File

@ -0,0 +1,24 @@
=================
OSC Mapping Table
=================
The following is an incomplete mapping between legacy OpenStack CLIs and
OpenStackClient. Think of it as a magic decoder ring if you were using the
legacy CLIs and want to transition to OpenStack CLI. Command options are only
shown when necessary.
``nova CLI``
------------
.. csv-table::
:header: "Nova CLI", "OSC Equivalent", "Description"
:widths: 25, 25, 50
:file: data/nova.csv
``swift CLI``
-------------
.. csv-table::
:header: "Swift CLI", "OSC Equivalent", "Description"
:widths: 25, 25, 50
:file: data/swift.csv

1
doc/source/index.rst
View File

@ -23,6 +23,7 @@ User Documentation
interactive
humaninterfaceguide
backwards-incompatible
decoder
Getting Started
---------------