python-novaclient-17.0.0/ 0000775 0001750 0001750 00000000000 13644321026 015303 5 ustar zuul zuul 0000000 0000000 python-novaclient-17.0.0/LICENSE 0000664 0001750 0001750 00000027073 13644320726 016327 0 ustar zuul zuul 0000000 0000000 Copyright (c) 2009 Jacob Kaplan-Moss - initial codebase (< v2.1)
Copyright (c) 2011 Rackspace - OpenStack extensions (>= v2.1)
All rights reserved.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
--- License for python-novaclient versions prior to 2.1 ---
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of this project nor the names of its contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
python-novaclient-17.0.0/.stestr.conf 0000664 0001750 0001750 00000000110 13644320726 017552 0 ustar zuul zuul 0000000 0000000 [DEFAULT]
test_path=${OS_TEST_PATH:-./novaclient/tests/unit}
top_dir=./
python-novaclient-17.0.0/doc/ 0000775 0001750 0001750 00000000000 13644321026 016050 5 ustar zuul zuul 0000000 0000000 python-novaclient-17.0.0/doc/requirements.txt 0000664 0001750 0001750 00000000756 13644320726 021352 0 ustar zuul zuul 0000000 0000000 # The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.30.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinxcontrib-apidoc>=0.2.0 # BSD
# redirect tests in docs
whereto>=0.3.0 # Apache-2.0
python-novaclient-17.0.0/doc/source/ 0000775 0001750 0001750 00000000000 13644321026 017350 5 ustar zuul zuul 0000000 0000000 python-novaclient-17.0.0/doc/source/contributor/ 0000775 0001750 0001750 00000000000 13644321026 021722 5 ustar zuul zuul 0000000 0000000 python-novaclient-17.0.0/doc/source/contributor/deprecation-policy.rst 0000664 0001750 0001750 00000002711 13644320726 026255 0 ustar zuul zuul 0000000 0000000 Deprecating commands
====================
There are times when commands need to be deprecated due to rename or removal.
The process for command deprecation is:
1. Push up a change for review which deprecates the command(s).
- The change should print a deprecation warning to ``stderr`` each time a
deprecated command is used.
- That warning message should include a rough timeline for when the command
will be removed and what should be used instead, if anything.
- The description in the help text for the deprecated command should mark
that it is deprecated.
- The change should include a release note with the ``deprecations`` section
filled out.
- The deprecation cycle is typically the first client release *after* the
next *full* nova server release so that there is at least six months of
deprecation.
2. Once the change is approved, have a member of the `nova-release`_ team
release a new version of `python-novaclient`.
.. _nova-release: https://review.opendev.org/#/admin/groups/147,members
3. Example: ``_
This change was made while the nova 12.0.0 Liberty release was in
development. The current version of `python-novaclient` at the time was
2.25.0. Once the change was merged, `python-novaclient` 2.26.0 was released.
Since there was less than six months before 12.0.0 would be released, the
deprecation cycle ran through the 13.0.0 nova server release.
python-novaclient-17.0.0/doc/source/contributor/microversions.rst 0000664 0001750 0001750 00000005260 13644320726 025367 0 ustar zuul zuul 0000000 0000000 =====================================
Adding support for a new microversion
=====================================
If a new microversion is added on the nova side,
then support must be added on the *python-novaclient* side also.
The following procedure describes how to add support for a new microversion
in *python-novaclient*.
#. Update ``API_MAX_VERSION``
Set ``API_MAX_VERSION`` in ``novaclient/__init__.py`` to the version
you are going to support.
.. note::
Microversion support should be added one by one in order.
For example, microversion 2.74 should be added right after
microversion 2.73. Microversion 2.74 should not be added right
after microversion 2.72 or earlier.
#. Update CLI and Python API
Update CLI (``novaclient/v2/shell.py``) and/or Python API
(``novaclient/v2/*.py``) to support the microversion.
#. Add tests
Add unit tests for the change. Add unit tests for the previous microversion
to check raising an error or an exception when new arguments or parameters
are specified. Add functional tests if necessary.
Add the microversion in the ``exclusions`` in the ``test_versions``
method of the ``novaclient.tests.unit.v2.test_shell.ShellTest`` class
if there are no versioned wrapped method changes for the microversion.
The versioned wrapped methods have ``@api_versions.wraps`` decorators.
For example (microversion 2.72 example)::
exclusions = set([
(snipped...)
72, # There are no version-wrapped shell method changes for this.
])
#. Update the CLI reference
Update the CLI reference (``doc/source/cli/nova.rst``)
if the CLI commands and/or arguments are modified.
#. Add a release note
Add a release note for the change. The release note should include a link
to the description for the microversion in the
:nova-doc:`Compute API Microversion History
`.
#. Commit message
The description of the blueprint and dependency on the patch in nova side
should be added in the commit message. For example::
Implements: blueprint remove-force-flag-from-live-migrate-and-evacuate
Depends-On: https://review.opendev.org/#/c/634600/
See the following examples:
- `Microversion 2.71 - show server group `_
- `API microversion 2.69: Handles Down Cells `_
- `Microversion 2.68: Remove 'forced' live migrations, evacuations `_
- `Add support changes-before for microversion 2.66 `_
- `Microversion 2.64 - Use new format policy in server group `_
python-novaclient-17.0.0/doc/source/contributor/testing.rst 0000664 0001750 0001750 00000001636 13644320726 024145 0 ustar zuul zuul 0000000 0000000 =========
Testing
=========
The preferred way to run the unit tests is using ``tox``. There are multiple
test targets that can be run to validate the code.
``tox -e pep8``
Style guidelines enforcement.
``tox -e py37``
Traditional unit testing (Python 3.7).
``tox -e functional``
Live functional testing against an existing OpenStack instance. (Python 3.7)
``tox -e cover``
Generate a coverage report on unit testing.
Functional testing assumes the existence of a `clouds.yaml` file as supported
by :os-client-config-doc:`os-client-config <>`.
It assumes the existence of a cloud named `devstack` that behaves like a normal
DevStack installation with a demo and an admin user/tenant - or clouds named
`functional_admin` and `functional_nonadmin`.
Refer to `Consistent Testing Interface`__ for more details.
__ https://opendev.org/openstack/governance/src/branch/master/reference/project-testing-interface.rst
python-novaclient-17.0.0/doc/source/contributor/index.rst 0000664 0001750 0001750 00000000756 13644320726 023601 0 ustar zuul zuul 0000000 0000000 ===================
Contributor Guide
===================
Code is hosted at `opendev.org`__. Submit bugs to the python-novaclient
project on `Launchpad`__. Submit code to the `openstack/python-novaclient`
project using `Gerrit`__.
__ https://opendev.org/openstack/python-novaclient
__ https://bugs.launchpad.net/python-novaclient
__ https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. toctree::
:maxdepth: 2
microversions
testing
deprecation-policy
python-novaclient-17.0.0/doc/source/user/ 0000775 0001750 0001750 00000000000 13644321026 020326 5 ustar zuul zuul 0000000 0000000 python-novaclient-17.0.0/doc/source/user/shell.rst 0000664 0001750 0001750 00000004600 13644320726 022175 0 ustar zuul zuul 0000000 0000000 ===================================
The :program:`nova` Shell Utility
===================================
.. program:: nova
.. highlight:: bash
The :program:`nova` shell utility interacts with OpenStack Nova API from the
command line. It supports the entirety of the OpenStack Nova API.
You'll need to provide :program:`nova` with your OpenStack Keystone user
information. You can do this with the `--os-username`, `--os-password`,
`--os-project-name` (`--os-project-id`), `--os-project-domain-name`
(`--os-project-domain-id`) and `--os-user-domain-name` (`--os-user-domain-id`)
options, but it's easier to just set them as environment variables by setting
some environment variables:
.. envvar:: OS_USERNAME
Your OpenStack Keystone user name.
.. envvar:: OS_PASSWORD
Your password.
.. envvar:: OS_PROJECT_NAME
The name of project for work.
.. envvar:: OS_PROJECT_ID
The ID of project for work.
.. envvar:: OS_PROJECT_DOMAIN_NAME
The name of domain containing the project.
.. envvar:: OS_PROJECT_DOMAIN_ID
The ID of domain containing the project.
.. envvar:: OS_USER_DOMAIN_NAME
The user's domain name.
.. envvar:: OS_USER_DOMAIN_ID
The user's domain ID.
.. envvar:: OS_AUTH_URL
The OpenStack Keystone endpoint URL.
.. envvar:: OS_COMPUTE_API_VERSION
The OpenStack Nova API version (microversion).
.. envvar:: OS_REGION_NAME
The Keystone region name. Defaults to the first region if multiple regions
are available.
.. envvar:: OS_TRUSTED_IMAGE_CERTIFICATE_IDS
A comma-delimited list of trusted image certificate IDs. Only used
with the ``nova boot`` and ``nova rebuild`` commands starting with the
2.63 microversion.
For example::
export OS_TRUSTED_IMAGE_CERTIFICATE_IDS=trusted-cert-id1,trusted-cert-id2
For example, in Bash you'd use::
export OS_USERNAME=yourname
export OS_PASSWORD=yadayadayada
export OS_PROJECT_NAME=myproject
export OS_PROJECT_DOMAIN_NAME=default
export OS_USER_DOMAIN_NAME=default
export OS_AUTH_URL=http:///identity
export OS_COMPUTE_API_VERSION=2.1
From there, all shell commands take the form::
nova [arguments...]
Run :program:`nova help` to get a full list of all possible commands, and run
:program:`nova help ` to get detailed help for that command.
For more information, see :doc:`the command reference `.
python-novaclient-17.0.0/doc/source/user/index.rst 0000664 0001750 0001750 00000000134 13644320726 022173 0 ustar zuul zuul 0000000 0000000 ============
User Guide
============
.. toctree::
:maxdepth: 2
shell
python-api
python-novaclient-17.0.0/doc/source/user/python-api.rst 0000664 0001750 0001750 00000007116 13644320726 023163 0 ustar zuul zuul 0000000 0000000 ==================================
The :mod:`novaclient` Python API
==================================
.. module:: novaclient
:synopsis: A client for the OpenStack Nova API.
:noindex:
.. currentmodule:: novaclient
Usage
-----
First create a client instance with your credentials::
>>> from novaclient import client
>>> nova = client.Client(VERSION, USERNAME, PASSWORD, PROJECT_ID, AUTH_URL)
Here ``VERSION`` can be a string or ``novaclient.api_versions.APIVersion`` obj.
If you prefer string value, you can use ``1.1`` (deprecated now), ``2`` or
``2.X`` (where X is a microversion).
Alternatively, you can create a client instance using the keystoneauth
session API::
>>> from keystoneauth1 import loading
>>> from keystoneauth1 import session
>>> from novaclient import client
>>> loader = loading.get_plugin_loader('password')
>>> auth = loader.load_from_options(auth_url=AUTH_URL,
... username=USERNAME,
... password=PASSWORD,
... project_id=PROJECT_ID)
>>> sess = session.Session(auth=auth)
>>> nova = client.Client(VERSION, session=sess)
If you have PROJECT_NAME instead of a PROJECT_ID, use the project_name
parameter. Similarly, if your cloud uses keystone v3 and you have a DOMAIN_NAME
or DOMAIN_ID, provide it as `user_domain_(name|id)` and if you are using a
PROJECT_NAME also provide the domain information as `project_domain_(name|id)`.
novaclient adds 'python-novaclient' and its version to the user-agent string
that keystoneauth produces. If you are creating an application using novaclient
and want to register a name and version in the user-agent string, pass those
to the Session::
>>> sess = session.Session(
... auth=auth, app_name'nodepool', app_version'1.2.3')
If you are making a library that consumes novaclient but is not an end-user
application, you can append a (name, version) tuple to the session's
`additional_user_agent` property::
>>> sess = session.Session(auth=auth)
>>> sess.additional_user_agent.append(('shade', '1.2.3'))
For more information on this keystoneauth API, see
:keystoneauth-doc:`Using Sessions `.
It is also possible to use an instance as a context manager in which case
there will be a session kept alive for the duration of the with statement::
>>> from novaclient import client
>>> with client.Client(VERSION, USERNAME, PASSWORD,
... PROJECT_ID, AUTH_URL) as nova:
... nova.servers.list()
... nova.flavors.list()
...
It is also possible to have a permanent (process-long) connection pool,
by passing a connection_pool=True::
>>> from novaclient import client
>>> nova = client.Client(VERSION, USERNAME, PASSWORD, PROJECT_ID,
... AUTH_URL, connection_pool=True)
Then call methods on its managers::
>>> nova.servers.list()
[]
>>> nova.flavors.list()
[,
,
,
,
,
,
]
>>> fl = nova.flavors.find(ram=512)
>>> nova.servers.create("my-server", flavor=fl)
.. warning:: Direct initialization of ``novaclient.v2.client.Client`` object
can cause you to "shoot yourself in the foot". See launchpad bug-report
`1493576`_ for more details.
.. _1493576: https://launchpad.net/bugs/1493576
Reference
---------
See :doc:`the module reference `.
python-novaclient-17.0.0/doc/source/conf.py 0000664 0001750 0001750 00000005312 13644320726 020656 0 ustar zuul zuul 0000000 0000000 # Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# python-novaclient documentation build configuration file
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'openstackdocstheme',
'sphinx.ext.autodoc',
'sphinxcontrib.apidoc',
]
# sphinxcontrib.apidoc options
apidoc_module_dir = '../../novaclient'
apidoc_output_dir = 'reference/api'
apidoc_excluded_paths = [
'tests/*']
apidoc_separate_modules = True
# The content that will be inserted into the main body of an autoclass
# directive.
autoclass_content = 'both'
# The master toctree document.
master_doc = 'index'
# openstackdocstheme options
repository_name = 'openstack/python-novaclient'
bug_project = 'python-novaclient'
bug_tag = 'doc'
copyright = 'OpenStack Contributors'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'openstackdocs'
# Add any paths that contain "extra" files, such as .htaccess or
# robots.txt.
html_extra_path = ['_extra']
# -- Options for LaTeX output -------------------------------------------------
latex_documents = [
('index', 'doc-python-novaclient.tex', 'python-novaclient Documentation',
'OpenStack Foundation', 'manual'),
]
latex_elements = {
'extraclassoptions': 'openany,oneside',
'preamble': r'\setcounter{tocdepth}{4}',
'makeindex': '',
'printindex': '',
}
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-novaclient'
bug_project = 'python-novaclient'
bug_tag = ''
openstack_projects = [
'keystoneauth',
'nova',
'os-client-config',
'python-openstackclient',
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('cli/nova', 'nova', 'OpenStack Nova command line client',
['OpenStack Contributors'], 1),
]
python-novaclient-17.0.0/doc/source/cli/ 0000775 0001750 0001750 00000000000 13644321026 020117 5 ustar zuul zuul 0000000 0000000 python-novaclient-17.0.0/doc/source/cli/nova.rst 0000664 0001750 0001750 00000256751 13644320726 021642 0 ustar zuul zuul 0000000 0000000 ======
nova
======
The nova client is the command-line interface (CLI) for
the Compute service (nova) API and its extensions.
For help on a specific :command:`nova` command, enter:
.. code-block:: console
$ nova help COMMAND
.. note:: Over time, command line functionality will be phased out
of the ``nova`` CLI and into the ``openstack`` CLI. Using
the ``openstack`` client where possible is preferred but
there is not full parity yet for all of the ``nova`` commands.
For information on using the ``openstack`` CLI, see
:python-openstackclient-doc:`OpenStackClient <>`.
.. _nova_command_usage:
nova usage
~~~~~~~~~~
.. code-block:: console
usage: nova [--version] [--debug] [--os-cache] [--timings]
[--os-region-name ] [--service-type ]
[--service-name ]
[--os-endpoint-type ]
[--os-compute-api-version ]
[--os-endpoint-override ] [--profile HMAC_KEY]
[--insecure] [--os-cacert ]
[--os-cert ] [--os-key ] [--timeout ]
[--collect-timing] [--os-auth-type ]
[--os-auth-url OS_AUTH_URL] [--os-system-scope OS_SYSTEM_SCOPE]
[--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME]
[--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-trust-id OS_TRUST_ID]
[--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
[--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
[--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-password OS_PASSWORD]
...
**Subcommands:**
``add-fixed-ip``
**DEPRECATED** Add new IP address on a network to
server.
``add-secgroup``
Add a Security Group to a server.
``agent-create``
Create new agent build.
``agent-delete``
Delete existing agent build.
``agent-list``
List all builds.
``agent-modify``
Modify existing agent build.
``aggregate-add-host``
Add the host to the specified aggregate.
``aggregate-cache-images``
Request images be pre-cached on hosts within an aggregate.
(Supported by API versions '2.81' - '2.latest')
``aggregate-create``
Create a new aggregate with the specified
details.
``aggregate-delete``
Delete the aggregate.
``aggregate-list``
Print a list of all aggregates.
``aggregate-remove-host``
Remove the specified host from the specified
aggregate.
``aggregate-set-metadata``
Update the metadata associated with the
aggregate.
``aggregate-show``
Show details of the specified aggregate.
``aggregate-update``
Update the aggregate's name and optionally
availability zone.
``availability-zone-list``
List all the availability zones.
``backup``
Backup a server by creating a 'backup' type
snapshot.
``boot``
Boot a new server.
``clear-password``
Clear the admin password for a server from the
metadata server. This action does not actually
change the instance server password.
``cloudpipe-configure``
**DEPRECATED** Update the VPN IP/port of a
cloudpipe instance.
``cloudpipe-create``
**DEPRECATED** Create a cloudpipe instance for the
given project.
``cloudpipe-list``
**DEPRECATED** Print a list of all cloudpipe
instances.
``console-log``
Get console log output of a server.
``delete``
Immediately shut down and delete specified
server(s).
``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``
Create a new flavor.
``flavor-delete``
Delete a specific flavor
``flavor-key``
Set or unset extra_spec for a flavor.
``flavor-list``
Print a list of available 'flavors' (sizes of
servers).
``flavor-show``
Show details about the given flavor.
``flavor-update``
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]
``floating-ip-associate``
**DEPRECATED** Associate a floating IP address to
a server.
``floating-ip-disassociate``
**DEPRECATED** Disassociate a floating IP address
from a server.
``force-delete``
Force delete a server.
``get-mks-console``
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]
``get-password``
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.
``get-rdp-console``
Get a rdp console to a server.
``get-serial-console``
Get a serial console to a server.
``get-spice-console``
Get a spice console to a server.
``get-vnc-console``
Get a vnc console to a server.
``host-action``
**DEPRECATED** Perform a power action on a host.
``host-describe``
**DEPRECATED** Describe a specific host.
``host-evacuate``
Evacuate all instances from failed host.
``host-evacuate-live``
Live migrate all instances off the specified
host to other available hosts.
``host-list``
**DEPRECATED** List all hosts by service.
``host-meta``
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``
**DEPRECATED** Update host settings.
``hypervisor-list``
List hypervisors. (Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to show help message
for proper version]
``hypervisor-servers``
List servers belonging to specific
hypervisors.
``hypervisor-show``
Display the details of the specified
hypervisor.
``hypervisor-stats``
Get hypervisor statistics over all compute
nodes.
``hypervisor-uptime``
Display the uptime of the specified
hypervisor.
``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.
``instance-usage-audit-log``
List/Get server usage audits.
``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``
Create a new key pair for use with servers.
``keypair-delete``
Delete keypair given by its name. (Supported
by API versions '2.0' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
``keypair-list``
Print a list of keypairs for a user (Supported
by API versions '2.0' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
``keypair-show``
Show details about the given keypair.
(Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to
show help message for proper version]
``limits``
Print rate and absolute limits.
``list``
List servers.
``list-secgroup``
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. (Supported
by API versions '2.24' - '2.latest') [hint:
use '--os-compute-api-version' flag to show
help message for proper version]
``live-migration-force-complete``
Force on-going live migration to complete.
(Supported by API versions '2.22' - '2.latest')
[hint: use '--os-compute-api-version' flag to show help message
for proper version]
``lock``
Lock a server. A normal (non-admin) user will
not be able to execute actions on a locked
server.
``meta``
Set or delete metadata on a server.
``migrate``
Migrate a server. The new host will be
selected by the scheduler.
``migration-list``
Print a list of migrations.
``pause``
Pause a server.
``quota-class-show``
List the quotas for a quota class.
``quota-class-update``
Update the quotas for a quota class.
(Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to
show help message for proper version]
``quota-defaults``
List the default quotas for a tenant.
``quota-delete``
Delete quota for a tenant/user so their quota
will Revert back to default.
``quota-show``
List the quotas for a tenant/user.
``quota-update``
Update the quotas for a tenant/user.
(Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to
show help message for proper version]
``reboot``
Reboot a server.
``rebuild``
Shutdown, re-image, and re-boot a server.
``refresh-network``
Refresh server network information.
``remove-fixed-ip``
**DEPRECATED** Remove an IP address from a server.
``remove-secgroup``
Remove a Security Group from a server.
``rescue``
Reboots a server into rescue mode, which
starts the machine from either the initial
image or a specified image, attaching the
current boot disk as secondary.
``reset-network``
Reset network of a server.
``reset-state``
Reset the state of a server.
``resize``
Resize a server.
``resize-confirm``
Confirm a previous resize.
``resize-revert``
Revert a previous resize (and return to the
previous VM).
``restore``
Restore a soft-deleted server.
``resume``
Resume a server.
``server-group-create``
Create a new server group with the specified
details.
``server-group-delete``
Delete specific server group(s).
``server-group-get``
Get a specific server group.
``server-group-list``
Print a list of all server groups.
``server-migration-list``
Get the migrations list of specified server.
(Supported by API versions '2.23' - '2.latest')
[hint: use '--os-compute-api-version' flag to show help message
for proper version]
``server-migration-show``
Get the migration of specified server.
(Supported by API versions '2.23' - '2.latest')
[hint: use '--os-compute-api-version' flag to show help message
for proper version]
``server-tag-add``
Add one or more tags to a server. (Supported
by API versions '2.26' - '2.latest') [hint:
use '--os-compute-api-version' flag to show
help message for proper version]
``server-tag-delete``
Delete one or more tags from a server.
(Supported by API versions '2.26' - '2.latest')
[hint: use '--os-compute-api-version' flag to show help message
for proper version]
``server-tag-delete-all``
Delete all tags from a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
``server-tag-list``
Get list of tags from a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
``server-tag-set``
Set list of tags to a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
``server-topology``
Retrieve NUMA topology of the given server.
(Supported by API versions '2.78' - '2.latest')
``service-delete``
Delete the service.
``service-disable``
Disable the service.
``service-enable``
Enable the service.
``service-force-down``
Force service to down. (Supported by API
versions '2.11' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
``service-list``
Show a list of all running services. Filter by
host & binary.
``set-password``
Change the admin password for a server.
``shelve``
Shelve a server.
``shelve-offload``
Remove a shelved server from the compute node.
``show``
Show details about the given server.
``ssh``
SSH into a server.
``start``
Start the server(s).
``stop``
Stop the server(s).
``suspend``
Suspend a server.
``trigger-crash-dump``
Trigger crash dump in an instance. (Supported
by API versions '2.17' - '2.latest') [hint:
use '--os-compute-api-version' flag to show
help message for proper version]
``unlock``
Unlock a server.
``unpause``
Unpause a server.
``unrescue``
Restart the server from normal boot disk
again.
``unshelve``
Unshelve a server.
``update``
Update the name or the description for a
server.
``usage``
Show usage data for a single tenant.
``usage-list``
List usage data for all tenants.
``version-list``
List all API versions.
``virtual-interface-list``
**DEPRECATED** Show virtual interface info about
the given server.
``volume-attach``
Attach a volume to a server.
``volume-attachments``
List all the volumes attached to a server.
``volume-detach``
Detach a volume from a server.
``volume-update``
Update the attachment on the server. Migrates the data from an
attached volume to the specified available volume and swaps out
the active attachment to the new volume.
Since microversion 2.85, support for updating the
``delete_on_termination`` delete flag, which allows changing the
behavior of volume deletion on instance deletion.
``x509-create-cert``
**DEPRECATED** Create x509 cert for a user in
tenant.
``x509-get-root-cert``
**DEPRECATED** Fetch the x509 root cert.
``bash-completion``
Prints all of the commands and options to
stdout so that the nova.bash_completion script
doesn't have to hard code them.
``help``
Display help about this program or one of its
subcommands.
.. _nova_command_options:
nova optional arguments
~~~~~~~~~~~~~~~~~~~~~~~
``--version``
show program's version number and exit
``--debug``
Print debugging output.
``--os-cache``
Use the auth token cache. Defaults to False if
``env[OS_CACHE]`` is not set.
``--timings``
Print call timing info.
``--os-region-name ``
Defaults to ``env[OS_REGION_NAME]``.
``--service-type ``
Defaults to compute for most actions.
``--service-name ``
Defaults to ``env[NOVA_SERVICE_NAME]``.
``--os-endpoint-type ``
Defaults to ``env[NOVA_ENDPOINT_TYPE]``,
``env[OS_ENDPOINT_TYPE]`` or publicURL.
``--os-compute-api-version ``
Accepts X, X.Y (where X is major and Y is
minor part) or "X.latest", defaults to
``env[OS_COMPUTE_API_VERSION]``.
``--os-endpoint-override ``
Use this API endpoint instead of the Service
Catalog. Defaults to
``env[OS_ENDPOINT_OVERRIDE]``.
``--profile HMAC_KEY``
HMAC key to use for encrypting context data
for performance profiling of operation. This
key should be the value of the HMAC key
configured for the OSprofiler middleware in
nova; it is specified in the Nova
configuration file at "/etc/nova/nova.conf".
Without the key, profiling will not be
triggered even if OSprofiler is enabled on the
server side.
``--os-auth-type , --os-auth-plugin ``
Authentication type to use
.. _nova_add-secgroup:
nova add-secgroup
-----------------
.. code-block:: console
usage: nova add-secgroup
Add a Security Group to a server.
**Positional arguments:**
````
Name or ID of server.
````
Name or ID of Security Group.
.. _nova_agent-create:
nova agent-create
-----------------
.. code-block:: console
usage: nova agent-create
Create new agent build.
**Positional arguments:**
````
Type of OS.
````
Type of architecture.
````
Version.
````
URL.
````
MD5 hash.
````
Type of hypervisor.
.. _nova_agent-delete:
nova agent-delete
-----------------
.. code-block:: console
usage: nova agent-delete
Delete existing agent build.
**Positional arguments:**
````
ID of the agent-build.
.. _nova_agent-list:
nova agent-list
---------------
.. code-block:: console
usage: nova agent-list [--hypervisor ]
List all builds.
**Optional arguments:**
``--hypervisor ``
Type of hypervisor.
.. _nova_agent-modify:
nova agent-modify
-----------------
.. code-block:: console
usage: nova agent-modify
Modify existing agent build.
**Positional arguments:**
````
ID of the agent-build.
````
Version.
````
URL
````
MD5 hash.
.. _nova_aggregate-add-host:
nova aggregate-add-host
-----------------------
.. code-block:: console
usage: nova aggregate-add-host
Add the host to the specified aggregate.
**Positional arguments:**
````
Name or ID of aggregate.
````
The host to add to the aggregate.
.. _nova_aggregate-cache-images:
nova aggregate-cache-images
---------------------------
.. code-block:: console
usage: nova aggregate-cache-images [ ..]
Request image(s) be pre-cached on hosts within the aggregate.
(Supported by API versions '2.81' - '2.latest')
.. versionadded:: 16.0.0
**Positional arguments:**
````
Name or ID of aggregate.
````
Name or ID of image(s) to cache.
.. _nova_aggregate-create:
nova aggregate-create
---------------------
.. code-block:: console
usage: nova aggregate-create []
Create a new aggregate with the specified details.
**Positional arguments:**
````
Name of aggregate.
````
The availability zone of the aggregate (optional).
.. _nova_aggregate-delete:
nova aggregate-delete
---------------------
.. code-block:: console
usage: nova aggregate-delete
Delete the aggregate.
**Positional arguments:**
````
Name or ID of aggregate to delete.
.. _nova_aggregate-list:
nova aggregate-list
-------------------
.. code-block:: console
usage: nova aggregate-list
Print a list of all aggregates.
.. _nova_aggregate-remove-host:
nova aggregate-remove-host
--------------------------
.. code-block:: console
usage: nova aggregate-remove-host
Remove the specified host from the specified aggregate.
**Positional arguments:**
````
Name or ID of aggregate.
````
The host to remove from the aggregate.
.. _nova_aggregate-set-metadata:
nova aggregate-set-metadata
---------------------------
.. code-block:: console
usage: nova aggregate-set-metadata [ ...]
Update the metadata associated with the aggregate.
**Positional arguments:**
````
Name or ID of aggregate to update.
````
Metadata to add/update to aggregate. Specify only the key to
delete a metadata item.
.. _nova_aggregate-show:
nova aggregate-show
-------------------
.. code-block:: console
usage: nova aggregate-show
Show details of the specified aggregate.
**Positional arguments:**
````
Name or ID of aggregate.
.. _nova_aggregate-update:
nova aggregate-update
---------------------
.. code-block:: console
usage: nova aggregate-update [--name NAME]
[--availability-zone ]
Update the aggregate's name and optionally availability zone.
**Positional arguments:**
````
Name or ID of aggregate to update.
**Optional arguments:**
``--name NAME``
New name for aggregate.
``--availability-zone ``
New availability zone for aggregate.
.. _nova_availability-zone-list:
nova availability-zone-list
---------------------------
.. code-block:: console
usage: nova availability-zone-list
List all the availability zones.
.. _nova_backup:
nova backup
-----------
.. code-block:: console
usage: nova backup
Backup a server by creating a 'backup' type snapshot.
**Positional arguments:**
````
Name or ID of server.
````
Name of the backup image.
````
The backup type, like "daily" or "weekly".
````
Int parameter representing how many backups to keep around.
.. _nova_boot:
nova boot
---------
.. code-block:: console
usage: nova boot [--flavor ] [--image ]
[--image-with ] [--boot-volume ]
[--snapshot ] [--min-count ]
[--max-count ] [--meta ]
[--key-name ] [--user-data ]
[--availability-zone ]
[--security-groups ]
[--block-device-mapping ]
[--block-device key1=value1[,key2=value2...]]
[--swap ]
[--ephemeral size=[,format=]]
[--hint ]
[--nic ]
[--config-drive ] [--poll] [--admin-pass ]
[--access-ip-v4 ] [--access-ip-v6 ]
[--description ] [--tags ]
[--return-reservation-id]
[--trusted-image-certificate-id ]
[--host ]
[--hypervisor-hostname ]
Boot a new server.
In order to create a server with pre-existing ports that contain a
``resource_request`` value, such as for guaranteed minimum bandwidth
quality of service support, microversion ``2.72`` is required.
**Positional arguments:**
````
Name for the new server.
**Optional arguments:**
``--flavor ``
Name or ID of flavor (see 'nova flavor-list').
``--image ``
Name or ID of image (see 'glance image-list').
``--image-with ``
Image metadata property (see 'glance image-show').
``--boot-volume ``
Volume ID to boot from.
``--snapshot ``
Snapshot ID to boot from (will create a
volume).
``--min-count ``
Boot at least servers (limited by
quota).
``--max-count ``
Boot up to servers (limited by
quota).
``--meta ``
Record arbitrary key/value metadata to
/meta_data.json on the metadata server. Can be
specified multiple times.
``--key-name ``
Key name of keypair that should be created
earlier with the command keypair-add.
``--user-data ``
user data file to pass to be exposed by the
metadata server.
``--availability-zone ``
The availability zone for server placement.
``--security-groups ``
Comma separated list of security group names.
``--block-device-mapping ``
Block device mapping in the format
=:::.
``--block-device``
key1=value1[,key2=value2...]
Block device mapping with the keys: id=UUID
(image_id, snapshot_id or volume_id only if
using source image, snapshot or volume)
source=source type (image, snapshot, volume or
blank), dest=destination type of the block
device (volume or local), bus=device's bus
(e.g. uml, lxc, virtio, ...; if omitted,
hypervisor driver chooses a suitable default,
honoured only if device type is supplied)
type=device type (e.g. disk, cdrom, ...;
defaults to 'disk') device=name of the device
(e.g. vda, xda, ...; if omitted, hypervisor
driver chooses suitable device depending on
selected bus; note the libvirt driver always
uses default device names), size=size of the
block device in MiB(for swap) and in GiB(for
other formats) (if omitted, hypervisor driver
calculates size), format=device will be
formatted (e.g. swap, ntfs, ...; optional),
bootindex=integer used for ordering the boot
disks (for image backed instances it is equal
to 0, for others need to be specified),
shutdown=shutdown behaviour (either preserve
or remove, for local destination set to
remove), tag=device metadata tag
(optional; supported by API versions '2.42'
- '2.latest'), and volume_type=type of volume
to create (either ID or name) when source is
`blank`, `image` or `snapshot` and dest is `volume`
(optional; supported by API versions '2.67'
- '2.latest').
``--swap ``
Create and attach a local swap block device of
MiB.
``--ephemeral``
size=[,format=]
Create and attach a local ephemeral block
device of GiB and format it to .
``--hint ``
Send arbitrary key/value pairs to the
scheduler for custom use.
``--nic ``
Create a NIC on the server. Specify option
multiple times to create multiple nics unless
using the special 'auto' or 'none' values.
auto: automatically allocate network resources
if none are available. This cannot be
specified with any other nic value and cannot
be specified multiple times. none: do not
attach a NIC at all. This cannot be specified
with any other nic value and cannot be
specified multiple times. net-id: attach NIC
to network with a specific UUID. net-name:
attach NIC to network with this name (either
port-id or net-id or net-name must be
provided), v4-fixed-ip: IPv4 fixed address for
NIC (optional), v6-fixed-ip: IPv6 fixed
address for NIC (optional), port-id: attach
NIC to port with this UUID tag: interface
metadata tag (optional) (either port-id or
net-id must be provided). (Supported by API
versions '2.42' - '2.latest')
``--config-drive ``
Enable config drive. The value must be a
boolean value.
``--poll``
Report the new server boot progress until it
completes.
``--admin-pass ``
Admin password for the instance.
``--access-ip-v4 ``
Alternative access IPv4 of the instance.
``--access-ip-v6 ``
Alternative access IPv6 of the instance.
``--description ``
Description for the server. (Supported by API
versions '2.19' - '2.latest')
``--tags ``
Tags for the server.Tags must be separated by commas: --tags
(Supported by API versions '2.52' - '2.latest')
``--return-reservation-id``
Return a reservation id bound to created servers.
``--trusted-image-certificate-id ``
Trusted image certificate IDs used to validate certificates
during the image signature verification process.
Defaults to env[OS_TRUSTED_IMAGE_CERTIFICATE_IDS].
May be specified multiple times to pass multiple trusted image
certificate IDs. (Supported by API versions '2.63' - '2.latest')
``--host ``
Requested host to create servers. Admin only by default.
(Supported by API versions '2.74' - '2.latest')
``--hypervisor-hostname ``
Requested hypervisor hostname to create servers. Admin only by default.
(Supported by API versions '2.74' - '2.latest')
.. _nova_clear-password:
nova clear-password
-------------------
.. code-block:: console
usage: nova clear-password
Clear the admin password for a server from the metadata server. This action
does not actually change the instance server password.
**Positional arguments:**
````
Name or ID of server.
.. _nova_console-log:
nova console-log
----------------
.. code-block:: console
usage: nova console-log [--length ]
Get console log output of a server.
**Locale encoding issues**
If you encounter an error such as:
.. code-block:: console
UnicodeEncodeError: 'ascii' codec can't encode characters in position
The solution to these problems is different depending on which locale your
computer is running in.
For instance, if you have a German Linux machine, you can fix the problem by
exporting the locale to de_DE.utf-8:
.. code-block:: console
export LC_ALL=de_DE.utf-8
export LANG=de_DE.utf-8
If you are on a US machine, en_US.utf-8 is the encoding of choice. On some
newer Linux systems, you could also try C.UTF-8 as the locale:
.. code-block:: console
export LC_ALL=C.UTF-8
export LANG=C.UTF-8
**Positional arguments:**
````
Name or ID of server.
**Optional arguments:**
``--length ``
Length in lines to tail.
.. _nova_delete:
nova delete
-----------
.. code-block:: console
usage: nova delete [--all-tenants] [ ...]
Immediately shut down and delete specified server(s).
**Positional arguments:**
````
Name or ID of server(s).
**Optional arguments:**
``--all-tenants``
Delete server(s) in another tenant by name (Admin only).
.. _nova_diagnostics:
nova diagnostics
----------------
.. code-block:: console
usage: nova diagnostics
Retrieve server diagnostics.
**Positional arguments:**
````
Name or ID of server.
.. _nova_evacuate:
nova evacuate
-------------
.. code-block:: console
usage: nova evacuate [--password ] [--on-shared-storage] [--force] []
Evacuate server from failed host.
**Positional arguments:**
````
Name or ID of server.
````
Name or ID of the target host. If no host is
specified, the scheduler will choose one.
**Optional arguments:**
``--password ``
Set the provided admin password on the evacuated
server. Not applicable if the server is on shared
storage.
``--on-shared-storage``
Specifies whether server files are located on shared
storage. (Supported by API versions '2.0' - '2.13')
``--force``
Force an evacuation by not verifying the provided destination host by the
scheduler. (Supported by API versions '2.29' - '2.67')
.. warning:: This could result in failures to actually evacuate the
server to the specified host. It is recommended to either not specify
a host so that the scheduler will pick one, or specify a host without
``--force``.
.. _nova_flavor-access-add:
nova flavor-access-add
----------------------
.. code-block:: console
usage: nova flavor-access-add
Add flavor access for the given tenant.
**Positional arguments:**
````
Flavor name or ID to add access for the given tenant.
````
Tenant ID to add flavor access for.
.. _nova_flavor-access-list:
nova flavor-access-list
-----------------------
.. code-block:: console
usage: nova flavor-access-list [--flavor ]
Print access information about the given flavor.
**Optional arguments:**
``--flavor ``
Filter results by flavor name or ID.
.. _nova_flavor-access-remove:
nova flavor-access-remove
-------------------------
.. code-block:: console
usage: nova flavor-access-remove
Remove flavor access for the given tenant.
**Positional arguments:**
````
Flavor name or ID to remove access for the given tenant.
````
Tenant ID to remove flavor access for.
.. _nova_flavor-create:
nova flavor-create
------------------
.. code-block:: console
usage: nova flavor-create [--ephemeral ] [--swap ]
[--rxtx-factor ] [--is-public ]
[--description ]
Create a new flavor.
**Positional arguments:**
````
Unique name of the new flavor.
````
Unique ID of the new flavor. Specifying 'auto' will
generated a UUID for the ID.
````
Memory size in MiB.
````
Disk size in GiB.
````
Number of vcpus
**Optional arguments:**
``--ephemeral ``
Ephemeral space size in GiB (default 0).
``--swap ``
Swap space size in MiB (default 0).
``--rxtx-factor ``
RX/TX factor (default 1).
``--is-public ``
Make flavor accessible to the public (default
true).
``--description ``
A free form description of the flavor. Limited to 65535 characters
in length. Only printable characters are allowed.
(Supported by API versions '2.55' - '2.latest')
.. _nova_flavor-delete:
nova flavor-delete
------------------
.. code-block:: console
usage: nova flavor-delete
Delete a specific flavor
**Positional arguments:**
````
Name or ID of the flavor to delete.
.. _nova_flavor-key:
nova flavor-key
---------------
.. code-block:: console
usage: nova flavor-key [ ...]
Set or unset extra_spec for a flavor.
**Positional arguments:**
````
Name or ID of flavor.
````
Actions: 'set' or 'unset'.
````
Extra_specs to set/unset (only key is necessary on unset).
.. _nova_flavor-list:
nova flavor-list
----------------
.. code-block:: console
usage: nova flavor-list [--extra-specs] [--all] [--marker ]
[--min-disk ] [--min-ram ]
[--limit ] [--sort-key ]
[--sort-dir ]
Print a list of available 'flavors' (sizes of servers).
**Optional arguments:**
``--extra-specs``
Get extra-specs of each flavor.
``--all``
Display all flavors (Admin only).
``--marker ``
The last flavor ID of the previous page; displays
list of flavors after "marker".
``--min-disk ``
Filters the flavors by a minimum disk space, in GiB.
``--min-ram ``
Filters the flavors by a minimum RAM, in MiB.
``--limit ``
Maximum number of flavors to display. If limit is
bigger than 'CONF.api.max_limit' option of Nova API,
limit 'CONF.api.max_limit' will be used instead.
``--sort-key ``
Flavors list sort key.
``--sort-dir ``
Flavors list sort direction.
.. _nova_flavor-show:
nova flavor-show
----------------
.. code-block:: console
usage: nova flavor-show
Show details about the given flavor.
**Positional arguments:**
````
Name or ID of flavor.
nova flavor-update
------------------
.. code-block:: console
usage: nova flavor-update
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]
.. versionadded:: 10.0.0
**Positional arguments**
````
Name or ID of the flavor to update.
````
A free form description of the flavor. Limited to 65535
characters in length. Only printable characters are allowed.
.. _nova_force-delete:
nova force-delete
-----------------
.. code-block:: console
usage: nova force-delete
Force delete a server.
**Positional arguments:**
````
Name or ID of server.
.. _nova_get-mks-console:
nova get-mks-console
--------------------
.. code-block:: console
usage: nova get-mks-console
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]
.. versionadded:: 3.0.0
**Positional arguments:**
````
Name or ID of server.
.. _nova_get-password:
nova get-password
-----------------
.. code-block:: console
usage: nova get-password []
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.
**Positional arguments:**
````
Name or ID of server.
````
Private key (used locally to decrypt password) (Optional).
When specified, the command displays the clear (decrypted) VM
password. When not specified, the ciphered VM password is
displayed.
.. _nova_get-rdp-console:
nova get-rdp-console
--------------------
.. code-block:: console
usage: nova get-rdp-console
Get a rdp console to a server.
**Positional arguments:**
````
Name or ID of server.
````
Type of rdp console ("rdp-html5").
.. _nova_get-serial-console:
nova get-serial-console
-----------------------
.. code-block:: console
usage: nova get-serial-console [--console-type CONSOLE_TYPE]
Get a serial console to a server.
**Positional arguments:**
````
Name or ID of server.
**Optional arguments:**
``--console-type CONSOLE_TYPE``
Type of serial console, default="serial".
.. _nova_get-spice-console:
nova get-spice-console
----------------------
.. code-block:: console
usage: nova get-spice-console
Get a spice console to a server.
**Positional arguments:**
````
Name or ID of server.
````
Type of spice console ("spice-html5").
.. _nova_get-vnc-console:
nova get-vnc-console
--------------------
.. code-block:: console
usage: nova get-vnc-console
Get a vnc console to a server.
**Positional arguments:**
````
Name or ID of server.
````
Type of vnc console ("novnc" or "xvpvnc").
.. _nova_host-evacuate:
nova host-evacuate
------------------
.. code-block:: console
usage: nova host-evacuate [--target_host ] [--force] [--strict]
Evacuate all instances from failed host.
**Positional arguments:**
````
The hypervisor hostname (or pattern) to search for.
.. warning::
Use a fully qualified domain name if you only want to evacuate from
a specific host.
**Optional arguments:**
``--target_host ``
Name of target host. If no host is specified
the scheduler will select a target.
``--force``
Force an evacuation by not verifying the provided destination host by the
scheduler. (Supported by API versions '2.29' - '2.67')
.. warning:: This could result in failures to actually evacuate the
server to the specified host. It is recommended to either not specify
a host so that the scheduler will pick one, or specify a host without
``--force``.
``--strict``
Evacuate host with exact hypervisor hostname match
.. _nova_host-evacuate-live:
nova host-evacuate-live
-----------------------
.. code-block:: console
usage: nova host-evacuate-live [--target-host