summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/network-agent.rst
blob: 9d158ba094c71b3721ebf1ace0ea33264e3dba28 (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
=============
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 set
-----------------

Set network agent properties

.. program:: network agent set
.. code:: bash

    os 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

    os network agent show
        <network-agent>

.. _network_agent_show-network-agent:
.. describe:: <network-agent>

    Network agent to display (ID only)