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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
.. -*- rst -*-
====================
DHCP agent scheduler
====================
The DHCP agent scheduler extension (``dhcp_agent_scheduler``)
enables administrators to assign DHCP servers for Neutron networks to given
Neutron DHCP agents, and retrieve mappings between Neutron networks
and DHCP agents.
List networks hosted by a DHCP agent
====================================
.. rest_method:: GET /v2.0/agents/{agent_id}/dhcp-networks
Lists networks that a DHCP agent hosts.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403
Request
-------
.. rest_parameters:: parameters.yaml
- agent_id: agent_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- network: network
- admin_state_up: network-admin_state_up
- availability_zone_hints: availability_zone_hints
- availability_zones: availability_zones
- created_at: created_at_resource
- dns_domain: dns_domain
- id: network-id
- ipv4_address_scope: ipv4_address_scope
- ipv6_address_scope: ipv6_address_scope
- l2_adjacency: l2_adjacency
- mtu: mtu
- name: network-name
- port_security_enabled: network-port_security_enabled
- project_id: project_id
- provider:network_type: provider:network_type
- provider:physical_network: provider:physical_network
- provider:segmentation_id: provider:segmentation_id
- qos_policy_id: qos_policy_id
- revision_number: revision_number
- router:external: router:external
- segments: segments
- shared: network-shared
- status: network-status
- subnets: network-subnets
- tenant_id: project_id
- updated_at: updated_at_resource
- vlan_transparent: vlan_transparent
- description: description
- is_default: network_is_default
Response Example
----------------
.. literalinclude:: samples/agents/agent-dhcp-networks-list-response.json
:language: javascript
Schedule a network to a DHCP agent
==================================
.. rest_method:: POST /v2.0/agents/{agent_id}/dhcp-networks
Add a network to a DHCP agent
Normal response codes: 201
Error response codes: 400, 403, 409, 404
Request
-------
.. rest_parameters:: parameters.yaml
- agent_id: agent_id-path
- network_id: network-id
Request Example
---------------
.. literalinclude:: samples/agents/agent-dhcp-network-add-request.json
:language: javascript
Response Parameters
-------------------
null
Response Example
----------------
There is no body content for the response of a successful POST request.
Remove network from a DHCP agent
================================
.. rest_method:: DELETE /v2.0/agents/{agent_id}/dhcp-networks/{network_id}
Removes a network from a dhcp agent.
Normal response codes: 204
Error response codes: 401, 403, 404, 409
Request
-------
.. rest_parameters:: parameters.yaml
- agent_id: agent_id-path
- network_id: network_id
Response Example
----------------
There is no body content for the response of a successful DELETE request.
List DHCP agents hosting a network
==================================
.. rest_method:: GET /v2.0/networks/{network_id}/dhcp-agents
Lists DHCP agents hosting a network.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401, 403
Request
-------
.. rest_parameters:: parameters.yaml
- network_id: network_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- admin_state_up: admin_state_up
- agents: agents
- agent_type: agent_type
- alive: alive
- binary: binary
- configurations: configurations
- created_at: created_at_resource
- description: description
- heartbeat_timestamp: heartbeat_timestamp
- host: host
- id: id
- started_at: started_at
- topic: topic
Response Example
----------------
.. literalinclude:: samples/agents/network-dhcp-agent-list-response.json
:language: javascript
|
