| 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 |
|
| 15 |
Convention for heading levels in Neutron devref: |
| 16 |
======= Heading 0 (reserved for the title in a document) |
| 17 |
------- Heading 1 |
| 18 |
~~~~~~~ Heading 2 |
| 19 |
+++++++ Heading 3 |
| 20 |
''''''' Heading 4 |
| 21 |
(Avoid deeper levels because they do not render well.) |
| 22 |
|
| 23 |
========= |
| 24 |
Using CLI |
| 25 |
========= |
| 26 |
|
| 27 |
There is `OpenStackClient (OSC) |
| 28 |
<https://docs.openstack.org/python-openstackclient/latest/>`__ |
| 29 |
which support the Networking API |
| 30 |
|
| 31 |
OpenStackClient |
| 32 |
--------------- |
| 33 |
|
| 34 |
OpenStackClient provides |
| 35 |
`the basic network commands <https://docs.openstack.org/python-openstackclient/latest/cli/command-list.html>`__ |
| 36 |
and python-neutronclient provides :doc:`extensions <osc_plugins>` |
| 37 |
(aka OSC plugins) for advanced networking services. |
| 38 |
|
| 39 |
.. toctree:: |
| 40 |
:maxdepth: 1 |
| 41 |
|
| 42 |
Basic network commands <https://docs.openstack.org/python-openstackclient/latest/cli/command-list.html> |
| 43 |
Network commands for advanced networking services <osc_plugins> |
| 44 |
Mapping Guide from neutron CLI <https://docs.openstack.org/python-openstackclient/latest/cli/decoder.html#neutron-cli> |
| 45 |
|
| 46 |
neutron CLI |
| 47 |
----------- |
| 48 |
|
| 49 |
.. warning:: |
| 50 |
|
| 51 |
neutron CLI is removed. Use openstack CLI instead. See `openstack CLI command list |
| 52 |
<https://docs.openstack.org/python-openstackclient/latest/cli/command-list.html>`__ |
| 53 |
and :doc:`its extensions for advanced networking services <osc_plugins>`. |
| 54 |
The command mapping from neutron CLI to openstack CLI is available |
| 55 |
`here <https://docs.openstack.org/python-openstackclient/latest/cli/decoder.html#neutron-cli>`__. |