summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorMichael Gugino <michael.gugino@walmart.com>2016-05-12 16:15:19 -0400
committerHuanxuan Ao <huanxuan.ao@easystack.cn>2016-08-05 16:25:33 +0800
commit0736336a71db9baf3e768e4560a619ae6a875fa4 (patch)
tree14ab3a9da676214b7139f18ec03d324f1786937e /doc/source/command-objects
parent5f6257206e1df085d1432778cfbc4489b87bc256 (diff)
downloadpython-openstackclient-0736336a71db9baf3e768e4560a619ae6a875fa4.tar.gz
Implement network agents functionality
python-neutronclient implements the following command set: agent-list, agent-show, agent-delete These commands display and modify various network agents and their information. python-openstacksdk has supported the api calls for these commands, but python-openstackclient does not implement these commands. This commit adds support for the following commands: openstack network agent list openstack network agent show <agent> openstack network agent delete <agent> Change-Id: I83ede6f89c37e7bdc38d7e9e7bb9d80e94c8becc Implements: blueprint implement-network-agents Depends-On: I9755637f76787d5fac8ff295ae273b308fcb98d0 Co-Authored-By: Huanxuan Ao <huanxuan.ao@easystack.cn>
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)