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
Add network to an agent
openstack network agent add network [--dhcp] <agent-id> <network>
Add network to a DHCP agent
Agent to which a network is added (ID only)
Network to be added to an agent (name or ID)
Add router to an agent
openstack network agent add router [--l3] <agent-id> <router>
Add router to an L3 agent
Agent to which a router is added (ID only)
Router to be added to an agent (name or ID)
Delete network agent(s)
openstack network agent delete <network-agent> [<network-agent> ...]
Network agent(s) to delete (ID only)
List network agents
openstack network agent list
[--format-config-file FORMAT_CONFIG]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--agent-type <agent-type>]
[--host <host>]
[--network <network> | --router <router>]
[--long]
Config file for the dict-to-csv formatter
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
sort the column(s) in ascending order
sort the column(s) in descending order
List only agents with the specified agent type. The supported agent types are: bgp, dhcp, open-vswitch, linux-bridge, ofa, l3, loadbalancer, metering, metadata, macvtap, nic.
List only agents running on the specified host
List agents hosting a network (name or ID)
List agents hosting this router (name or ID)
List additional fields in output
Remove network from an agent.
openstack network agent remove network [--dhcp] <agent-id> <network>
Remove network from DHCP agent
Agent to which a network is removed (ID only)
Network to be removed from an agent (name or ID)
Remove router from an agent
openstack network agent remove router [--l3] <agent-id> <router>
Remove router from an L3 agent
Agent from which router will be removed (ID only)
Router to be removed from an agent (name or ID)
Set network agent properties
openstack network agent set
[--description <description>]
[--enable | --disable]
<network-agent>
Set network agent description
Enable network agent
Disable network agent
Network agent to modify (ID only)
Display network agent details
openstack network agent show <network-agent>
Network agent to display (ID only)
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.