674e4e620b
There are a number of commands we're never going to implement:
host-evacuate
host-evacuate-live
host-servers-migrate
As noted in Dan Smith's blog [1], these are wrapper commands or meta
operations that call a particular action - namely 'evacuate',
'live-migration', and 'migrate' in old novaclient parlance - for
each server on a particular host.
These commands have historically been confusing. The underlying
server commands have been implemented as 'server evacuate', 'server
migrate --live', and 'server migrate', respectively. If a user wants
to call these for each server on the host, they can do so with a
little bit of shell scripting (hint: you want 'server list --host')
or use something more suitable for this kind of task such as Puppet
or Ansible.
host-meta
As above, this is equivalent to calling 'meta' for all servers on
the host. Combine 'server set --property' with 'server list --host'
instead (or use Ansible).
instance-usage-audit-log
This corresponds to the '/os-instance_usage_audit_log' API which is
intended for use by OpenStack Telemetry. There's no user-facing
application of this.
The remaining entries are updated to include their implementations. We
simply missed updating the mapping doc when implementing them.
With this, the OSC implementation of the nova API is *documented* as
being complete, as opposed to merely actually being complete 😉
[1] https://www.danplanet.com/blog/2016/03/03/evacuate-in-nova-one-command-to-confuse-us-all/
Change-Id: If08d501dd66c561956266d3b3f21dfd3559d8394
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
9.2 KiB
9.2 KiB
| 1 | add-secgroup | server add security group | Add a Security Group to a server. |
|---|---|---|---|
| 2 | agent-create | compute agent create | Create new agent build. |
| 3 | agent-delete | compute agent delete | Delete existing agent build. |
| 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 | aggregate cache image | 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. |
| 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 | clear-password | server set --root-password | Clear the admin password for a server from the metadata server. This action does not actually change the instance server password. |
| 19 | console-log | console log show | Get console log output of a server. |
| 20 | delete | server delete | Immediately shut down and delete specified server(s). |
| 21 | diagnostics | openstack server show --diagnostics | Retrieve server diagnostics. |
| 22 | evacuate | server evacuate | Evacuate server from failed host. |
| 23 | flavor-access-add | flavor set --project | Add flavor access for the given tenant. |
| 24 | flavor-access-list | flavor show | Print access information about the given flavor. |
| 25 | flavor-access-remove | flavor unset | Remove flavor access for the given tenant. |
| 26 | flavor-create | flavor create | Create a new flavor. |
| 27 | flavor-delete | flavor delete | Delete a specific flavor |
| 28 | flavor-key | flavor set / unset --property | Set or unset extra_spec for a flavor. |
| 29 | flavor-list | flavor list | Print a list of available 'flavors' |
| 30 | flavor-show | flavor show | Show details about the given flavor. |
| 31 | flavor-update | flavor set --description | Update the description of an existing flavor. (Supported by API versions '2.55' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version] |
| 32 | force-delete | server delete | Force delete a server. |
| 33 | get-mks-console | console url show --mks | Get an MKS console to a server. (Supported by API versions '2.8' - '2.latest') [hint: use ' --os-compute-api-version' flag to show help message for proper version] |
| 34 | get-password | WONTFIX | Get the admin password for a server. This operation calls the metadata service to query metadata information and does not read password information from the server itself. |
| 35 | get-rdp-console | console url show --rdp | Get a rdp console to a server. |
| 36 | get-serial-console | console url show --serial | Get a serial console to a server. |
| 37 | get-spice-console | console url show --spice | Get a spice console to a server. |
| 38 | get-vnc-console | console url show --novnc | Get a vnc console to a server. |
| 39 | host-evacuate | WONTFIX | Evacuate all instances from failed host. |
| 40 | host-evacuate-live | WONTFIX | Live migrate all instances off the specified host to other available hosts. |
| 41 | host-meta | WONTFIX | Set or Delete metadata on all instances of a host. |
| 42 | host-servers-migrate | WONTFIX | Cold migrate all instances off the specified host to other available hosts. |
| 43 | hypervisor-list | hypervisor list | List hypervisors. (Supported by API versions '2.0' - '2.latest') |
| 44 | hypervisor-servers | server list --host | 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 | server event list | List actions on a server. |
| 51 | instance-usage-audit-log | WONTFIX | List/Get server usage audits. |
| 52 | interface-attach | server add port / server add floating ip / server add fixed ip | Attach a network interface to a server. |
| 53 | interface-detach | server remove port | Detach a network interface from a server. |
| 54 | interface-list | port list --server | List interfaces attached to a server. |
| 55 | keypair-add | keypair create | Create a new key pair for use with servers. |
| 56 | keypair-delete | keypair delete | Delete keypair given by its name. |
| 57 | keypair-list | keypair list | Print a list of keypairs for a user |
| 58 | keypair-show | keypair show | Show details about the given keypair. |
| 59 | limits | limits show | Print rate and absolute limits. |
| 60 | list | server list | List active servers. |
| 61 | list-secgroup | security group list | List Security Group(s) of a server. |
| 62 | live-migration | server migration list | Migrate running server to a new machine. |
| 63 | live-migration-abort | server migration abort | Abort an on-going live migration. |
| 64 | live-migration-force-comp | server migration force complete | Force on-going live migration to complete. |
| 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. |
| 72 | quota-defaults | quota list | List the default quotas for a tenant. |
| 73 | quota-delete | quota delete --compute | Delete quota for a tenant/user so their quota will Revert back to default. |
| 74 | quota-show | quota show | List the quotas for a tenant/user. |
| 75 | quota-update | quota set | Update the quotas for a tenant/user. |
| 76 | reboot | server reboot | Reboot a server. |
| 77 | rebuild | server rebuild | Shutdown, re-image, and re-boot a server. |
| 78 | refresh-network | WONTFIX | Refresh server network information. |
| 79 | remove-secgroup | server remove security group | Remove a Security Group from a server. |
| 80 | rescue | server rescue | Reboots a server into rescue mode. |
| 81 | reset-network | WONTFIX | Reset network of a server. |
| 82 | reset-state | server set --state | Reset the state of a server. |
| 83 | resize | server resize | Resize a server. |
| 84 | resize-confirm | server resize --confirm | Confirm a previous resize. |
| 85 | resize-revert | server resize --revert | Revert a previous resize. |
| 86 | restore | server restore | Restore a soft-deleted server. |
| 87 | resume | server resume | Resume a server. |
| 88 | server-group-create | server group create | Create a new server group with the specified details. |
| 89 | server-group-delete | server group delete | Delete specific server group(s). |
| 90 | server-group-get | server group show | Get a specific server group. |
| 91 | server-group-list | server group list | Print a list of all server groups. |
| 92 | server-migration-list | server migration list | Get the migrations list of specified server. |
| 93 | server-migration-show | server migration show | Get the migration of specified server. |
| 94 | server-tag-add | server set --tag | Add one or more tags to a server. |
| 95 | server-tag-delete | server unset --tag | Delete one or more tags from a server. |
| 96 | server-tag-delete-all | server unset --tag | Delete all tags from a server. |
| 97 | server-tag-list | server list --tag | Get list of tags from a server. |
| 98 | server-tag-set | server set --tag | Set list of tags to a server. |
| 99 | server-topology | openstack server show --topology | Retrieve server topology. (Supported by API versions '2.78' - '2.latest') [hint: use '-- os-compute-api-version' flag to show help message for proper version] |
| 100 | service-delete | compute service delete | Delete the service. |
| 101 | service-disable | compute service set --disable | Disable the service. |
| 102 | service-enable | compute service set --enable | Enable the service. |
| 103 | service-force-down | compute service set --force | Force service to down. |
| 104 | service-list | compute service list | Show a list of all running services. |
| 105 | set-password | server set --root-password | Change the admin password for a server. |
| 106 | shelve | server shelve | Shelve a server. |
| 107 | shelve-offload | shelve --offload | Remove a shelved server from the compute node. |
| 108 | show | server show | Show details about the given server. |
| 109 | ssh | server ssh | SSH into a server. |
| 110 | start | server start | Start the server(s). |
| 111 | stop | server stop | Stop the server(s). |
| 112 | suspend | server suspend | Suspend a server. |
| 113 | trigger-crash-dump | server dump create | Trigger crash dump in an instance. |
| 114 | unlock | server unlock | Unlock a server. |
| 115 | unpause | server unpause | Unpause a server. |
| 116 | unrescue | server unrescue | Restart the server from normal boot disk again. |
| 117 | unshelve | server unshelve | Unshelve a server. |
| 118 | update | server set / unset | Update the name or the description for a server. |
| 119 | usage | usage show | Show usage data for a single tenant. |
| 120 | usage-list | usage list | List usage data for all tenants. |
| 121 | version-list | versions show --service compute | List all API versions. |
| 122 | volume-attach | server add volume | Attach a volume to a server. |
| 123 | volume-attachments | 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. |