Client for OpenStack services
Go to file
Tang Chen ca34aa1587 Floating IP: Fix "ip floating list" in neutron network
The implementation of "ip floating list" in the commit below
is incorrect:

    Change-Id: I253f66f6bc64470e1a18ffea506048eb53f67d5c

This is because the FloatingIP objects returned from Nova and
Neutron network are different. They need different handling.

This patch fixes this problem.

The output for Neutron network would be:

+--------------------------------------+---------------------+------------------+------+
| ID                                   | Floating IP Address | Fixed IP Address | Port |
+--------------------------------------+---------------------+------------------+------+
| 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3          | None             | None |
+--------------------------------------+---------------------+------------------+------+

The output for Neutron network would be:

+----+---------------------+------------------+-----------+--------+
| ID | Floating IP Address | Fixed IP Address | Server ID | Pool   |
+----+---------------------+------------------+-----------+--------+
|  1 | 172.24.4.1          | None             | None      | public |
+----+---------------------+------------------+-----------+--------+

Change-Id: I1295e922df695414511d9a07ca4a8e2428040064
Partial-Bug: 1519502
Related-to: blueprint neutron-client
2016-02-19 11:10:53 +08:00
doc Merge "Subnet Pool: Add "subnet pool delete" command" 2016-02-18 09:58:22 +00:00
examples Switch to ksa Session 2015-12-02 01:55:14 +00:00
functional Merge "Refactor security group functional tests" 2016-02-15 20:46:51 +00:00
openstackclient Floating IP: Fix "ip floating list" in neutron network 2016-02-19 11:10:53 +08:00
releasenotes Merge "Subnet Pool: Add "subnet pool delete" command" 2016-02-18 09:58:22 +00:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:54:21 +00:00
.gitignore Add reno for release notes management 2015-12-02 14:32:07 -06:00
.gitreview Add openstack-common and test infrastructure. 2012-04-28 22:27:34 +00:00
.mailmap Clean up test environment and remove unused imports. 2013-01-22 11:44:18 -06:00
.testr.conf Use format options for functional tests 2015-05-17 12:33:39 +00:00
HACKING.rst Remove non-existing hacking deviations from doc 2015-08-09 13:22:48 -07:00
LICENSE Remove LICENSE APPENDIX 2015-11-18 13:25:56 +09:00
README.rst Use Block Storage instead of Volume 2015-11-27 17:56:10 +08:00
babel.cfg Add translation markers for user v2 actions 2014-10-09 14:47:19 -04:00
post_test_hook.sh unwedge the gate 2015-10-08 03:09:43 -04:00
requirements.txt Updated from global requirements 2016-02-10 21:59:14 +00:00
setup.cfg Merge "Subnet Pool: Add "subnet pool delete" command" 2016-02-18 09:58:22 +00:00
setup.py Updated from global requirements 2015-09-18 16:42:31 +00:00
test-requirements.txt Remove unused test-requirments 2016-02-18 22:51:04 +08:00
tox.ini Deprecated tox -downloadcache option removed 2015-12-11 23:30:31 +01:00

README.rst

OpenStackClient

Latest Version

Downloads

OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Store and Block Storage APIs together in a single shell with a uniform command structure.

The primary goal is to provide a unified shell command structure and a common language to describe operations in OpenStack.

Getting Started

OpenStack Client can be installed from PyPI using pip:

pip install python-openstackclient

There are a few variants on getting help. A list of global options and supported commands is shown with --help:

openstack --help

There is also a help command that can be used to get help text for a specific command:

openstack help
openstack help server create

Configuration

The CLI is configured via environment variables and command-line options as listed in http://docs.openstack.org/developer/python-openstackclient/authentication.html.

Authentication using username/password is most commonly used:

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

The corresponding command-line options look very similar:

--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--os-password <password>]

If a password is not provided above (in plaintext), you will be interactively prompted to provide one securely.

Authentication may also be performed using an already-acquired token and a URL pointing directly to the service API that presumably was acquired from the Service Catalog:

export OS_TOKEN=<token>
export OS_URL=<url-to-openstack-service>

The corresponding command-line options look very similar:

--os-token <token>
--os-url <url-to-openstack-service>