openstack/python-openstackclient
Code Issues Proposed changes
6460f1eb35
python-openstackclient/doc/source/man/openstack.rst
Dean Troyer 6f9dcc13f6 Prep for 0.2 release (0.2.rc1) 
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page

Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
2013-08-01 16:21:22 -05:00

2.7 KiB
Raw Blame History

openstack
SYNOPSIS

openstack [<global-options>] <command> [<command-arguments>]

openstack help <command>

DESCRIPTION

openstack provides a common command-line interface to OpenStack APIs. It is generally equivalent to the CLIs provided by the OpenStack project client librariess, but with a distinct and consistent command structure.

openstack uses a similar authentication scheme as the OpenStack project CLIs, with the credential information supplied either as environment variables or as options on the command line. The primary difference is a preference for using OS_PROJECT_NAME/OS_PROJECT_ID over the old tenant-based names. The old names work for now though.

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<user-name>
export OS_PASSWORD=<password>  # (optional)

OPTIONS

openstack recognizes the following global topions:

--os-auth-url <auth-url>

Authentication URL

--os-project-name <auth-project-name>

Authentication project name (only one of --os-project-name or --os-project-id need be supplied)

--os-project-id <auth-project-id>

Authentication tenant ID (only one of --os-project-name or --os-project-id need be supplied)

--os-username <auth-username>

Authentication username

--os-password <auth-password>

Authentication password

--os-region-name <auth-region-name>

Authentication region name

--os-default-domain <auth-domain>

Default domain ID (defaults to 'default')

NOTES

[This section intentionally left blank. So there.]

COMMANDS

To get a list of the available commands:

openstack -h

To get a description of a specific command:

openstack help <command>

FILES

~/.openstack

ENVIRONMENT VARIABLES

The following environment variables can be set to alter the behaviour of openstack

OS_USERNAME

Set the username

OS_PASSWORD

Set the password

BUGS

Bug reports are accepted at the python-openstackclient LaunchPad project "https://bugs.launchpad.net/python-openstackclient/+bugs".

AUTHORS

Please refer to the AUTHORS file distributed with OpenStackClient.

COPYRIGHT

Copyright 2011-2013 OpenStack Foundation and the authors listed in the AUTHORS file.

LICENSE

http://www.apache.org/licenses/LICENSE-2.0

SEE ALSO

The OpenStack project CLIs, the OpenStack API references. <links TBD>