openstack/python-novaclient
Code Issues Proposed changes
edebd28d54
python-novaclient/doc/source/user/shell.rst

97 lines
2.6 KiB
ReStructuredText
Raw Normal View History

doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
===================================
The :program:`nova` Shell Utility
===================================
Initial commit from fork
2011-01-25 14:01:22 -06:00
renamed cmdline tool from novatools to nova. Changed version to 2.1. Changed license to Apache. Added copyright notices. Cleaner exception reporting in non-debug scnario.
2011-02-24 13:54:10 -04:00
.. program:: nova
Initial commit from fork
2011-01-25 14:01:22 -06:00
.. highlight:: bash
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
The :program:`nova` shell utility interacts with OpenStack Nova API from the
command line. It supports the entirety of the OpenStack Nova API.
Initial commit from fork
2011-01-25 14:01:22 -06:00
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
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:
Initial commit from fork
2011-01-25 14:01:22 -06:00
docs: Update docs to reflect deprecation status Change-Id: I56b862305b31916cef143494050e5e08b1ac70b1 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2022-04-05 18:02:39 +01:00
.. deprecated:: 17.8.0
The ``nova`` CLI has been deprecated in favour of the unified
``openstack`` CLI. For information on using the ``openstack`` CLI, see
:python-openstackclient-doc:`OpenStackClient <>`.
Change CLIAuth arg names Change the argument names used for common Keystone authentication per the updated http://wiki.openstack.org/CLIAuth: --auth_url -> --os_auth_url --password -> --os_password --username -> --os_username --tenant_name -> os_tenant_name --region_name -> os_region_name All old args are depricated but available for backward compatibility. Fixes bug 954531 Change-Id: Ic67c447e4e4b8d793f587c789cecd149446194f3
2012-03-13 22:30:52 -05:00
.. envvar:: OS_USERNAME
Initial commit from fork
2011-01-25 14:01:22 -06:00
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
Your OpenStack Keystone user name.
Initial commit from fork
2011-01-25 14:01:22 -06:00
Change CLIAuth arg names Change the argument names used for common Keystone authentication per the updated http://wiki.openstack.org/CLIAuth: --auth_url -> --os_auth_url --password -> --os_password --username -> --os_username --tenant_name -> os_tenant_name --region_name -> os_region_name All old args are depricated but available for backward compatibility. Fixes bug 954531 Change-Id: Ic67c447e4e4b8d793f587c789cecd149446194f3
2012-03-13 22:30:52 -05:00
.. envvar:: OS_PASSWORD
Initial commit from fork
2011-01-25 14:01:22 -06:00
tests working
2011-11-09 07:10:46 -08:00
Your password.
Initial commit from fork
2011-01-25 14:01:22 -06:00
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
.. 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
changed docs about using project id
2011-06-13 16:16:58 +04:00
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
The user's domain ID.
changed docs about using project id
2011-06-13 16:16:58 +04:00
Change CLIAuth arg names Change the argument names used for common Keystone authentication per the updated http://wiki.openstack.org/CLIAuth: --auth_url -> --os_auth_url --password -> --os_password --username -> --os_username --tenant_name -> os_tenant_name --region_name -> os_region_name All old args are depricated but available for backward compatibility. Fixes bug 954531 Change-Id: Ic67c447e4e4b8d793f587c789cecd149446194f3
2012-03-13 22:30:52 -05:00
.. envvar:: OS_AUTH_URL
renamed to novaclient and fixed flavor tests
2011-02-26 05:04:40 -04:00
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
The OpenStack Keystone endpoint URL.
renamed to novaclient and fixed flavor tests
2011-02-26 05:04:40 -04:00
Rename NOVA_VERSION to OS_COMPUTE_API_VERSION. Fixes bug 940432. Change-Id: I18187eb68d936632b4ae78676a0a9f062afba8f2
2012-04-12 14:16:31 -05:00
.. envvar:: OS_COMPUTE_API_VERSION
Added documentation for NOVA_VERSION
2011-08-07 14:00:23 -05:00
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
The OpenStack Nova API version (microversion).
Added documentation for NOVA_VERSION
2011-08-07 14:00:23 -05:00
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
.. envvar:: OS_REGION_NAME
The Keystone region name. Defaults to the first region if multiple regions
are available.
Microversion 2.63 - Add trusted_image_certificates This change adds a `--trusted-image-certificate-id` option to the `nova boot` and `nova rebuild` commands. This option takes in a a single trusted certificate ID. The option may be used multiple times to specify multiple trusted certificate IDs, which will be used to validate certificates in the image signature verification process. If ID values are not specified using this option, the value of the newly added OS_TRUSTED_IMAGE_CERTIFICATE_IDS environment variable will be used instead. This value will be converted into a list before being passed on. The ``nova rebuild`` command also gets a new ``--trusted-image-certificates-unset`` option to unset/reset the trusted image certificates in a server during rebuild. This is similar to unsetting key_name and user_data during rebuild. Corresponding `trusted_image_certificates` kwarg has been added to the server create and rebuild Python API bindings. Co-Authored-By: Brianna Poulos <Brianna.Poulos@jhuapl.edu> Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com> Change-Id: I235541a689732826950c7b2a510d5835211120c3 Implements: blueprint nova-validate-certificates
2017-09-03 17:24:40 -04:00
.. 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
Initial commit from fork
2011-01-25 14:01:22 -06:00
For example, in Bash you'd use::
Change CLIAuth arg names Change the argument names used for common Keystone authentication per the updated http://wiki.openstack.org/CLIAuth: --auth_url -> --os_auth_url --password -> --os_password --username -> --os_username --tenant_name -> os_tenant_name --region_name -> os_region_name All old args are depricated but available for backward compatibility. Fixes bug 954531 Change-Id: Ic67c447e4e4b8d793f587c789cecd149446194f3
2012-03-13 22:30:52 -05:00
export OS_USERNAME=yourname
export OS_PASSWORD=yadayadayada
Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895
2017-10-16 17:53:34 +09:00
export OS_PROJECT_NAME=myproject
export OS_PROJECT_DOMAIN_NAME=default
export OS_USER_DOMAIN_NAME=default
export OS_AUTH_URL=http://<url-to-openstack-keystone>/identity
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
export OS_COMPUTE_API_VERSION=2.1
Use Sphinx 1.5 warning-is-error With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. There are only three related fixes required. Change-Id: I84b020c18a8a1c7c11a35bacd61523bbb094abe4
2017-03-16 16:16:44 +00:00
Initial commit from fork
2011-01-25 14:01:22 -06:00
From there, all shell commands take the form::
Use Sphinx 1.5 warning-is-error With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. There are only three related fixes required. Change-Id: I84b020c18a8a1c7c11a35bacd61523bbb094abe4
2017-03-16 16:16:44 +00:00
renamed cmdline tool from novatools to nova. Changed version to 2.1. Changed license to Apache. Added copyright notices. Cleaner exception reporting in non-debug scnario.
2011-02-24 13:54:10 -04:00
nova <command> [arguments...]
Initial commit from fork
2011-01-25 14:01:22 -06:00
doc: Create directory structure for docs migration The spec [1] recommends the following sections: - install - contributor - configuration - cli - admin - user - reference Only a few of these are useful here: - contributor - cli - user - reference Add these and populate them. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-04 11:06:56 +01:00
Run :program:`nova help` to get a full list of all possible commands, and run
:program:`nova help <command>` to get detailed help for that command.
PDF documentation build Also reorganizes the document structure to match both HTML and PDF docs. Story: 2006100 Task: 35143 Change-Id: Ie3f38e2ecf52e6a6cbd52bb36196e6f589f1ca0f
2019-10-11 03:48:51 +09:00
For more information, see :doc:`the command reference </cli/nova>`.
Copy Permalink