Akihiro Motoki c4ec6759b6 doc: Improve network CLI page
* Move OSC first as neutron CLI is deprecated
* Add more information on OSC usage (links to embeded command list
  and the mapping guide)
* Add deprecation notice for neutron CLI

This commit also makes toctree structure simpler
At now, we have two index page unlinked from the top page.
I thought it is good first, but it potentially makes things tricky.
Let's remove such tweaks for easy maintenance.

Change-Id: I7fd79f465fa6c04bf5b13f6578796d4c2d01edfd
2017-07-10 11:25:29 +00:00

2.2 KiB

python-neutronclient documentation

This is a client for OpenStack Networking API. It provides Python API bindings <reference/index> (the neutronclient module) and command-line interface (CLI) <cli/index>.

There are two CLIs which support the Networking API: neutron CLI <cli/neutron> and OpenStack Client (OSC). OpenStack Client provides the basic network commands and python-neutronclient provides extensions (aka OSC plugins) for advanced networking services.

User Documentation

cli/index reference/index

Contributor Guide

In the Contributor Guide <contributor/index>, you will find information on neutronclient's lower level programming details or APIs as well as the transition to OpenStack client.

contributor/index

Note

neutron CLI has been deprecated from Ocata release. We do not add, change and drop any existing commands any more. We only accept changes on OSC plugin, neutronclient python bindings and bug fixes on the deprecated CLI (neutron command).

History

Release notes is available at http://docs.openstack.org/releasenotes/python-neutronclient/.