-
Notifications
You must be signed in to change notification settings - Fork 0
/
12.0--ariel-flow_vlans-POST.html
293 lines (200 loc) · 7.98 KB
/
12.0--ariel-flow_vlans-POST.html
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!DOCTYPE html><html lang="en-us">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<meta name="dcterms.rights" content="© Copyright IBM Corporation 2022">
<meta name="description" content="Creates a new flow VLAN field as specified by input parameters.">
<meta name="keywords" content="/ariel/flow_vlans, POST, API, REST API">
<meta name="geo.country" content="ZZ">
<script>
digitalData = {
page: {
pageInfo: {
language: "en-us",
version: "v18",
ibm: {
country: "ZZ",
type: "CT701"
}
}
}
};
</script><!-- Licensed Materials - Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="ibmdita.css">
<link rel="Start" href="c_rest_api_version120_ariel_intro.html">
<title>POST /ariel/flow_vlans</title>
</head>
<body id="api-12.0--ariel-flow_vlans-POST"><main role="main"><article role="article" aria-labelledby="d153866e10">
<h1 class="topictitle1" id="d153866e10">POST /ariel/flow_vlans</h1>
<div class="body refbody"><p class="shortdesc">Creates a new flow VLAN field as specified by input parameters.</p>
<div class="section refsyn"></div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/flow_vlans resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. POST /ariel/flow_vlans resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d153866e60" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d153866e60 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/flow_vlans request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. POST /ariel/flow_vlans request parameter details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d153866e108" class="thbot">Parameter</th>
<th id="d153866e111" class="thbot">Type</th>
<th id="d153866e114" class="thbot">Optionality</th>
<th id="d153866e117" class="thbot">Data Type</th>
<th id="d153866e120" class="thbot">MIME Type</th>
<th id="d153866e124" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d153866e108 "><p>fields</p>
</td>
<td headers="d153866e111 "><p>header</p>
</td>
<td headers="d153866e114 "><p>Optional</p>
</td>
<td headers="d153866e117 "><p>String</p>
</td>
<td headers="d153866e120 "><p>text/plain</p>
</td>
<td headers="d153866e124 "><p>Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/flow_vlans request body details" class="defaultstyle"><caption><span class="tablecap">Table 3. POST /ariel/flow_vlans request body details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d153866e191" class="thbot">Parameter</th>
<th id="d153866e194" class="thbot">Data Type</th>
<th id="d153866e197" class="thbot">MIME Type</th>
<th id="d153866e200" class="thbot">Description</th>
<th id="d153866e203" class="thbot">Sample</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d153866e191 "><p>body</p>
</td>
<td headers="d153866e194 "><p>Object</p>
</td>
<td headers="d153866e197 "><p>application/json</p>
</td>
<td headers="d153866e200 "><div class="p">Only the enterprise VLAN ID and customer VLAN ID can be set when creating a new flow VLAN field. All other fields are ignored.
<ul>
<li><strong>id</strong> - Int - The ID of the flow VLAN field. Cannot be updated by POST.</li>
<li><strong>enterprise_vlan_id</strong> - Short - The enterprise VLAN ID for the flow VLAN domain configuration field. The value must be in the range 0 - 4095, where 0 indicates the enterprise VLAN field is non-existent.</li>
<li><strong>customer_vlan_id</strong> - Short - The customer VLAN ID for the flow VLAN domain configuration field. The value must be in the range 1 - 4095.</li>
</ul>
</div>
</td>
<td headers="d153866e203 "><p>{
"customer_vlan_id": 42,
"enterprise_vlan_id": 42,
"id": 42
}</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /ariel/flow_vlans response codes" class="defaultstyle"><caption><span class="tablecap">Table 4. POST /ariel/flow_vlans response codes</span></caption><colgroup><col style="width:20%"><col style="width:20%"><col style="width:60%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d153866e277" class="thbot">HTTP Response Code</th>
<th id="d153866e280" class="thbot">Unique Code</th>
<th id="d153866e283" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d153866e277 "><p>201</p>
</td>
<td headers="d153866e280 "><p></p>
</td>
<td headers="d153866e283 "><p>The flow VLAN field has been successfully created.</p>
</td>
</tr>
<tr>
<td headers="d153866e277 "><p>409</p>
</td>
<td headers="d153866e280 "><p>1020</p>
</td>
<td headers="d153866e283 "><p>A flow VLAN ID object parameter already exists and belongs to a domain.</p>
</td>
</tr>
<tr>
<td headers="d153866e277 "><p>422</p>
</td>
<td headers="d153866e280 "><p>1022</p>
</td>
<td headers="d153866e283 "><p>The VLAN provided was invalid. Customer VLAN ID must be between 1 and 4095.</p>
</td>
</tr>
<tr>
<td headers="d153866e277 "><p>422</p>
</td>
<td headers="d153866e280 "><p>1023</p>
</td>
<td headers="d153866e283 "><p>The VLAN provided was invalid. Enterprise VLAN ID must be between 0 and 4095 and customer VLAN ID must be between 1 and 4095.</p>
</td>
</tr>
<tr>
<td headers="d153866e277 "><p>422</p>
</td>
<td headers="d153866e280 "><p>1024</p>
</td>
<td headers="d153866e283 "><p>The VLAN provided was invalid. Enterprise VLAN ID must be between 0 and 4095.</p>
</td>
</tr>
<tr>
<td headers="d153866e277 "><p>500</p>
</td>
<td headers="d153866e280 "><p>1025</p>
</td>
<td headers="d153866e283 "><p>An error occurred while the flow VLAN field was being created.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="d153866e387"><h2 class="sectiontitle" id="d153866e387">Response Description</h2>
<div class="p">New flow VLAN ID object. A flow VLAN ID object contains the following fields:
<ul>
<li><strong>id</strong> - Int - The ID of the flow VLAN field.</li>
<li><strong>enterprise_vlan_id</strong> - Short - The enterprise VLAN ID.</li>
<li><strong>customer_vlan_id</strong> - Short - The customer VLAN ID.</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="d153866e413"><h2 class="sectiontitle" id="d153866e413">Response Sample</h2>
<pre class="codeblock"><code>
{
"customer_vlan_id": 42,
"enterprise_vlan_id": 42,
"id": 42
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="d153866e10"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version120_ariel_intro.html" title="Use the references for REST API 12.0 Ariel endpoints.">Ariel endpoints</a></div>
</div>
</nav></aside></article></main></body></html>