blob: 64ad45ab40d21faa03db3b88e4ef311527fc04e8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
==================================
python-neutronclient documentation
==================================
This is a client for OpenStack Networking API. It provides
:doc:`Python API bindings <reference/index>` (the neutronclient module) and
:doc:`command-line interface (CLI) <cli/index>`.
There are two CLIs which support the Networking API:
:doc:`neutron CLI <cli/neutron>` and
`OpenStack Client (OSC) <https://docs.openstack.org/python-openstackclient/latest/>`__.
OpenStack Client provides the basic network commands and
python-neutronclient provides extensions (aka OSC plugins)
for advanced networking services.
User Documentation
------------------
.. toctree::
:maxdepth: 2
cli/index
reference/index
Contributor Guide
-----------------
In the :doc:`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.
.. toctree::
:maxdepth: 2
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/.
|
