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

53 lines
1.4 KiB
ReStructuredText
Raw Normal View History

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
The :program:`nova` shell utility
[docs] Fix length of underline Title length must match the underline Change-Id: Ia7a2bf54a6697c63c423bacd53dfb125b9c620f6
2015-09-17 16:05:33 +03:00
=================================
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
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
The :program:`nova` shell utility interacts with OpenStack Nova API
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
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
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
First, you'll need an OpenStack Nova account and an API key. You get this
by using the `nova-manage` command in OpenStack Nova.
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
You'll need to provide :program:`nova` with your OpenStack username and
Change '_' to '-' in options This changes every command-line option with a '_' in its name and changes them to '-'. The old option names are maintained for backward compatibility but are no longer in the help text. BP command-options Note: there is a dodgy hack in novaclient/shell.py to handle usage-list's --end option that conflicts with --endpoint-type if --endpoint_type is also present for backward compatibility. If --endpoint_type is not added to the parser it works. Go figure. Better solutions that do not break backward compatibility are welcome. Rebased due to https://review.openstack.org/11072 merging. Note: --availability_zone changed to --availability-zone with no backward compatability since this s a new option. Change-Id: I09ab546659be0a0d3f0eadb22ab5e13fac2f059d
2012-08-22 13:01:17 -05:00
API key. You can do this with the :option:`--os-username`, :option:`--os-password`
and :option:`--os-tenant-id` options, but it's easier to just set them as
changed docs about using project id
2011-06-13 16:16:58 +04:00
environment variables by setting two environment variables:
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_USERNAME
Initial commit from fork
2011-01-25 14:01:22 -06:00
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
Your OpenStack Nova username.
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
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_TENANT_NAME
changed docs about using project id
2011-06-13 16:16:58 +04:00
Project for work.
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
The OpenStack API server URL.
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
The OpenStack API version.
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
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://...
Rename v1_1 to v2 Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3. Since future development(microversioning) will be done across V2, implementation should be done in appropriate module(to prevent misleading). Despite the fact that implementation for all versions are equal, discover method for contrib path worked only for v1.1. This patch fixes this bug and modifies shell tests to check all versions. Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
2015-02-03 02:32:58 +02:00
export OS_COMPUTE_API_VERSION=2
Initial commit from fork
2011-01-25 14:01:22 -06:00
From there, all shell commands take the form::
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
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
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
Renamed all CloudServers to OpenStack and python-cloudservers to python-novatools
2011-02-08 09:27:22 -04:00
command.
Copy Permalink