summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-08-05 16:01:13 +0000
committerGerrit Code Review <review@openstack.org>2016-08-05 16:01:13 +0000
commit020f13e12b04ed6e93c2dcfbf4ecf60e23fb44db (patch)
treeb94c4dcd17849b48762ac6af1ac20f7a131d6cf9 /doc/source/command-objects
parent6dd3f45e39868906c74ff716e750a57e329ae611 (diff)
parent0736336a71db9baf3e768e4560a619ae6a875fa4 (diff)
downloadpython-openstackclient-020f13e12b04ed6e93c2dcfbf4ecf60e23fb44db.tar.gz
Merge "Implement network agents functionality"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/network-agent.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/source/command-objects/network-agent.rst b/doc/source/command-objects/network-agent.rst
new file mode 100644
index 00000000..32cb371c
--- /dev/null
+++ b/doc/source/command-objects/network-agent.rst
@@ -0,0 +1,53 @@
+=============
+network agent
+=============
+
+A **network agent** is an agent that handles various tasks used to
+implement virtual networks. These agents include neutron-dhcp-agent,
+neutron-l3-agent, neutron-metering-agent, and neutron-lbaas-agent,
+among others. The agent is available when the alive status of the
+agent is "True".
+
+Network v2
+
+network agent delete
+--------------------
+
+Delete network agent(s)
+
+.. program:: network agent delete
+.. code:: bash
+
+ os network agent delete
+ <network-agent> [<network-agent> ...]
+
+.. _network_agent_delete-network-agent:
+.. describe:: <network-agent>
+
+ Network agent(s) to delete (ID only)
+
+network agent list
+------------------
+
+List network agents
+
+.. program:: network agent list
+.. code:: bash
+
+ os network agent list
+
+network agent show
+------------------
+
+Display network agent details
+
+.. program:: network agent show
+.. code:: bash
+
+ os network agent show
+ <network-agent>
+
+.. _network_agent_show-network-agent:
+.. describe:: <network-agent>
+
+ Network agent to display (ID only)