@itentialopensource/adapter-drivenets_networkcloud 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +74 -48
- package/CHANGELOG.md +16 -1
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +31 -22
- package/adapter.js +160 -330
- package/adapterBase.js +538 -873
- package/changelogs/CHANGELOG.md +9 -0
- package/metadata.json +49 -0
- package/package.json +23 -25
- package/pronghorn.json +474 -142
- package/propertiesSchema.json +453 -40
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +3111 -0
- package/report/adapter-openapi.yaml +2662 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691507349574.json +120 -0
- package/report/updateReport1692202386592.json +120 -0
- package/report/updateReport1694460102344.json +120 -0
- package/report/updateReport1698420353530.json +120 -0
- package/sampleProperties.json +63 -2
- package/test/integration/adapterTestBasicGet.js +1 -1
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +306 -109
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +1 -0
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +71 -23
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +3 -10
- package/utils/tbUtils.js +2 -3
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +1 -3
- package/workflows/README.md +0 -3
|
@@ -0,0 +1,2662 @@
|
|
|
1
|
+
openapi: 3.0.0
|
|
2
|
+
info:
|
|
3
|
+
title: DriveNets Network Cloud+ API
|
|
4
|
+
description: >-
|
|
5
|
+
API definitions for programmatic access to DriveNets Network Cloud+. The API calls are modelled after, and reflected in the Self-Service Portal User Interface.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
You receive your username and password from DriveNets. The credentials for the API and the SSP are the same. When you first sign up with the SSP, a POST API request (/auth/login) is sent with the following payload:
|
|
9
|
+
|
|
10
|
+
{"username":"user@company.com","password":"mypass"}
|
|
11
|
+
|
|
12
|
+
Where “user@company.com” and “mypass” are the email address and password you provided during sign up.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
The API call returns a token value. This is the authorization token for your account. This token is sent in the header of all API requests, as follows:
|
|
16
|
+
|
|
17
|
+
Authorization: Bearer <token-value>
|
|
18
|
+
|
|
19
|
+
The REST API enables you to interact with the DriveNets Network Cloud+ systems to provision services for your customers from your server-side applications.
|
|
20
|
+
|
|
21
|
+
### Base URL
|
|
22
|
+
|
|
23
|
+
All APIs are served over HTTPS and all the URLs referenced in the API documentation have the following base:
|
|
24
|
+
|
|
25
|
+
https://:domain/network-cloud/v1/:resource/
|
|
26
|
+
|
|
27
|
+
Where:
|
|
28
|
+
|
|
29
|
+
- domain - refers to the ISP Orchestration Gateway (e.g., portal.drivenets.net)
|
|
30
|
+
|
|
31
|
+
- resource - refers to the resource on which the API call is made. A resource can be:
|
|
32
|
+
|
|
33
|
+
- services
|
|
34
|
+
|
|
35
|
+
- config
|
|
36
|
+
|
|
37
|
+
- function
|
|
38
|
+
|
|
39
|
+
- policy
|
|
40
|
+
|
|
41
|
+
- version - refers to the API version.
|
|
42
|
+
contact: {}
|
|
43
|
+
version: '1.0'
|
|
44
|
+
servers:
|
|
45
|
+
- url: https://portal.drivenets.net
|
|
46
|
+
variables: {}
|
|
47
|
+
paths:
|
|
48
|
+
/network-cloud/login:
|
|
49
|
+
post:
|
|
50
|
+
tags:
|
|
51
|
+
- Log in
|
|
52
|
+
summary: AppController_login
|
|
53
|
+
description: Use the credentials provided to log into the Self Service Portal.
|
|
54
|
+
operationId: AppController_login
|
|
55
|
+
parameters:
|
|
56
|
+
- name: x-trace-id
|
|
57
|
+
in: header
|
|
58
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
59
|
+
style: simple
|
|
60
|
+
schema: {}
|
|
61
|
+
- name: x-request-id
|
|
62
|
+
in: header
|
|
63
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
64
|
+
style: simple
|
|
65
|
+
schema: {}
|
|
66
|
+
requestBody:
|
|
67
|
+
description: ''
|
|
68
|
+
content:
|
|
69
|
+
application/json:
|
|
70
|
+
schema:
|
|
71
|
+
$ref: '#/components/schemas/UserLoginDTO'
|
|
72
|
+
required: true
|
|
73
|
+
responses:
|
|
74
|
+
'200':
|
|
75
|
+
description: Success
|
|
76
|
+
headers: {}
|
|
77
|
+
content:
|
|
78
|
+
application/json:
|
|
79
|
+
schema:
|
|
80
|
+
$ref: '#/components/schemas/AccessToken'
|
|
81
|
+
'401':
|
|
82
|
+
description: Unauthorized
|
|
83
|
+
headers: {}
|
|
84
|
+
content: {}
|
|
85
|
+
deprecated: false
|
|
86
|
+
/refresh-token:
|
|
87
|
+
get:
|
|
88
|
+
tags:
|
|
89
|
+
- Log in
|
|
90
|
+
summary: AppController_refreshToken
|
|
91
|
+
description: Sends a request to Network Cloud+ to generate a new access token.
|
|
92
|
+
operationId: AppController_refreshToken
|
|
93
|
+
parameters:
|
|
94
|
+
- name: x-trace-id
|
|
95
|
+
in: header
|
|
96
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
97
|
+
style: simple
|
|
98
|
+
schema: {}
|
|
99
|
+
- name: x-request-id
|
|
100
|
+
in: header
|
|
101
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
102
|
+
style: simple
|
|
103
|
+
schema: {}
|
|
104
|
+
responses:
|
|
105
|
+
'200':
|
|
106
|
+
description: Success
|
|
107
|
+
headers: {}
|
|
108
|
+
content:
|
|
109
|
+
application/json:
|
|
110
|
+
schema:
|
|
111
|
+
$ref: '#/components/schemas/RefreshedToken'
|
|
112
|
+
'401':
|
|
113
|
+
description: Access token is missing or invalid
|
|
114
|
+
headers: {}
|
|
115
|
+
content: {}
|
|
116
|
+
deprecated: false
|
|
117
|
+
security:
|
|
118
|
+
- bearer: []
|
|
119
|
+
/locations:
|
|
120
|
+
get:
|
|
121
|
+
tags:
|
|
122
|
+
- Point of Presence (PoP) Services
|
|
123
|
+
summary: getLocations
|
|
124
|
+
description: Retrieve a list of all PoPs and the services available at each location.
|
|
125
|
+
operationId: getLocations
|
|
126
|
+
parameters:
|
|
127
|
+
- name: x-trace-id
|
|
128
|
+
in: header
|
|
129
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
130
|
+
style: simple
|
|
131
|
+
schema: {}
|
|
132
|
+
- name: x-request-id
|
|
133
|
+
in: header
|
|
134
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
135
|
+
style: simple
|
|
136
|
+
schema: {}
|
|
137
|
+
- name: version
|
|
138
|
+
in: path
|
|
139
|
+
description: The API version.
|
|
140
|
+
required: true
|
|
141
|
+
style: simple
|
|
142
|
+
schema:
|
|
143
|
+
allOf:
|
|
144
|
+
- $ref: '#/components/schemas/version'
|
|
145
|
+
- description: The API version.
|
|
146
|
+
example: v1
|
|
147
|
+
responses:
|
|
148
|
+
'200':
|
|
149
|
+
description: Services per location
|
|
150
|
+
headers: {}
|
|
151
|
+
content:
|
|
152
|
+
application/json:
|
|
153
|
+
schema:
|
|
154
|
+
type: array
|
|
155
|
+
items:
|
|
156
|
+
$ref: '#/components/schemas/ServicesPerLocationResponse'
|
|
157
|
+
description: ''
|
|
158
|
+
'401':
|
|
159
|
+
description: Access token is missing or invalid
|
|
160
|
+
headers: {}
|
|
161
|
+
content: {}
|
|
162
|
+
'403':
|
|
163
|
+
description: Service information error
|
|
164
|
+
headers: {}
|
|
165
|
+
content:
|
|
166
|
+
application/json:
|
|
167
|
+
schema:
|
|
168
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
169
|
+
'404':
|
|
170
|
+
description: Service not found
|
|
171
|
+
headers: {}
|
|
172
|
+
content:
|
|
173
|
+
application/json:
|
|
174
|
+
schema:
|
|
175
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
176
|
+
'500':
|
|
177
|
+
description: Internal server error
|
|
178
|
+
headers: {}
|
|
179
|
+
content: {}
|
|
180
|
+
deprecated: false
|
|
181
|
+
/locations/{location}:
|
|
182
|
+
get:
|
|
183
|
+
tags:
|
|
184
|
+
- Point of Presence (PoP) Services
|
|
185
|
+
summary: getLocation
|
|
186
|
+
description: Retrieve a list of the services available at a specific POP location.
|
|
187
|
+
operationId: getLocation
|
|
188
|
+
parameters:
|
|
189
|
+
- name: x-trace-id
|
|
190
|
+
in: header
|
|
191
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
192
|
+
style: simple
|
|
193
|
+
schema: {}
|
|
194
|
+
- name: x-request-id
|
|
195
|
+
in: header
|
|
196
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
197
|
+
style: simple
|
|
198
|
+
schema: {}
|
|
199
|
+
- name: location
|
|
200
|
+
in: path
|
|
201
|
+
description: ''
|
|
202
|
+
required: true
|
|
203
|
+
style: simple
|
|
204
|
+
schema: {}
|
|
205
|
+
- name: version
|
|
206
|
+
in: path
|
|
207
|
+
description: The API version.
|
|
208
|
+
required: true
|
|
209
|
+
style: simple
|
|
210
|
+
schema:
|
|
211
|
+
allOf:
|
|
212
|
+
- $ref: '#/components/schemas/version'
|
|
213
|
+
- description: The API version.
|
|
214
|
+
example: v1
|
|
215
|
+
responses:
|
|
216
|
+
'200':
|
|
217
|
+
description: Services per location information
|
|
218
|
+
headers: {}
|
|
219
|
+
content:
|
|
220
|
+
application/json:
|
|
221
|
+
schema:
|
|
222
|
+
type: array
|
|
223
|
+
items:
|
|
224
|
+
$ref: '#/components/schemas/ServicesPerLocationResponse'
|
|
225
|
+
description: ''
|
|
226
|
+
'401':
|
|
227
|
+
description: Access token is missing or invalid
|
|
228
|
+
headers: {}
|
|
229
|
+
content: {}
|
|
230
|
+
'403':
|
|
231
|
+
description: Service information error
|
|
232
|
+
headers: {}
|
|
233
|
+
content:
|
|
234
|
+
application/json:
|
|
235
|
+
schema:
|
|
236
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
237
|
+
'404':
|
|
238
|
+
description: Service not found
|
|
239
|
+
headers: {}
|
|
240
|
+
content:
|
|
241
|
+
application/json:
|
|
242
|
+
schema:
|
|
243
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
244
|
+
'500':
|
|
245
|
+
description: Internal server error
|
|
246
|
+
headers: {}
|
|
247
|
+
content: {}
|
|
248
|
+
deprecated: false
|
|
249
|
+
/:
|
|
250
|
+
post:
|
|
251
|
+
tags:
|
|
252
|
+
- Services
|
|
253
|
+
summary: postServiceItem
|
|
254
|
+
description: >-
|
|
255
|
+
The services you can add:
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
- **Equinix Connect** - Creates a connection between Network Cloud+ and the customer's CPE in the Equinix network.
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
- **Internet Gateway** - Connects a customer to the internet.
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
- **Internet Service Provider** - Connects the internet gateway to an ISP.
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
Combining one or more atomic services and then adding a policy create a solution. For example, the four atomic services above and several policies form the Internet Connect solution.
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
The response includes a unique service ID named 'ID' that references the specific service and its customer. You must save this ID to modify or delete a service.
|
|
271
|
+
operationId: postServiceItem
|
|
272
|
+
parameters:
|
|
273
|
+
- name: x-trace-id
|
|
274
|
+
in: header
|
|
275
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
276
|
+
style: simple
|
|
277
|
+
schema: {}
|
|
278
|
+
- name: x-request-id
|
|
279
|
+
in: header
|
|
280
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
281
|
+
style: simple
|
|
282
|
+
schema: {}
|
|
283
|
+
- name: x-account-id
|
|
284
|
+
in: header
|
|
285
|
+
description: A unique ID issued by the Service Provider to identify a customer. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
286
|
+
style: simple
|
|
287
|
+
schema: {}
|
|
288
|
+
- name: version
|
|
289
|
+
in: path
|
|
290
|
+
description: The API version.
|
|
291
|
+
required: true
|
|
292
|
+
style: simple
|
|
293
|
+
schema:
|
|
294
|
+
allOf:
|
|
295
|
+
- $ref: '#/components/schemas/version'
|
|
296
|
+
- description: The API version.
|
|
297
|
+
example: v1
|
|
298
|
+
requestBody:
|
|
299
|
+
description: ''
|
|
300
|
+
content:
|
|
301
|
+
application/json:
|
|
302
|
+
schema:
|
|
303
|
+
$ref: '#/components/schemas/CreateServiceBodyRequest'
|
|
304
|
+
required: true
|
|
305
|
+
responses:
|
|
306
|
+
'202':
|
|
307
|
+
description: Service configuration received successfully, config initiated
|
|
308
|
+
headers: {}
|
|
309
|
+
content:
|
|
310
|
+
application/json:
|
|
311
|
+
schema:
|
|
312
|
+
$ref: '#/components/schemas/ServiceBodyResponse'
|
|
313
|
+
'400':
|
|
314
|
+
description: Failed to add service
|
|
315
|
+
headers: {}
|
|
316
|
+
content:
|
|
317
|
+
application/json:
|
|
318
|
+
schema:
|
|
319
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
320
|
+
'401':
|
|
321
|
+
description: Access token is missing or invalid
|
|
322
|
+
headers: {}
|
|
323
|
+
content: {}
|
|
324
|
+
'500':
|
|
325
|
+
description: Internal server error
|
|
326
|
+
headers: {}
|
|
327
|
+
content: {}
|
|
328
|
+
deprecated: false
|
|
329
|
+
/{businessSid}:
|
|
330
|
+
put:
|
|
331
|
+
tags:
|
|
332
|
+
- Services
|
|
333
|
+
summary: putServiceItem
|
|
334
|
+
description: ''
|
|
335
|
+
operationId: putServiceItem
|
|
336
|
+
parameters:
|
|
337
|
+
- name: x-trace-id
|
|
338
|
+
in: header
|
|
339
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
340
|
+
style: simple
|
|
341
|
+
schema: {}
|
|
342
|
+
- name: x-request-id
|
|
343
|
+
in: header
|
|
344
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
345
|
+
style: simple
|
|
346
|
+
schema: {}
|
|
347
|
+
- name: x-account-id
|
|
348
|
+
in: header
|
|
349
|
+
description: A unique ID issued by the Service Provider to identify a customer. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
350
|
+
style: simple
|
|
351
|
+
schema: {}
|
|
352
|
+
- name: businessSid
|
|
353
|
+
in: path
|
|
354
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
355
|
+
required: true
|
|
356
|
+
style: simple
|
|
357
|
+
schema: {}
|
|
358
|
+
- name: version
|
|
359
|
+
in: path
|
|
360
|
+
description: The API version.
|
|
361
|
+
required: true
|
|
362
|
+
style: simple
|
|
363
|
+
schema:
|
|
364
|
+
allOf:
|
|
365
|
+
- $ref: '#/components/schemas/version'
|
|
366
|
+
- description: The API version.
|
|
367
|
+
example: v1
|
|
368
|
+
requestBody:
|
|
369
|
+
description: ''
|
|
370
|
+
content:
|
|
371
|
+
application/json:
|
|
372
|
+
schema:
|
|
373
|
+
$ref: '#/components/schemas/ServiceBodyRequest'
|
|
374
|
+
required: true
|
|
375
|
+
responses:
|
|
376
|
+
'202':
|
|
377
|
+
description: Service configuration received successfully, config initiated
|
|
378
|
+
headers: {}
|
|
379
|
+
content:
|
|
380
|
+
application/json:
|
|
381
|
+
schema:
|
|
382
|
+
$ref: '#/components/schemas/ServiceBodyResponse'
|
|
383
|
+
'204':
|
|
384
|
+
description: Service already configured
|
|
385
|
+
headers: {}
|
|
386
|
+
content: {}
|
|
387
|
+
'400':
|
|
388
|
+
description: Failed to configure service
|
|
389
|
+
headers: {}
|
|
390
|
+
content:
|
|
391
|
+
application/json:
|
|
392
|
+
schema:
|
|
393
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
394
|
+
'401':
|
|
395
|
+
description: Access token is missing or invalid
|
|
396
|
+
headers: {}
|
|
397
|
+
content: {}
|
|
398
|
+
'423':
|
|
399
|
+
description: Service is locked. configuration in progress
|
|
400
|
+
headers: {}
|
|
401
|
+
content:
|
|
402
|
+
application/json:
|
|
403
|
+
schema:
|
|
404
|
+
$ref: '#/components/schemas/ResourceBusyResponse'
|
|
405
|
+
'500':
|
|
406
|
+
description: Internal server error
|
|
407
|
+
headers: {}
|
|
408
|
+
content: {}
|
|
409
|
+
deprecated: false
|
|
410
|
+
delete:
|
|
411
|
+
tags:
|
|
412
|
+
- Services
|
|
413
|
+
summary: deleteServiceItem
|
|
414
|
+
description: Delete all services that form the business service ID.
|
|
415
|
+
operationId: deleteServiceItem
|
|
416
|
+
parameters:
|
|
417
|
+
- name: x-trace-id
|
|
418
|
+
in: header
|
|
419
|
+
description: An optional troubleshooting header that tracks a request to /from your API. It references multiple APIs in a configuration sequence. The ID transfers the request in the response body to enable you to view if any changes have occurred. You can only use hyphens and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
420
|
+
style: simple
|
|
421
|
+
schema: {}
|
|
422
|
+
- name: x-request-id
|
|
423
|
+
in: header
|
|
424
|
+
description: An optional troubleshooting header. A unique ID is passed to the server in the API call. The server includes that ID in every log created. It enables the server operator to easily search for a specific request in the log information using the unique ID instead of cross referencing timestamps and IP addresses when troubleshooting. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
425
|
+
style: simple
|
|
426
|
+
schema: {}
|
|
427
|
+
- name: x-account-id
|
|
428
|
+
in: header
|
|
429
|
+
description: A unique ID issued by the Service Provider to identify a customer. You can only use hyphen and alphanumeric characters, for example -, a-z, A-Z, and 0-9.
|
|
430
|
+
style: simple
|
|
431
|
+
schema: {}
|
|
432
|
+
- name: businessSid
|
|
433
|
+
in: path
|
|
434
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
435
|
+
required: true
|
|
436
|
+
style: simple
|
|
437
|
+
schema: {}
|
|
438
|
+
- name: version
|
|
439
|
+
in: path
|
|
440
|
+
description: The API version.
|
|
441
|
+
required: true
|
|
442
|
+
style: simple
|
|
443
|
+
schema:
|
|
444
|
+
allOf:
|
|
445
|
+
- $ref: '#/components/schemas/version'
|
|
446
|
+
- description: The API version.
|
|
447
|
+
example: v1
|
|
448
|
+
responses:
|
|
449
|
+
'200':
|
|
450
|
+
description: Service deleted successfully
|
|
451
|
+
headers: {}
|
|
452
|
+
content:
|
|
453
|
+
application/json:
|
|
454
|
+
schema:
|
|
455
|
+
$ref: '#/components/schemas/DeleteServiceResponse'
|
|
456
|
+
'401':
|
|
457
|
+
description: Access token is missing or invalid
|
|
458
|
+
headers: {}
|
|
459
|
+
content: {}
|
|
460
|
+
'403':
|
|
461
|
+
description: Failed to delete service
|
|
462
|
+
headers: {}
|
|
463
|
+
content:
|
|
464
|
+
application/json:
|
|
465
|
+
schema:
|
|
466
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
467
|
+
'404':
|
|
468
|
+
description: Service not found
|
|
469
|
+
headers: {}
|
|
470
|
+
content: {}
|
|
471
|
+
'500':
|
|
472
|
+
description: Internal server error
|
|
473
|
+
headers: {}
|
|
474
|
+
content: {}
|
|
475
|
+
deprecated: false
|
|
476
|
+
get:
|
|
477
|
+
tags:
|
|
478
|
+
- Services
|
|
479
|
+
summary: getServiceItem
|
|
480
|
+
description: ''
|
|
481
|
+
operationId: getServiceItem
|
|
482
|
+
parameters:
|
|
483
|
+
- name: businessSid
|
|
484
|
+
in: path
|
|
485
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
486
|
+
required: true
|
|
487
|
+
style: simple
|
|
488
|
+
schema: {}
|
|
489
|
+
- name: version
|
|
490
|
+
in: path
|
|
491
|
+
description: The API version.
|
|
492
|
+
required: true
|
|
493
|
+
style: simple
|
|
494
|
+
schema:
|
|
495
|
+
allOf:
|
|
496
|
+
- $ref: '#/components/schemas/version'
|
|
497
|
+
- description: The API version.
|
|
498
|
+
example: v1
|
|
499
|
+
responses:
|
|
500
|
+
'200':
|
|
501
|
+
description: Service information
|
|
502
|
+
headers: {}
|
|
503
|
+
content:
|
|
504
|
+
application/json:
|
|
505
|
+
schema:
|
|
506
|
+
$ref: '#/components/schemas/ServiceBodyRequest'
|
|
507
|
+
'401':
|
|
508
|
+
description: Access token is missing or invalid
|
|
509
|
+
headers: {}
|
|
510
|
+
content: {}
|
|
511
|
+
'403':
|
|
512
|
+
description: 'Error: Service info'
|
|
513
|
+
headers: {}
|
|
514
|
+
content:
|
|
515
|
+
application/json:
|
|
516
|
+
schema:
|
|
517
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
518
|
+
'404':
|
|
519
|
+
description: Service not found
|
|
520
|
+
headers: {}
|
|
521
|
+
content: {}
|
|
522
|
+
'500':
|
|
523
|
+
description: Internal server error
|
|
524
|
+
headers: {}
|
|
525
|
+
content: {}
|
|
526
|
+
deprecated: false
|
|
527
|
+
/{businessSid}/state:
|
|
528
|
+
get:
|
|
529
|
+
tags:
|
|
530
|
+
- Service State
|
|
531
|
+
summary: getServiceItemState
|
|
532
|
+
description: Get the operational state of a particular business service ID.
|
|
533
|
+
operationId: getServiceItemState
|
|
534
|
+
parameters:
|
|
535
|
+
- name: businessSid
|
|
536
|
+
in: path
|
|
537
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
538
|
+
required: true
|
|
539
|
+
style: simple
|
|
540
|
+
schema: {}
|
|
541
|
+
- name: version
|
|
542
|
+
in: path
|
|
543
|
+
description: The API version.
|
|
544
|
+
required: true
|
|
545
|
+
style: simple
|
|
546
|
+
schema:
|
|
547
|
+
allOf:
|
|
548
|
+
- $ref: '#/components/schemas/version'
|
|
549
|
+
- description: The API version.
|
|
550
|
+
example: v1
|
|
551
|
+
responses:
|
|
552
|
+
'200':
|
|
553
|
+
description: Service state
|
|
554
|
+
headers: {}
|
|
555
|
+
content:
|
|
556
|
+
application/json:
|
|
557
|
+
schema:
|
|
558
|
+
$ref: '#/components/schemas/GetServiceStateResponse'
|
|
559
|
+
'401':
|
|
560
|
+
description: Access token is missing or invalid
|
|
561
|
+
headers: {}
|
|
562
|
+
content: {}
|
|
563
|
+
'403':
|
|
564
|
+
description: Service state error
|
|
565
|
+
headers: {}
|
|
566
|
+
content:
|
|
567
|
+
application/json:
|
|
568
|
+
schema:
|
|
569
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
570
|
+
'404':
|
|
571
|
+
description: Service not found
|
|
572
|
+
headers: {}
|
|
573
|
+
content: {}
|
|
574
|
+
'500':
|
|
575
|
+
description: Internal server error
|
|
576
|
+
headers: {}
|
|
577
|
+
content: {}
|
|
578
|
+
deprecated: false
|
|
579
|
+
/{businessSid}/monitoring:
|
|
580
|
+
get:
|
|
581
|
+
tags:
|
|
582
|
+
- Service State
|
|
583
|
+
summary: getServiceMonitoring
|
|
584
|
+
description: ''
|
|
585
|
+
operationId: getServiceMonitoring
|
|
586
|
+
parameters:
|
|
587
|
+
- name: businessSid
|
|
588
|
+
in: path
|
|
589
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
590
|
+
required: true
|
|
591
|
+
style: simple
|
|
592
|
+
schema: {}
|
|
593
|
+
- name: version
|
|
594
|
+
in: path
|
|
595
|
+
description: The API version.
|
|
596
|
+
required: true
|
|
597
|
+
style: simple
|
|
598
|
+
schema:
|
|
599
|
+
allOf:
|
|
600
|
+
- $ref: '#/components/schemas/version'
|
|
601
|
+
- description: The API version.
|
|
602
|
+
example: v1
|
|
603
|
+
responses:
|
|
604
|
+
'200':
|
|
605
|
+
description: Service monitoring data
|
|
606
|
+
headers: {}
|
|
607
|
+
content:
|
|
608
|
+
application/json:
|
|
609
|
+
schema:
|
|
610
|
+
$ref: '#/components/schemas/GetServiceMonitoringResponse'
|
|
611
|
+
'401':
|
|
612
|
+
description: Access token is missing or invalid
|
|
613
|
+
headers: {}
|
|
614
|
+
content: {}
|
|
615
|
+
'403':
|
|
616
|
+
description: Service state error
|
|
617
|
+
headers: {}
|
|
618
|
+
content:
|
|
619
|
+
application/json:
|
|
620
|
+
schema:
|
|
621
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
622
|
+
'404':
|
|
623
|
+
description: Service not found
|
|
624
|
+
headers: {}
|
|
625
|
+
content: {}
|
|
626
|
+
'500':
|
|
627
|
+
description: Internal server error
|
|
628
|
+
headers: {}
|
|
629
|
+
content: {}
|
|
630
|
+
deprecated: false
|
|
631
|
+
/serviceNode/command:
|
|
632
|
+
post:
|
|
633
|
+
tags:
|
|
634
|
+
- Show Command
|
|
635
|
+
summary: showCommand
|
|
636
|
+
description: Show commands display information about the system and system configuration, useful for troubleshooting. Information about the show commands can be found in DriveNets Documentation portal.
|
|
637
|
+
operationId: showCommand
|
|
638
|
+
parameters:
|
|
639
|
+
- name: version
|
|
640
|
+
in: path
|
|
641
|
+
description: The API version.
|
|
642
|
+
required: true
|
|
643
|
+
style: simple
|
|
644
|
+
schema:
|
|
645
|
+
allOf:
|
|
646
|
+
- $ref: '#/components/schemas/version'
|
|
647
|
+
- description: The API version.
|
|
648
|
+
example: v1
|
|
649
|
+
requestBody:
|
|
650
|
+
description: ''
|
|
651
|
+
content:
|
|
652
|
+
application/json:
|
|
653
|
+
schema:
|
|
654
|
+
$ref: '#/components/schemas/ShowCommandBodyRequest'
|
|
655
|
+
required: true
|
|
656
|
+
responses:
|
|
657
|
+
'200':
|
|
658
|
+
description: Show command response
|
|
659
|
+
headers: {}
|
|
660
|
+
content:
|
|
661
|
+
application/json:
|
|
662
|
+
schema:
|
|
663
|
+
$ref: '#/components/schemas/CommandResponse'
|
|
664
|
+
'400':
|
|
665
|
+
description: Show command response failed
|
|
666
|
+
headers: {}
|
|
667
|
+
content:
|
|
668
|
+
application/json:
|
|
669
|
+
schema:
|
|
670
|
+
$ref: '#/components/schemas/ErrorResponse'
|
|
671
|
+
'401':
|
|
672
|
+
description: Access token is missing or invalid
|
|
673
|
+
headers: {}
|
|
674
|
+
content: {}
|
|
675
|
+
'500':
|
|
676
|
+
description: Internal server error
|
|
677
|
+
headers: {}
|
|
678
|
+
content: {}
|
|
679
|
+
deprecated: false
|
|
680
|
+
components:
|
|
681
|
+
schemas:
|
|
682
|
+
IPv4_Address:
|
|
683
|
+
title: IPv4_Address
|
|
684
|
+
type: object
|
|
685
|
+
properties:
|
|
686
|
+
ipv4Address:
|
|
687
|
+
type: string
|
|
688
|
+
description: An IP v4 address.
|
|
689
|
+
ipv4Prefix:
|
|
690
|
+
type: integer
|
|
691
|
+
description: The prefix of the address (CIDR).
|
|
692
|
+
format: int32
|
|
693
|
+
IPv6_Address:
|
|
694
|
+
title: IPv6_Address
|
|
695
|
+
type: object
|
|
696
|
+
properties:
|
|
697
|
+
ipv6Address:
|
|
698
|
+
type: string
|
|
699
|
+
description: An IP v6 address.
|
|
700
|
+
ipv6Prefix:
|
|
701
|
+
type: integer
|
|
702
|
+
description: The prefix of the address (CIDR)
|
|
703
|
+
format: int32
|
|
704
|
+
Provider_Aggregated_Address:
|
|
705
|
+
title: Provider_Aggregated_Address
|
|
706
|
+
type: object
|
|
707
|
+
properties:
|
|
708
|
+
ipv4AggregatedAddress:
|
|
709
|
+
$ref: '#/components/schemas/Ipv4AggregatedAddress'
|
|
710
|
+
ipv6AggregatedAddress:
|
|
711
|
+
$ref: '#/components/schemas/Ipv6AggregatedAddress'
|
|
712
|
+
description: Private IP addresses provided from DriveNets' IP address pool. The subnet allocated is the same for all connections.
|
|
713
|
+
IG_Provider_Independent_Address:
|
|
714
|
+
title: IG_Provider_Independent_Address
|
|
715
|
+
type: object
|
|
716
|
+
properties:
|
|
717
|
+
ipv4IndependentAddress:
|
|
718
|
+
$ref: '#/components/schemas/IPv4_Address'
|
|
719
|
+
ipv6IndependentAddress:
|
|
720
|
+
$ref: '#/components/schemas/IPv6_Address'
|
|
721
|
+
description: Public or private IP addresses provided by the customer. Two sets of addresses must be created for redundancy.
|
|
722
|
+
IG_Provider_Aggregated_Address:
|
|
723
|
+
title: IG_Provider_Aggregated_Address
|
|
724
|
+
type: object
|
|
725
|
+
properties:
|
|
726
|
+
ipv4AggregatedAddress:
|
|
727
|
+
$ref: '#/components/schemas/Ipv4AggregatedAddress1'
|
|
728
|
+
ipv6AggregatedAddress:
|
|
729
|
+
$ref: '#/components/schemas/Ipv6AggregatedAddress1'
|
|
730
|
+
description: Private IP addresses provided from DriveNets' IP address pool. The subnet allocated is the same for all connections.
|
|
731
|
+
L3VpnParams:
|
|
732
|
+
title: L3VpnParams
|
|
733
|
+
type: object
|
|
734
|
+
properties:
|
|
735
|
+
rt:
|
|
736
|
+
type: string
|
|
737
|
+
FunctionParams:
|
|
738
|
+
title: FunctionParams
|
|
739
|
+
type: object
|
|
740
|
+
properties:
|
|
741
|
+
location:
|
|
742
|
+
type: string
|
|
743
|
+
direction:
|
|
744
|
+
$ref: '#/components/schemas/FunctionDirection'
|
|
745
|
+
functionOrder:
|
|
746
|
+
maximum: 1
|
|
747
|
+
minimum: 1
|
|
748
|
+
type: integer
|
|
749
|
+
format: int32
|
|
750
|
+
default: 1
|
|
751
|
+
params:
|
|
752
|
+
oneOf:
|
|
753
|
+
- $ref: '#/components/schemas/NatParams'
|
|
754
|
+
CreateServiceBodyRequest:
|
|
755
|
+
title: CreateServiceBodyRequest
|
|
756
|
+
required:
|
|
757
|
+
- businessSid
|
|
758
|
+
- atomicServices
|
|
759
|
+
type: object
|
|
760
|
+
properties:
|
|
761
|
+
businessSid:
|
|
762
|
+
type: string
|
|
763
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
764
|
+
example: 34314231-3425423-123f23-23a2g42
|
|
765
|
+
businessSidDescription:
|
|
766
|
+
type: string
|
|
767
|
+
description: Business id description
|
|
768
|
+
example: vADI service of Pepsi
|
|
769
|
+
atomicServices:
|
|
770
|
+
type: array
|
|
771
|
+
items:
|
|
772
|
+
$ref: '#/components/schemas/AtomicService'
|
|
773
|
+
description: Entries for atomic services
|
|
774
|
+
policies:
|
|
775
|
+
type: array
|
|
776
|
+
items:
|
|
777
|
+
$ref: '#/components/schemas/Policy'
|
|
778
|
+
description: Entries for policies
|
|
779
|
+
ServiceBodyRequest:
|
|
780
|
+
title: ServiceBodyRequest
|
|
781
|
+
type: object
|
|
782
|
+
properties:
|
|
783
|
+
businessSidDescription:
|
|
784
|
+
type: string
|
|
785
|
+
description: Business id description
|
|
786
|
+
example: vADI service of Pepsi
|
|
787
|
+
atomicServices:
|
|
788
|
+
type: array
|
|
789
|
+
items:
|
|
790
|
+
$ref: '#/components/schemas/AtomicService1'
|
|
791
|
+
description: Entries for atomic services
|
|
792
|
+
policies:
|
|
793
|
+
type: array
|
|
794
|
+
items:
|
|
795
|
+
$ref: '#/components/schemas/Policy1'
|
|
796
|
+
description: Entries for policies
|
|
797
|
+
ServiceBodyResponse:
|
|
798
|
+
title: ServiceBodyResponse
|
|
799
|
+
type: object
|
|
800
|
+
properties:
|
|
801
|
+
businessSid:
|
|
802
|
+
type: string
|
|
803
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
804
|
+
example: 34314231-3425423-123f23-23a2g42
|
|
805
|
+
atomicServices:
|
|
806
|
+
type: array
|
|
807
|
+
items:
|
|
808
|
+
$ref: '#/components/schemas/AtomicService2'
|
|
809
|
+
description: Entries for atomic services
|
|
810
|
+
policies:
|
|
811
|
+
type: array
|
|
812
|
+
items:
|
|
813
|
+
$ref: '#/components/schemas/Policy2'
|
|
814
|
+
description: Entries for policies
|
|
815
|
+
DeleteServiceResponse:
|
|
816
|
+
title: DeleteServiceResponse
|
|
817
|
+
required:
|
|
818
|
+
- id
|
|
819
|
+
type: object
|
|
820
|
+
properties:
|
|
821
|
+
id:
|
|
822
|
+
type: string
|
|
823
|
+
description: Unique service ID
|
|
824
|
+
example: abcdef-abcdef-12345-12345
|
|
825
|
+
EquinixConnectParams:
|
|
826
|
+
title: EquinixConnectParams
|
|
827
|
+
required:
|
|
828
|
+
- location
|
|
829
|
+
- fabricSubType
|
|
830
|
+
- bandwidth
|
|
831
|
+
- ipAddress
|
|
832
|
+
- routing
|
|
833
|
+
type: object
|
|
834
|
+
properties:
|
|
835
|
+
location:
|
|
836
|
+
type: string
|
|
837
|
+
description: Location of the peering location
|
|
838
|
+
fabricSubType:
|
|
839
|
+
$ref: '#/components/schemas/FabricSubType'
|
|
840
|
+
bandwidth:
|
|
841
|
+
$ref: '#/components/schemas/Bandwidth'
|
|
842
|
+
isRedundant:
|
|
843
|
+
type: boolean
|
|
844
|
+
default: false
|
|
845
|
+
ipAddress:
|
|
846
|
+
$ref: '#/components/schemas/IpAddress'
|
|
847
|
+
customerIpAddress:
|
|
848
|
+
maxItems: 2
|
|
849
|
+
type: array
|
|
850
|
+
items:
|
|
851
|
+
$ref: '#/components/schemas/Provider_Independent_Address'
|
|
852
|
+
description: Public or private IP addresses provided by the customer. Two sets of addresses must be created for redundancy.
|
|
853
|
+
routing:
|
|
854
|
+
$ref: '#/components/schemas/Routing1'
|
|
855
|
+
description:
|
|
856
|
+
type: string
|
|
857
|
+
EquinixConnectResponseParams:
|
|
858
|
+
title: EquinixConnectResponseParams
|
|
859
|
+
type: object
|
|
860
|
+
properties:
|
|
861
|
+
location:
|
|
862
|
+
type: string
|
|
863
|
+
description: Location of the peering location
|
|
864
|
+
fabricSubType:
|
|
865
|
+
$ref: '#/components/schemas/FabricSubType'
|
|
866
|
+
bandwidth:
|
|
867
|
+
$ref: '#/components/schemas/Bandwidth'
|
|
868
|
+
isRedundant:
|
|
869
|
+
type: boolean
|
|
870
|
+
default: false
|
|
871
|
+
ipAddress:
|
|
872
|
+
$ref: '#/components/schemas/IpAddress'
|
|
873
|
+
customerIpAddress:
|
|
874
|
+
maxItems: 2
|
|
875
|
+
type: array
|
|
876
|
+
items:
|
|
877
|
+
$ref: '#/components/schemas/Provider_Independent_Address'
|
|
878
|
+
description: Public or private IP addresses provided by the customer. Two sets of addresses must be created for redundancy.
|
|
879
|
+
routing:
|
|
880
|
+
$ref: '#/components/schemas/Routing1'
|
|
881
|
+
description:
|
|
882
|
+
type: string
|
|
883
|
+
authenticationKey:
|
|
884
|
+
type: string
|
|
885
|
+
description: Drivenets-assigned authentication key uuid, a 128-bit identifier.
|
|
886
|
+
serviceProfile:
|
|
887
|
+
type: string
|
|
888
|
+
description: Name of Drivenets service profile in Equinix to connect to.
|
|
889
|
+
AzureConnectParams:
|
|
890
|
+
title: AzureConnectParams
|
|
891
|
+
required:
|
|
892
|
+
- sKey
|
|
893
|
+
- bandwidth
|
|
894
|
+
- location
|
|
895
|
+
- ipAddress
|
|
896
|
+
- routing
|
|
897
|
+
type: object
|
|
898
|
+
properties:
|
|
899
|
+
sKey:
|
|
900
|
+
type: string
|
|
901
|
+
description: The s-key generated by Azure for the ExpressRoute service
|
|
902
|
+
bandwidth:
|
|
903
|
+
$ref: '#/components/schemas/Bandwidth1'
|
|
904
|
+
location:
|
|
905
|
+
type: string
|
|
906
|
+
ipAddress:
|
|
907
|
+
allOf:
|
|
908
|
+
- $ref: '#/components/schemas/IpAddress1'
|
|
909
|
+
- description: The IP address to be used for Azure, bpth IPv4 (mask /30) and IPv6 (mask /126) addresses will be allocated from address pool, IPv4 address can be private.
|
|
910
|
+
routing:
|
|
911
|
+
$ref: '#/components/schemas/Routing'
|
|
912
|
+
outboundRoutingPolicy:
|
|
913
|
+
allOf:
|
|
914
|
+
- $ref: '#/components/schemas/OutboundRoutingPolicy'
|
|
915
|
+
- description: Configuration details that control bgp routes advertisment from the atomic service (of the customer).
|
|
916
|
+
inboundRoutingPolicy:
|
|
917
|
+
allOf:
|
|
918
|
+
- $ref: '#/components/schemas/InboundRoutingPolicy'
|
|
919
|
+
- description: Configuration details that control ingress bgp routes advertisment towards the atomic service (of the customer).
|
|
920
|
+
InternetGatewayParams:
|
|
921
|
+
title: InternetGatewayParams
|
|
922
|
+
required:
|
|
923
|
+
- location
|
|
924
|
+
type: object
|
|
925
|
+
properties:
|
|
926
|
+
location:
|
|
927
|
+
type: string
|
|
928
|
+
description: Location of the internet gataeway
|
|
929
|
+
ipAddress:
|
|
930
|
+
oneOf:
|
|
931
|
+
- $ref: '#/components/schemas/IG_Provider_Independent_Address'
|
|
932
|
+
- $ref: '#/components/schemas/IG_Provider_Aggregated_Address'
|
|
933
|
+
ispRoutingPolicy:
|
|
934
|
+
allOf:
|
|
935
|
+
- $ref: '#/components/schemas/InboundRoutingPolicy'
|
|
936
|
+
- description: Configuration details that control ingress bgp routes advertisment towards the atomic service (of the customer).
|
|
937
|
+
internetGatewayRedundancyMode:
|
|
938
|
+
$ref: '#/components/schemas/InternetGatewayRedundancyMode'
|
|
939
|
+
InternetServiceProviderParams:
|
|
940
|
+
title: InternetServiceProviderParams
|
|
941
|
+
required:
|
|
942
|
+
- location
|
|
943
|
+
- bandwidth
|
|
944
|
+
type: object
|
|
945
|
+
properties:
|
|
946
|
+
location:
|
|
947
|
+
type: string
|
|
948
|
+
bandwidth:
|
|
949
|
+
$ref: '#/components/schemas/Bandwidth1'
|
|
950
|
+
provider:
|
|
951
|
+
allOf:
|
|
952
|
+
- $ref: '#/components/schemas/Provider'
|
|
953
|
+
- description: The provider we're connected to
|
|
954
|
+
isRedundant:
|
|
955
|
+
type: boolean
|
|
956
|
+
default: false
|
|
957
|
+
NatParams:
|
|
958
|
+
title: NatParams
|
|
959
|
+
type: object
|
|
960
|
+
properties:
|
|
961
|
+
translationsRules:
|
|
962
|
+
anyOf:
|
|
963
|
+
- type: array
|
|
964
|
+
items:
|
|
965
|
+
$ref: '#/components/schemas/NatStaticRule2'
|
|
966
|
+
- type: array
|
|
967
|
+
items:
|
|
968
|
+
$ref: '#/components/schemas/NaptStaticRule2'
|
|
969
|
+
- type: array
|
|
970
|
+
items:
|
|
971
|
+
$ref: '#/components/schemas/NatDynamicRule2'
|
|
972
|
+
- type: array
|
|
973
|
+
items:
|
|
974
|
+
$ref: '#/components/schemas/NaptDynamicRule2'
|
|
975
|
+
timeouts:
|
|
976
|
+
$ref: '#/components/schemas/NatTimeouts'
|
|
977
|
+
NatStaticRule:
|
|
978
|
+
title: NatStaticRule
|
|
979
|
+
type: object
|
|
980
|
+
properties:
|
|
981
|
+
internalIP:
|
|
982
|
+
type: string
|
|
983
|
+
externalIP:
|
|
984
|
+
$ref: '#/components/schemas/ExternalIP'
|
|
985
|
+
description: NAT static rule - ip to ip
|
|
986
|
+
NaptStaticRule:
|
|
987
|
+
title: NaptStaticRule
|
|
988
|
+
type: object
|
|
989
|
+
properties:
|
|
990
|
+
internalIP:
|
|
991
|
+
type: string
|
|
992
|
+
internalPort:
|
|
993
|
+
type: integer
|
|
994
|
+
format: int32
|
|
995
|
+
externalIP:
|
|
996
|
+
$ref: '#/components/schemas/ExternalIP'
|
|
997
|
+
externalPort:
|
|
998
|
+
type: integer
|
|
999
|
+
format: int32
|
|
1000
|
+
protocol:
|
|
1001
|
+
allOf:
|
|
1002
|
+
- $ref: '#/components/schemas/NatProtocolType'
|
|
1003
|
+
- description: ip protocol types for NAT rules.
|
|
1004
|
+
description: PAT static rule - ip and port to ip and port
|
|
1005
|
+
NatDynamicRule:
|
|
1006
|
+
title: NatDynamicRule
|
|
1007
|
+
type: object
|
|
1008
|
+
properties:
|
|
1009
|
+
internalPrefix:
|
|
1010
|
+
type: array
|
|
1011
|
+
items:
|
|
1012
|
+
$ref: '#/components/schemas/IPv4_Address'
|
|
1013
|
+
description: ''
|
|
1014
|
+
externalPool:
|
|
1015
|
+
$ref: '#/components/schemas/ExternalPool'
|
|
1016
|
+
description: NAT dynamic rule - subnet/s to ip addresses pool
|
|
1017
|
+
FunctionDirection:
|
|
1018
|
+
title: FunctionDirection
|
|
1019
|
+
type: object
|
|
1020
|
+
properties:
|
|
1021
|
+
internalAtomicService:
|
|
1022
|
+
oneOf:
|
|
1023
|
+
- type: string
|
|
1024
|
+
example: 12345-12345-abcdef-abcdef
|
|
1025
|
+
- type: string
|
|
1026
|
+
example: MyEquinixConnect1
|
|
1027
|
+
externalAtomicService:
|
|
1028
|
+
oneOf:
|
|
1029
|
+
- type: string
|
|
1030
|
+
example: 12345-12345-abcdef-abcdef
|
|
1031
|
+
- type: string
|
|
1032
|
+
example: MyEquinixConnect1
|
|
1033
|
+
NaptDynamicRule:
|
|
1034
|
+
title: NaptDynamicRule
|
|
1035
|
+
type: object
|
|
1036
|
+
properties:
|
|
1037
|
+
internalPrefix:
|
|
1038
|
+
type: array
|
|
1039
|
+
items:
|
|
1040
|
+
$ref: '#/components/schemas/IPv4_Address'
|
|
1041
|
+
description: ''
|
|
1042
|
+
externalIP:
|
|
1043
|
+
$ref: '#/components/schemas/ExternalIP'
|
|
1044
|
+
description: PAT dynamic rule - subnet/s to single ip address
|
|
1045
|
+
NatTimeouts:
|
|
1046
|
+
title: NatTimeouts
|
|
1047
|
+
type: object
|
|
1048
|
+
properties:
|
|
1049
|
+
udpTimeout:
|
|
1050
|
+
$ref: '#/components/schemas/UdpTimeout'
|
|
1051
|
+
tcpTimeout:
|
|
1052
|
+
$ref: '#/components/schemas/TcpTimeout'
|
|
1053
|
+
icmpTimeout:
|
|
1054
|
+
$ref: '#/components/schemas/IcmpTimeout'
|
|
1055
|
+
fragmentedTimeout:
|
|
1056
|
+
$ref: '#/components/schemas/FragmentedTimeout'
|
|
1057
|
+
ipTimeout:
|
|
1058
|
+
$ref: '#/components/schemas/IpTimeout'
|
|
1059
|
+
UdpTimeout:
|
|
1060
|
+
title: UdpTimeout
|
|
1061
|
+
type: object
|
|
1062
|
+
properties:
|
|
1063
|
+
udpTimeout:
|
|
1064
|
+
maximum: 7440
|
|
1065
|
+
minimum: 10
|
|
1066
|
+
type: integer
|
|
1067
|
+
format: int32
|
|
1068
|
+
default: 300
|
|
1069
|
+
TcpTimeout:
|
|
1070
|
+
title: TcpTimeout
|
|
1071
|
+
type: object
|
|
1072
|
+
properties:
|
|
1073
|
+
tcpTimeout:
|
|
1074
|
+
maximum: 10000
|
|
1075
|
+
minimum: 10
|
|
1076
|
+
type: integer
|
|
1077
|
+
format: int32
|
|
1078
|
+
default: 7440
|
|
1079
|
+
IcmpTimeout:
|
|
1080
|
+
title: IcmpTimeout
|
|
1081
|
+
type: object
|
|
1082
|
+
properties:
|
|
1083
|
+
icmpTimeout:
|
|
1084
|
+
maximum: 10000
|
|
1085
|
+
minimum: 10
|
|
1086
|
+
type: integer
|
|
1087
|
+
format: int32
|
|
1088
|
+
default: 60
|
|
1089
|
+
FragmentedTimeout:
|
|
1090
|
+
title: FragmentedTimeout
|
|
1091
|
+
type: object
|
|
1092
|
+
properties:
|
|
1093
|
+
fragmentedTimeout:
|
|
1094
|
+
maximum: 120
|
|
1095
|
+
minimum: 10
|
|
1096
|
+
type: integer
|
|
1097
|
+
format: int32
|
|
1098
|
+
default: 120
|
|
1099
|
+
IpTimeout:
|
|
1100
|
+
title: IpTimeout
|
|
1101
|
+
type: object
|
|
1102
|
+
properties:
|
|
1103
|
+
ipTimeout:
|
|
1104
|
+
maximum: 10000
|
|
1105
|
+
minimum: 10
|
|
1106
|
+
type: integer
|
|
1107
|
+
format: int32
|
|
1108
|
+
default: 7440
|
|
1109
|
+
NatProtocolType:
|
|
1110
|
+
title: NatProtocolType
|
|
1111
|
+
enum:
|
|
1112
|
+
- tcp
|
|
1113
|
+
- udp
|
|
1114
|
+
type: string
|
|
1115
|
+
description: ip protocol types for NAT rules.
|
|
1116
|
+
AzureBgpRouting:
|
|
1117
|
+
title: AzureBgpRouting
|
|
1118
|
+
type: object
|
|
1119
|
+
properties:
|
|
1120
|
+
isBfdEnabled:
|
|
1121
|
+
type: boolean
|
|
1122
|
+
default: false
|
|
1123
|
+
bgpPeering:
|
|
1124
|
+
maxItems: 2
|
|
1125
|
+
type: array
|
|
1126
|
+
items:
|
|
1127
|
+
$ref: '#/components/schemas/BgpPeering2'
|
|
1128
|
+
description: ''
|
|
1129
|
+
BgpRouting:
|
|
1130
|
+
title: BgpRouting
|
|
1131
|
+
type: object
|
|
1132
|
+
properties:
|
|
1133
|
+
isBfdEnabled:
|
|
1134
|
+
type: boolean
|
|
1135
|
+
default: false
|
|
1136
|
+
bgpPeering:
|
|
1137
|
+
maxItems: 2
|
|
1138
|
+
type: array
|
|
1139
|
+
items:
|
|
1140
|
+
$ref: '#/components/schemas/BgpPeering4'
|
|
1141
|
+
description: ''
|
|
1142
|
+
staticRoute:
|
|
1143
|
+
title: staticRoute
|
|
1144
|
+
type: object
|
|
1145
|
+
properties:
|
|
1146
|
+
staticRoute:
|
|
1147
|
+
maxItems: 10
|
|
1148
|
+
type: array
|
|
1149
|
+
items:
|
|
1150
|
+
$ref: '#/components/schemas/static_route'
|
|
1151
|
+
description: Configuration details for the Home Cloud Gateway service
|
|
1152
|
+
bgp_peering_oper_object:
|
|
1153
|
+
title: bgp_peering_oper_object
|
|
1154
|
+
type: object
|
|
1155
|
+
properties:
|
|
1156
|
+
bgpPeering:
|
|
1157
|
+
$ref: '#/components/schemas/BgpPeering3'
|
|
1158
|
+
static_oper_object:
|
|
1159
|
+
title: static_oper_object
|
|
1160
|
+
type: object
|
|
1161
|
+
properties:
|
|
1162
|
+
staticRoute:
|
|
1163
|
+
maxItems: 10
|
|
1164
|
+
type: array
|
|
1165
|
+
items:
|
|
1166
|
+
$ref: '#/components/schemas/static_route'
|
|
1167
|
+
description: Configuration details for the Home Cloud Gateway service
|
|
1168
|
+
bgp_peering:
|
|
1169
|
+
title: bgp_peering
|
|
1170
|
+
required:
|
|
1171
|
+
- localAsn
|
|
1172
|
+
type: object
|
|
1173
|
+
properties:
|
|
1174
|
+
remoteAsn:
|
|
1175
|
+
type: string
|
|
1176
|
+
description: Remote customer ASN
|
|
1177
|
+
example: 12076 - For Azure.
|
|
1178
|
+
localAsn:
|
|
1179
|
+
type: string
|
|
1180
|
+
description: Local device ASN
|
|
1181
|
+
example: '13979'
|
|
1182
|
+
bgpTimeout:
|
|
1183
|
+
maximum: 180
|
|
1184
|
+
minimum: 30
|
|
1185
|
+
type: integer
|
|
1186
|
+
description: Represents the BGP hold-time timer, bgp keep-alive will be implicitly calculated as bgpTimeout/3.
|
|
1187
|
+
format: int32
|
|
1188
|
+
default: 180
|
|
1189
|
+
bgpSecret:
|
|
1190
|
+
type: string
|
|
1191
|
+
common_bgp_peering:
|
|
1192
|
+
title: common_bgp_peering
|
|
1193
|
+
required:
|
|
1194
|
+
- localAsn
|
|
1195
|
+
type: object
|
|
1196
|
+
properties:
|
|
1197
|
+
remoteAsn:
|
|
1198
|
+
type: string
|
|
1199
|
+
description: Remote customer ASN
|
|
1200
|
+
example: 12076 - For Azure.
|
|
1201
|
+
localAsn:
|
|
1202
|
+
type: string
|
|
1203
|
+
description: Local device ASN
|
|
1204
|
+
example: '13979'
|
|
1205
|
+
bgpTimeout:
|
|
1206
|
+
maximum: 180
|
|
1207
|
+
minimum: 30
|
|
1208
|
+
type: integer
|
|
1209
|
+
description: Represents the BGP hold-time timer, bgp keep-alive will be implicitly calculated as bgpTimeout/3.
|
|
1210
|
+
format: int32
|
|
1211
|
+
default: 180
|
|
1212
|
+
BgpSecret:
|
|
1213
|
+
title: BgpSecret
|
|
1214
|
+
type: object
|
|
1215
|
+
properties:
|
|
1216
|
+
bgpSecret:
|
|
1217
|
+
type: string
|
|
1218
|
+
IPv6StaticRoute:
|
|
1219
|
+
title: IPv6StaticRoute
|
|
1220
|
+
type: object
|
|
1221
|
+
properties:
|
|
1222
|
+
ipv6Network:
|
|
1223
|
+
type: string
|
|
1224
|
+
description: Network to be routed via static route
|
|
1225
|
+
ipv6Prefix:
|
|
1226
|
+
type: integer
|
|
1227
|
+
description: Prefix size of network to be routed
|
|
1228
|
+
format: int32
|
|
1229
|
+
nextHop:
|
|
1230
|
+
type: string
|
|
1231
|
+
description: IPv4 Static route
|
|
1232
|
+
IPv4StaticRoute:
|
|
1233
|
+
title: IPv4StaticRoute
|
|
1234
|
+
type: object
|
|
1235
|
+
properties:
|
|
1236
|
+
ipv4Network:
|
|
1237
|
+
type: string
|
|
1238
|
+
description: Network to be routed via static route
|
|
1239
|
+
ipv4Prefix:
|
|
1240
|
+
type: integer
|
|
1241
|
+
description: Prefix size of network to be routed
|
|
1242
|
+
format: int32
|
|
1243
|
+
nextHop:
|
|
1244
|
+
type: string
|
|
1245
|
+
description: IPv4 Static route
|
|
1246
|
+
InboundRoutingPolicy:
|
|
1247
|
+
title: InboundRoutingPolicy
|
|
1248
|
+
type: object
|
|
1249
|
+
properties:
|
|
1250
|
+
prefixFilter:
|
|
1251
|
+
maxItems: 20
|
|
1252
|
+
type: array
|
|
1253
|
+
items:
|
|
1254
|
+
$ref: '#/components/schemas/prefix_rule'
|
|
1255
|
+
description: Configuration details for prefix filtering. The rules will be applied in the order they are configured, until first match is made.
|
|
1256
|
+
isDefaultRoute:
|
|
1257
|
+
type: boolean
|
|
1258
|
+
description: should the customer receive default route via bgp.
|
|
1259
|
+
default: true
|
|
1260
|
+
example: true
|
|
1261
|
+
description: Configuration details that control ingress bgp routes advertisment towards the atomic service (of the customer).
|
|
1262
|
+
OutboundRoutingPolicy:
|
|
1263
|
+
title: OutboundRoutingPolicy
|
|
1264
|
+
type: object
|
|
1265
|
+
properties:
|
|
1266
|
+
prefixFilter:
|
|
1267
|
+
maxItems: 20
|
|
1268
|
+
type: array
|
|
1269
|
+
items:
|
|
1270
|
+
$ref: '#/components/schemas/prefix_rule'
|
|
1271
|
+
description: Configuration details for prefix filtering. The rules will be applied in the order they are configured, until first match is made.
|
|
1272
|
+
isDefaultRoute:
|
|
1273
|
+
type: boolean
|
|
1274
|
+
description: should the customer receive default route via bgp.
|
|
1275
|
+
default: true
|
|
1276
|
+
example: true
|
|
1277
|
+
description: Configuration details that control bgp routes advertisment from the atomic service (of the customer).
|
|
1278
|
+
prefix_rule:
|
|
1279
|
+
title: prefix_rule
|
|
1280
|
+
type: object
|
|
1281
|
+
properties:
|
|
1282
|
+
ipv4Address:
|
|
1283
|
+
type: string
|
|
1284
|
+
description: An IP v4 address.
|
|
1285
|
+
ipv4Prefix:
|
|
1286
|
+
type: integer
|
|
1287
|
+
description: The prefix of the address (CIDR).
|
|
1288
|
+
format: int32
|
|
1289
|
+
gtV4:
|
|
1290
|
+
maximum: 32
|
|
1291
|
+
minimum: 0
|
|
1292
|
+
type: integer
|
|
1293
|
+
description: Define prefix length greater then or equal to
|
|
1294
|
+
format: int32
|
|
1295
|
+
ltV4:
|
|
1296
|
+
maximum: 32
|
|
1297
|
+
minimum: 0
|
|
1298
|
+
type: integer
|
|
1299
|
+
description: Define prefix length less then or equal to
|
|
1300
|
+
format: int32
|
|
1301
|
+
ipv6Address:
|
|
1302
|
+
type: string
|
|
1303
|
+
description: An IP v6 address.
|
|
1304
|
+
ipv6Prefix:
|
|
1305
|
+
type: integer
|
|
1306
|
+
description: The prefix of the address (CIDR)
|
|
1307
|
+
format: int32
|
|
1308
|
+
gtV6:
|
|
1309
|
+
maximum: 128
|
|
1310
|
+
minimum: 0
|
|
1311
|
+
type: integer
|
|
1312
|
+
description: Define prefix length greater then or equal to
|
|
1313
|
+
format: int32
|
|
1314
|
+
ltV6:
|
|
1315
|
+
maximum: 128
|
|
1316
|
+
minimum: 0
|
|
1317
|
+
type: integer
|
|
1318
|
+
description: Define prefix length less then or equal to
|
|
1319
|
+
format: int32
|
|
1320
|
+
ruleType:
|
|
1321
|
+
allOf:
|
|
1322
|
+
- $ref: '#/components/schemas/RuleType'
|
|
1323
|
+
- description: Define if prefix is permitted or denied
|
|
1324
|
+
prefix_ipv4:
|
|
1325
|
+
title: prefix_ipv4
|
|
1326
|
+
type: object
|
|
1327
|
+
properties:
|
|
1328
|
+
ipv4Address:
|
|
1329
|
+
type: string
|
|
1330
|
+
description: An IP v4 address.
|
|
1331
|
+
ipv4Prefix:
|
|
1332
|
+
type: integer
|
|
1333
|
+
description: The prefix of the address (CIDR).
|
|
1334
|
+
format: int32
|
|
1335
|
+
gtV4:
|
|
1336
|
+
maximum: 32
|
|
1337
|
+
minimum: 0
|
|
1338
|
+
type: integer
|
|
1339
|
+
description: Define prefix length greater then or equal to
|
|
1340
|
+
format: int32
|
|
1341
|
+
ltV4:
|
|
1342
|
+
maximum: 32
|
|
1343
|
+
minimum: 0
|
|
1344
|
+
type: integer
|
|
1345
|
+
description: Define prefix length less then or equal to
|
|
1346
|
+
format: int32
|
|
1347
|
+
prefix_ipv6:
|
|
1348
|
+
title: prefix_ipv6
|
|
1349
|
+
type: object
|
|
1350
|
+
properties:
|
|
1351
|
+
ipv6Address:
|
|
1352
|
+
type: string
|
|
1353
|
+
description: An IP v6 address.
|
|
1354
|
+
ipv6Prefix:
|
|
1355
|
+
type: integer
|
|
1356
|
+
description: The prefix of the address (CIDR)
|
|
1357
|
+
format: int32
|
|
1358
|
+
gtV6:
|
|
1359
|
+
maximum: 128
|
|
1360
|
+
minimum: 0
|
|
1361
|
+
type: integer
|
|
1362
|
+
description: Define prefix length greater then or equal to
|
|
1363
|
+
format: int32
|
|
1364
|
+
ltV6:
|
|
1365
|
+
maximum: 128
|
|
1366
|
+
minimum: 0
|
|
1367
|
+
type: integer
|
|
1368
|
+
description: Define prefix length less then or equal to
|
|
1369
|
+
format: int32
|
|
1370
|
+
EquinixConnectOperParams:
|
|
1371
|
+
title: EquinixConnectOperParams
|
|
1372
|
+
type: object
|
|
1373
|
+
properties:
|
|
1374
|
+
availableLocations:
|
|
1375
|
+
type: array
|
|
1376
|
+
items:
|
|
1377
|
+
type: string
|
|
1378
|
+
description: ''
|
|
1379
|
+
example:
|
|
1380
|
+
- dallas
|
|
1381
|
+
- los-angeles
|
|
1382
|
+
- houston
|
|
1383
|
+
equinixConnectCircuit:
|
|
1384
|
+
type: array
|
|
1385
|
+
items:
|
|
1386
|
+
$ref: '#/components/schemas/EquinixConnectCircuit'
|
|
1387
|
+
description: ''
|
|
1388
|
+
BgpState:
|
|
1389
|
+
title: BgpState
|
|
1390
|
+
type: object
|
|
1391
|
+
properties:
|
|
1392
|
+
bgpStateV4:
|
|
1393
|
+
allOf:
|
|
1394
|
+
- $ref: '#/components/schemas/BgpStates'
|
|
1395
|
+
- description: BGP peering state
|
|
1396
|
+
bgpStateV6:
|
|
1397
|
+
allOf:
|
|
1398
|
+
- $ref: '#/components/schemas/BgpStates'
|
|
1399
|
+
- description: BGP peering state
|
|
1400
|
+
description: BGP peering state
|
|
1401
|
+
BgpStates:
|
|
1402
|
+
title: BgpStates
|
|
1403
|
+
enum:
|
|
1404
|
+
- up
|
|
1405
|
+
- down
|
|
1406
|
+
type: string
|
|
1407
|
+
description: BGP peering state
|
|
1408
|
+
BfdState:
|
|
1409
|
+
title: BfdState
|
|
1410
|
+
enum:
|
|
1411
|
+
- up
|
|
1412
|
+
- down
|
|
1413
|
+
type: string
|
|
1414
|
+
description: BFD session state
|
|
1415
|
+
linkState:
|
|
1416
|
+
title: linkState
|
|
1417
|
+
enum:
|
|
1418
|
+
- up
|
|
1419
|
+
- down
|
|
1420
|
+
type: string
|
|
1421
|
+
description: Link state
|
|
1422
|
+
connectivityDetails:
|
|
1423
|
+
title: connectivityDetails
|
|
1424
|
+
type: object
|
|
1425
|
+
properties:
|
|
1426
|
+
connectionUuid:
|
|
1427
|
+
type: string
|
|
1428
|
+
description: The connection UUID
|
|
1429
|
+
linkUuid:
|
|
1430
|
+
type: string
|
|
1431
|
+
description: The link UUID
|
|
1432
|
+
description: Holds the link and connection UUIDs
|
|
1433
|
+
IGOperParams:
|
|
1434
|
+
title: IGOperParams
|
|
1435
|
+
type: object
|
|
1436
|
+
properties:
|
|
1437
|
+
availableLocations:
|
|
1438
|
+
type: array
|
|
1439
|
+
items:
|
|
1440
|
+
type: string
|
|
1441
|
+
description: ''
|
|
1442
|
+
example:
|
|
1443
|
+
- dallas
|
|
1444
|
+
- los-angeles
|
|
1445
|
+
- houston
|
|
1446
|
+
igCircuit:
|
|
1447
|
+
type: array
|
|
1448
|
+
items:
|
|
1449
|
+
$ref: '#/components/schemas/IgCircuit'
|
|
1450
|
+
description: ''
|
|
1451
|
+
ISPOperParams:
|
|
1452
|
+
title: ISPOperParams
|
|
1453
|
+
type: object
|
|
1454
|
+
properties:
|
|
1455
|
+
availableLocations:
|
|
1456
|
+
type: array
|
|
1457
|
+
items:
|
|
1458
|
+
type: string
|
|
1459
|
+
description: ''
|
|
1460
|
+
example:
|
|
1461
|
+
- dallas
|
|
1462
|
+
- los-angeles
|
|
1463
|
+
- houston
|
|
1464
|
+
ispCircuit:
|
|
1465
|
+
type: array
|
|
1466
|
+
items:
|
|
1467
|
+
$ref: '#/components/schemas/IspCircuit'
|
|
1468
|
+
description: ''
|
|
1469
|
+
AzureConnectOperParams:
|
|
1470
|
+
title: AzureConnectOperParams
|
|
1471
|
+
type: object
|
|
1472
|
+
properties:
|
|
1473
|
+
availableLocations:
|
|
1474
|
+
type: array
|
|
1475
|
+
items:
|
|
1476
|
+
type: string
|
|
1477
|
+
description: ''
|
|
1478
|
+
example:
|
|
1479
|
+
- dallas
|
|
1480
|
+
- los-angeles
|
|
1481
|
+
- houston
|
|
1482
|
+
sKey:
|
|
1483
|
+
type: string
|
|
1484
|
+
description: Azure service key.
|
|
1485
|
+
azureConnectCircuit:
|
|
1486
|
+
type: array
|
|
1487
|
+
items:
|
|
1488
|
+
$ref: '#/components/schemas/AzureConnectCircuit'
|
|
1489
|
+
description: ''
|
|
1490
|
+
ErrorResponse:
|
|
1491
|
+
title: ErrorResponse
|
|
1492
|
+
required:
|
|
1493
|
+
- message
|
|
1494
|
+
type: object
|
|
1495
|
+
properties:
|
|
1496
|
+
errors:
|
|
1497
|
+
type: array
|
|
1498
|
+
items:
|
|
1499
|
+
$ref: '#/components/schemas/Error'
|
|
1500
|
+
description: ''
|
|
1501
|
+
message:
|
|
1502
|
+
type: string
|
|
1503
|
+
example: Failed to configure service
|
|
1504
|
+
NatOperParams:
|
|
1505
|
+
title: NatOperParams
|
|
1506
|
+
type: object
|
|
1507
|
+
properties:
|
|
1508
|
+
location:
|
|
1509
|
+
type: string
|
|
1510
|
+
natState:
|
|
1511
|
+
$ref: '#/components/schemas/NatState'
|
|
1512
|
+
error:
|
|
1513
|
+
$ref: '#/components/schemas/ErrorStructure2'
|
|
1514
|
+
GetServiceStateResponse:
|
|
1515
|
+
title: GetServiceStateResponse
|
|
1516
|
+
type: object
|
|
1517
|
+
properties:
|
|
1518
|
+
businessSid:
|
|
1519
|
+
type: string
|
|
1520
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
1521
|
+
example: 34314231-3425423-123f23-23a2g42
|
|
1522
|
+
businessSidState:
|
|
1523
|
+
$ref: '#/components/schemas/BusinessSidState'
|
|
1524
|
+
atomicServices:
|
|
1525
|
+
type: array
|
|
1526
|
+
items:
|
|
1527
|
+
$ref: '#/components/schemas/AtomicService3'
|
|
1528
|
+
description: Entries for atomic services
|
|
1529
|
+
policies:
|
|
1530
|
+
type: array
|
|
1531
|
+
items:
|
|
1532
|
+
$ref: '#/components/schemas/Policy3'
|
|
1533
|
+
description: Entries for policies
|
|
1534
|
+
GetServiceMonitoringResponse:
|
|
1535
|
+
title: GetServiceMonitoringResponse
|
|
1536
|
+
type: object
|
|
1537
|
+
properties:
|
|
1538
|
+
businessSid:
|
|
1539
|
+
type: string
|
|
1540
|
+
description: Unique ID provided by the Service Provider to identify a solution, which is a collection of several atomic services. When forming a solution, use the same BusinessSID.
|
|
1541
|
+
example: 34314231-3425423-123f23-23a2g42
|
|
1542
|
+
atomicServices:
|
|
1543
|
+
type: array
|
|
1544
|
+
items:
|
|
1545
|
+
$ref: '#/components/schemas/AtomicService4'
|
|
1546
|
+
description: Entries for atomic services
|
|
1547
|
+
GetRemoteBgpPrefixList:
|
|
1548
|
+
title: GetRemoteBgpPrefixList
|
|
1549
|
+
type: object
|
|
1550
|
+
properties:
|
|
1551
|
+
bgpIpV4PrefixList:
|
|
1552
|
+
type: array
|
|
1553
|
+
items:
|
|
1554
|
+
type: string
|
|
1555
|
+
description: ''
|
|
1556
|
+
example:
|
|
1557
|
+
- 123.1.0.0/24
|
|
1558
|
+
bgpIpV6PrefixList:
|
|
1559
|
+
type: array
|
|
1560
|
+
items:
|
|
1561
|
+
type: string
|
|
1562
|
+
description: ''
|
|
1563
|
+
example:
|
|
1564
|
+
- 3FFE:FFFF:0:CD31::/120
|
|
1565
|
+
GetRemotePeeringState:
|
|
1566
|
+
title: GetRemotePeeringState
|
|
1567
|
+
type: object
|
|
1568
|
+
properties:
|
|
1569
|
+
peeringInfo:
|
|
1570
|
+
type: array
|
|
1571
|
+
items:
|
|
1572
|
+
$ref: '#/components/schemas/PeeringInfo'
|
|
1573
|
+
description: ''
|
|
1574
|
+
GetRemotePortNames:
|
|
1575
|
+
title: GetRemotePortNames
|
|
1576
|
+
type: object
|
|
1577
|
+
properties:
|
|
1578
|
+
primaryPortName:
|
|
1579
|
+
type: string
|
|
1580
|
+
description: The primary port name
|
|
1581
|
+
secondaryPortName:
|
|
1582
|
+
type: string
|
|
1583
|
+
description: The secondary port name
|
|
1584
|
+
GetAzureConnectCircuitUsage:
|
|
1585
|
+
title: GetAzureConnectCircuitUsage
|
|
1586
|
+
type: object
|
|
1587
|
+
properties:
|
|
1588
|
+
remoteCounters:
|
|
1589
|
+
$ref: '#/components/schemas/GetCircuitUsage'
|
|
1590
|
+
error:
|
|
1591
|
+
$ref: '#/components/schemas/ErrorStructure2'
|
|
1592
|
+
GetCircuitUsage:
|
|
1593
|
+
title: GetCircuitUsage
|
|
1594
|
+
type: object
|
|
1595
|
+
properties:
|
|
1596
|
+
counters:
|
|
1597
|
+
type: array
|
|
1598
|
+
items:
|
|
1599
|
+
$ref: '#/components/schemas/Counter'
|
|
1600
|
+
description: ''
|
|
1601
|
+
CreatePolicyBodyRequest:
|
|
1602
|
+
title: CreatePolicyBodyRequest
|
|
1603
|
+
required:
|
|
1604
|
+
- sourceAtomicServiceTransactionTag
|
|
1605
|
+
- DestinationAtomicServiceTransactionTag
|
|
1606
|
+
type: object
|
|
1607
|
+
properties:
|
|
1608
|
+
sourceAtomicServiceTransactionTag:
|
|
1609
|
+
type: string
|
|
1610
|
+
description: Unique TAG of component per transaction
|
|
1611
|
+
example: MyEquinixConnect1
|
|
1612
|
+
DestinationAtomicServiceTransactionTag:
|
|
1613
|
+
type: string
|
|
1614
|
+
description: Unique TAG of component per transaction
|
|
1615
|
+
example: MyEquinixConnect1
|
|
1616
|
+
PolicyBodyRequest:
|
|
1617
|
+
title: PolicyBodyRequest
|
|
1618
|
+
type: object
|
|
1619
|
+
properties:
|
|
1620
|
+
sourceAtomicService:
|
|
1621
|
+
oneOf:
|
|
1622
|
+
- type: string
|
|
1623
|
+
example: 12345-12345-abcdef-abcdef
|
|
1624
|
+
- type: string
|
|
1625
|
+
example: MyEquinixConnect1
|
|
1626
|
+
destinationAtomicService:
|
|
1627
|
+
oneOf:
|
|
1628
|
+
- type: string
|
|
1629
|
+
example: 12345-12345-abcdef-abcdef
|
|
1630
|
+
- type: string
|
|
1631
|
+
example: MyEquinixConnect1
|
|
1632
|
+
ResourceBusyResponse:
|
|
1633
|
+
title: ResourceBusyResponse
|
|
1634
|
+
type: object
|
|
1635
|
+
properties:
|
|
1636
|
+
id:
|
|
1637
|
+
type: string
|
|
1638
|
+
description: ID of the atomic service
|
|
1639
|
+
ShowCommandBodyRequest:
|
|
1640
|
+
title: ShowCommandBodyRequest
|
|
1641
|
+
required:
|
|
1642
|
+
- operation
|
|
1643
|
+
- snDnId
|
|
1644
|
+
- snDnName
|
|
1645
|
+
- qualifier
|
|
1646
|
+
type: object
|
|
1647
|
+
properties:
|
|
1648
|
+
operation:
|
|
1649
|
+
type: string
|
|
1650
|
+
description: >-
|
|
1651
|
+
Show Commands:
|
|
1652
|
+
BGP, BGP_NEIGHBORS, BGP_SUMMARY,
|
|
1653
|
+
BGP_ROUTE, BGP_NEXTHOP_REACHABLE,
|
|
1654
|
+
BGP_NEXTHOP, BGP_IPV4, BGP_IPV4_PREFIX_LIST
|
|
1655
|
+
BGP_IPV6, BGP_IPV6_PREFIX_LIST, INTERFACE
|
|
1656
|
+
INTERFACE_COUNTERS, VRF
|
|
1657
|
+
example: INTERFACE
|
|
1658
|
+
snDnId:
|
|
1659
|
+
type: string
|
|
1660
|
+
description: Unique ID of service node
|
|
1661
|
+
example: 12345-12345-abcdef-abcdef
|
|
1662
|
+
snDnName:
|
|
1663
|
+
type: string
|
|
1664
|
+
description: Service Node Name
|
|
1665
|
+
example: Dallas324T
|
|
1666
|
+
qualifier:
|
|
1667
|
+
type: string
|
|
1668
|
+
description: Qualifier
|
|
1669
|
+
example: ge100-0/0/0
|
|
1670
|
+
CommandResponse:
|
|
1671
|
+
title: CommandResponse
|
|
1672
|
+
required:
|
|
1673
|
+
- message
|
|
1674
|
+
- status
|
|
1675
|
+
type: object
|
|
1676
|
+
properties:
|
|
1677
|
+
message:
|
|
1678
|
+
type: string
|
|
1679
|
+
example: '| Interface | Admin | Operational | VRF || ge100-0/0/0 | Enabled | up | default |'
|
|
1680
|
+
status:
|
|
1681
|
+
type: string
|
|
1682
|
+
description: Failed to add function
|
|
1683
|
+
example: nack
|
|
1684
|
+
UserLoginDTO:
|
|
1685
|
+
title: UserLoginDTO
|
|
1686
|
+
required:
|
|
1687
|
+
- username
|
|
1688
|
+
- password
|
|
1689
|
+
type: object
|
|
1690
|
+
properties:
|
|
1691
|
+
username:
|
|
1692
|
+
type: string
|
|
1693
|
+
description: Enter the username you were provided during sign up.
|
|
1694
|
+
password:
|
|
1695
|
+
type: string
|
|
1696
|
+
description: Enter the password you were provided during sign up.
|
|
1697
|
+
AccessToken:
|
|
1698
|
+
title: AccessToken
|
|
1699
|
+
type: object
|
|
1700
|
+
properties:
|
|
1701
|
+
access_token:
|
|
1702
|
+
type: string
|
|
1703
|
+
RefreshedToken:
|
|
1704
|
+
title: RefreshedToken
|
|
1705
|
+
type: object
|
|
1706
|
+
properties:
|
|
1707
|
+
refreshed_token:
|
|
1708
|
+
type: string
|
|
1709
|
+
AtomicService:
|
|
1710
|
+
title: AtomicService
|
|
1711
|
+
required:
|
|
1712
|
+
- atomicServiceTransactionTag
|
|
1713
|
+
- atomicServiceType
|
|
1714
|
+
type: object
|
|
1715
|
+
properties:
|
|
1716
|
+
atomicServiceTransactionTag:
|
|
1717
|
+
type: string
|
|
1718
|
+
description: Unique TAG of component per transaction
|
|
1719
|
+
example: MyEquinixConnect1
|
|
1720
|
+
atomicServiceType:
|
|
1721
|
+
allOf:
|
|
1722
|
+
- $ref: '#/components/schemas/AtomicServiceType'
|
|
1723
|
+
- description: Type of the atomic service.
|
|
1724
|
+
atomicServiceParams:
|
|
1725
|
+
$ref: '#/components/schemas/AtomicServiceParams'
|
|
1726
|
+
circuits:
|
|
1727
|
+
type: array
|
|
1728
|
+
items:
|
|
1729
|
+
$ref: '#/components/schemas/Circuit'
|
|
1730
|
+
description: Entries for atomic service circuits
|
|
1731
|
+
AtomicService1:
|
|
1732
|
+
title: AtomicService1
|
|
1733
|
+
type: object
|
|
1734
|
+
properties:
|
|
1735
|
+
atomicServiceId:
|
|
1736
|
+
type: string
|
|
1737
|
+
description: Unique UUID of component
|
|
1738
|
+
example: 12345-12345-abcdef-abcdef
|
|
1739
|
+
atomicServiceTransactionTag:
|
|
1740
|
+
type: string
|
|
1741
|
+
description: Unique TAG of component per transaction
|
|
1742
|
+
example: MyEquinixConnect1
|
|
1743
|
+
atomicServiceType:
|
|
1744
|
+
allOf:
|
|
1745
|
+
- $ref: '#/components/schemas/AtomicServiceType'
|
|
1746
|
+
- description: Type of the atomic service.
|
|
1747
|
+
atomicServiceParams:
|
|
1748
|
+
$ref: '#/components/schemas/AtomicServiceParams'
|
|
1749
|
+
circuits:
|
|
1750
|
+
type: array
|
|
1751
|
+
items:
|
|
1752
|
+
$ref: '#/components/schemas/Circuit1'
|
|
1753
|
+
description: Entries for atomic service circuits
|
|
1754
|
+
AtomicService2:
|
|
1755
|
+
title: AtomicService2
|
|
1756
|
+
type: object
|
|
1757
|
+
properties:
|
|
1758
|
+
atomicServiceId:
|
|
1759
|
+
type: string
|
|
1760
|
+
description: Unique UUID of component
|
|
1761
|
+
example: 12345-12345-abcdef-abcdef
|
|
1762
|
+
atomicServiceTransactionTag:
|
|
1763
|
+
type: string
|
|
1764
|
+
description: Unique TAG of component per transaction
|
|
1765
|
+
example: MyEquinixConnect1
|
|
1766
|
+
atomicServiceType:
|
|
1767
|
+
allOf:
|
|
1768
|
+
- $ref: '#/components/schemas/AtomicServiceType'
|
|
1769
|
+
- description: Type of the atomic service.
|
|
1770
|
+
atomicServiceParams:
|
|
1771
|
+
$ref: '#/components/schemas/AtomicServiceParams'
|
|
1772
|
+
circuits:
|
|
1773
|
+
type: array
|
|
1774
|
+
items:
|
|
1775
|
+
$ref: '#/components/schemas/Circuit2'
|
|
1776
|
+
description: Entries for atomic service circuits
|
|
1777
|
+
AtomicService3:
|
|
1778
|
+
title: AtomicService3
|
|
1779
|
+
type: object
|
|
1780
|
+
properties:
|
|
1781
|
+
atomicServiceId:
|
|
1782
|
+
type: string
|
|
1783
|
+
description: Unique UUID of component
|
|
1784
|
+
example: 12345-12345-abcdef-abcdef
|
|
1785
|
+
atomicServiceTransactionTag:
|
|
1786
|
+
type: string
|
|
1787
|
+
description: Unique TAG of component per transaction
|
|
1788
|
+
example: MyEquinixConnect1
|
|
1789
|
+
atomicServiceType:
|
|
1790
|
+
allOf:
|
|
1791
|
+
- $ref: '#/components/schemas/AtomicServiceType3'
|
|
1792
|
+
- description: Service type
|
|
1793
|
+
atomicServiceParams:
|
|
1794
|
+
$ref: '#/components/schemas/AtomicServiceParams'
|
|
1795
|
+
circuits:
|
|
1796
|
+
type: array
|
|
1797
|
+
items:
|
|
1798
|
+
$ref: '#/components/schemas/Circuit3'
|
|
1799
|
+
description: Entries for atomic service circuits
|
|
1800
|
+
AtomicService4:
|
|
1801
|
+
title: AtomicService4
|
|
1802
|
+
type: object
|
|
1803
|
+
properties:
|
|
1804
|
+
atomicServiceTransactionTag:
|
|
1805
|
+
type: string
|
|
1806
|
+
description: Unique TAG of component per transaction
|
|
1807
|
+
example: MyEquinixConnect1
|
|
1808
|
+
atomicServiceType:
|
|
1809
|
+
allOf:
|
|
1810
|
+
- $ref: '#/components/schemas/AtomicServiceType4'
|
|
1811
|
+
- description: Service type
|
|
1812
|
+
circuits:
|
|
1813
|
+
type: array
|
|
1814
|
+
items:
|
|
1815
|
+
$ref: '#/components/schemas/Circuit4'
|
|
1816
|
+
description: Entries for atomic service circuits
|
|
1817
|
+
AtomicServiceType:
|
|
1818
|
+
title: AtomicServiceType
|
|
1819
|
+
enum:
|
|
1820
|
+
- EQUINIX_CONNECT
|
|
1821
|
+
- INTERNET_GATEWAY
|
|
1822
|
+
- INTERNET_SERVICE_PROVIDER
|
|
1823
|
+
- AZURE_CONNECT
|
|
1824
|
+
type: string
|
|
1825
|
+
description: Type of the atomic service.
|
|
1826
|
+
AtomicServiceType3:
|
|
1827
|
+
title: AtomicServiceType3
|
|
1828
|
+
enum:
|
|
1829
|
+
- EQUINIX_CONNECT
|
|
1830
|
+
- INTERNET_GATEWAY
|
|
1831
|
+
- INTERNET_SERVICE_PROVIDER
|
|
1832
|
+
- AZURE_CONNECT
|
|
1833
|
+
type: string
|
|
1834
|
+
description: Service type
|
|
1835
|
+
AtomicServiceType4:
|
|
1836
|
+
title: AtomicServiceType4
|
|
1837
|
+
enum:
|
|
1838
|
+
- AZURE_CONNECT
|
|
1839
|
+
type: string
|
|
1840
|
+
description: Service type
|
|
1841
|
+
AvailableService:
|
|
1842
|
+
title: AvailableService
|
|
1843
|
+
type: object
|
|
1844
|
+
properties:
|
|
1845
|
+
serviceName:
|
|
1846
|
+
$ref: '#/components/schemas/ServiceName'
|
|
1847
|
+
overallBandwidthRedundantServices:
|
|
1848
|
+
type: string
|
|
1849
|
+
example: 1gbps
|
|
1850
|
+
overallBandwidthNonRedundantServices:
|
|
1851
|
+
type: string
|
|
1852
|
+
example: 1gbps
|
|
1853
|
+
remainingBandwidthRedundantServices:
|
|
1854
|
+
type: string
|
|
1855
|
+
example: 100mbps
|
|
1856
|
+
remainingBandwidthNonRedundantServices:
|
|
1857
|
+
type: string
|
|
1858
|
+
example: 100mbps
|
|
1859
|
+
maxBandwidthRedundantService:
|
|
1860
|
+
type: string
|
|
1861
|
+
example: 100mbps
|
|
1862
|
+
maxBandwidthNonRedundantService:
|
|
1863
|
+
type: string
|
|
1864
|
+
example: 100mbps
|
|
1865
|
+
Azure_Provider_Private_Address:
|
|
1866
|
+
title: Azure_Provider_Private_Address
|
|
1867
|
+
type: object
|
|
1868
|
+
properties:
|
|
1869
|
+
ipv4PrivateAddress:
|
|
1870
|
+
$ref: '#/components/schemas/IPv4_Address'
|
|
1871
|
+
ipv6ProviderCustomAddress:
|
|
1872
|
+
$ref: '#/components/schemas/IPv6_Address'
|
|
1873
|
+
connectionPriority:
|
|
1874
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
1875
|
+
AzureConnectCircuit:
|
|
1876
|
+
title: AzureConnectCircuit
|
|
1877
|
+
type: object
|
|
1878
|
+
properties:
|
|
1879
|
+
location:
|
|
1880
|
+
type: string
|
|
1881
|
+
description: The Azure location of the reported circuit
|
|
1882
|
+
circuitState:
|
|
1883
|
+
$ref: '#/components/schemas/CircuitState'
|
|
1884
|
+
remoteIpv4PeeringState:
|
|
1885
|
+
$ref: '#/components/schemas/GetRemotePeeringState'
|
|
1886
|
+
remoteIpv6PeeringState:
|
|
1887
|
+
$ref: '#/components/schemas/GetRemotePeeringState'
|
|
1888
|
+
remoteAdvertisedPrefixList:
|
|
1889
|
+
$ref: '#/components/schemas/GetRemoteBgpPrefixList'
|
|
1890
|
+
PortNames:
|
|
1891
|
+
$ref: '#/components/schemas/GetRemotePortNames'
|
|
1892
|
+
connections:
|
|
1893
|
+
maxItems: 2
|
|
1894
|
+
type: array
|
|
1895
|
+
items:
|
|
1896
|
+
$ref: '#/components/schemas/Connection1'
|
|
1897
|
+
description: ''
|
|
1898
|
+
error:
|
|
1899
|
+
$ref: '#/components/schemas/ErrorStructure2'
|
|
1900
|
+
Bandwidth:
|
|
1901
|
+
title: Bandwidth
|
|
1902
|
+
enum:
|
|
1903
|
+
- 100mbps
|
|
1904
|
+
- 500mbps
|
|
1905
|
+
- 1gbps
|
|
1906
|
+
- 5gbps
|
|
1907
|
+
- 10gbps
|
|
1908
|
+
type: string
|
|
1909
|
+
Bandwidth1:
|
|
1910
|
+
title: Bandwidth1
|
|
1911
|
+
enum:
|
|
1912
|
+
- 50mbps
|
|
1913
|
+
- 100mbps
|
|
1914
|
+
- 200mbps
|
|
1915
|
+
- 500mbps
|
|
1916
|
+
- 1gbps
|
|
1917
|
+
- 2gbps
|
|
1918
|
+
- 5gbps
|
|
1919
|
+
- 10gbps
|
|
1920
|
+
type: string
|
|
1921
|
+
BgpPeering2:
|
|
1922
|
+
title: BgpPeering2
|
|
1923
|
+
required:
|
|
1924
|
+
- bgpV4
|
|
1925
|
+
- bgpV6
|
|
1926
|
+
- connectionPriority
|
|
1927
|
+
type: object
|
|
1928
|
+
properties:
|
|
1929
|
+
bgpV4:
|
|
1930
|
+
$ref: '#/components/schemas/common_bgp_peering'
|
|
1931
|
+
bgpV6:
|
|
1932
|
+
$ref: '#/components/schemas/common_bgp_peering'
|
|
1933
|
+
connectionPriority:
|
|
1934
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
1935
|
+
BgpPeering3:
|
|
1936
|
+
title: BgpPeering3
|
|
1937
|
+
type: object
|
|
1938
|
+
properties:
|
|
1939
|
+
bgpV4:
|
|
1940
|
+
$ref: '#/components/schemas/bgp_peering'
|
|
1941
|
+
bgpV6:
|
|
1942
|
+
$ref: '#/components/schemas/bgp_peering'
|
|
1943
|
+
BgpPeering4:
|
|
1944
|
+
title: BgpPeering4
|
|
1945
|
+
type: object
|
|
1946
|
+
properties:
|
|
1947
|
+
bgpV4:
|
|
1948
|
+
$ref: '#/components/schemas/bgp_peering'
|
|
1949
|
+
bgpV6:
|
|
1950
|
+
$ref: '#/components/schemas/bgp_peering'
|
|
1951
|
+
connectionPriority:
|
|
1952
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
1953
|
+
redundancyMode:
|
|
1954
|
+
$ref: '#/components/schemas/RedundancyMode'
|
|
1955
|
+
BgpPeeringState:
|
|
1956
|
+
title: BgpPeeringState
|
|
1957
|
+
enum:
|
|
1958
|
+
- enabled
|
|
1959
|
+
- disabled
|
|
1960
|
+
type: string
|
|
1961
|
+
BusinessSidState:
|
|
1962
|
+
title: BusinessSidState
|
|
1963
|
+
enum:
|
|
1964
|
+
- CONFIGURED
|
|
1965
|
+
- IN-PROGRESS
|
|
1966
|
+
- FAILED
|
|
1967
|
+
type: string
|
|
1968
|
+
Circuit:
|
|
1969
|
+
title: Circuit
|
|
1970
|
+
type: object
|
|
1971
|
+
properties:
|
|
1972
|
+
circuitTransactionTag:
|
|
1973
|
+
type: string
|
|
1974
|
+
description: user provided circuit tag
|
|
1975
|
+
example: MyCircuit
|
|
1976
|
+
params:
|
|
1977
|
+
$ref: '#/components/schemas/CircuitParams'
|
|
1978
|
+
Circuit1:
|
|
1979
|
+
title: Circuit1
|
|
1980
|
+
type: object
|
|
1981
|
+
properties:
|
|
1982
|
+
circuitId:
|
|
1983
|
+
type: string
|
|
1984
|
+
description: Unique circuit ID issued by the Network Cloud+ to identify an circuit.
|
|
1985
|
+
circuitTransactionTag:
|
|
1986
|
+
type: string
|
|
1987
|
+
description: user provided circuit tag
|
|
1988
|
+
example: MyCircuit
|
|
1989
|
+
params:
|
|
1990
|
+
$ref: '#/components/schemas/CircuitParams'
|
|
1991
|
+
Circuit2:
|
|
1992
|
+
title: Circuit2
|
|
1993
|
+
type: object
|
|
1994
|
+
properties:
|
|
1995
|
+
circuitId:
|
|
1996
|
+
type: string
|
|
1997
|
+
description: Unique circuit ID issued by the Network Cloud+ to identify an circuit.
|
|
1998
|
+
circuitTransactionTag:
|
|
1999
|
+
type: string
|
|
2000
|
+
description: user provided circuit tag
|
|
2001
|
+
example: MyCircuit
|
|
2002
|
+
params:
|
|
2003
|
+
$ref: '#/components/schemas/CircuitResponseParams'
|
|
2004
|
+
Circuit3:
|
|
2005
|
+
title: Circuit3
|
|
2006
|
+
type: object
|
|
2007
|
+
properties:
|
|
2008
|
+
circuitId:
|
|
2009
|
+
type: string
|
|
2010
|
+
description: genarated circuit id
|
|
2011
|
+
circuitTransactionTag:
|
|
2012
|
+
type: string
|
|
2013
|
+
description: user provided circuit tag
|
|
2014
|
+
example: MyCircuit
|
|
2015
|
+
params:
|
|
2016
|
+
oneOf:
|
|
2017
|
+
- $ref: '#/components/schemas/EquinixConnectOperParams'
|
|
2018
|
+
- $ref: '#/components/schemas/IGOperParams'
|
|
2019
|
+
- $ref: '#/components/schemas/ISPOperParams'
|
|
2020
|
+
- $ref: '#/components/schemas/AzureConnectOperParams'
|
|
2021
|
+
Circuit4:
|
|
2022
|
+
title: Circuit4
|
|
2023
|
+
type: object
|
|
2024
|
+
properties:
|
|
2025
|
+
circuitId:
|
|
2026
|
+
type: string
|
|
2027
|
+
description: genarated circuit id
|
|
2028
|
+
circuitTransactionTag:
|
|
2029
|
+
type: string
|
|
2030
|
+
description: user provided circuit tag
|
|
2031
|
+
example: MyCircuit
|
|
2032
|
+
params:
|
|
2033
|
+
oneOf:
|
|
2034
|
+
- $ref: '#/components/schemas/GetAzureConnectCircuitUsage'
|
|
2035
|
+
CircuitState:
|
|
2036
|
+
title: CircuitState
|
|
2037
|
+
enum:
|
|
2038
|
+
- up
|
|
2039
|
+
- down
|
|
2040
|
+
- degraded
|
|
2041
|
+
type: string
|
|
2042
|
+
Connection:
|
|
2043
|
+
title: Connection
|
|
2044
|
+
type: object
|
|
2045
|
+
properties:
|
|
2046
|
+
connectionPriority:
|
|
2047
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
2048
|
+
zSideToken:
|
|
2049
|
+
type: string
|
|
2050
|
+
description: Equinix-assigned service token uuid, a 128-bit namespace identifier
|
|
2051
|
+
ipAddress:
|
|
2052
|
+
type: array
|
|
2053
|
+
items:
|
|
2054
|
+
$ref: '#/components/schemas/IP_Address'
|
|
2055
|
+
description: ''
|
|
2056
|
+
routing:
|
|
2057
|
+
$ref: '#/components/schemas/OperRouting'
|
|
2058
|
+
connectionProviderState:
|
|
2059
|
+
anyOf:
|
|
2060
|
+
- $ref: '#/components/schemas/BgpState'
|
|
2061
|
+
- $ref: '#/components/schemas/BfdState'
|
|
2062
|
+
- $ref: '#/components/schemas/linkState'
|
|
2063
|
+
equinixState:
|
|
2064
|
+
$ref: '#/components/schemas/EquinixState'
|
|
2065
|
+
connectionDetails:
|
|
2066
|
+
allOf:
|
|
2067
|
+
- $ref: '#/components/schemas/connectivityDetails'
|
|
2068
|
+
- description: Holds the link and connection UUIDs
|
|
2069
|
+
equinixPortUuid:
|
|
2070
|
+
type: string
|
|
2071
|
+
description: uuid of the port of Equinix
|
|
2072
|
+
equinixConnectionUuid:
|
|
2073
|
+
type: string
|
|
2074
|
+
description: the connection uuid of L2 connectivity of EVPL
|
|
2075
|
+
Connection1:
|
|
2076
|
+
title: Connection1
|
|
2077
|
+
type: object
|
|
2078
|
+
properties:
|
|
2079
|
+
connectionPriority:
|
|
2080
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
2081
|
+
ipAddress:
|
|
2082
|
+
type: array
|
|
2083
|
+
items:
|
|
2084
|
+
$ref: '#/components/schemas/IP_Address'
|
|
2085
|
+
description: ''
|
|
2086
|
+
routing:
|
|
2087
|
+
$ref: '#/components/schemas/bgp_peering_oper_object'
|
|
2088
|
+
connectionState:
|
|
2089
|
+
anyOf:
|
|
2090
|
+
- $ref: '#/components/schemas/BgpState'
|
|
2091
|
+
- $ref: '#/components/schemas/BfdState'
|
|
2092
|
+
- $ref: '#/components/schemas/linkState'
|
|
2093
|
+
connectionDetails:
|
|
2094
|
+
allOf:
|
|
2095
|
+
- $ref: '#/components/schemas/connectivityDetails'
|
|
2096
|
+
- description: Holds the link and connection UUIDs
|
|
2097
|
+
ConnectionPriority:
|
|
2098
|
+
title: ConnectionPriority
|
|
2099
|
+
enum:
|
|
2100
|
+
- primary
|
|
2101
|
+
- secondary
|
|
2102
|
+
type: string
|
|
2103
|
+
description: For redundancy select whether this IP address is a primary or secondary type.
|
|
2104
|
+
ConnectionPriority1:
|
|
2105
|
+
title: ConnectionPriority1
|
|
2106
|
+
enum:
|
|
2107
|
+
- primary
|
|
2108
|
+
- secondary
|
|
2109
|
+
type: string
|
|
2110
|
+
ConnectionProviderState:
|
|
2111
|
+
title: ConnectionProviderState
|
|
2112
|
+
type: object
|
|
2113
|
+
properties:
|
|
2114
|
+
bgpStateV4:
|
|
2115
|
+
allOf:
|
|
2116
|
+
- $ref: '#/components/schemas/BgpStates'
|
|
2117
|
+
- description: BGP peering state
|
|
2118
|
+
bgpStateV6:
|
|
2119
|
+
allOf:
|
|
2120
|
+
- $ref: '#/components/schemas/BgpStates'
|
|
2121
|
+
- description: BGP peering state
|
|
2122
|
+
ConnectionState:
|
|
2123
|
+
title: ConnectionState
|
|
2124
|
+
type: object
|
|
2125
|
+
properties:
|
|
2126
|
+
bgpStateV4:
|
|
2127
|
+
allOf:
|
|
2128
|
+
- $ref: '#/components/schemas/BgpStates'
|
|
2129
|
+
- description: BGP peering state
|
|
2130
|
+
bgpStateV6:
|
|
2131
|
+
allOf:
|
|
2132
|
+
- $ref: '#/components/schemas/BgpStates'
|
|
2133
|
+
- description: BGP peering state
|
|
2134
|
+
Counter:
|
|
2135
|
+
title: Counter
|
|
2136
|
+
type: object
|
|
2137
|
+
properties:
|
|
2138
|
+
bytesIn:
|
|
2139
|
+
type: string
|
|
2140
|
+
description: BytesIn on the reported circuit
|
|
2141
|
+
bytesOut:
|
|
2142
|
+
type: string
|
|
2143
|
+
description: BytesOut on the reported circuit
|
|
2144
|
+
connectionPriority:
|
|
2145
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
2146
|
+
DnsnHostname:
|
|
2147
|
+
title: DnsnHostname
|
|
2148
|
+
type: object
|
|
2149
|
+
properties:
|
|
2150
|
+
dnsnHostname:
|
|
2151
|
+
type: string
|
|
2152
|
+
description: The hostname in which the IG atomic service circuit found of
|
|
2153
|
+
EquinixConnectCircuit:
|
|
2154
|
+
title: EquinixConnectCircuit
|
|
2155
|
+
type: object
|
|
2156
|
+
properties:
|
|
2157
|
+
location:
|
|
2158
|
+
type: string
|
|
2159
|
+
description: Location of the reported circuit
|
|
2160
|
+
circuitState:
|
|
2161
|
+
$ref: '#/components/schemas/CircuitState'
|
|
2162
|
+
connections:
|
|
2163
|
+
maxItems: 2
|
|
2164
|
+
type: array
|
|
2165
|
+
items:
|
|
2166
|
+
$ref: '#/components/schemas/Connection'
|
|
2167
|
+
description: ''
|
|
2168
|
+
error:
|
|
2169
|
+
$ref: '#/components/schemas/ErrorStructure2'
|
|
2170
|
+
EquinixState:
|
|
2171
|
+
title: EquinixState
|
|
2172
|
+
enum:
|
|
2173
|
+
- AVAILABLE
|
|
2174
|
+
- FAILED
|
|
2175
|
+
- PENDING_APPROVAL
|
|
2176
|
+
type: string
|
|
2177
|
+
Error:
|
|
2178
|
+
title: Error
|
|
2179
|
+
type: object
|
|
2180
|
+
properties:
|
|
2181
|
+
fieldPath:
|
|
2182
|
+
type: string
|
|
2183
|
+
example: params_ipAddress_ipv4IndependentAddress[0]_ipv4Address
|
|
2184
|
+
description:
|
|
2185
|
+
type: string
|
|
2186
|
+
example: configured bandwidth exceeds remaining bandwidth
|
|
2187
|
+
ErrorStructure:
|
|
2188
|
+
title: ErrorStructure
|
|
2189
|
+
type: object
|
|
2190
|
+
properties:
|
|
2191
|
+
generalError:
|
|
2192
|
+
type: string
|
|
2193
|
+
description: General error happened in service Node
|
|
2194
|
+
ErrorStructure1:
|
|
2195
|
+
title: ErrorStructure1
|
|
2196
|
+
type: object
|
|
2197
|
+
properties:
|
|
2198
|
+
serviceNodeErrors:
|
|
2199
|
+
type: array
|
|
2200
|
+
items:
|
|
2201
|
+
$ref: '#/components/schemas/ServiceNodeError'
|
|
2202
|
+
description: ''
|
|
2203
|
+
ExternalIP:
|
|
2204
|
+
title: ExternalIP
|
|
2205
|
+
type: object
|
|
2206
|
+
properties:
|
|
2207
|
+
providerIndependentExternalIP:
|
|
2208
|
+
type: string
|
|
2209
|
+
providerAggregatedExternalIP:
|
|
2210
|
+
type: boolean
|
|
2211
|
+
ExternalPool:
|
|
2212
|
+
title: ExternalPool
|
|
2213
|
+
type: object
|
|
2214
|
+
properties:
|
|
2215
|
+
providerIndependentExternalIpPool:
|
|
2216
|
+
type: array
|
|
2217
|
+
items:
|
|
2218
|
+
type: array
|
|
2219
|
+
items:
|
|
2220
|
+
$ref: '#/components/schemas/IpAddressesPool'
|
|
2221
|
+
providerAggregatedExternalIpPoolSize:
|
|
2222
|
+
maximum: 32
|
|
2223
|
+
minimum: 24
|
|
2224
|
+
type: integer
|
|
2225
|
+
description: Define pool size for the user addresses
|
|
2226
|
+
format: int32
|
|
2227
|
+
FabricSubType:
|
|
2228
|
+
title: FabricSubType
|
|
2229
|
+
enum:
|
|
2230
|
+
- zSideToken
|
|
2231
|
+
- serviceProfile
|
|
2232
|
+
type: string
|
|
2233
|
+
Function:
|
|
2234
|
+
title: Function
|
|
2235
|
+
required:
|
|
2236
|
+
- functionType
|
|
2237
|
+
- functionParams
|
|
2238
|
+
type: object
|
|
2239
|
+
properties:
|
|
2240
|
+
functionTransactionTag:
|
|
2241
|
+
type: string
|
|
2242
|
+
description: user provided function tag
|
|
2243
|
+
functionType:
|
|
2244
|
+
type: string
|
|
2245
|
+
description: Type of function
|
|
2246
|
+
example: NAT
|
|
2247
|
+
functionParams:
|
|
2248
|
+
$ref: '#/components/schemas/FunctionParams'
|
|
2249
|
+
Function1:
|
|
2250
|
+
title: Function1
|
|
2251
|
+
type: object
|
|
2252
|
+
properties:
|
|
2253
|
+
functionId:
|
|
2254
|
+
type: string
|
|
2255
|
+
description: Unique function ID issued by the Network Cloud+ to identify an function.
|
|
2256
|
+
functionTransactionTag:
|
|
2257
|
+
type: string
|
|
2258
|
+
description: user provided function tag.
|
|
2259
|
+
functionType:
|
|
2260
|
+
type: string
|
|
2261
|
+
description: Type of function.
|
|
2262
|
+
example: NAT
|
|
2263
|
+
functionParams:
|
|
2264
|
+
$ref: '#/components/schemas/FunctionParams'
|
|
2265
|
+
Function2:
|
|
2266
|
+
title: Function2
|
|
2267
|
+
type: object
|
|
2268
|
+
properties:
|
|
2269
|
+
functionId:
|
|
2270
|
+
type: string
|
|
2271
|
+
description: Unique function ID issued by the Network Cloud+ to identify an function.
|
|
2272
|
+
functionTransactionTag:
|
|
2273
|
+
type: string
|
|
2274
|
+
description: user provided function tag
|
|
2275
|
+
functionType:
|
|
2276
|
+
type: string
|
|
2277
|
+
description: Type of the function
|
|
2278
|
+
example: NAT
|
|
2279
|
+
functionParams:
|
|
2280
|
+
$ref: '#/components/schemas/FunctionParams'
|
|
2281
|
+
Function3:
|
|
2282
|
+
title: Function3
|
|
2283
|
+
type: object
|
|
2284
|
+
properties:
|
|
2285
|
+
functionId:
|
|
2286
|
+
type: string
|
|
2287
|
+
description: genarated function id
|
|
2288
|
+
functionTransactionTag:
|
|
2289
|
+
type: string
|
|
2290
|
+
description: user provided function tag
|
|
2291
|
+
functionType:
|
|
2292
|
+
type: string
|
|
2293
|
+
description: Type of function
|
|
2294
|
+
example: NAT
|
|
2295
|
+
functionParams:
|
|
2296
|
+
oneOf:
|
|
2297
|
+
- $ref: '#/components/schemas/NatOperParams'
|
|
2298
|
+
IgCircuit:
|
|
2299
|
+
title: IgCircuit
|
|
2300
|
+
type: object
|
|
2301
|
+
properties:
|
|
2302
|
+
location:
|
|
2303
|
+
type: string
|
|
2304
|
+
description: Location of the reported circuit
|
|
2305
|
+
ipAddress:
|
|
2306
|
+
type: array
|
|
2307
|
+
items:
|
|
2308
|
+
$ref: '#/components/schemas/IP_Address'
|
|
2309
|
+
description: ''
|
|
2310
|
+
dnsnHostnames:
|
|
2311
|
+
maxItems: 2
|
|
2312
|
+
type: array
|
|
2313
|
+
items:
|
|
2314
|
+
$ref: '#/components/schemas/DnsnHostname'
|
|
2315
|
+
description: ''
|
|
2316
|
+
error:
|
|
2317
|
+
$ref: '#/components/schemas/ErrorStructure2'
|
|
2318
|
+
InternetGatewayRedundancyMode:
|
|
2319
|
+
title: InternetGatewayRedundancyMode
|
|
2320
|
+
enum:
|
|
2321
|
+
- active-active
|
|
2322
|
+
- active-standby
|
|
2323
|
+
type: string
|
|
2324
|
+
IpAddress:
|
|
2325
|
+
title: IpAddress
|
|
2326
|
+
type: object
|
|
2327
|
+
properties:
|
|
2328
|
+
providerIndependentAddress:
|
|
2329
|
+
maxItems: 2
|
|
2330
|
+
type: array
|
|
2331
|
+
items:
|
|
2332
|
+
$ref: '#/components/schemas/Provider_Independent_Address'
|
|
2333
|
+
description: Public or private IP addresses provided by the customer. Two sets of addresses must be created for redundancy.
|
|
2334
|
+
providerAggregatedAddress:
|
|
2335
|
+
allOf:
|
|
2336
|
+
- $ref: '#/components/schemas/Provider_Aggregated_Address'
|
|
2337
|
+
- description: Private IP addresses provided from DriveNets' IP address pool. The subnet allocated is the same for all connections.
|
|
2338
|
+
IpAddress1:
|
|
2339
|
+
title: IpAddress1
|
|
2340
|
+
type: object
|
|
2341
|
+
properties:
|
|
2342
|
+
customerPrivateIpAddress:
|
|
2343
|
+
maxItems: 2
|
|
2344
|
+
type: array
|
|
2345
|
+
items:
|
|
2346
|
+
$ref: '#/components/schemas/Azure_Provider_Private_Address'
|
|
2347
|
+
description: Private address provided by the account
|
|
2348
|
+
providerAggregatedAddress:
|
|
2349
|
+
allOf:
|
|
2350
|
+
- $ref: '#/components/schemas/Provider_Aggregated_Address'
|
|
2351
|
+
- description: Private IP addresses provided from DriveNets' IP address pool. The subnet allocated is the same for all connections.
|
|
2352
|
+
description: The IP address to be used for Azure, bpth IPv4 (mask /30) and IPv6 (mask /126) addresses will be allocated from address pool, IPv4 address can be private.
|
|
2353
|
+
IpAddressesPool:
|
|
2354
|
+
title: IpAddressesPool
|
|
2355
|
+
type: object
|
|
2356
|
+
properties:
|
|
2357
|
+
externalIPStart:
|
|
2358
|
+
type: string
|
|
2359
|
+
externalIPStop:
|
|
2360
|
+
type: string
|
|
2361
|
+
Ipv4AggregatedAddress:
|
|
2362
|
+
title: Ipv4AggregatedAddress
|
|
2363
|
+
type: object
|
|
2364
|
+
properties:
|
|
2365
|
+
prefixSize:
|
|
2366
|
+
maximum: 30
|
|
2367
|
+
minimum: 24
|
|
2368
|
+
type: integer
|
|
2369
|
+
description: Define the prefix length for the user address.
|
|
2370
|
+
format: int32
|
|
2371
|
+
Ipv6AggregatedAddress:
|
|
2372
|
+
title: Ipv6AggregatedAddress
|
|
2373
|
+
type: object
|
|
2374
|
+
properties:
|
|
2375
|
+
prefixSize:
|
|
2376
|
+
maximum: 126
|
|
2377
|
+
minimum: 64
|
|
2378
|
+
type: integer
|
|
2379
|
+
description: Define the prefix length for the user address.
|
|
2380
|
+
format: int32
|
|
2381
|
+
Ipv4AggregatedAddress1:
|
|
2382
|
+
title: Ipv4AggregatedAddress1
|
|
2383
|
+
type: object
|
|
2384
|
+
properties:
|
|
2385
|
+
prefixSize:
|
|
2386
|
+
maximum: 30
|
|
2387
|
+
minimum: 24
|
|
2388
|
+
type: integer
|
|
2389
|
+
description: Define prefix length for the user address
|
|
2390
|
+
format: int32
|
|
2391
|
+
Ipv6AggregatedAddress1:
|
|
2392
|
+
title: Ipv6AggregatedAddress1
|
|
2393
|
+
type: object
|
|
2394
|
+
properties:
|
|
2395
|
+
prefixSize:
|
|
2396
|
+
maximum: 126
|
|
2397
|
+
minimum: 64
|
|
2398
|
+
type: integer
|
|
2399
|
+
description: Define prefix length for the user address
|
|
2400
|
+
format: int32
|
|
2401
|
+
IspCircuit:
|
|
2402
|
+
title: IspCircuit
|
|
2403
|
+
type: object
|
|
2404
|
+
properties:
|
|
2405
|
+
location:
|
|
2406
|
+
type: string
|
|
2407
|
+
description: Location of the reported circuit
|
|
2408
|
+
error:
|
|
2409
|
+
$ref: '#/components/schemas/ErrorStructure2'
|
|
2410
|
+
NaptDynamicRule2:
|
|
2411
|
+
title: NaptDynamicRule2
|
|
2412
|
+
type: object
|
|
2413
|
+
properties:
|
|
2414
|
+
naptDynamicRule:
|
|
2415
|
+
allOf:
|
|
2416
|
+
- $ref: '#/components/schemas/NaptDynamicRule'
|
|
2417
|
+
- description: PAT dynamic rule - subnet/s to single ip address
|
|
2418
|
+
NaptStaticRule2:
|
|
2419
|
+
title: NaptStaticRule2
|
|
2420
|
+
type: object
|
|
2421
|
+
properties:
|
|
2422
|
+
naptStaticRule:
|
|
2423
|
+
allOf:
|
|
2424
|
+
- $ref: '#/components/schemas/NaptStaticRule'
|
|
2425
|
+
- description: PAT static rule - ip and port to ip and port
|
|
2426
|
+
NatDynamicRule2:
|
|
2427
|
+
title: NatDynamicRule2
|
|
2428
|
+
type: object
|
|
2429
|
+
properties:
|
|
2430
|
+
natDynamicRule:
|
|
2431
|
+
allOf:
|
|
2432
|
+
- $ref: '#/components/schemas/NatDynamicRule'
|
|
2433
|
+
- description: NAT dynamic rule - subnet/s to ip addresses pool
|
|
2434
|
+
NatState:
|
|
2435
|
+
title: NatState
|
|
2436
|
+
enum:
|
|
2437
|
+
- up
|
|
2438
|
+
- down
|
|
2439
|
+
- degraded
|
|
2440
|
+
type: string
|
|
2441
|
+
NatStaticRule2:
|
|
2442
|
+
title: NatStaticRule2
|
|
2443
|
+
type: object
|
|
2444
|
+
properties:
|
|
2445
|
+
natStaticRule:
|
|
2446
|
+
allOf:
|
|
2447
|
+
- $ref: '#/components/schemas/NatStaticRule'
|
|
2448
|
+
- description: NAT static rule - ip to ip
|
|
2449
|
+
PeeringInfo:
|
|
2450
|
+
title: PeeringInfo
|
|
2451
|
+
type: object
|
|
2452
|
+
properties:
|
|
2453
|
+
bgpPeeringState:
|
|
2454
|
+
$ref: '#/components/schemas/BgpPeeringState'
|
|
2455
|
+
connectionPriority:
|
|
2456
|
+
$ref: '#/components/schemas/ConnectionPriority1'
|
|
2457
|
+
Policy:
|
|
2458
|
+
title: Policy
|
|
2459
|
+
type: object
|
|
2460
|
+
properties:
|
|
2461
|
+
policyTransactionTag:
|
|
2462
|
+
type: string
|
|
2463
|
+
description: user provided policy tag
|
|
2464
|
+
policyParams:
|
|
2465
|
+
$ref: '#/components/schemas/CreatePolicyBodyRequest'
|
|
2466
|
+
functions:
|
|
2467
|
+
type: array
|
|
2468
|
+
items:
|
|
2469
|
+
$ref: '#/components/schemas/Function'
|
|
2470
|
+
description: Entries for functions
|
|
2471
|
+
Policy1:
|
|
2472
|
+
title: Policy1
|
|
2473
|
+
type: object
|
|
2474
|
+
properties:
|
|
2475
|
+
policyId:
|
|
2476
|
+
type: string
|
|
2477
|
+
description: Unique policy ID issued by the Network Cloud+ to identify an policy.
|
|
2478
|
+
policyTransactionTag:
|
|
2479
|
+
type: string
|
|
2480
|
+
description: user provided policy tag
|
|
2481
|
+
policyParams:
|
|
2482
|
+
$ref: '#/components/schemas/PolicyBodyRequest'
|
|
2483
|
+
functions:
|
|
2484
|
+
type: array
|
|
2485
|
+
items:
|
|
2486
|
+
$ref: '#/components/schemas/Function1'
|
|
2487
|
+
description: Entries for functions
|
|
2488
|
+
Policy2:
|
|
2489
|
+
title: Policy2
|
|
2490
|
+
type: object
|
|
2491
|
+
properties:
|
|
2492
|
+
policyId:
|
|
2493
|
+
type: string
|
|
2494
|
+
description: Unique policy ID issued by the Network Cloud+ to identify an policy.
|
|
2495
|
+
policyTransactionTag:
|
|
2496
|
+
type: string
|
|
2497
|
+
description: user provided policy tag
|
|
2498
|
+
policyParams:
|
|
2499
|
+
$ref: '#/components/schemas/PolicyBodyRequest'
|
|
2500
|
+
functions:
|
|
2501
|
+
type: array
|
|
2502
|
+
items:
|
|
2503
|
+
$ref: '#/components/schemas/Function2'
|
|
2504
|
+
description: Entries for functions
|
|
2505
|
+
Policy3:
|
|
2506
|
+
title: Policy3
|
|
2507
|
+
type: object
|
|
2508
|
+
properties:
|
|
2509
|
+
policyId:
|
|
2510
|
+
type: string
|
|
2511
|
+
description: genarated policy id
|
|
2512
|
+
policyTransactionTag:
|
|
2513
|
+
type: string
|
|
2514
|
+
description: user provided policy tag
|
|
2515
|
+
policyParams:
|
|
2516
|
+
$ref: '#/components/schemas/PolicyBodyRequest'
|
|
2517
|
+
functions:
|
|
2518
|
+
type: array
|
|
2519
|
+
items:
|
|
2520
|
+
$ref: '#/components/schemas/Function3'
|
|
2521
|
+
description: Entries for functions
|
|
2522
|
+
Provider:
|
|
2523
|
+
title: Provider
|
|
2524
|
+
enum:
|
|
2525
|
+
- AT&T
|
|
2526
|
+
type: string
|
|
2527
|
+
description: The provider we're connected to
|
|
2528
|
+
Provider_Independent_Address:
|
|
2529
|
+
title: Provider_Independent_Address
|
|
2530
|
+
type: object
|
|
2531
|
+
properties:
|
|
2532
|
+
ipv4IndependentAddress:
|
|
2533
|
+
$ref: '#/components/schemas/IPv4_Address'
|
|
2534
|
+
ipv6IndependentAddress:
|
|
2535
|
+
$ref: '#/components/schemas/IPv6_Address'
|
|
2536
|
+
connectionPriority:
|
|
2537
|
+
allOf:
|
|
2538
|
+
- $ref: '#/components/schemas/ConnectionPriority'
|
|
2539
|
+
- description: For redundancy select whether this IP address is a primary or secondary type.
|
|
2540
|
+
RedundancyMode:
|
|
2541
|
+
title: RedundancyMode
|
|
2542
|
+
enum:
|
|
2543
|
+
- active
|
|
2544
|
+
- standby
|
|
2545
|
+
type: string
|
|
2546
|
+
Routing:
|
|
2547
|
+
title: Routing
|
|
2548
|
+
type: object
|
|
2549
|
+
properties:
|
|
2550
|
+
isBfdEnabled:
|
|
2551
|
+
type: boolean
|
|
2552
|
+
default: false
|
|
2553
|
+
bgpPeering:
|
|
2554
|
+
maxItems: 2
|
|
2555
|
+
type: array
|
|
2556
|
+
items:
|
|
2557
|
+
$ref: '#/components/schemas/BgpPeering2'
|
|
2558
|
+
description: ''
|
|
2559
|
+
bgpSecret:
|
|
2560
|
+
type: string
|
|
2561
|
+
RuleType:
|
|
2562
|
+
title: RuleType
|
|
2563
|
+
enum:
|
|
2564
|
+
- permit
|
|
2565
|
+
- deny
|
|
2566
|
+
type: string
|
|
2567
|
+
description: Define if prefix is permitted or denied
|
|
2568
|
+
ServiceName:
|
|
2569
|
+
title: ServiceName
|
|
2570
|
+
enum:
|
|
2571
|
+
- EQUINIX_CONNECT
|
|
2572
|
+
- INTERNET_GATEWAY
|
|
2573
|
+
- INTERNET_SERVICE_PROVIDER
|
|
2574
|
+
- AZURE_CONNECT
|
|
2575
|
+
type: string
|
|
2576
|
+
ServiceNodeError:
|
|
2577
|
+
title: ServiceNodeError
|
|
2578
|
+
type: object
|
|
2579
|
+
properties:
|
|
2580
|
+
serviceNodeId:
|
|
2581
|
+
type: string
|
|
2582
|
+
description: Type of the service node
|
|
2583
|
+
error:
|
|
2584
|
+
type: string
|
|
2585
|
+
description: Error happened in the service node
|
|
2586
|
+
ServicesPerLocationResponse:
|
|
2587
|
+
title: ServicesPerLocationResponse
|
|
2588
|
+
type: object
|
|
2589
|
+
properties:
|
|
2590
|
+
location:
|
|
2591
|
+
type: string
|
|
2592
|
+
example: LAXCA
|
|
2593
|
+
availableServices:
|
|
2594
|
+
type: array
|
|
2595
|
+
items:
|
|
2596
|
+
$ref: '#/components/schemas/AvailableService'
|
|
2597
|
+
description: ''
|
|
2598
|
+
version:
|
|
2599
|
+
title: version
|
|
2600
|
+
enum:
|
|
2601
|
+
- v1
|
|
2602
|
+
- v2
|
|
2603
|
+
- v3
|
|
2604
|
+
- v4
|
|
2605
|
+
type: string
|
|
2606
|
+
IP_Address:
|
|
2607
|
+
oneOf:
|
|
2608
|
+
- $ref: '#/components/schemas/IPv4_Address'
|
|
2609
|
+
- $ref: '#/components/schemas/IPv6_Address'
|
|
2610
|
+
AtomicServiceParams:
|
|
2611
|
+
oneOf:
|
|
2612
|
+
- $ref: '#/components/schemas/L3VpnParams'
|
|
2613
|
+
CircuitParams:
|
|
2614
|
+
oneOf:
|
|
2615
|
+
- $ref: '#/components/schemas/EquinixConnectParams'
|
|
2616
|
+
- $ref: '#/components/schemas/InternetGatewayParams'
|
|
2617
|
+
- $ref: '#/components/schemas/InternetServiceProviderParams'
|
|
2618
|
+
- $ref: '#/components/schemas/AzureConnectParams'
|
|
2619
|
+
CircuitResponseParams:
|
|
2620
|
+
oneOf:
|
|
2621
|
+
- $ref: '#/components/schemas/InternetGatewayParams'
|
|
2622
|
+
- $ref: '#/components/schemas/InternetServiceProviderParams'
|
|
2623
|
+
- $ref: '#/components/schemas/AzureConnectParams'
|
|
2624
|
+
- $ref: '#/components/schemas/EquinixConnectResponseParams'
|
|
2625
|
+
Routing1:
|
|
2626
|
+
oneOf:
|
|
2627
|
+
- $ref: '#/components/schemas/BgpRouting'
|
|
2628
|
+
- $ref: '#/components/schemas/staticRoute'
|
|
2629
|
+
OperRouting:
|
|
2630
|
+
oneOf:
|
|
2631
|
+
- $ref: '#/components/schemas/bgp_peering_oper_object'
|
|
2632
|
+
- $ref: '#/components/schemas/static_oper_object'
|
|
2633
|
+
static_route:
|
|
2634
|
+
oneOf:
|
|
2635
|
+
- $ref: '#/components/schemas/IPv4StaticRoute'
|
|
2636
|
+
- $ref: '#/components/schemas/IPv6StaticRoute'
|
|
2637
|
+
description: Configuration details for the Home Cloud Gateway service
|
|
2638
|
+
prefix_ip:
|
|
2639
|
+
oneOf:
|
|
2640
|
+
- $ref: '#/components/schemas/prefix_ipv4'
|
|
2641
|
+
- $ref: '#/components/schemas/prefix_ipv6'
|
|
2642
|
+
ErrorStructure2:
|
|
2643
|
+
oneOf:
|
|
2644
|
+
- $ref: '#/components/schemas/ErrorStructure'
|
|
2645
|
+
- $ref: '#/components/schemas/ErrorStructure1'
|
|
2646
|
+
securitySchemes:
|
|
2647
|
+
bearer:
|
|
2648
|
+
type: http
|
|
2649
|
+
scheme: bearer
|
|
2650
|
+
bearerFormat: jwt
|
|
2651
|
+
security: []
|
|
2652
|
+
tags:
|
|
2653
|
+
- name: Log in
|
|
2654
|
+
description: ''
|
|
2655
|
+
- name: Point of Presence (PoP) Services
|
|
2656
|
+
description: ''
|
|
2657
|
+
- name: Services
|
|
2658
|
+
description: ''
|
|
2659
|
+
- name: Service State
|
|
2660
|
+
description: ''
|
|
2661
|
+
- name: Show Command
|
|
2662
|
+
description: ''
|