-
Notifications
You must be signed in to change notification settings - Fork 69
/
Copy pathCloudInventory.yaml
616 lines (611 loc) · 31.7 KB
/
CloudInventory.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache License 2.0
# GENERATED FILE - DO NOT EDIT THIS FILE
---
swagger: '2.0'
info:
version: '31.1.1'
title: Avi CloudInventory Object API
contact:
name: Avi Networks Inc.
url: https://avinetworks.com/contact-us
email: [email protected]
description: |
CLI
```
- show cloudinventory <key>
```
securityDefinitions:
basicAuth:
type: basic
description: basic authentication
basePath: /api
paths:
/cloud-inventory:
get:
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: query
description: object name
required: false
type: string
- name: refers_to
in: query
description: Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
type: string
- name: referred_by
in: query
description: Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
type: string
- name: fields
in: query
description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
type: string
- name: include_name
in: query
description: All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
required: false
type: boolean
- name: skip_default
in: query
description: Default values are not set.
required: false
type: boolean
- name: join_subresources
in: query
description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
type: string
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/CloudInventoryApiResponse"
401:
description: log in failed
post:
consumes:
- application/json
produces:
- application/json
parameters:
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: CloudInventory object creation
required: true
schema:
$ref: "#/definitions/CloudInventory"
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/CloudInventory"
401:
description: log in failed
/cloud-inventory/{uuid}:
get:
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: query
description: object name
required: false
type: string
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- name: uuid
in: path
description: UUID of the object to fetch
required: true
type: string
- name: fields
in: query
description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
type: string
- name: include_name
in: query
description: All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
required: false
type: boolean
- name: skip_default
in: query
description: Default values are not set.
required: false
type: boolean
- name: join_subresources
in: query
description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/CloudInventory"
401:
description: log in failed
put:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: CloudInventory object creation
required: true
schema:
$ref: "#/definitions/CloudInventory"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/CloudInventory"
401:
description: log in failed
patch:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: CloudInventory object creation
required: true
schema:
$ref: "#/definitions/CloudInventory"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/CloudInventory"
401:
description: log in failed
delete:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
204:
description: object deleted
schema:
type: string
404:
description: not found
definitions:
CloudConfig:
type: object
required:
- name
- vtype
properties:
autoscale_polling_interval:
description: "CloudConnector polling interval in seconds for external autoscale groups, minimum 60 seconds. Allowed values are 60-3600. Field introduced in 22.1.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: integer
default: 60
format: uint32
dhcp_enabled:
description: "Select the IP address management scheme. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
dns_resolution_on_se:
description: " Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
enable_vip_on_all_interfaces:
description: "Enable VIP on all data interfaces for the Cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
enable_vip_static_routes:
description: "Use static routes for VIP side network resolution during VirtualService placement. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
ip6_autocfg_enabled:
description: "Enable IPv6 auto configuration. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
license_tier:
description: "Specifies the default license tier which would be used by new SE Groups. This field by default inherits the value from system configuration. Enum options - ENTERPRISE_16, ENTERPRISE, ENTERPRISE_18, BASIC, ESSENTIALS, ENTERPRISE_WITH_CLOUD_SERVICES. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
license_type:
description: "If no license type is specified then default license enforcement for the cloud type is chosen. The default mappings are Container Cloud is Max Ses, OpenStack and VMware is cores and linux it is Sockets. Enum options - LIC_BACKEND_SERVERS, LIC_SOCKETS, LIC_CORES, LIC_HOSTS, LIC_SE_BANDWIDTH, LIC_METERED_SE_BANDWIDTH. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
maintenance_mode:
description: "Cloud is in maintenance mode. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
mtu:
description: "MTU setting for the cloud. Field introduced in 22.1.1. Unit is BYTES. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: integer
default: 1500
format: uint32
name:
description: "Name of the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
prefer_static_routes:
description: "Prefer static routes over interface routes during VirtualService placement. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
state_based_dns_registration:
description: "DNS records for VIPs are added/deleted based on the operational state of the VIPs. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
default: True
tenant_ref:
description: " It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
url:
description: "URL of the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
uuid:
description: "UUID of the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
vcenter_configuration:
description: "VCenter configuration of the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/vCenterConfiguration'
vmc_deployment:
description: "This deployment is VMware on AWS cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
vtype:
description: "Cloud type. Enum options - CLOUD_NONE, CLOUD_VCENTER, CLOUD_OPENSTACK, CLOUD_AWS, CLOUD_VCA, CLOUD_APIC, CLOUD_MESOS, CLOUD_LINUXSERVER, CLOUD_DOCKER_UCP, CLOUD_RANCHER, CLOUD_OSHIFT_K8S, CLOUD_AZURE, CLOUD_GCP, CLOUD_NSXT. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "CLOUD_NONE"
CloudConfigApiResponse:
type: object
required:
- count
- results
properties:
count:
type: integer
format: int32
results:
type: array
items:
$ref: "#/definitions/CloudConfig"
next:
type: string
CloudInventory:
type: object
properties:
_last_modified:
description: "UNIX time since epoch in microseconds. Units(MICROSECONDS)."
readOnly: True
type: string
config:
description: "Configuration summary of the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/CloudConfig'
mvrf:
description: " Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/CloudMvrf'
status:
description: "Cloud status. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/CloudStatus'
url:
description: "url"
readOnly: True
type: string
uuid:
description: "UUID of the cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
CloudInventoryApiResponse:
type: object
required:
- count
- results
properties:
count:
type: integer
format: int32
results:
type: array
items:
$ref: "#/definitions/CloudInventory"
next:
type: string
CloudMvrf:
type: object
properties:
cloud_ref:
description: " It is a reference to an object of type Cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
lldp_enable:
description: " Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
default: True
name:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
system_default:
description: " Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
tenant_ref:
description: " It is a reference to an object of type Tenant. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
url:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
uuid:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
CloudMvrfApiResponse:
type: object
required:
- count
- results
properties:
count:
type: integer
format: int32
results:
type: array
items:
$ref: "#/definitions/CloudMvrf"
next:
type: string
CloudStatus:
type: object
properties:
cc_id:
description: "Cloud Id. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
reason:
description: "Reason message for the current state. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
se_image_state:
description: "ServiceEngine image state. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/SEImageStatus'
state:
description: "Cloud State. Enum options - CLOUD_STATE_UNKNOWN, CLOUD_STATE_IN_PROGRESS, CLOUD_STATE_FAILED, CLOUD_STATE_PLACEMENT_READY, CLOUD_STATE_DELETING, CLOUD_STATE_NOT_CONNECTED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
ContentLibConfig:
type: object
properties:
id:
description: "Content Library Id. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
name:
description: "Content Library name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
IpAddr:
type: object
required:
- addr
- type
properties:
addr:
description: "IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
type:
description: " Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
IpAddrPrefix:
type: object
required:
- ip_addr
- mask
properties:
ip_addr:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
mask:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: int32
SEImageStatus:
type: object
properties:
reason:
description: "Reason message for the current state. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
state:
description: "SE image state for the version. Enum options - IMG_STATE_UNKNOWN, IMG_GEN_IN_PROGRESS, IMG_GEN_FAILED, IMG_GEN_COMPLETE. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
version:
description: "version or Tag. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
vCenterConfiguration:
type: object
required:
- privilege
properties:
content_lib:
description: "vCenter content library where Service Engine images are stored. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/ContentLibConfig'
datacenter:
description: "Datacenter for virtual infrastructure discovery. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
datacenter_managed_object_id:
description: "Managed object id of the datacenter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
is_nsx_environment:
description: "If true, NSX-T segment spanning multiple VDS with vCenter cloud are merged to a single network in Avi. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
management_ip_subnet:
description: "Management subnet to use for Avi Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddrPrefix'
management_network:
description: "Management network to use for Avi Service Engines. It is a reference to an object of type VIMgrNWRuntime. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
password:
description: "The password Avi Vantage will use when authenticating with vCenter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
privilege:
description: "Set the access mode to vCenter as either Read, which allows Avi to discover networks and servers, or Write, which also allows Avi to create Service Engines and configure their network properties. Enum options - NO_ACCESS, READ_ACCESS, WRITE_ACCESS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
default: "WRITE_ACCESS"
use_content_lib:
description: "If false, Service Engine image will not be pushed to content library. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Enterprise with Cloud Services edition."
type: boolean
default: True
username:
description: "The username Avi Vantage will use when authenticating with vCenter. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
vcenter_template_se_location:
description: "Avi Service Engine Template in vCenter to be used for creating Service Engines. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
vcenter_url:
description: "vCenter hostname or IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string