-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathControllerProperties.json
1073 lines (1073 loc) · 66.7 KB
/
ControllerProperties.json
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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"version": "31.1.1",
"title": "Avi ControllerProperties Object API",
"contact": {
"name": "Avi Networks Inc.",
"url": "https://avinetworks.com/contact-us",
"email": "[email protected]"
},
"description": "CLI\n```\n- configure controller properties\n- show controller properties\n```\n"
},
"securityDefinitions": {
"basicAuth": {
"type": "basic",
"description": "basic authentication"
}
},
"basePath": "/api",
"paths": {
"/controllerproperties": {
"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/ControllerProperties"
}
},
"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": "ControllerProperties object creation",
"required": true,
"schema": {
"$ref": "#/definitions/ControllerProperties"
}
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ControllerProperties"
}
},
"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": "ControllerProperties object creation",
"required": true,
"schema": {
"$ref": "#/definitions/ControllerProperties"
}
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ControllerProperties"
}
},
"401": {
"description": "log in failed"
}
}
}
}
},
"definitions": {
"ConfigPbAttributes": {
"type": "object",
"properties": {
"version": {
"description": "Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1,
"format": "uint32"
}
}
},
"ControllerProperties": {
"type": "object",
"properties": {
"_last_modified": {
"description": "UNIX time since epoch in microseconds. Units(MICROSECONDS).",
"readOnly": true,
"type": "string"
},
"allow_admin_network_updates": {
"description": "Allow non-admin tenants to update admin VrfContext and Network objects. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"allow_ip_forwarding": {
"description": " Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"allow_unauthenticated_apis": {
"description": "Allow unauthenticated access for special APIs. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"allow_unauthenticated_nodes": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"api_idle_timeout": {
"description": " Allowed values are 0-1440. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 15,
"format": "uint32"
},
"api_perf_logging_threshold": {
"description": "Threshold to log request timing in portal_performance.log and Server-Timing response header. Any stage taking longer than 1% of the threshold will be included in the Server-Timing header. Field introduced in 18.1.4, 18.2.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 10000,
"format": "uint32"
},
"appviewx_compat_mode": {
"description": "Export configuration in appviewx compatibility mode. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.",
"type": "boolean"
},
"async_patch_merge_period": {
"description": "Period for which asynchronous patch requests are queued. Allowed values are 30-120. Special values are 0 - Deactivated. Field introduced in 18.2.11, 20.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"format": "uint32"
},
"async_patch_request_cleanup_duration": {
"description": "Duration for which asynchronous patch requests should be kept, after being marked as SUCCESS or FAIL. Allowed values are 5-120. Field introduced in 18.2.11, 20.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"attach_ip_retry_interval": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 360,
"format": "uint32"
},
"attach_ip_retry_limit": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 4,
"format": "uint32"
},
"bm_use_ansible": {
"description": "Use Ansible for SE creation in baremetal. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean",
"default": true
},
"check_vsvip_fqdn_syntax": {
"description": "Enforce VsVip FQDN syntax checks. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
"type": "boolean",
"default": true
},
"cleanup_expired_authtoken_timeout_period": {
"description": "Period for auth token cleanup job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"cleanup_sessions_timeout_period": {
"description": "Period for sessions cleanup job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"cloud_discovery_interval": {
"description": "Time in minutes to wait between consecutive cloud discovery cycles. Allowed values are 1-1440. Field introduced in 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 5,
"format": "uint32"
},
"cloud_reconcile": {
"description": "Enable/Disable periodic reconcile for all the clouds. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean",
"default": true
},
"cloud_reconcile_interval": {
"description": "Time in minutes to wait between consecutive cloud reconcile cycles. Allowed values are 1-1440. Field introduced in 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 5,
"format": "uint32"
},
"cluster_ip_gratuitous_arp_period": {
"description": "Period for cluster ip gratuitous arp job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"configpb_attributes": {
"description": "Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/ConfigPbAttributes"
},
"consistency_check_timeout_period": {
"description": "Period for consistency check job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"controller_resource_info_collection_period": {
"description": "Periodically collect stats. Field introduced in 20.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 525600,
"format": "uint32"
},
"crashed_se_reboot": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 900,
"format": "uint32"
},
"dead_se_detection_timer": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 360,
"format": "uint32"
},
"default_minimum_api_timeout": {
"description": "Minimum api timeout value.If this value is not 60, it will be the default timeout for all APIs that do not have a specific timeout.If an API has a specific timeout but is less than this value, this value will become the new timeout. Allowed values are 60-3600. Field introduced in 18.2.6. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"del_offline_se_after_reboot_delay": {
"description": "The amount of time the controller will wait before deleting an offline SE after it has been rebooted. For unresponsive SEs, the total time will be unresponsive_se_reboot + del_offline_se_after_reboot_delay. For crashed SEs, the total time will be crashed_se_reboot + del_offline_se_after_reboot_delay. Field introduced in 20.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"detach_ip_retry_interval": {
"description": "Amount of time to wait after last Detach IP failure before attempting next Detach IP retry. Field introduced in 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"detach_ip_retry_limit": {
"description": "Maximum number of Detach IP retries. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 4,
"format": "uint32"
},
"detach_ip_timeout": {
"description": "Time to wait before marking Detach IP as failed. Field introduced in 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"dns_refresh_period": {
"description": "Period for refresh pool and gslb DNS job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 60), Basic edition(Allowed values- 60), Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"dummy": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"format": "uint32"
},
"edit_system_limits": {
"description": "Allow editing of system limits. Keep in mind that these system limits have been carefully selected based on rigorous testing in our testig environments. Modifying these limits could destabilize your cluster. Do this at your own risk!. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"enable_api_sharding": {
"description": "This setting enables the controller leader to shard API requests to the followers (if any). Field introduced in 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean",
"default": true
},
"enable_memory_balancer": {
"description": "Enable/Disable Memory Balancer. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean",
"default": true
},
"enable_per_process_stop": {
"description": "Enable stopping of individual processes if process cross the given threshold limit, even when the total controller memory usage is belowits threshold limit. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"enable_resmgr_log_cache_print": {
"description": "Enable printing of cached logs inside Resource Manager. Used for debugging purposes only. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"event_manager_max_goroutines": {
"description": "Maximum number of goroutines for event manager process. Allowed values are 1-64. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 8,
"format": "uint32"
},
"event_manager_max_subscribers": {
"description": "Maximum number of subscribers for event manager process. Allowed values are 1-6. Special values are 0 - Disabled. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 5,
"format": "uint32"
},
"event_manager_processing_time_threshold": {
"description": "Log instances for event manager processing delay; recorded whenever event processing delay exceeds configured interval specified in seconds. Allowed values are 1-5. Special values are 0 - Disabled. Field introduced in 30.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 4,
"format": "uint32"
},
"false_positive_learning_config": {
"description": "False Positive learning configuration. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/FalsePositiveLearningConfig"
},
"fatal_error_lease_time": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 120,
"format": "uint32"
},
"federated_datastore_cleanup_duration": {
"description": "Federated datastore will not cleanup diffs unless they are at least this duration in the past. Field introduced in 20.1.1. Unit is HOURS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 120,
"format": "uint64"
},
"file_object_cleanup_period": {
"description": "Period for file object cleanup job. Field introduced in 20.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1440,
"format": "uint32"
},
"fileobject_max_file_versions": {
"description": "This is the max number of file versions that will be retained for a file referenced by the local FileObject. Subsequent uploads of file will result in the file rotation of the older version and the latest version retained. Example When a file Upload is done for the first time, there will be a v1 version. Subsequent uploads will get mapped to v1, v2 and v3 versions. On the fourth upload of the file, the v1 will be file rotated and v2, v3 and v4 will be retained. Allowed values are 1-5. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 3,
"format": "uint32"
},
"gslb_purge_batch_size": {
"description": "Batch size for the vs_mgr to perform datastrorecleanup during a GSLB purge. Allowed values are 50-1200. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1000,
"format": "uint32"
},
"gslb_purge_sleep_time_ms": {
"description": "Sleep time in the vs_mgr during a FederatedPurge RPC call. Allowed values are 50-100. Field introduced in 22.1.3. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 50,
"format": "uint32"
},
"ignore_vrf_in_networksubnetlist": {
"description": "Ignore the vrf_context filter for /networksubnetlist API. Field introduced in 22.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"max_dead_se_in_grp": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1,
"format": "uint32"
},
"max_pcap_per_tenant": {
"description": "Maximum number of pcap files stored per tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 4,
"format": "uint32"
},
"max_se_spawn_interval_delay": {
"description": "Maximum delay possible to add to se_spawn_retry_interval after successive SE spawn failure. Field introduced in 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1800,
"format": "uint32"
},
"max_seq_attach_ip_failures": {
"description": "Maximum number of consecutive attach IP failures that halts VS placement. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 3,
"format": "uint32"
},
"max_seq_vnic_failures": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 3,
"format": "uint32"
},
"max_threads_cc_vip_bg_worker": {
"description": "Maximum number of threads in threadpool used by cloud connector CCVIPBGWorker. Allowed values are 1-100. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 20,
"format": "uint32"
},
"permission_scoped_shared_admin_networks": {
"description": "Network and VrfContext objects from the admin tenant will not be shared to non-admin tenants unless admin permissions are granted. Field introduced in 18.2.7, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"persistence_key_rotate_period": {
"description": "Period for rotate app persistence keys job. Allowed values are 1-1051200. Special values are 0 - Disabled. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition.",
"type": "integer",
"format": "uint32"
},
"portal_request_burst_limit": {
"description": "Burst limit on number of incoming requests. 0 to disable. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"format": "uint32"
},
"portal_request_rate_limit": {
"description": "Maximum average number of requests allowed per second. 0 to disable. Field introduced in 20.1.1. Unit is PER_SECOND. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"format": "uint32"
},
"portal_token": {
"description": "Token used for uploading tech-support to portal. Field introduced in 16.4.6,17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"postgres_vacuum_period": {
"description": "Period for which postgres vacuum are executed. Allowed values are 30-40320. Special values are 0 - Deactivated. Field introduced in 22.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 20160,
"format": "uint32"
},
"process_locked_useraccounts_timeout_period": {
"description": "Period for process locked user accounts job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1,
"format": "uint32"
},
"process_pki_profile_timeout_period": {
"description": "Period for process PKI profile job. Field introduced in 18.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1440,
"format": "uint32"
},
"query_host_fail": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 180,
"format": "uint32"
},
"resmgr_log_caching_period": {
"description": "Period for each cycle of log caching in Resource Manager. At the end of each cycle, the in memory cached log history will be cleared. Field introduced in 20.1.5. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 21600,
"format": "uint32"
},
"restrict_cloud_read_access": {
"description": "Restrict read access to cloud. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"safenet_hsm_version": {
"description": "Version of the safenet package installed on the controller. Field introduced in 16.5.2,17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"se_create_timeout": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 900,
"format": "uint32"
},
"se_failover_attempt_interval": {
"description": "Interval between attempting failovers to an SE. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"se_from_marketplace": {
"description": "This setting decides whether SE is to be deployed from the cloud marketplace or to be created by the controller. The setting is applicable only when BYOL license is selected. Enum options - MARKETPLACE, IMAGE_SE. Field introduced in 18.1.4, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string",
"default": "IMAGE_SE"
},
"se_offline_del": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 172000,
"format": "uint32"
},
"se_spawn_retry_interval": {
"description": "Default retry period before attempting another Service Engine spawn in SE Group. Field introduced in 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"se_upgrade_flow_cleanup_timeout": {
"description": "Timeout for flows cleanup by ServiceEngine during Upgrade.Internal knob to be exercised under the surveillance of VMware AVI support team. Field introduced in 22.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 90,
"format": "uint32"
},
"se_vnic_cooldown": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 120,
"format": "uint32"
},
"se_vnic_gc_wait_time": {
"description": "Duration to wait after last vNIC addition before proceeding with vNIC garbage collection. Used for testing purposes. Field introduced in 20.1.4. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"secure_channel_cleanup_timeout": {
"description": "Period for secure channel cleanup job. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"secure_channel_controller_token_timeout": {
"description": " Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"secure_channel_se_token_timeout": {
"description": " Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"seupgrade_copy_buffer_size": {
"description": "This parameter defines the buffer size during SE image downloads in a SeGroup. It is used to pace the SE downloads so that controller network/CPU bandwidth is a bounded operation. Field introduced in 22.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 512,
"format": "uint32"
},
"seupgrade_copy_pool_size": {
"description": "This parameter defines the number of simultaneous SE image downloads in a SeGroup. It is used to pace the SE downloads so that controller network/CPU bandwidth is a bounded operation. A value of 0 will disable the pacing scheme and all the SE(s) in the SeGroup will attempt to download the image. . Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 5,
"format": "uint32"
},
"seupgrade_fabric_pool_size": {
"description": "The pool size is used to control the number of concurrent segroup upgrades. This field value takes affect upon controller warm reboot. Allowed values are 2-20. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 20,
"format": "uint32"
},
"seupgrade_segroup_min_dead_timeout": {
"description": "Time to wait before marking segroup upgrade as stuck. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 360,
"format": "uint32"
},
"shared_ssl_certificates": {
"description": "SSL Certificates in the admin tenant can be used in non-admin tenants. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "boolean"
},
"skopeo_retry_interval": {
"description": "Time interval (in seconds) between retires for skopeo commands. Field introduced in 30.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 5,
"format": "uint32"
},
"skopeo_retry_limit": {
"description": "Number of times to try skopeo commands for remote image registries. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 3,
"format": "uint32"
},
"soft_min_mem_per_se_limit": {
"description": "Soft Limit on the minimum SE Memory that an SE needs to have on SE Register. Field introduced in 30.1.1. Unit is MB. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1900,
"format": "uint32"
},
"ssl_certificate_expiry_warning_days": {
"description": "Number of days for SSL Certificate expiry warning. Unit is DAYS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "array",
"items": {
"type": "integer"
},
"format": "uint32"
},
"system_report_cleanup_interval": {
"description": "Time in minutes to wait between cleanup of SystemReports. Allowed values are 15-300. Field introduced in 22.1.6, 30.2.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"system_report_limit": {
"description": "Number of SystemReports retained in the system. Once the number of system reports exceed this threshold, the oldest SystemReport will be removed and the latest one retained. i.e. the SystemReport will be rotated and the reports don't exceed the threshold. Allowed values are 5-50. Field introduced in 22.1.6, 30.2.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 10,
"format": "uint32"
},
"unresponsive_se_reboot": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"update_dns_entry_retry_limit": {
"description": "Number of times to retry a DNS entry update/delete operation. Field introduced in 21.1.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 3,
"format": "uint32"
},
"update_dns_entry_timeout": {
"description": "Timeout period for a DNS entry update/delete operation. Field introduced in 21.1.4. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 120,
"format": "uint32"
},
"upgrade_dns_ttl": {
"description": "Time to account for DNS TTL during upgrade. This is in addition to vs_scalein_timeout_for_upgrade in se_group. Field introduced in 17.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5), Basic edition(Allowed values- 5), Enterprise with Cloud Services edition.",
"type": "integer",
"default": 5,
"format": "uint32"
},
"upgrade_fat_se_lease_time": {
"description": "Amount of time Controller waits for a large-sized SE (>=128GB memory) to reconnect after it is rebooted during upgrade. Field introduced in 18.2.10, 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1200,
"format": "uint32"
},
"upgrade_lease_time": {
"description": "Amount of time Controller waits for a regular-sized SE (<128GB memory) to reconnect after it is rebooted during upgrade. Starting 18.2.10/20.1.1, the default time has increased from 360 seconds to 600 seconds. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 600,
"format": "uint32"
},
"upgrade_se_per_vs_scale_ops_txn_time": {
"description": "This parameter defines the upper-bound value of the VS scale-in or VS scale-out operation executed in the SeScaleIn and SeScale context. User can tweak this parameter to a higher value if the Segroup gets suspended due to SeScalein or SeScaleOut timeout failure typically associated with high number of VS(es) scaled out. . Field introduced in 18.2.10, 20.1.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 3,
"format": "uint32"
},
"url": {
"description": "url",
"readOnly": true,
"type": "string"
},
"user_agent_cache_config": {
"description": "Configuration for User-Agent Cache used in Bot Management. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"$ref": "#/definitions/UserAgentCacheConfig"
},
"uuid": {
"description": " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "string"
},
"vnic_op_fail_time": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 180,
"format": "uint32"
},
"vs_awaiting_se_timeout": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"vs_key_rotate_period": {
"description": "Period for rotate VS keys job. Allowed values are 1-1051200. Special values are 0 - Disabled. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 360,
"format": "uint32"
},
"vs_scaleout_ready_check_interval": {
"description": "Interval for checking scaleout_ready status while controller is waiting for ScaleOutReady RPC from the Service Engine. Field introduced in 18.2.2. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "int32"
},
"vs_se_attach_ip_fail": {
"description": "Time to wait before marking attach IP operation on an SE as failed. Field introduced in 17.2.2. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 600,
"format": "uint32"
},
"vs_se_bootup_fail": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 480,
"format": "uint32"
},
"vs_se_bootup_fail_patch": {
"description": "Wait for longer for patch SEs to boot up. Field introduced in 30.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 600,
"format": "uint32"
},
"vs_se_create_fail": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1500,
"format": "uint32"
},
"vs_se_ping_fail": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 60,
"format": "uint32"
},
"vs_se_vnic_fail": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
},
"vs_se_vnic_ip_fail": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 120,
"format": "uint32"
},
"vsphere_ha_detection_timeout": {
"description": "vSphere HA monitor detection timeout. If vsphere_ha_enabled is true and the controller is not able to reach the SE, placement will wait for this duration for vsphere_ha_inprogress to be marked true before taking corrective action. Field introduced in 20.1.7, 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 120,
"format": "uint32"
},
"vsphere_ha_recovery_timeout": {
"description": "vSphere HA monitor recovery timeout. Once vsphere_ha_inprogress is set to true (meaning host failure detected and vSphere HA will recover the Service Engine), placement will wait for at least this duration for the SE to reconnect to the controller before taking corrective action. Field introduced in 20.1.7, 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 480,
"format": "uint32"
},
"vsphere_ha_timer_interval": {
"description": "vSphere HA monitor timer interval for sending cc_check_se_status to Cloud Connector. Field introduced in 20.1.7, 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 20,
"format": "uint32"
},
"warmstart_se_reconnect_wait_time": {
"description": " Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 480,
"format": "uint32"
},
"warmstart_vs_resync_wait_time": {
"description": "Timeout for warmstart VS resync. Field introduced in 18.1.4, 18.2.1. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300,
"format": "uint32"
}
}
},
"ControllerPropertiesApiResponse": {
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/ControllerProperties"
}
},
"next": {
"type": "string"
}
}
},
"FalsePositiveLearningConfig": {
"type": "object",
"properties": {
"max_apps_supported": {
"description": "Max number of applications supported to detect false positive. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 2,
"format": "uint64"
},
"min_monitor_time": {
"description": "Minimum monitor time required to automatically detect false positive. Unit is minutes. Field introduced in 22.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 10080,
"format": "uint64"
},
"min_trans_per_application": {
"description": "Minimum number of transactions in one application required to automatically detect false positive. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 1000000,
"format": "uint64"
},
"min_trans_per_uri": {
"description": "Minimum number of transactions in one URI required to automatically detect false positive. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 10000,
"format": "uint64"
}
}
},
"FileReferenceMapping": {
"type": "object",
"required": [
"file_path",
"reference"
],
"properties": {
"file_path": {
"description": "Absolute file path corresponding to the reference. Supported parameters in file_path are {image_path}, {current_version} and {prev_version}. For example, {image_path}/{prev_version}/se_nsxt.ova would resolve to /vol/pkgs/30.1.1-9000-20230714.075215/se_nsxt.ova. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
},
"reference": {
"description": "Short named reference for file path. For example, SE_IMG. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "string"
}
}
},
"UserAgentCacheConfig": {
"type": "object",
"properties": {
"batch_size": {
"description": "How many unknown User-Agents to batch up before querying Controller - unless max_wait_time is reached first. Allowed values are 1-500. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 100,
"format": "uint32"
},
"controller_cache_size": {
"description": "The number of User-Agent entries to cache on the Controller. Allowed values are 500-10000000. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.",
"type": "integer",
"default": 300000,
"format": "uint32"
},
"max_age": {