summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/network-agent.rst53
-rw-r--r--doc/source/commands.rst1
2 files changed, 54 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)
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index 025f42f9..aff197f2 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -109,6 +109,7 @@ referring to both Compute and Volume quotas.
* ``mapping``: (**Identity**) a definition to translate identity provider attributes to Identity concepts
* ``module``: (**Internal**) - installed Python modules in the OSC process
* ``network``: (**Compute**, **Network**) - a virtual network for connecting servers and other resources
+* ``network agent``: (**Network**) - A network agent is an agent that handles various tasks used to implement virtual networks
* ``network rbac``: (**Network**) - an RBAC policy for network resources
* ``network segment``: (**Network**) - a segment of a virtual network
* ``object``: (**Object Storage**) a single file in the Object Storage