summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/network-agent.rst
diff options
context:
space:
mode:
authorAnkur Gupta <ankur.gupta@intel.com>2016-10-12 22:39:35 -0500
committerAkihiro Motoki <amotoki@gmail.com>2017-07-11 08:17:09 +0000
commit18c532377a2f6d87adef80465fea7ed50d5a17d1 (patch)
treebb153cbaf3a07fff1bfc9bc5437ea0cb9d87a694 /doc/source/cli/command-objects/network-agent.rst
parentfaf6e16120206de763c1570698f71114307dab98 (diff)
downloadpython-openstackclient-18c532377a2f6d87adef80465fea7ed50d5a17d1.tar.gz
Network L3 Router Commands for OSC
Implements: blueprint network-l3-commands Co-Authored-By: Akihiro Motoki <amotoki@gmail.com> Change-Id: Ia24d76227e164062e89a74c1621b8acb830b26cf
Diffstat (limited to 'doc/source/cli/command-objects/network-agent.rst')
-rw-r--r--doc/source/cli/command-objects/network-agent.rst121
1 files changed, 93 insertions, 28 deletions
diff --git a/doc/source/cli/command-objects/network-agent.rst b/doc/source/cli/command-objects/network-agent.rst
index f69d0ece..2ceb263f 100644
--- a/doc/source/cli/command-objects/network-agent.rst
+++ b/doc/source/cli/command-objects/network-agent.rst
@@ -33,7 +33,34 @@ Add network to an agent
.. describe:: <network>
- Network to be added to an agent (ID or name)
+ Network to be added to an agent (name or ID)
+
+network agent add router
+------------------------
+
+Add router to an agent
+
+.. program:: network agent add router
+.. code:: bash
+
+ openstack network agent add router
+ [--l3]
+ <agent-id>
+ <router>
+
+.. option:: --l3
+
+ Add router to L3 agent
+
+.. _network_agent_add_router-agent-id:
+.. describe:: <agent-id>
+
+ Agent to which a router is added (ID only)
+
+.. _network_agent_add_router-router:
+.. describe:: <router>
+
+ Router to be added to an agent (name or ID)
network agent delete
--------------------
@@ -62,7 +89,8 @@ List network agents
openstack network agent list
[--agent-type <agent-type>]
[--host <host>]
- [--network <network>]
+ [--network <network> | --router <router>]
+ [--long]
.. option:: --agent-type <agent-type>
@@ -77,7 +105,69 @@ List network agents
.. option:: --network <network>
- List agents hosting a network (ID or name)
+ List agents hosting a network (name or ID)
+
+.. option:: --router <router>
+
+ List agents hosting this router (name or ID)
+
+.. option:: --long
+
+ List additional fields in output
+
+network agent remove network
+----------------------------
+
+Remove network from an agent
+
+.. program:: network agent remove network
+.. code:: bash
+
+ openstack network agent remove network
+ [--dhcp]
+ <agent-id>
+ <network>
+
+.. option:: --dhcp
+
+ Remove network from DHCP agent
+
+.. _network_agent_remove_network-agent-id:
+.. describe:: <agent-id>
+
+ Agent to which a network is removed (ID only)
+
+.. _network_agent_remove_network-network:
+.. describe:: <network>
+
+ Network to be removed from an agent (name or ID)
+
+network agent remove router
+---------------------------
+
+Remove router from an agent
+
+.. program:: network agent remove router
+.. code:: bash
+
+ openstack agent remove router
+ [--l3]
+ <agent-id>
+ <router>
+
+.. option:: --l3
+
+ Remove router from L3 agent
+
+.. _network_agent_remove_router-agent-id:
+.. describe:: <agent-id>
+
+ Agent from which router will be removed (ID only)
+
+.. _network_agent_remove_router-router:
+.. describe:: <router>
+
+ Router to be removed from an agent (name or ID)
network agent set
-----------------
@@ -124,28 +214,3 @@ Display network agent details
.. describe:: <network-agent>
Network agent to display (ID only)
-
-network agent remove network
-----------------------------
-
-Remove network from an agent
-
-.. program:: network agent remove network
-.. code:: bash
-
- openstack network agent remove network
- [--dhcp]
- <agent-id>
- <network>
-
-.. describe:: --dhcp
-
- Remove network from DHCP agent.
-
-.. describe:: <agent-id>
-
- Agent to which a network is removed (ID only)
-
-.. describe:: <network>
-
- Network to be removed from an agent (ID or name)