rearrange content to fit the new standard layout
Part of doc-migration work The proposed document strucutre is documented at: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: I3b774ae8c55e5d980e82ae4e81ade75f79074197
This commit is contained in:
Akihiro Motoki
parent
70c3da917b
commit
40ca013fab
@ -1,4 +1,3 @@
|
|||||||
========================
|
|
||||||
Team and repository tags
|
Team and repository tags
|
||||||
========================
|
========================
|
||||||
|
|
||||||
@ -10,8 +9,8 @@ Team and repository tags
|
|||||||
This package contains neutron-dynamic-routing code which depends upon neutron
|
This package contains neutron-dynamic-routing code which depends upon neutron
|
||||||
and it's related libraries to run.
|
and it's related libraries to run.
|
||||||
|
|
||||||
External Resources
|
Project Resources
|
||||||
==================
|
=================
|
||||||
|
|
||||||
The homepage for Neutron is: https://launchpad.net/neutron. Use this
|
The homepage for Neutron is: https://launchpad.net/neutron. Use this
|
||||||
site for asking for help, and filing bugs. We use a single launchpad
|
site for asking for help, and filing bugs. We use a single launchpad
|
||||||
|
|||||||
@ -22,6 +22,7 @@
|
|||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
|
=====
|
||||||
Agent
|
Agent
|
||||||
=====
|
=====
|
||||||
|
|
||||||
@ -90,4 +91,4 @@ Here is an example to associate/disassociate a BGP Speaker to/from a DRAgent.
|
|||||||
.. note:: Currently, auto-scheduling is not supported.
|
.. note:: Currently, auto-scheduling is not supported.
|
||||||
|
|
||||||
ReST API's for neutron-dynamic-routing scheduler is defined in the
|
ReST API's for neutron-dynamic-routing scheduler is defined in the
|
||||||
API document :doc:`api`
|
API document :doc:`/reference/index`
|
||||||
@ -22,10 +22,14 @@
|
|||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
=====
|
====================
|
||||||
Usage
|
Administration Guide
|
||||||
=====
|
====================
|
||||||
|
|
||||||
To use neutron-dynamic-routing in a project::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
import neutron_dynamic_routing
|
system-design
|
||||||
|
bgp-speaker
|
||||||
|
route-advertisement
|
||||||
|
agent-scheduler
|
||||||
194
doc/source/cli/bgp-peer.rst
Normal file
194
doc/source/cli/bgp-peer.rst
Normal file
@ -0,0 +1,194 @@
|
|||||||
|
========
|
||||||
|
BGP Peer
|
||||||
|
========
|
||||||
|
|
||||||
|
BGP Peer Create
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-peer-create [-h]
|
||||||
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>]
|
||||||
|
[--noindent] [--prefix PREFIX]
|
||||||
|
[--request-format {json}]
|
||||||
|
[--tenant-id TENANT_ID] --peer-ip
|
||||||
|
PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS
|
||||||
|
[--auth-type PEER_AUTH_TYPE]
|
||||||
|
[--password AUTH_PASSWORD]
|
||||||
|
NAME
|
||||||
|
|
||||||
|
Create a BGP Peer.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``NAME``
|
||||||
|
Name of the BGP peer to create
|
||||||
|
|
||||||
|
``--peer-ip PEER_IP_ADDRESS``
|
||||||
|
Peer IP address.
|
||||||
|
|
||||||
|
``--remote-as PEER_REMOTE_AS``
|
||||||
|
Peer AS number. (Integer in [1, 65535] is allowed.)
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``--auth-type PEER_AUTH_TYPE``
|
||||||
|
Authentication algorithm. Supported algorithms:
|
||||||
|
none(default), md5
|
||||||
|
|
||||||
|
``--password AUTH_PASSWORD``
|
||||||
|
Authentication password.
|
||||||
|
|
||||||
|
BGP Peer List
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-peer-list [-h]
|
||||||
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
||||||
|
[--quote {all,minimal,none,nonnumeric}]
|
||||||
|
[--request-format {json}] [-D] [-F FIELD]
|
||||||
|
[-P SIZE] [--sort-key FIELD]
|
||||||
|
[--sort-dir {asc,desc}]
|
||||||
|
|
||||||
|
List BGP peers.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
|
|
||||||
|
BGP Peer Show
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-peer-show [-h]
|
||||||
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
||||||
|
[--prefix PREFIX] [--request-format {json}] [-D]
|
||||||
|
[-F FIELD]
|
||||||
|
BGP_PEER
|
||||||
|
|
||||||
|
Show information of a given BGP peer.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_PEER``
|
||||||
|
ID or name of the BGP peer to look up.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
|
|
||||||
|
BGP Peer Delete
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-peer-delete [-h] [--request-format {json}] BGP_PEER
|
||||||
|
|
||||||
|
Delete a BGP peer.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_PEER``
|
||||||
|
ID or name of the BGP peer to delete.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
BGP Peer Update
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-peer-update [-h] [--request-format {json}] [--name NAME]
|
||||||
|
[--password AUTH_PASSWORD]
|
||||||
|
BGP_PEER
|
||||||
|
|
||||||
|
Update BGP Peer's information.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_PEER``
|
||||||
|
ID or name of the BGP peer to update.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``--name NAME``
|
||||||
|
Updated name of the BGP peer.
|
||||||
|
|
||||||
|
``--password AUTH_PASSWORD``
|
||||||
|
Updated authentication password.
|
||||||
|
|
||||||
|
Add Peer to BGP Speaker
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-peer-add [-h] [--request-format {json}]
|
||||||
|
BGP_SPEAKER BGP_PEER
|
||||||
|
|
||||||
|
Add a peer to the BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
``BGP_PEER``
|
||||||
|
ID or name of the BGP peer to add.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
Delete Peer from BGP Speaker
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-peer-remove [-h] [--request-format {json}]
|
||||||
|
BGP_SPEAKER BGP_PEER
|
||||||
|
|
||||||
|
Remove a peer from the BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
``BGP_PEER``
|
||||||
|
ID or name of the BGP peer to remove.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
246
doc/source/cli/bgp-speaker.rst
Normal file
246
doc/source/cli/bgp-speaker.rst
Normal file
@ -0,0 +1,246 @@
|
|||||||
|
===========
|
||||||
|
BGP Speaker
|
||||||
|
===========
|
||||||
|
|
||||||
|
BGP Speaker Create
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-create [-h]
|
||||||
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>]
|
||||||
|
[--noindent] [--prefix PREFIX]
|
||||||
|
[--request-format {json}]
|
||||||
|
[--tenant-id TENANT_ID] --local-as LOCAL_AS
|
||||||
|
[--ip-version {4,6}]
|
||||||
|
[--advertise-floating-ip-host-routes {True,False}]
|
||||||
|
[--advertise-tenant-networks {True,False}]
|
||||||
|
NAME
|
||||||
|
|
||||||
|
Create a BGP Speaker with a specified NAME.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``NAME``
|
||||||
|
Name of the BGP speaker to create.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``--local-as LOCAL_AS``
|
||||||
|
Local AS number. (Integer in [1, 65535] is allowed.)
|
||||||
|
|
||||||
|
``--ip-version {4,6}``
|
||||||
|
IP version for the BGP speaker (default is 4)
|
||||||
|
|
||||||
|
``--advertise-floating-ip-host-routes {True,False}``
|
||||||
|
Whether to enable or disable the advertisement of
|
||||||
|
floating-ip host routes by the BGP speaker. By default
|
||||||
|
floating ip host routes will be advertised by the BGP
|
||||||
|
speaker.
|
||||||
|
|
||||||
|
``--advertise-tenant-networks {True,False}``
|
||||||
|
Whether to enable or disable the advertisement of
|
||||||
|
tenant network routes by the BGP speaker. By default
|
||||||
|
tenant network routes will be advertised by the BGP
|
||||||
|
speaker.
|
||||||
|
|
||||||
|
BGP Speaker List
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-list [-h]
|
||||||
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>]
|
||||||
|
[--noindent]
|
||||||
|
[--quote {all,minimal,none,nonnumeric}]
|
||||||
|
[--request-format {json}] [-D] [-F FIELD]
|
||||||
|
[-P SIZE] [--sort-key FIELD]
|
||||||
|
[--sort-dir {asc,desc}]
|
||||||
|
|
||||||
|
List BGP speakers.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
|
|
||||||
|
BGP Speaker Show
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-show [-h]
|
||||||
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>]
|
||||||
|
[--noindent] [--prefix PREFIX]
|
||||||
|
[--request-format {json}] [-D] [-F FIELD]
|
||||||
|
BGP_SPEAKER
|
||||||
|
|
||||||
|
Show information of a given BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker to look up.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
|
|
||||||
|
BGP Speaker Delete
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-delete [-h] [--request-format {json}] BGP_SPEAKER
|
||||||
|
|
||||||
|
Delete a BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker to delete.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
BGP Speaker Update
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-update [-h] [--request-format {json}] [--name NAME]
|
||||||
|
[--advertise-floating-ip-host-routes {True,False}]
|
||||||
|
[--advertise-tenant-networks {True,False}]
|
||||||
|
BGP_SPEAKER
|
||||||
|
|
||||||
|
Update BGP Speaker's information.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker to update.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``--name NAME``
|
||||||
|
Name of the BGP speaker to update.
|
||||||
|
|
||||||
|
``--advertise-floating-ip-host-routes {True,False}``
|
||||||
|
Whether to enable or disable the advertisement of
|
||||||
|
floating-ip host routes by the BGP speaker. By default
|
||||||
|
floating ip host routes will be advertised by the BGP
|
||||||
|
speaker.
|
||||||
|
|
||||||
|
``--advertise-tenant-networks {True,False}``
|
||||||
|
Whether to enable or disable the advertisement of
|
||||||
|
tenant network routes by the BGP speaker. By default
|
||||||
|
tenant network routes will be advertised by the BGP
|
||||||
|
speaker.
|
||||||
|
|
||||||
|
Add Network to BGP Speaker
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-network-add [-h] [--request-format {json}]
|
||||||
|
BGP_SPEAKER NETWORK
|
||||||
|
|
||||||
|
Add a network to the BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
``NETWORK``
|
||||||
|
ID or name of the network to add.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
Delete Network from BGP Speaker
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-network-remove [-h] [--request-format {json}]
|
||||||
|
BGP_SPEAKER NETWORK
|
||||||
|
|
||||||
|
Remove a network from the BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
``NETWORK``
|
||||||
|
ID or name of the network to remove.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
BGP Advertised Routes List
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-advertiseroute-list [-h]
|
||||||
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN]
|
||||||
|
[--max-width <integer>]
|
||||||
|
[--noindent]
|
||||||
|
[--quote {all,minimal,none,nonnumeric}]
|
||||||
|
[--request-format {json}] [-D]
|
||||||
|
[-F FIELD] [-P SIZE]
|
||||||
|
[--sort-key FIELD]
|
||||||
|
[--sort-dir {asc,desc}]
|
||||||
|
BGP_SPEAKER
|
||||||
|
|
||||||
|
List routes advertised by a given BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
116
doc/source/cli/dynamic-routing-agent.rst
Normal file
116
doc/source/cli/dynamic-routing-agent.rst
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
=====================
|
||||||
|
Dynamic Routing Agent
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Add BGP Speaker to Dynamic Routing Agent
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-dragent-speaker-add [-h] [--request-format {json}]
|
||||||
|
BGP_DRAGENT_ID BGP_SPEAKER
|
||||||
|
|
||||||
|
Add a BGP speaker to a Dynamic Routing agent.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_DRAGENT_ID``
|
||||||
|
ID of the Dynamic Routing agent.
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
Delete BGP Speaker from Dynamic Routing Agent
|
||||||
|
---------------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-dragent-speaker-remove [-h] [--request-format {json}]
|
||||||
|
BGP_DRAGENT_ID BGP_SPEAKER
|
||||||
|
|
||||||
|
Removes a BGP speaker from a Dynamic Routing agent.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_DRAGENT_ID``
|
||||||
|
ID of the Dynamic Routing agent.
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
List BGP Speakers hosted by a Dynamic Routing Agent
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-speaker-list-on-dragent [-h]
|
||||||
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN] [--max-width <integer>]
|
||||||
|
[--noindent]
|
||||||
|
[--quote {all,minimal,none,nonnumeric}]
|
||||||
|
[--request-format {json}] [-D]
|
||||||
|
[-F FIELD]
|
||||||
|
BGP_DRAGENT_ID
|
||||||
|
|
||||||
|
List BGP speakers hosted by a Dynamic Routing agent.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_DRAGENT_ID``
|
||||||
|
ID of the Dynamic Routing agent.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
|
|
||||||
|
List Dynamic Routing Agents Hosting a BGP Speaker
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: neutron bgp-dragent-list-hosting-speaker [-h]
|
||||||
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
||||||
|
[-c COLUMN]
|
||||||
|
[--max-width <integer>]
|
||||||
|
[--noindent]
|
||||||
|
[--quote {all,minimal,none,nonnumeric}]
|
||||||
|
[--request-format {json}] [-D]
|
||||||
|
[-F FIELD]
|
||||||
|
BGP_SPEAKER
|
||||||
|
|
||||||
|
List Dynamic Routing agents hosting a BGP speaker.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``BGP_SPEAKER``
|
||||||
|
ID or name of the BGP speaker.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``-h, --help``
|
||||||
|
show this help message and exit
|
||||||
|
|
||||||
|
``-D, --show-details``
|
||||||
|
Show detailed information.
|
||||||
|
|
||||||
|
``-F FIELD, --field FIELD``
|
||||||
|
Specify the field(s) to be returned by server. You can
|
||||||
|
repeat this option.
|
||||||
43
doc/source/cli/index.rst
Normal file
43
doc/source/cli/index.rst
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
..
|
||||||
|
Copyright 2016 Huawei Technologies India Pvt Limited.
|
||||||
|
|
||||||
|
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.)
|
||||||
|
|
||||||
|
Command-Line Interface
|
||||||
|
======================
|
||||||
|
|
||||||
|
Neutron client has provided the command-line interfaces (CLI) to realize dynamic routing
|
||||||
|
services supported by neutron-dynamic-routing project.
|
||||||
|
|
||||||
|
Current implementation only supports the command line interfaces for BGP functionality.
|
||||||
|
For query on what specific :command:`neutron bgp` commands are supported,
|
||||||
|
enter:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ neutron help | grep bgp
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
*
|
||||||
@ -25,4 +25,4 @@
|
|||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
.. include:: ../../../CONTRIBUTING.rst
|
||||||
@ -22,8 +22,8 @@
|
|||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
Drivers
|
DRAgent Drivers
|
||||||
=======
|
===============
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
------------
|
------------
|
||||||
43
doc/source/contributor/index.rst
Normal file
43
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
..
|
||||||
|
Copyright 2016 Huawei Technologies India Pvt Limited.
|
||||||
|
|
||||||
|
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.)
|
||||||
|
|
||||||
|
===============
|
||||||
|
Developer Guide
|
||||||
|
===============
|
||||||
|
|
||||||
|
In the Developer Guide, you will find information on neutron-dynamic-routing
|
||||||
|
lower level programming APIs. There are sections that cover the core pieces
|
||||||
|
of neutron-dynamic-routing, including its API, command-lines, database,
|
||||||
|
system-design, alembic-migration etc. There are also subsections that describe
|
||||||
|
specific drivers inside neutron-dynamic-routing. Finally, the developer guide
|
||||||
|
includes information about testing and supported functionalities as well. This
|
||||||
|
documentation is generated by the Sphinx toolkit and lives in the source
|
||||||
|
tree.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
contributing
|
||||||
|
testing
|
||||||
|
dragent-drivers
|
||||||
@ -1,623 +0,0 @@
|
|||||||
..
|
|
||||||
Copyright 2016 Huawei Technologies India Pvt Limited.
|
|
||||||
|
|
||||||
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.)
|
|
||||||
|
|
||||||
Command Lines
|
|
||||||
=============
|
|
||||||
|
|
||||||
Neutron client has provided the command-line interfaces (CLI) to realize dynamic routing
|
|
||||||
services supported by neutron-dynamic-routing project.
|
|
||||||
|
|
||||||
Current implementation only supports the command line interfaces for BGP functionality.
|
|
||||||
For query on what specific :command:`neutron bgp` commands are supported,
|
|
||||||
enter:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ neutron help | grep bgp
|
|
||||||
|
|
||||||
BGP
|
|
||||||
---
|
|
||||||
|
|
||||||
BGP Speaker Create
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-create [-h]
|
|
||||||
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>]
|
|
||||||
[--noindent] [--prefix PREFIX]
|
|
||||||
[--request-format {json}]
|
|
||||||
[--tenant-id TENANT_ID] --local-as LOCAL_AS
|
|
||||||
[--ip-version {4,6}]
|
|
||||||
[--advertise-floating-ip-host-routes {True,False}]
|
|
||||||
[--advertise-tenant-networks {True,False}]
|
|
||||||
NAME
|
|
||||||
|
|
||||||
Create a BGP Speaker with a specified NAME.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``NAME``
|
|
||||||
Name of the BGP speaker to create.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``--local-as LOCAL_AS``
|
|
||||||
Local AS number. (Integer in [1, 65535] is allowed.)
|
|
||||||
|
|
||||||
``--ip-version {4,6}``
|
|
||||||
IP version for the BGP speaker (default is 4)
|
|
||||||
|
|
||||||
``--advertise-floating-ip-host-routes {True,False}``
|
|
||||||
Whether to enable or disable the advertisement of
|
|
||||||
floating-ip host routes by the BGP speaker. By default
|
|
||||||
floating ip host routes will be advertised by the BGP
|
|
||||||
speaker.
|
|
||||||
|
|
||||||
``--advertise-tenant-networks {True,False}``
|
|
||||||
Whether to enable or disable the advertisement of
|
|
||||||
tenant network routes by the BGP speaker. By default
|
|
||||||
tenant network routes will be advertised by the BGP
|
|
||||||
speaker.
|
|
||||||
|
|
||||||
BGP Speaker List
|
|
||||||
~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-list [-h]
|
|
||||||
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>]
|
|
||||||
[--noindent]
|
|
||||||
[--quote {all,minimal,none,nonnumeric}]
|
|
||||||
[--request-format {json}] [-D] [-F FIELD]
|
|
||||||
[-P SIZE] [--sort-key FIELD]
|
|
||||||
[--sort-dir {asc,desc}]
|
|
||||||
|
|
||||||
List BGP speakers.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
|
|
||||||
BGP Speaker Show
|
|
||||||
~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-show [-h]
|
|
||||||
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>]
|
|
||||||
[--noindent] [--prefix PREFIX]
|
|
||||||
[--request-format {json}] [-D] [-F FIELD]
|
|
||||||
BGP_SPEAKER
|
|
||||||
|
|
||||||
Show information of a given BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker to look up.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
|
|
||||||
BGP Speaker Delete
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-delete [-h] [--request-format {json}] BGP_SPEAKER
|
|
||||||
|
|
||||||
Delete a BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker to delete.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
BGP Speaker Update
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-update [-h] [--request-format {json}] [--name NAME]
|
|
||||||
[--advertise-floating-ip-host-routes {True,False}]
|
|
||||||
[--advertise-tenant-networks {True,False}]
|
|
||||||
BGP_SPEAKER
|
|
||||||
|
|
||||||
Update BGP Speaker's information.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker to update.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``--name NAME``
|
|
||||||
Name of the BGP speaker to update.
|
|
||||||
|
|
||||||
``--advertise-floating-ip-host-routes {True,False}``
|
|
||||||
Whether to enable or disable the advertisement of
|
|
||||||
floating-ip host routes by the BGP speaker. By default
|
|
||||||
floating ip host routes will be advertised by the BGP
|
|
||||||
speaker.
|
|
||||||
|
|
||||||
``--advertise-tenant-networks {True,False}``
|
|
||||||
Whether to enable or disable the advertisement of
|
|
||||||
tenant network routes by the BGP speaker. By default
|
|
||||||
tenant network routes will be advertised by the BGP
|
|
||||||
speaker.
|
|
||||||
|
|
||||||
Add Network to BGP Speaker
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-network-add [-h] [--request-format {json}]
|
|
||||||
BGP_SPEAKER NETWORK
|
|
||||||
|
|
||||||
Add a network to the BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
``NETWORK``
|
|
||||||
ID or name of the network to add.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
Delete Network from BGP Speaker
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-network-remove [-h] [--request-format {json}]
|
|
||||||
BGP_SPEAKER NETWORK
|
|
||||||
|
|
||||||
Remove a network from the BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
``NETWORK``
|
|
||||||
ID or name of the network to remove.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
BGP Advertised Routes List
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-advertiseroute-list [-h]
|
|
||||||
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN]
|
|
||||||
[--max-width <integer>]
|
|
||||||
[--noindent]
|
|
||||||
[--quote {all,minimal,none,nonnumeric}]
|
|
||||||
[--request-format {json}] [-D]
|
|
||||||
[-F FIELD] [-P SIZE]
|
|
||||||
[--sort-key FIELD]
|
|
||||||
[--sort-dir {asc,desc}]
|
|
||||||
BGP_SPEAKER
|
|
||||||
|
|
||||||
List routes advertised by a given BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
|
|
||||||
BGP Peer Create
|
|
||||||
~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-peer-create [-h]
|
|
||||||
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>]
|
|
||||||
[--noindent] [--prefix PREFIX]
|
|
||||||
[--request-format {json}]
|
|
||||||
[--tenant-id TENANT_ID] --peer-ip
|
|
||||||
PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS
|
|
||||||
[--auth-type PEER_AUTH_TYPE]
|
|
||||||
[--password AUTH_PASSWORD]
|
|
||||||
NAME
|
|
||||||
|
|
||||||
Create a BGP Peer.
|
|
||||||
|
|
||||||
positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``NAME``
|
|
||||||
Name of the BGP peer to create
|
|
||||||
|
|
||||||
``--peer-ip PEER_IP_ADDRESS``
|
|
||||||
Peer IP address.
|
|
||||||
|
|
||||||
``--remote-as PEER_REMOTE_AS``
|
|
||||||
Peer AS number. (Integer in [1, 65535] is allowed.)
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``--auth-type PEER_AUTH_TYPE``
|
|
||||||
Authentication algorithm. Supported algorithms:
|
|
||||||
none(default), md5
|
|
||||||
|
|
||||||
``--password AUTH_PASSWORD``
|
|
||||||
Authentication password.
|
|
||||||
|
|
||||||
BGP Peer List
|
|
||||||
~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-peer-list [-h]
|
|
||||||
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
||||||
[--quote {all,minimal,none,nonnumeric}]
|
|
||||||
[--request-format {json}] [-D] [-F FIELD]
|
|
||||||
[-P SIZE] [--sort-key FIELD]
|
|
||||||
[--sort-dir {asc,desc}]
|
|
||||||
|
|
||||||
List BGP peers.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
|
|
||||||
BGP Peer Show
|
|
||||||
~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-peer-show [-h]
|
|
||||||
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
||||||
[--prefix PREFIX] [--request-format {json}] [-D]
|
|
||||||
[-F FIELD]
|
|
||||||
BGP_PEER
|
|
||||||
|
|
||||||
Show information of a given BGP peer.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_PEER``
|
|
||||||
ID or name of the BGP peer to look up.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
|
|
||||||
BGP Peer Delete
|
|
||||||
~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-peer-delete [-h] [--request-format {json}] BGP_PEER
|
|
||||||
|
|
||||||
Delete a BGP peer.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_PEER``
|
|
||||||
ID or name of the BGP peer to delete.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
BGP Peer Update
|
|
||||||
~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-peer-update [-h] [--request-format {json}] [--name NAME]
|
|
||||||
[--password AUTH_PASSWORD]
|
|
||||||
BGP_PEER
|
|
||||||
|
|
||||||
Update BGP Peer's information.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_PEER``
|
|
||||||
ID or name of the BGP peer to update.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``--name NAME``
|
|
||||||
Updated name of the BGP peer.
|
|
||||||
|
|
||||||
``--password AUTH_PASSWORD``
|
|
||||||
Updated authentication password.
|
|
||||||
|
|
||||||
Add Peer to BGP Speaker
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-peer-add [-h] [--request-format {json}]
|
|
||||||
BGP_SPEAKER BGP_PEER
|
|
||||||
|
|
||||||
Add a peer to the BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
``BGP_PEER``
|
|
||||||
ID or name of the BGP peer to add.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
Delete Peer from BGP Speaker
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-peer-remove [-h] [--request-format {json}]
|
|
||||||
BGP_SPEAKER BGP_PEER
|
|
||||||
|
|
||||||
Remove a peer from the BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
``BGP_PEER``
|
|
||||||
ID or name of the BGP peer to remove.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
Add BGP Speaker to Dynamic Routing Agent
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-dragent-speaker-add [-h] [--request-format {json}]
|
|
||||||
BGP_DRAGENT_ID BGP_SPEAKER
|
|
||||||
|
|
||||||
Add a BGP speaker to a Dynamic Routing agent.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_DRAGENT_ID``
|
|
||||||
ID of the Dynamic Routing agent.
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
Delete BGP Speaker from Dynamic Routing Agent
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-dragent-speaker-remove [-h] [--request-format {json}]
|
|
||||||
BGP_DRAGENT_ID BGP_SPEAKER
|
|
||||||
|
|
||||||
Removes a BGP speaker from a Dynamic Routing agent.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_DRAGENT_ID``
|
|
||||||
ID of the Dynamic Routing agent.
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
List BGP Speakers hosted by a Dynamic Routing Agent
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-speaker-list-on-dragent [-h]
|
|
||||||
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN] [--max-width <integer>]
|
|
||||||
[--noindent]
|
|
||||||
[--quote {all,minimal,none,nonnumeric}]
|
|
||||||
[--request-format {json}] [-D]
|
|
||||||
[-F FIELD]
|
|
||||||
BGP_DRAGENT_ID
|
|
||||||
|
|
||||||
List BGP speakers hosted by a Dynamic Routing agent.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_DRAGENT_ID``
|
|
||||||
ID of the Dynamic Routing agent.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
|
|
||||||
List Dynamic Routing Agents Hosting a BGP Speaker
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
usage: neutron bgp-dragent-list-hosting-speaker [-h]
|
|
||||||
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
||||||
[-c COLUMN]
|
|
||||||
[--max-width <integer>]
|
|
||||||
[--noindent]
|
|
||||||
[--quote {all,minimal,none,nonnumeric}]
|
|
||||||
[--request-format {json}] [-D]
|
|
||||||
[-F FIELD]
|
|
||||||
BGP_SPEAKER
|
|
||||||
|
|
||||||
List Dynamic Routing agents hosting a BGP speaker.
|
|
||||||
|
|
||||||
Positional Arguments
|
|
||||||
++++++++++++++++++++
|
|
||||||
|
|
||||||
``BGP_SPEAKER``
|
|
||||||
ID or name of the BGP speaker.
|
|
||||||
|
|
||||||
Optional Arguments
|
|
||||||
++++++++++++++++++
|
|
||||||
|
|
||||||
``-h, --help``
|
|
||||||
show this help message and exit
|
|
||||||
|
|
||||||
``-D, --show-details``
|
|
||||||
Show detailed information.
|
|
||||||
|
|
||||||
``-F FIELD, --field FIELD``
|
|
||||||
Specify the field(s) to be returned by server. You can
|
|
||||||
repeat this option.
|
|
||||||
@ -22,57 +22,23 @@
|
|||||||
''''''' Heading 4
|
''''''' Heading 4
|
||||||
(Avoid deeper levels because they do not render well.)
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
|
===================================================
|
||||||
Welcome to neutron-dynamic-routing's documentation!
|
Welcome to neutron-dynamic-routing's documentation!
|
||||||
===================================================
|
===================================================
|
||||||
|
|
||||||
.. include:: ../../README.rst
|
.. include:: ../../README.rst
|
||||||
|
|
||||||
|
Contents
|
||||||
|
========
|
||||||
|
|
||||||
===============
|
|
||||||
Developer Guide
|
|
||||||
===============
|
|
||||||
In the Developer Guide, you will find information on neutron-dynamic-routing
|
|
||||||
lower level programming APIs. There are sections that cover the core pieces
|
|
||||||
of neutron-dynamic-routing, including its API, command-lines, database,
|
|
||||||
system-design, alembic-migration etc. There are also subsections that describe
|
|
||||||
specific drivers inside neutron-dynamic-routing. Finally, the developer guide
|
|
||||||
includes information about testing and supported functionalities as well. This
|
|
||||||
documentation is generated by the Sphinx toolkit and lives in the source
|
|
||||||
tree.
|
|
||||||
|
|
||||||
Programming HowTos and Tutorials
|
|
||||||
--------------------------------
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
installation
|
install/index
|
||||||
usage
|
admin/index
|
||||||
contributing
|
reference/index
|
||||||
|
cli/index
|
||||||
Design
|
contributor/index
|
||||||
------
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
design/system-design
|
|
||||||
design/api
|
|
||||||
design/command-lines
|
|
||||||
design/agent-scheduler
|
|
||||||
design/drivers
|
|
||||||
|
|
||||||
Functionality
|
|
||||||
-------------
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
functionality/bgp-speaker
|
|
||||||
functionality/route-advertisement
|
|
||||||
|
|
||||||
Others
|
|
||||||
------
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
others/testing
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user