9599ffe65d
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
152 lines
2.9 KiB
ReStructuredText
152 lines
2.9 KiB
ReStructuredText
=============
|
|
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 add network
|
|
-------------------------
|
|
|
|
Add network to an agent
|
|
|
|
.. program:: network agent add network
|
|
.. code:: bash
|
|
|
|
openstack network agent add network
|
|
[--dhcp]
|
|
<agent-id>
|
|
<network>
|
|
|
|
.. describe:: --dhcp
|
|
|
|
Add a network to DHCP agent
|
|
|
|
.. describe:: <agent-id>
|
|
|
|
Agent to which a network is added (ID only)
|
|
|
|
.. describe:: <network>
|
|
|
|
Network to be added to an agent (ID or name)
|
|
|
|
network agent delete
|
|
--------------------
|
|
|
|
Delete network agent(s)
|
|
|
|
.. program:: network agent delete
|
|
.. code:: bash
|
|
|
|
openstack 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
|
|
|
|
openstack network agent list
|
|
[--agent-type <agent-type>]
|
|
[--host <host>]
|
|
[--network <network>]
|
|
|
|
.. option:: --agent-type <agent-type>
|
|
|
|
List only agents with the specified agent type.
|
|
The supported agent types are: dhcp, open-vswitch,
|
|
linux-bridge, ofa, l3, loadbalancer, metering,
|
|
metadata, macvtap, nic.
|
|
|
|
.. option:: --host <host>
|
|
|
|
List only agents running on the specified host
|
|
|
|
.. option:: --network <network>
|
|
|
|
List agents hosting a network (ID or name)
|
|
|
|
network agent set
|
|
-----------------
|
|
|
|
Set network agent properties
|
|
|
|
.. program:: network agent set
|
|
.. code:: bash
|
|
|
|
openstack network agent set
|
|
[--description <description>]
|
|
[--enable | --disable]
|
|
<network-agent>
|
|
|
|
.. option:: --description <description>
|
|
|
|
Set network agent description
|
|
|
|
.. option:: --enable
|
|
|
|
Enable network agent
|
|
|
|
.. option:: --disable
|
|
|
|
Disable network agent
|
|
|
|
.. _network_agent_set-network-agent:
|
|
.. describe:: <network-agent>
|
|
|
|
Network agent to modify (ID only)
|
|
|
|
network agent show
|
|
------------------
|
|
|
|
Display network agent details
|
|
|
|
.. program:: network agent show
|
|
.. code:: bash
|
|
|
|
openstack network agent show
|
|
<network-agent>
|
|
|
|
.. _network_agent_show-network-agent:
|
|
.. 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)
|