| 1 |
.. |
| 2 |
Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 3 |
not use this file except in compliance with the License. You may obtain |
| 4 |
a copy of the License at |
| 5 |
|
| 6 |
http://www.apache.org/licenses/LICENSE-2.0 |
| 7 |
|
| 8 |
Unless required by applicable law or agreed to in writing, software |
| 9 |
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 10 |
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 11 |
License for the specific language governing permissions and limitations |
| 12 |
under the License. |
| 13 |
|
| 14 |
Convention for heading levels in Neutron devref: |
| 15 |
======= Heading 0 (reserved for the title in a document) |
| 16 |
------- Heading 1 |
| 17 |
~~~~~~~ Heading 2 |
| 18 |
+++++++ Heading 3 |
| 19 |
''''''' Heading 4 |
| 20 |
(Avoid deeper levels because they do not render well.) |
| 21 |
|
| 22 |
================================== |
| 23 |
python-neutronclient documentation |
| 24 |
================================== |
| 25 |
|
| 26 |
This is a client for OpenStack Networking API. It provides |
| 27 |
:doc:`Python API bindings <reference/index>` (the neutronclient module). |
| 28 |
|
| 29 |
There is |
| 30 |
`OpenStack Client (OSC) <https://docs.openstack.org/python-openstackclient/latest/>`__. |
| 31 |
CLI which support the Networking API. |
| 32 |
|
| 33 |
User Documentation |
| 34 |
------------------ |
| 35 |
|
| 36 |
.. toctree:: |
| 37 |
:maxdepth: 2 |
| 38 |
|
| 39 |
cli/index |
| 40 |
reference/index |
| 41 |
|
| 42 |
Contributor Guide |
| 43 |
----------------- |
| 44 |
|
| 45 |
In the :doc:`Contributor Guide <contributor/index>`, you will find |
| 46 |
information on neutronclient's lower level programming details or APIs |
| 47 |
as well as the transition to OpenStack client. |
| 48 |
|
| 49 |
.. toctree:: |
| 50 |
:maxdepth: 2 |
| 51 |
|
| 52 |
contributor/index |
| 53 |
|
| 54 |
.. note:: |
| 55 |
|
| 56 |
neutron CLI has been deprecated from Ocata release. |
| 57 |
We do not add, change and drop any existing commands any more. |
| 58 |
We only accept changes on OSC plugin, neutronclient python bindings |
| 59 |
and bug fixes on the deprecated CLI (``neutron`` command). |
| 60 |
|
| 61 |
History |
| 62 |
------- |
| 63 |
|
| 64 |
Release notes is available at |
| 65 |
http://docs.openstack.org/releasenotes/python-neutronclient/. |