summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/network-agent.rst
blob: f69d0ece6920b6dc977d2a8f323db1f11bb00214 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
=============
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)