diff --git a/doc/source/admin/configuration/schedulers.rst b/doc/source/admin/configuration/schedulers.rst index 835af618248d..56f87d069eca 100644 --- a/doc/source/admin/configuration/schedulers.rst +++ b/doc/source/admin/configuration/schedulers.rst @@ -986,16 +986,16 @@ aggregate-related commands. nova aggregate-list Print a list of all aggregates. -nova aggregate-create [availability-zone] +nova aggregate-create [] Create a new aggregate named ````, and optionally in availability zone - ``[availability-zone]`` if specified. The command returns the ID of the newly - created aggregate. Hosts can be made available to multiple host aggregates. - Be careful when adding a host to an additional host aggregate when the host - is also in an availability zone. Pay attention when using the :command:`nova - aggregate-set-metadata` and :command:`nova aggregate-update` commands to - avoid user confusion when they boot instances in different availability - zones. An error occurs if you cannot add a particular host to an aggregate - zone for which it is not intended. + ``[]`` if specified. The command returns the ID of the + newly created aggregate. Hosts can be made available to multiple host + aggregates. Be careful when adding a host to an additional host aggregate + when the host is also in an availability zone. Pay attention when using the + :command:`nova aggregate-set-metadata` and :command:`nova aggregate-update` + commands to avoid user confusion when they boot instances in different + availability zones. An error occurs if you cannot add a particular host to + an aggregate zone for which it is not intended. nova aggregate-delete Delete an aggregate with its ```` or ````. @@ -1014,14 +1014,26 @@ nova aggregate-set-metadata [ ...] Add or update metadata (key-value pairs) associated with the aggregate with its ```` or ````. -nova aggregate-update [] - Update the name and availability zone (optional) for the aggregate. +nova aggregate-update [--name ] [--availability-zone ] + Update the name and/or availability zone for the aggregate. nova host-list - List all hosts by service. + List all hosts by service. It has been depricated since microversion 2.43. + Use :command:`nova hypervisor-list` instead. -nova host-update --maintenance [enable | disable] - Put/resume host into/from maintenance. +nova hypervisor-list [--matching ] [--marker ] [--limit ] + List hypervisors. + +nova host-update [--status ] [--maintenance ] + Put/resume host into/from maintenance. It has been depricated since + microversion 2.43. To enable or disable a service, + use :command:`nova service-enable` or :command:`nova service-disable` instead. + +nova service-enable + Enable the service. + +nova service-disable [--reason ] + Disable the service. .. note:: diff --git a/doc/source/user/aggregates.rst b/doc/source/user/aggregates.rst index 4b9db6e73134..5d7bb2b8982d 100644 --- a/doc/source/user/aggregates.rst +++ b/doc/source/user/aggregates.rst @@ -82,7 +82,7 @@ The OSAPI Admin API is extended to support the following operations: * Aggregates - * list aggregates: returns a list of all the host-aggregates (optionally filtered by availability zone) + * list aggregates: returns a list of all the host-aggregates * create aggregate: creates an aggregate, takes a friendly name, etc. returns an id * show aggregate: shows the details of an aggregate (id, name, availability_zone, hosts and metadata) * update aggregate: updates the name and availability zone of an aggregate @@ -90,12 +90,27 @@ The OSAPI Admin API is extended to support the following operations: * delete aggregate: deletes an aggregate, it fails if the aggregate is not empty * add host: adds a host to the aggregate * remove host: removes a host from the aggregate - * Hosts + * list all hosts by service + + * It has been depricated since microversion 2.43. Use `list hypervisors` instead. * start host maintenance (or evacuate-host): disallow a host to serve API requests and migrate instances to other hosts of the aggregate + + * It has been depricated since microversion 2.43. Use `disable service` instead. * stop host maintenance: (or rebalance-host): put the host back into operational mode, migrating instances back onto that host + * It has been depricated since microversion 2.43. Use `enable service` instead. + +* Hypervisors + + * list hypervisors: list hypervisors with hypervisor hostname + +* Compute services + + * enable service + * disable service + Using the Nova CLI ------------------ @@ -107,13 +122,21 @@ Usage :: * aggregate-list Print a list of all aggregates. - * aggregate-create Create a new aggregate with the specified details. - * aggregate-delete Delete the aggregate by its id. - * aggregate-details Show details of the specified aggregate. - * aggregate-add-host Add the host to the specified aggregate. - * aggregate-remove-host Remove the specified host from the specified aggregate. - * aggregate-set-metadata [ ...] Update the metadata associated with the aggregate. - * aggregate-update [] Update the aggregate's name and optionally availability zone. + * aggregate-create [] Create a new aggregate with the specified details. + * aggregate-delete Delete the aggregate by its ID or name. + * aggregate-show Show details of the aggregate specified by its ID or name. + * aggregate-add-host Add the host to the aggregate specified by its ID or name. + * aggregate-remove-host Remove the specified host from the aggregate specified by its ID or name. + * aggregate-set-metadata [ ...] + Update the metadata associated with the aggregate specified by its ID or name. + * aggregate-update [--name ] [--availability-zone ] + Update the aggregate's name or availability zone. - * host-list List all hosts by service - * host-update --maintenance [enable | disable] Put/resume host into/from maintenance. + * host-list List all hosts by service. + * hypervisor-list [--matching ] [--marker ] [--limit ] + List hypervisors. + + * host-update [--status ] [--maintenance ] + Put/resume host into/from maintenance. + * service-enable Enable the service. + * service-disable [--reason ] Disable the service.