openstack/python-openstackclient
Code Issues Proposed changes
4493740171
python-openstackclient/doc/source/cli/command-objects/network-agent.rst
Doug Hellmann 9599ffe65d reorganize existing documentation according to the new standard layout 
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>
2017-06-23 11:54:32 +02:00

2.9 KiB
Raw Blame History

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

network agent add network

openstack network agent add network
    [--dhcp]
    <agent-id>
    <network>

--dhcp

Add a network to DHCP agent

<agent-id>

Agent to which a network is added (ID only)

<network>

Network to be added to an agent (ID or name)

network agent delete

Delete network agent(s)

network agent delete

openstack network agent delete
    <network-agent> [<network-agent> ...]




Network agent(s) to delete (ID only)

network agent list

List network agents

network agent list

openstack network agent list
    [--agent-type <agent-type>]
    [--host <host>]
    [--network <network>]

--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.

--host <host>

List only agents running on the specified host

--network <network>

List agents hosting a network (ID or name)

network agent set

Set network agent properties

network agent set

openstack network agent set
    [--description <description>]
    [--enable | --disable]
    <network-agent>

--description <description>

Set network agent description

--enable

Enable network agent

--disable

Disable network agent

Network agent to modify (ID only)

network agent show

Display network agent details

network agent show

openstack network agent show
    <network-agent>




Network agent to display (ID only)

network agent remove network

Remove network from an agent

network agent remove network

openstack network agent remove network
    [--dhcp]
    <agent-id>
    <network>

--dhcp

Remove network from DHCP agent.

<agent-id>

Agent to which a network is removed (ID only)

<network>

Network to be removed from an agent (ID or name)