@robinmordasiewicz/f5xc-api-mcp 2.0.10-2601051503 → 2.0.19-2601071557
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/CHANGELOG.md +25 -14
- package/README.md +9 -5
- package/dist/generator/domain-metadata.d.ts +1 -3
- package/dist/generator/domain-metadata.d.ts.map +1 -1
- package/dist/generator/domain-metadata.js +0 -20
- package/dist/generator/domain-metadata.js.map +1 -1
- package/dist/generator/naming/acronyms.d.ts +1 -1
- package/dist/generator/naming/acronyms.js +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +176 -26
- package/specs/domains/ai_services.json +242 -36
- package/specs/domains/api.json +1507 -183
- package/specs/domains/authentication.json +358 -46
- package/specs/domains/bigip.json +825 -105
- package/specs/domains/billing_and_usage.json +666 -83
- package/specs/domains/blindfold.json +988 -111
- package/specs/domains/bot_and_threat_defense.json +550 -66
- package/specs/domains/cdn.json +2431 -198
- package/specs/domains/ce_management.json +9272 -15726
- package/specs/domains/certificates.json +540 -78
- package/specs/domains/cloud_infrastructure.json +1102 -122
- package/specs/domains/container_services.json +782 -99
- package/specs/domains/data_and_privacy_security.json +508 -68
- package/specs/domains/data_intelligence.json +487 -64
- package/specs/domains/ddos.json +1302 -161
- package/specs/domains/dns.json +1286 -162
- package/specs/domains/managed_kubernetes.json +687 -89
- package/specs/domains/marketplace.json +994 -105
- package/specs/domains/network.json +2340 -239
- package/specs/domains/network_security.json +1963 -192
- package/specs/domains/nginx_one.json +475 -63
- package/specs/domains/object_storage.json +163 -16
- package/specs/domains/observability.json +1519 -148
- package/specs/domains/rate_limiting.json +456 -56
- package/specs/domains/secops_and_incident_response.json +275 -37
- package/specs/domains/service_mesh.json +1320 -128
- package/specs/domains/shape.json +4196 -398
- package/specs/domains/sites.json +5053 -405
- package/specs/domains/statistics.json +2784 -236
- package/specs/domains/support.json +1038 -109
- package/specs/domains/telemetry_and_insights.json +993 -80
- package/specs/domains/tenant_and_identity.json +3487 -313
- package/specs/domains/threat_campaign.json +695 -72
- package/specs/domains/users.json +437 -72
- package/specs/domains/virtual.json +3716 -261
- package/specs/domains/vpm_and_node_management.json +61 -2
- package/specs/domains/waf.json +1551 -149
- package/specs/index.json +121 -26
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Support",
|
|
5
5
|
"description": "Case management workflows including submission, commentary, and closure paths. Urgency adjustments and routing for time-sensitive incidents. Tax exemption verification requests. Site-level tcpdump operations—initiation, enumeration, and termination—for low-level network troubleshooting and protocol analysis.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -13,7 +13,57 @@
|
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
15
|
"summary": "Issue lifecycle with comments, severity changes, and resolution tracking. Packet capture for connection analysis.",
|
|
16
|
-
"x-f5xc-cli-domain": "support"
|
|
16
|
+
"x-f5xc-cli-domain": "support",
|
|
17
|
+
"x-f5xc-best-practices": {
|
|
18
|
+
"common_errors": [
|
|
19
|
+
{
|
|
20
|
+
"code": 400,
|
|
21
|
+
"message": "Invalid request body",
|
|
22
|
+
"resolution": "Validate JSON structure and required fields before submission",
|
|
23
|
+
"prevention": "Use schema validation from OpenAPI spec"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"code": 401,
|
|
27
|
+
"message": "Authentication failed",
|
|
28
|
+
"resolution": "Verify API token is valid and not expired",
|
|
29
|
+
"prevention": "Use environment variables for token management"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"code": 403,
|
|
33
|
+
"message": "Permission denied",
|
|
34
|
+
"resolution": "Check user role and namespace permissions",
|
|
35
|
+
"prevention": "Verify RBAC policies before operations"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"code": 404,
|
|
39
|
+
"message": "Resource not found",
|
|
40
|
+
"resolution": "Verify resource name and namespace exist",
|
|
41
|
+
"prevention": "List resources before attempting operations"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"code": 409,
|
|
45
|
+
"message": "Resource already exists",
|
|
46
|
+
"resolution": "Use unique name or delete existing resource",
|
|
47
|
+
"prevention": "Check existence before creation"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"code": 429,
|
|
51
|
+
"message": "Rate limit exceeded",
|
|
52
|
+
"resolution": "Implement exponential backoff and retry logic",
|
|
53
|
+
"prevention": "Batch operations and add delays between requests"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"security_notes": [
|
|
57
|
+
"Always use HTTPS for all API communications",
|
|
58
|
+
"Store API tokens securely, never in source code",
|
|
59
|
+
"Rotate API tokens regularly following security policies"
|
|
60
|
+
],
|
|
61
|
+
"performance_tips": [
|
|
62
|
+
"Use pagination for large result sets",
|
|
63
|
+
"Batch related operations when possible",
|
|
64
|
+
"Cache read-only responses appropriately"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
17
67
|
},
|
|
18
68
|
"servers": [
|
|
19
69
|
{
|
|
@@ -293,6 +343,13 @@
|
|
|
293
343
|
"latency": "low",
|
|
294
344
|
"resource_usage": "low"
|
|
295
345
|
}
|
|
346
|
+
},
|
|
347
|
+
"x-f5xc-discovered-response-time": {
|
|
348
|
+
"p50_ms": 1000,
|
|
349
|
+
"p95_ms": 3000,
|
|
350
|
+
"p99_ms": 8000,
|
|
351
|
+
"sample_count": 0,
|
|
352
|
+
"source": "estimate"
|
|
296
353
|
}
|
|
297
354
|
},
|
|
298
355
|
"x-displayname": "CRL Resync.",
|
|
@@ -492,6 +549,13 @@
|
|
|
492
549
|
"latency": "low",
|
|
493
550
|
"resource_usage": "low"
|
|
494
551
|
}
|
|
552
|
+
},
|
|
553
|
+
"x-f5xc-discovered-response-time": {
|
|
554
|
+
"p50_ms": 1000,
|
|
555
|
+
"p95_ms": 3000,
|
|
556
|
+
"p99_ms": 8000,
|
|
557
|
+
"sample_count": 0,
|
|
558
|
+
"source": "estimate"
|
|
495
559
|
}
|
|
496
560
|
},
|
|
497
561
|
"x-displayname": "Customer Support.",
|
|
@@ -691,6 +755,13 @@
|
|
|
691
755
|
"latency": "low",
|
|
692
756
|
"resource_usage": "low"
|
|
693
757
|
}
|
|
758
|
+
},
|
|
759
|
+
"x-f5xc-discovered-response-time": {
|
|
760
|
+
"p50_ms": 1000,
|
|
761
|
+
"p95_ms": 3000,
|
|
762
|
+
"p99_ms": 8000,
|
|
763
|
+
"sample_count": 0,
|
|
764
|
+
"source": "estimate"
|
|
694
765
|
}
|
|
695
766
|
},
|
|
696
767
|
"x-displayname": "Customer Support.",
|
|
@@ -905,6 +976,13 @@
|
|
|
905
976
|
"latency": "low",
|
|
906
977
|
"resource_usage": "low"
|
|
907
978
|
}
|
|
979
|
+
},
|
|
980
|
+
"x-f5xc-discovered-response-time": {
|
|
981
|
+
"p50_ms": 1000,
|
|
982
|
+
"p95_ms": 3000,
|
|
983
|
+
"p99_ms": 8000,
|
|
984
|
+
"sample_count": 0,
|
|
985
|
+
"source": "estimate"
|
|
908
986
|
}
|
|
909
987
|
},
|
|
910
988
|
"x-displayname": "Customer Support.",
|
|
@@ -1132,6 +1210,13 @@
|
|
|
1132
1210
|
"latency": "moderate",
|
|
1133
1211
|
"resource_usage": "moderate"
|
|
1134
1212
|
}
|
|
1213
|
+
},
|
|
1214
|
+
"x-f5xc-discovered-response-time": {
|
|
1215
|
+
"p50_ms": 200,
|
|
1216
|
+
"p95_ms": 800,
|
|
1217
|
+
"p99_ms": 2000,
|
|
1218
|
+
"sample_count": 0,
|
|
1219
|
+
"source": "estimate"
|
|
1135
1220
|
}
|
|
1136
1221
|
},
|
|
1137
1222
|
"x-displayname": "Customer Support.",
|
|
@@ -1359,6 +1444,13 @@
|
|
|
1359
1444
|
"latency": "low",
|
|
1360
1445
|
"resource_usage": "low"
|
|
1361
1446
|
}
|
|
1447
|
+
},
|
|
1448
|
+
"x-f5xc-discovered-response-time": {
|
|
1449
|
+
"p50_ms": 1000,
|
|
1450
|
+
"p95_ms": 3000,
|
|
1451
|
+
"p99_ms": 8000,
|
|
1452
|
+
"sample_count": 0,
|
|
1453
|
+
"source": "estimate"
|
|
1362
1454
|
}
|
|
1363
1455
|
},
|
|
1364
1456
|
"x-displayname": "Customer Support.",
|
|
@@ -1586,6 +1678,13 @@
|
|
|
1586
1678
|
"latency": "low",
|
|
1587
1679
|
"resource_usage": "low"
|
|
1588
1680
|
}
|
|
1681
|
+
},
|
|
1682
|
+
"x-f5xc-discovered-response-time": {
|
|
1683
|
+
"p50_ms": 1000,
|
|
1684
|
+
"p95_ms": 3000,
|
|
1685
|
+
"p99_ms": 8000,
|
|
1686
|
+
"sample_count": 0,
|
|
1687
|
+
"source": "estimate"
|
|
1589
1688
|
}
|
|
1590
1689
|
},
|
|
1591
1690
|
"x-displayname": "Customer Support.",
|
|
@@ -1813,6 +1912,13 @@
|
|
|
1813
1912
|
"latency": "low",
|
|
1814
1913
|
"resource_usage": "low"
|
|
1815
1914
|
}
|
|
1915
|
+
},
|
|
1916
|
+
"x-f5xc-discovered-response-time": {
|
|
1917
|
+
"p50_ms": 1000,
|
|
1918
|
+
"p95_ms": 3000,
|
|
1919
|
+
"p99_ms": 8000,
|
|
1920
|
+
"sample_count": 0,
|
|
1921
|
+
"source": "estimate"
|
|
1816
1922
|
}
|
|
1817
1923
|
},
|
|
1818
1924
|
"x-displayname": "Customer Support.",
|
|
@@ -2040,6 +2146,13 @@
|
|
|
2040
2146
|
"latency": "low",
|
|
2041
2147
|
"resource_usage": "low"
|
|
2042
2148
|
}
|
|
2149
|
+
},
|
|
2150
|
+
"x-f5xc-discovered-response-time": {
|
|
2151
|
+
"p50_ms": 1000,
|
|
2152
|
+
"p95_ms": 3000,
|
|
2153
|
+
"p99_ms": 8000,
|
|
2154
|
+
"sample_count": 0,
|
|
2155
|
+
"source": "estimate"
|
|
2043
2156
|
}
|
|
2044
2157
|
},
|
|
2045
2158
|
"x-displayname": "Customer Support.",
|
|
@@ -2267,6 +2380,13 @@
|
|
|
2267
2380
|
"latency": "low",
|
|
2268
2381
|
"resource_usage": "low"
|
|
2269
2382
|
}
|
|
2383
|
+
},
|
|
2384
|
+
"x-f5xc-discovered-response-time": {
|
|
2385
|
+
"p50_ms": 1000,
|
|
2386
|
+
"p95_ms": 3000,
|
|
2387
|
+
"p99_ms": 8000,
|
|
2388
|
+
"sample_count": 0,
|
|
2389
|
+
"source": "estimate"
|
|
2270
2390
|
}
|
|
2271
2391
|
},
|
|
2272
2392
|
"x-displayname": "Customer Support.",
|
|
@@ -2494,6 +2614,13 @@
|
|
|
2494
2614
|
"latency": "moderate",
|
|
2495
2615
|
"resource_usage": "moderate"
|
|
2496
2616
|
}
|
|
2617
|
+
},
|
|
2618
|
+
"x-f5xc-discovered-response-time": {
|
|
2619
|
+
"p50_ms": 200,
|
|
2620
|
+
"p95_ms": 800,
|
|
2621
|
+
"p99_ms": 2000,
|
|
2622
|
+
"sample_count": 0,
|
|
2623
|
+
"source": "estimate"
|
|
2497
2624
|
}
|
|
2498
2625
|
},
|
|
2499
2626
|
"x-displayname": "Customer Support.",
|
|
@@ -2714,6 +2841,13 @@
|
|
|
2714
2841
|
"latency": "low",
|
|
2715
2842
|
"resource_usage": "low"
|
|
2716
2843
|
}
|
|
2844
|
+
},
|
|
2845
|
+
"x-f5xc-discovered-response-time": {
|
|
2846
|
+
"p50_ms": 200,
|
|
2847
|
+
"p95_ms": 800,
|
|
2848
|
+
"p99_ms": 2000,
|
|
2849
|
+
"sample_count": 0,
|
|
2850
|
+
"source": "estimate"
|
|
2717
2851
|
}
|
|
2718
2852
|
},
|
|
2719
2853
|
"x-displayname": "Customer Support.",
|
|
@@ -2902,6 +3036,13 @@
|
|
|
2902
3036
|
"latency": "moderate",
|
|
2903
3037
|
"resource_usage": "moderate"
|
|
2904
3038
|
}
|
|
3039
|
+
},
|
|
3040
|
+
"x-f5xc-discovered-response-time": {
|
|
3041
|
+
"p50_ms": 200,
|
|
3042
|
+
"p95_ms": 800,
|
|
3043
|
+
"p99_ms": 2000,
|
|
3044
|
+
"sample_count": 0,
|
|
3045
|
+
"source": "estimate"
|
|
2905
3046
|
}
|
|
2906
3047
|
},
|
|
2907
3048
|
"x-displayname": "Debug",
|
|
@@ -3101,6 +3242,13 @@
|
|
|
3101
3242
|
"latency": "moderate",
|
|
3102
3243
|
"resource_usage": "moderate"
|
|
3103
3244
|
}
|
|
3245
|
+
},
|
|
3246
|
+
"x-f5xc-discovered-response-time": {
|
|
3247
|
+
"p50_ms": 200,
|
|
3248
|
+
"p95_ms": 800,
|
|
3249
|
+
"p99_ms": 2000,
|
|
3250
|
+
"sample_count": 0,
|
|
3251
|
+
"source": "estimate"
|
|
3104
3252
|
}
|
|
3105
3253
|
},
|
|
3106
3254
|
"x-displayname": "Debug",
|
|
@@ -3289,6 +3437,13 @@
|
|
|
3289
3437
|
"latency": "moderate",
|
|
3290
3438
|
"resource_usage": "moderate"
|
|
3291
3439
|
}
|
|
3440
|
+
},
|
|
3441
|
+
"x-f5xc-discovered-response-time": {
|
|
3442
|
+
"p50_ms": 200,
|
|
3443
|
+
"p95_ms": 800,
|
|
3444
|
+
"p99_ms": 2000,
|
|
3445
|
+
"sample_count": 0,
|
|
3446
|
+
"source": "estimate"
|
|
3292
3447
|
}
|
|
3293
3448
|
},
|
|
3294
3449
|
"x-displayname": "Debug",
|
|
@@ -3488,6 +3643,13 @@
|
|
|
3488
3643
|
"latency": "moderate",
|
|
3489
3644
|
"resource_usage": "moderate"
|
|
3490
3645
|
}
|
|
3646
|
+
},
|
|
3647
|
+
"x-f5xc-discovered-response-time": {
|
|
3648
|
+
"p50_ms": 200,
|
|
3649
|
+
"p95_ms": 800,
|
|
3650
|
+
"p99_ms": 2000,
|
|
3651
|
+
"sample_count": 0,
|
|
3652
|
+
"source": "estimate"
|
|
3491
3653
|
}
|
|
3492
3654
|
},
|
|
3493
3655
|
"x-displayname": "Debug",
|
|
@@ -3713,6 +3875,13 @@
|
|
|
3713
3875
|
"latency": "low",
|
|
3714
3876
|
"resource_usage": "low"
|
|
3715
3877
|
}
|
|
3878
|
+
},
|
|
3879
|
+
"x-f5xc-discovered-response-time": {
|
|
3880
|
+
"p50_ms": 1000,
|
|
3881
|
+
"p95_ms": 3000,
|
|
3882
|
+
"p99_ms": 8000,
|
|
3883
|
+
"sample_count": 0,
|
|
3884
|
+
"source": "estimate"
|
|
3716
3885
|
}
|
|
3717
3886
|
},
|
|
3718
3887
|
"x-displayname": "Debug",
|
|
@@ -3912,6 +4081,13 @@
|
|
|
3912
4081
|
"latency": "moderate",
|
|
3913
4082
|
"resource_usage": "moderate"
|
|
3914
4083
|
}
|
|
4084
|
+
},
|
|
4085
|
+
"x-f5xc-discovered-response-time": {
|
|
4086
|
+
"p50_ms": 200,
|
|
4087
|
+
"p95_ms": 800,
|
|
4088
|
+
"p99_ms": 2000,
|
|
4089
|
+
"sample_count": 0,
|
|
4090
|
+
"source": "estimate"
|
|
3915
4091
|
}
|
|
3916
4092
|
},
|
|
3917
4093
|
"x-displayname": "Debug",
|
|
@@ -4113,6 +4289,13 @@
|
|
|
4113
4289
|
"latency": "moderate",
|
|
4114
4290
|
"resource_usage": "moderate"
|
|
4115
4291
|
}
|
|
4292
|
+
},
|
|
4293
|
+
"x-f5xc-discovered-response-time": {
|
|
4294
|
+
"p50_ms": 200,
|
|
4295
|
+
"p95_ms": 800,
|
|
4296
|
+
"p99_ms": 2000,
|
|
4297
|
+
"sample_count": 0,
|
|
4298
|
+
"source": "estimate"
|
|
4116
4299
|
}
|
|
4117
4300
|
},
|
|
4118
4301
|
"x-displayname": "Debug",
|
|
@@ -4338,6 +4521,13 @@
|
|
|
4338
4521
|
"latency": "moderate",
|
|
4339
4522
|
"resource_usage": "moderate"
|
|
4340
4523
|
}
|
|
4524
|
+
},
|
|
4525
|
+
"x-f5xc-discovered-response-time": {
|
|
4526
|
+
"p50_ms": 200,
|
|
4527
|
+
"p95_ms": 800,
|
|
4528
|
+
"p99_ms": 2000,
|
|
4529
|
+
"sample_count": 0,
|
|
4530
|
+
"source": "estimate"
|
|
4341
4531
|
}
|
|
4342
4532
|
},
|
|
4343
4533
|
"x-displayname": "Debug",
|
|
@@ -4571,6 +4761,13 @@
|
|
|
4571
4761
|
"latency": "low",
|
|
4572
4762
|
"resource_usage": "low"
|
|
4573
4763
|
}
|
|
4764
|
+
},
|
|
4765
|
+
"x-f5xc-discovered-response-time": {
|
|
4766
|
+
"p50_ms": 1000,
|
|
4767
|
+
"p95_ms": 3000,
|
|
4768
|
+
"p99_ms": 8000,
|
|
4769
|
+
"sample_count": 0,
|
|
4770
|
+
"source": "estimate"
|
|
4574
4771
|
}
|
|
4575
4772
|
},
|
|
4576
4773
|
"x-displayname": "Debug",
|
|
@@ -4797,6 +4994,13 @@
|
|
|
4797
4994
|
"latency": "moderate",
|
|
4798
4995
|
"resource_usage": "moderate"
|
|
4799
4996
|
}
|
|
4997
|
+
},
|
|
4998
|
+
"x-f5xc-discovered-response-time": {
|
|
4999
|
+
"p50_ms": 200,
|
|
5000
|
+
"p95_ms": 800,
|
|
5001
|
+
"p99_ms": 2000,
|
|
5002
|
+
"sample_count": 0,
|
|
5003
|
+
"source": "estimate"
|
|
4800
5004
|
}
|
|
4801
5005
|
},
|
|
4802
5006
|
"x-displayname": "Debug",
|
|
@@ -5030,6 +5234,13 @@
|
|
|
5030
5234
|
"latency": "low",
|
|
5031
5235
|
"resource_usage": "low"
|
|
5032
5236
|
}
|
|
5237
|
+
},
|
|
5238
|
+
"x-f5xc-discovered-response-time": {
|
|
5239
|
+
"p50_ms": 1000,
|
|
5240
|
+
"p95_ms": 3000,
|
|
5241
|
+
"p99_ms": 8000,
|
|
5242
|
+
"sample_count": 0,
|
|
5243
|
+
"source": "estimate"
|
|
5033
5244
|
}
|
|
5034
5245
|
},
|
|
5035
5246
|
"x-displayname": "Debug",
|
|
@@ -5270,6 +5481,13 @@
|
|
|
5270
5481
|
"latency": "low",
|
|
5271
5482
|
"resource_usage": "low"
|
|
5272
5483
|
}
|
|
5484
|
+
},
|
|
5485
|
+
"x-f5xc-discovered-response-time": {
|
|
5486
|
+
"p50_ms": 1000,
|
|
5487
|
+
"p95_ms": 3000,
|
|
5488
|
+
"p99_ms": 8000,
|
|
5489
|
+
"sample_count": 0,
|
|
5490
|
+
"source": "estimate"
|
|
5273
5491
|
}
|
|
5274
5492
|
},
|
|
5275
5493
|
"x-displayname": "Debug",
|
|
@@ -5510,6 +5728,13 @@
|
|
|
5510
5728
|
"latency": "low",
|
|
5511
5729
|
"resource_usage": "low"
|
|
5512
5730
|
}
|
|
5731
|
+
},
|
|
5732
|
+
"x-f5xc-discovered-response-time": {
|
|
5733
|
+
"p50_ms": 1000,
|
|
5734
|
+
"p95_ms": 3000,
|
|
5735
|
+
"p99_ms": 8000,
|
|
5736
|
+
"sample_count": 0,
|
|
5737
|
+
"source": "estimate"
|
|
5513
5738
|
}
|
|
5514
5739
|
},
|
|
5515
5740
|
"x-displayname": "Debug",
|
|
@@ -5749,6 +5974,13 @@
|
|
|
5749
5974
|
"latency": "moderate",
|
|
5750
5975
|
"resource_usage": "moderate"
|
|
5751
5976
|
}
|
|
5977
|
+
},
|
|
5978
|
+
"x-f5xc-discovered-response-time": {
|
|
5979
|
+
"p50_ms": 200,
|
|
5980
|
+
"p95_ms": 800,
|
|
5981
|
+
"p99_ms": 2000,
|
|
5982
|
+
"sample_count": 0,
|
|
5983
|
+
"source": "estimate"
|
|
5752
5984
|
}
|
|
5753
5985
|
},
|
|
5754
5986
|
"x-displayname": "Debug",
|
|
@@ -6002,6 +6234,13 @@
|
|
|
6002
6234
|
"latency": "low",
|
|
6003
6235
|
"resource_usage": "low"
|
|
6004
6236
|
}
|
|
6237
|
+
},
|
|
6238
|
+
"x-f5xc-discovered-response-time": {
|
|
6239
|
+
"p50_ms": 1000,
|
|
6240
|
+
"p95_ms": 3000,
|
|
6241
|
+
"p99_ms": 8000,
|
|
6242
|
+
"sample_count": 0,
|
|
6243
|
+
"source": "estimate"
|
|
6005
6244
|
}
|
|
6006
6245
|
},
|
|
6007
6246
|
"x-displayname": "Debug",
|
|
@@ -6203,6 +6442,13 @@
|
|
|
6203
6442
|
"latency": "moderate",
|
|
6204
6443
|
"resource_usage": "moderate"
|
|
6205
6444
|
}
|
|
6445
|
+
},
|
|
6446
|
+
"x-f5xc-discovered-response-time": {
|
|
6447
|
+
"p50_ms": 200,
|
|
6448
|
+
"p95_ms": 800,
|
|
6449
|
+
"p99_ms": 2000,
|
|
6450
|
+
"sample_count": 0,
|
|
6451
|
+
"source": "estimate"
|
|
6206
6452
|
}
|
|
6207
6453
|
},
|
|
6208
6454
|
"x-displayname": "Dhcp Leases.",
|
|
@@ -6417,6 +6663,13 @@
|
|
|
6417
6663
|
"latency": "moderate",
|
|
6418
6664
|
"resource_usage": "moderate"
|
|
6419
6665
|
}
|
|
6666
|
+
},
|
|
6667
|
+
"x-f5xc-discovered-response-time": {
|
|
6668
|
+
"p50_ms": 200,
|
|
6669
|
+
"p95_ms": 800,
|
|
6670
|
+
"p99_ms": 2000,
|
|
6671
|
+
"sample_count": 0,
|
|
6672
|
+
"source": "estimate"
|
|
6420
6673
|
}
|
|
6421
6674
|
},
|
|
6422
6675
|
"post": {
|
|
@@ -6652,6 +6905,13 @@
|
|
|
6652
6905
|
"latency": "low",
|
|
6653
6906
|
"resource_usage": "low"
|
|
6654
6907
|
}
|
|
6908
|
+
},
|
|
6909
|
+
"x-f5xc-discovered-response-time": {
|
|
6910
|
+
"p50_ms": 1000,
|
|
6911
|
+
"p95_ms": 3000,
|
|
6912
|
+
"p99_ms": 8000,
|
|
6913
|
+
"sample_count": 0,
|
|
6914
|
+
"source": "estimate"
|
|
6655
6915
|
}
|
|
6656
6916
|
},
|
|
6657
6917
|
"x-displayname": "LTE configuration.",
|
|
@@ -6892,6 +7152,13 @@
|
|
|
6892
7152
|
"latency": "low",
|
|
6893
7153
|
"resource_usage": "low"
|
|
6894
7154
|
}
|
|
7155
|
+
},
|
|
7156
|
+
"x-f5xc-discovered-response-time": {
|
|
7157
|
+
"p50_ms": 1000,
|
|
7158
|
+
"p95_ms": 3000,
|
|
7159
|
+
"p99_ms": 8000,
|
|
7160
|
+
"sample_count": 0,
|
|
7161
|
+
"source": "estimate"
|
|
6895
7162
|
}
|
|
6896
7163
|
},
|
|
6897
7164
|
"x-displayname": "LTE configuration.",
|
|
@@ -7106,6 +7373,13 @@
|
|
|
7106
7373
|
"latency": "moderate",
|
|
7107
7374
|
"resource_usage": "moderate"
|
|
7108
7375
|
}
|
|
7376
|
+
},
|
|
7377
|
+
"x-f5xc-discovered-response-time": {
|
|
7378
|
+
"p50_ms": 200,
|
|
7379
|
+
"p95_ms": 800,
|
|
7380
|
+
"p99_ms": 2000,
|
|
7381
|
+
"sample_count": 0,
|
|
7382
|
+
"source": "estimate"
|
|
7109
7383
|
}
|
|
7110
7384
|
},
|
|
7111
7385
|
"x-displayname": "LTE configuration.",
|
|
@@ -7329,6 +7603,13 @@
|
|
|
7329
7603
|
"latency": "low",
|
|
7330
7604
|
"resource_usage": "low"
|
|
7331
7605
|
}
|
|
7606
|
+
},
|
|
7607
|
+
"x-f5xc-discovered-response-time": {
|
|
7608
|
+
"p50_ms": 1000,
|
|
7609
|
+
"p95_ms": 3000,
|
|
7610
|
+
"p99_ms": 8000,
|
|
7611
|
+
"sample_count": 0,
|
|
7612
|
+
"source": "estimate"
|
|
7332
7613
|
}
|
|
7333
7614
|
},
|
|
7334
7615
|
"x-displayname": "Ping",
|
|
@@ -7545,6 +7826,13 @@
|
|
|
7545
7826
|
"latency": "low",
|
|
7546
7827
|
"resource_usage": "low"
|
|
7547
7828
|
}
|
|
7829
|
+
},
|
|
7830
|
+
"x-f5xc-discovered-response-time": {
|
|
7831
|
+
"p50_ms": 1000,
|
|
7832
|
+
"p95_ms": 3000,
|
|
7833
|
+
"p99_ms": 8000,
|
|
7834
|
+
"sample_count": 0,
|
|
7835
|
+
"source": "estimate"
|
|
7548
7836
|
}
|
|
7549
7837
|
},
|
|
7550
7838
|
"x-displayname": "Tcpdump",
|
|
@@ -7768,6 +8056,13 @@
|
|
|
7768
8056
|
"latency": "low",
|
|
7769
8057
|
"resource_usage": "low"
|
|
7770
8058
|
}
|
|
8059
|
+
},
|
|
8060
|
+
"x-f5xc-discovered-response-time": {
|
|
8061
|
+
"p50_ms": 1000,
|
|
8062
|
+
"p95_ms": 3000,
|
|
8063
|
+
"p99_ms": 8000,
|
|
8064
|
+
"sample_count": 0,
|
|
8065
|
+
"source": "estimate"
|
|
7771
8066
|
}
|
|
7772
8067
|
},
|
|
7773
8068
|
"x-displayname": "Tcpdump",
|
|
@@ -7984,6 +8279,13 @@
|
|
|
7984
8279
|
"latency": "low",
|
|
7985
8280
|
"resource_usage": "low"
|
|
7986
8281
|
}
|
|
8282
|
+
},
|
|
8283
|
+
"x-f5xc-discovered-response-time": {
|
|
8284
|
+
"p50_ms": 1000,
|
|
8285
|
+
"p95_ms": 3000,
|
|
8286
|
+
"p99_ms": 8000,
|
|
8287
|
+
"sample_count": 0,
|
|
8288
|
+
"source": "estimate"
|
|
7987
8289
|
}
|
|
7988
8290
|
},
|
|
7989
8291
|
"x-displayname": "Tcpdump",
|
|
@@ -8207,6 +8509,13 @@
|
|
|
8207
8509
|
"latency": "low",
|
|
8208
8510
|
"resource_usage": "low"
|
|
8209
8511
|
}
|
|
8512
|
+
},
|
|
8513
|
+
"x-f5xc-discovered-response-time": {
|
|
8514
|
+
"p50_ms": 1000,
|
|
8515
|
+
"p95_ms": 3000,
|
|
8516
|
+
"p99_ms": 8000,
|
|
8517
|
+
"sample_count": 0,
|
|
8518
|
+
"source": "estimate"
|
|
8210
8519
|
}
|
|
8211
8520
|
},
|
|
8212
8521
|
"x-displayname": "Tcpdump",
|
|
@@ -8406,6 +8715,13 @@
|
|
|
8406
8715
|
"latency": "low",
|
|
8407
8716
|
"resource_usage": "low"
|
|
8408
8717
|
}
|
|
8718
|
+
},
|
|
8719
|
+
"x-f5xc-discovered-response-time": {
|
|
8720
|
+
"p50_ms": 1000,
|
|
8721
|
+
"p95_ms": 3000,
|
|
8722
|
+
"p99_ms": 8000,
|
|
8723
|
+
"sample_count": 0,
|
|
8724
|
+
"source": "estimate"
|
|
8409
8725
|
}
|
|
8410
8726
|
},
|
|
8411
8727
|
"x-displayname": "Ticket Tracking System.",
|
|
@@ -8605,6 +8921,13 @@
|
|
|
8605
8921
|
"latency": "low",
|
|
8606
8922
|
"resource_usage": "low"
|
|
8607
8923
|
}
|
|
8924
|
+
},
|
|
8925
|
+
"x-f5xc-discovered-response-time": {
|
|
8926
|
+
"p50_ms": 1000,
|
|
8927
|
+
"p95_ms": 3000,
|
|
8928
|
+
"p99_ms": 8000,
|
|
8929
|
+
"sample_count": 0,
|
|
8930
|
+
"source": "estimate"
|
|
8608
8931
|
}
|
|
8609
8932
|
},
|
|
8610
8933
|
"x-displayname": "Ticket Tracking System.",
|
|
@@ -8819,6 +9142,13 @@
|
|
|
8819
9142
|
"latency": "low",
|
|
8820
9143
|
"resource_usage": "low"
|
|
8821
9144
|
}
|
|
9145
|
+
},
|
|
9146
|
+
"x-f5xc-discovered-response-time": {
|
|
9147
|
+
"p50_ms": 1000,
|
|
9148
|
+
"p95_ms": 3000,
|
|
9149
|
+
"p99_ms": 8000,
|
|
9150
|
+
"sample_count": 0,
|
|
9151
|
+
"source": "estimate"
|
|
8822
9152
|
}
|
|
8823
9153
|
},
|
|
8824
9154
|
"x-displayname": "Ticket Tracking System.",
|
|
@@ -9041,6 +9371,13 @@
|
|
|
9041
9371
|
"latency": "low",
|
|
9042
9372
|
"resource_usage": "low"
|
|
9043
9373
|
}
|
|
9374
|
+
},
|
|
9375
|
+
"x-f5xc-discovered-response-time": {
|
|
9376
|
+
"p50_ms": 800,
|
|
9377
|
+
"p95_ms": 2500,
|
|
9378
|
+
"p99_ms": 6000,
|
|
9379
|
+
"sample_count": 0,
|
|
9380
|
+
"source": "estimate"
|
|
9044
9381
|
}
|
|
9045
9382
|
},
|
|
9046
9383
|
"x-displayname": "Ticket Tracking System.",
|
|
@@ -9268,6 +9605,13 @@
|
|
|
9268
9605
|
"latency": "moderate",
|
|
9269
9606
|
"resource_usage": "moderate"
|
|
9270
9607
|
}
|
|
9608
|
+
},
|
|
9609
|
+
"x-f5xc-discovered-response-time": {
|
|
9610
|
+
"p50_ms": 200,
|
|
9611
|
+
"p95_ms": 800,
|
|
9612
|
+
"p99_ms": 2000,
|
|
9613
|
+
"sample_count": 0,
|
|
9614
|
+
"source": "estimate"
|
|
9271
9615
|
}
|
|
9272
9616
|
},
|
|
9273
9617
|
"x-displayname": "Ticket Tracking System.",
|
|
@@ -9488,6 +9832,13 @@
|
|
|
9488
9832
|
"latency": "low",
|
|
9489
9833
|
"resource_usage": "low"
|
|
9490
9834
|
}
|
|
9835
|
+
},
|
|
9836
|
+
"x-f5xc-discovered-response-time": {
|
|
9837
|
+
"p50_ms": 200,
|
|
9838
|
+
"p95_ms": 800,
|
|
9839
|
+
"p99_ms": 2000,
|
|
9840
|
+
"sample_count": 0,
|
|
9841
|
+
"source": "estimate"
|
|
9491
9842
|
}
|
|
9492
9843
|
},
|
|
9493
9844
|
"delete": {
|
|
@@ -9707,6 +10058,13 @@
|
|
|
9707
10058
|
"latency": "high",
|
|
9708
10059
|
"resource_usage": "moderate"
|
|
9709
10060
|
}
|
|
10061
|
+
},
|
|
10062
|
+
"x-f5xc-discovered-response-time": {
|
|
10063
|
+
"p50_ms": 500,
|
|
10064
|
+
"p95_ms": 1500,
|
|
10065
|
+
"p99_ms": 4000,
|
|
10066
|
+
"sample_count": 0,
|
|
10067
|
+
"source": "estimate"
|
|
9710
10068
|
}
|
|
9711
10069
|
},
|
|
9712
10070
|
"x-displayname": "Ticket Tracking System.",
|
|
@@ -9921,6 +10279,13 @@
|
|
|
9921
10279
|
"latency": "moderate",
|
|
9922
10280
|
"resource_usage": "moderate"
|
|
9923
10281
|
}
|
|
10282
|
+
},
|
|
10283
|
+
"x-f5xc-discovered-response-time": {
|
|
10284
|
+
"p50_ms": 200,
|
|
10285
|
+
"p95_ms": 800,
|
|
10286
|
+
"p99_ms": 2000,
|
|
10287
|
+
"sample_count": 0,
|
|
10288
|
+
"source": "estimate"
|
|
9924
10289
|
}
|
|
9925
10290
|
},
|
|
9926
10291
|
"post": {
|
|
@@ -10156,6 +10521,13 @@
|
|
|
10156
10521
|
"latency": "low",
|
|
10157
10522
|
"resource_usage": "low"
|
|
10158
10523
|
}
|
|
10524
|
+
},
|
|
10525
|
+
"x-f5xc-discovered-response-time": {
|
|
10526
|
+
"p50_ms": 1000,
|
|
10527
|
+
"p95_ms": 3000,
|
|
10528
|
+
"p99_ms": 8000,
|
|
10529
|
+
"sample_count": 0,
|
|
10530
|
+
"source": "estimate"
|
|
10159
10531
|
}
|
|
10160
10532
|
},
|
|
10161
10533
|
"x-displayname": "USB info",
|
|
@@ -10370,6 +10742,13 @@
|
|
|
10370
10742
|
"latency": "moderate",
|
|
10371
10743
|
"resource_usage": "moderate"
|
|
10372
10744
|
}
|
|
10745
|
+
},
|
|
10746
|
+
"x-f5xc-discovered-response-time": {
|
|
10747
|
+
"p50_ms": 500,
|
|
10748
|
+
"p95_ms": 2000,
|
|
10749
|
+
"p99_ms": 5000,
|
|
10750
|
+
"sample_count": 0,
|
|
10751
|
+
"source": "estimate"
|
|
10373
10752
|
}
|
|
10374
10753
|
},
|
|
10375
10754
|
"x-displayname": "USB info",
|
|
@@ -10585,6 +10964,13 @@
|
|
|
10585
10964
|
"latency": "moderate",
|
|
10586
10965
|
"resource_usage": "moderate"
|
|
10587
10966
|
}
|
|
10967
|
+
},
|
|
10968
|
+
"x-f5xc-discovered-response-time": {
|
|
10969
|
+
"p50_ms": 200,
|
|
10970
|
+
"p95_ms": 800,
|
|
10971
|
+
"p99_ms": 2000,
|
|
10972
|
+
"sample_count": 0,
|
|
10973
|
+
"source": "estimate"
|
|
10588
10974
|
}
|
|
10589
10975
|
},
|
|
10590
10976
|
"x-displayname": "USB info",
|
|
@@ -10826,6 +11212,13 @@
|
|
|
10826
11212
|
"latency": "low",
|
|
10827
11213
|
"resource_usage": "low"
|
|
10828
11214
|
}
|
|
11215
|
+
},
|
|
11216
|
+
"x-f5xc-discovered-response-time": {
|
|
11217
|
+
"p50_ms": 1000,
|
|
11218
|
+
"p95_ms": 3000,
|
|
11219
|
+
"p99_ms": 8000,
|
|
11220
|
+
"sample_count": 0,
|
|
11221
|
+
"source": "estimate"
|
|
10829
11222
|
}
|
|
10830
11223
|
},
|
|
10831
11224
|
"x-displayname": "USB info",
|
|
@@ -11067,6 +11460,13 @@
|
|
|
11067
11460
|
"latency": "low",
|
|
11068
11461
|
"resource_usage": "low"
|
|
11069
11462
|
}
|
|
11463
|
+
},
|
|
11464
|
+
"x-f5xc-discovered-response-time": {
|
|
11465
|
+
"p50_ms": 1000,
|
|
11466
|
+
"p95_ms": 3000,
|
|
11467
|
+
"p99_ms": 8000,
|
|
11468
|
+
"sample_count": 0,
|
|
11469
|
+
"source": "estimate"
|
|
11070
11470
|
}
|
|
11071
11471
|
},
|
|
11072
11472
|
"x-displayname": "USB info",
|
|
@@ -11281,6 +11681,13 @@
|
|
|
11281
11681
|
"latency": "moderate",
|
|
11282
11682
|
"resource_usage": "moderate"
|
|
11283
11683
|
}
|
|
11684
|
+
},
|
|
11685
|
+
"x-f5xc-discovered-response-time": {
|
|
11686
|
+
"p50_ms": 200,
|
|
11687
|
+
"p95_ms": 800,
|
|
11688
|
+
"p99_ms": 2000,
|
|
11689
|
+
"sample_count": 0,
|
|
11690
|
+
"source": "estimate"
|
|
11284
11691
|
}
|
|
11285
11692
|
},
|
|
11286
11693
|
"post": {
|
|
@@ -11516,6 +11923,13 @@
|
|
|
11516
11923
|
"latency": "low",
|
|
11517
11924
|
"resource_usage": "low"
|
|
11518
11925
|
}
|
|
11926
|
+
},
|
|
11927
|
+
"x-f5xc-discovered-response-time": {
|
|
11928
|
+
"p50_ms": 1000,
|
|
11929
|
+
"p95_ms": 3000,
|
|
11930
|
+
"p99_ms": 8000,
|
|
11931
|
+
"sample_count": 0,
|
|
11932
|
+
"source": "estimate"
|
|
11519
11933
|
}
|
|
11520
11934
|
},
|
|
11521
11935
|
"x-displayname": "WIFI info",
|
|
@@ -11756,6 +12170,13 @@
|
|
|
11756
12170
|
"latency": "low",
|
|
11757
12171
|
"resource_usage": "low"
|
|
11758
12172
|
}
|
|
12173
|
+
},
|
|
12174
|
+
"x-f5xc-discovered-response-time": {
|
|
12175
|
+
"p50_ms": 1000,
|
|
12176
|
+
"p95_ms": 3000,
|
|
12177
|
+
"p99_ms": 8000,
|
|
12178
|
+
"sample_count": 0,
|
|
12179
|
+
"source": "estimate"
|
|
11759
12180
|
}
|
|
11760
12181
|
},
|
|
11761
12182
|
"x-displayname": "WIFI info",
|
|
@@ -11970,6 +12391,13 @@
|
|
|
11970
12391
|
"latency": "moderate",
|
|
11971
12392
|
"resource_usage": "moderate"
|
|
11972
12393
|
}
|
|
12394
|
+
},
|
|
12395
|
+
"x-f5xc-discovered-response-time": {
|
|
12396
|
+
"p50_ms": 200,
|
|
12397
|
+
"p95_ms": 800,
|
|
12398
|
+
"p99_ms": 2000,
|
|
12399
|
+
"sample_count": 0,
|
|
12400
|
+
"source": "estimate"
|
|
11973
12401
|
}
|
|
11974
12402
|
},
|
|
11975
12403
|
"x-displayname": "WIFI info",
|
|
@@ -12184,6 +12612,13 @@
|
|
|
12184
12612
|
"latency": "moderate",
|
|
12185
12613
|
"resource_usage": "moderate"
|
|
12186
12614
|
}
|
|
12615
|
+
},
|
|
12616
|
+
"x-f5xc-discovered-response-time": {
|
|
12617
|
+
"p50_ms": 500,
|
|
12618
|
+
"p95_ms": 2000,
|
|
12619
|
+
"p99_ms": 5000,
|
|
12620
|
+
"sample_count": 0,
|
|
12621
|
+
"source": "estimate"
|
|
12187
12622
|
}
|
|
12188
12623
|
},
|
|
12189
12624
|
"x-displayname": "WIFI info",
|
|
@@ -12215,6 +12650,7 @@
|
|
|
12215
12650
|
"title": "CRL Name",
|
|
12216
12651
|
"x-displayname": "CRL Name",
|
|
12217
12652
|
"x-f5xc-example": "example-resource",
|
|
12653
|
+
"x-f5xc-description-short": "Exclusive with [uid] Name of the CRL object.",
|
|
12218
12654
|
"minLength": 0,
|
|
12219
12655
|
"maxLength": 16,
|
|
12220
12656
|
"x-f5xc-required-for": {
|
|
@@ -12225,7 +12661,7 @@
|
|
|
12225
12661
|
},
|
|
12226
12662
|
"x-original-maxLength": 1024,
|
|
12227
12663
|
"x-reconciled-from-discovery": true,
|
|
12228
|
-
"x-reconciled-at": "2026-01-
|
|
12664
|
+
"x-reconciled-at": "2026-01-07T15:28:05.308544+00:00"
|
|
12229
12665
|
},
|
|
12230
12666
|
"namespace": {
|
|
12231
12667
|
"type": "string",
|
|
@@ -12234,6 +12670,7 @@
|
|
|
12234
12670
|
"x-displayname": "Namespace",
|
|
12235
12671
|
"x-ves-example": "System",
|
|
12236
12672
|
"x-f5xc-example": "system",
|
|
12673
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
12237
12674
|
"minLength": 0,
|
|
12238
12675
|
"maxLength": 6,
|
|
12239
12676
|
"x-f5xc-required-for": {
|
|
@@ -12244,7 +12681,7 @@
|
|
|
12244
12681
|
},
|
|
12245
12682
|
"x-original-maxLength": 1024,
|
|
12246
12683
|
"x-reconciled-from-discovery": true,
|
|
12247
|
-
"x-reconciled-at": "2026-01-
|
|
12684
|
+
"x-reconciled-at": "2026-01-07T15:28:05.308551+00:00"
|
|
12248
12685
|
},
|
|
12249
12686
|
"site": {
|
|
12250
12687
|
"type": "string",
|
|
@@ -12253,6 +12690,7 @@
|
|
|
12253
12690
|
"x-displayname": "Site Name",
|
|
12254
12691
|
"x-ves-example": "Value",
|
|
12255
12692
|
"x-f5xc-example": "value",
|
|
12693
|
+
"x-f5xc-description-short": "Name of the site for which request is sent.",
|
|
12256
12694
|
"minLength": 0,
|
|
12257
12695
|
"maxLength": 1024,
|
|
12258
12696
|
"x-f5xc-required-for": {
|
|
@@ -12267,6 +12705,7 @@
|
|
|
12267
12705
|
"description": "Exclusive with [name]\nUID of the CRL object.",
|
|
12268
12706
|
"title": "CRL UID",
|
|
12269
12707
|
"x-displayname": "CRL UID",
|
|
12708
|
+
"x-f5xc-description-short": "Exclusive with [name] UID of the CRL object.",
|
|
12270
12709
|
"minLength": 0,
|
|
12271
12710
|
"maxLength": 36,
|
|
12272
12711
|
"x-f5xc-required-for": {
|
|
@@ -12279,9 +12718,10 @@
|
|
|
12279
12718
|
"x-original-maxLength": 1024,
|
|
12280
12719
|
"format": "uuid",
|
|
12281
12720
|
"x-reconciled-from-discovery": true,
|
|
12282
|
-
"x-reconciled-at": "2026-01-
|
|
12721
|
+
"x-reconciled-at": "2026-01-07T15:28:05.308560+00:00"
|
|
12283
12722
|
}
|
|
12284
12723
|
},
|
|
12724
|
+
"x-f5xc-description-short": "Request to trigger resync of CRL in VER.",
|
|
12285
12725
|
"x-f5xc-minimum-configuration": {
|
|
12286
12726
|
"description": "Minimum configuration for crlResyncCRLRequest",
|
|
12287
12727
|
"required_fields": [
|
|
@@ -12310,6 +12750,7 @@
|
|
|
12310
12750
|
"description": "Status of the CRL request.",
|
|
12311
12751
|
"title": "Status",
|
|
12312
12752
|
"x-displayname": "Status",
|
|
12753
|
+
"x-f5xc-example": "active",
|
|
12313
12754
|
"minLength": 0,
|
|
12314
12755
|
"maxLength": 17,
|
|
12315
12756
|
"x-f5xc-required-for": {
|
|
@@ -12320,7 +12761,7 @@
|
|
|
12320
12761
|
},
|
|
12321
12762
|
"x-original-maxLength": 1024,
|
|
12322
12763
|
"x-reconciled-from-discovery": true,
|
|
12323
|
-
"x-reconciled-at": "2026-01-
|
|
12764
|
+
"x-reconciled-at": "2026-01-07T15:28:05.308566+00:00"
|
|
12324
12765
|
}
|
|
12325
12766
|
},
|
|
12326
12767
|
"x-f5xc-minimum-configuration": {
|
|
@@ -12350,6 +12791,8 @@
|
|
|
12350
12791
|
"x-displayname": "Attachment data.",
|
|
12351
12792
|
"x-ves-example": "DGVzdCBhdHRhY2htZW50.",
|
|
12352
12793
|
"x-f5xc-example": "dGVzdCBhdHRhY2htZW50",
|
|
12794
|
+
"x-f5xc-description-short": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.",
|
|
12795
|
+
"x-f5xc-description-medium": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.",
|
|
12353
12796
|
"minLength": 0,
|
|
12354
12797
|
"maxLength": 1024,
|
|
12355
12798
|
"x-f5xc-required-for": {
|
|
@@ -12366,6 +12809,7 @@
|
|
|
12366
12809
|
"x-displayname": "Content type.",
|
|
12367
12810
|
"x-ves-example": "Application/pdf.",
|
|
12368
12811
|
"x-f5xc-example": "application/pdf",
|
|
12812
|
+
"x-f5xc-description-short": "Mime content type of the attachment. Helps the UI to properly display the data.",
|
|
12369
12813
|
"minLength": 0,
|
|
12370
12814
|
"maxLength": 1024,
|
|
12371
12815
|
"x-f5xc-required-for": {
|
|
@@ -12382,6 +12826,7 @@
|
|
|
12382
12826
|
"x-displayname": "Filename",
|
|
12383
12827
|
"x-ves-example": "attachment.pdf.",
|
|
12384
12828
|
"x-f5xc-example": "attachment.pdf",
|
|
12829
|
+
"x-f5xc-description-short": "Filename of the attachment as provided by the caller.",
|
|
12385
12830
|
"minLength": 0,
|
|
12386
12831
|
"maxLength": 1024,
|
|
12387
12832
|
"x-f5xc-required-for": {
|
|
@@ -12398,6 +12843,7 @@
|
|
|
12398
12843
|
"x-displayname": "3rd party ID.",
|
|
12399
12844
|
"x-ves-example": "1234",
|
|
12400
12845
|
"x-f5xc-example": "1234",
|
|
12846
|
+
"x-f5xc-description-short": "Optional ID as assigned by the 3rd party actually storing the data.",
|
|
12401
12847
|
"minLength": 0,
|
|
12402
12848
|
"maxLength": 1024,
|
|
12403
12849
|
"x-f5xc-required-for": {
|
|
@@ -12409,6 +12855,8 @@
|
|
|
12409
12855
|
"x-field-mutability": "read-only"
|
|
12410
12856
|
}
|
|
12411
12857
|
},
|
|
12858
|
+
"x-f5xc-description-short": "Attachment represents a single support ticket comment attachment.",
|
|
12859
|
+
"x-f5xc-description-medium": "Attachment represents a single support ticket comment attachment. Attachment are normally not store with the ticket itself, they represent a handle in the third party, so the contact can be retrieved omn demand.",
|
|
12412
12860
|
"x-f5xc-minimum-configuration": {
|
|
12413
12861
|
"description": "Minimum configuration for customer_supportAttachmentType",
|
|
12414
12862
|
"required_fields": [
|
|
@@ -12438,6 +12886,7 @@
|
|
|
12438
12886
|
"x-displayname": "Name",
|
|
12439
12887
|
"x-ves-example": "Value",
|
|
12440
12888
|
"x-f5xc-example": "value",
|
|
12889
|
+
"x-f5xc-description-short": "The name of the customer support ticket object to be closed.",
|
|
12441
12890
|
"minLength": 0,
|
|
12442
12891
|
"maxLength": 16,
|
|
12443
12892
|
"x-f5xc-required-for": {
|
|
@@ -12448,7 +12897,7 @@
|
|
|
12448
12897
|
},
|
|
12449
12898
|
"x-original-maxLength": 1024,
|
|
12450
12899
|
"x-reconciled-from-discovery": true,
|
|
12451
|
-
"x-reconciled-at": "2026-01-
|
|
12900
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688842+00:00"
|
|
12452
12901
|
},
|
|
12453
12902
|
"namespace": {
|
|
12454
12903
|
"type": "string",
|
|
@@ -12457,6 +12906,7 @@
|
|
|
12457
12906
|
"x-displayname": "Namespace",
|
|
12458
12907
|
"x-ves-example": "Value",
|
|
12459
12908
|
"x-f5xc-example": "value",
|
|
12909
|
+
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
|
|
12460
12910
|
"minLength": 0,
|
|
12461
12911
|
"maxLength": 6,
|
|
12462
12912
|
"x-f5xc-required-for": {
|
|
@@ -12467,9 +12917,10 @@
|
|
|
12467
12917
|
},
|
|
12468
12918
|
"x-original-maxLength": 1024,
|
|
12469
12919
|
"x-reconciled-from-discovery": true,
|
|
12470
|
-
"x-reconciled-at": "2026-01-
|
|
12920
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688849+00:00"
|
|
12471
12921
|
}
|
|
12472
12922
|
},
|
|
12923
|
+
"x-f5xc-description-short": "Closes an open existing customer support ticket.",
|
|
12473
12924
|
"x-f5xc-minimum-configuration": {
|
|
12474
12925
|
"description": "Minimum configuration for customer_supportCloseRequest",
|
|
12475
12926
|
"required_fields": [
|
|
@@ -12494,6 +12945,7 @@
|
|
|
12494
12945
|
"$ref": "#/components/schemas/schemacustomer_supportErrorCode"
|
|
12495
12946
|
}
|
|
12496
12947
|
},
|
|
12948
|
+
"x-f5xc-description-short": "Gives details of result of closing a customer support ticket.",
|
|
12497
12949
|
"x-f5xc-minimum-configuration": {
|
|
12498
12950
|
"description": "Minimum configuration for customer_supportCloseResponse",
|
|
12499
12951
|
"required_fields": [
|
|
@@ -12521,6 +12973,7 @@
|
|
|
12521
12973
|
"$ref": "#/components/schemas/customer_supportAttachmentType"
|
|
12522
12974
|
},
|
|
12523
12975
|
"x-displayname": "Attachments.",
|
|
12976
|
+
"x-f5xc-description-short": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
|
|
12524
12977
|
"x-f5xc-required-for": {
|
|
12525
12978
|
"minimum_config": false,
|
|
12526
12979
|
"create": false,
|
|
@@ -12535,6 +12988,7 @@
|
|
|
12535
12988
|
"x-displayname": "Name",
|
|
12536
12989
|
"x-ves-example": "Value",
|
|
12537
12990
|
"x-f5xc-example": "value",
|
|
12991
|
+
"x-f5xc-description-short": "The name of the customer support ticket object to be updated.",
|
|
12538
12992
|
"minLength": 0,
|
|
12539
12993
|
"maxLength": 1024,
|
|
12540
12994
|
"x-f5xc-required-for": {
|
|
@@ -12551,6 +13005,7 @@
|
|
|
12551
13005
|
"x-displayname": "Name",
|
|
12552
13006
|
"x-ves-example": "Value",
|
|
12553
13007
|
"x-f5xc-example": "value",
|
|
13008
|
+
"x-f5xc-description-short": "The name of the customer support ticket object to be updated.",
|
|
12554
13009
|
"minLength": 0,
|
|
12555
13010
|
"maxLength": 16,
|
|
12556
13011
|
"x-f5xc-required-for": {
|
|
@@ -12561,7 +13016,7 @@
|
|
|
12561
13016
|
},
|
|
12562
13017
|
"x-original-maxLength": 1024,
|
|
12563
13018
|
"x-reconciled-from-discovery": true,
|
|
12564
|
-
"x-reconciled-at": "2026-01-
|
|
13019
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688860+00:00"
|
|
12565
13020
|
},
|
|
12566
13021
|
"namespace": {
|
|
12567
13022
|
"type": "string",
|
|
@@ -12570,6 +13025,7 @@
|
|
|
12570
13025
|
"x-displayname": "Namespace",
|
|
12571
13026
|
"x-ves-example": "Value",
|
|
12572
13027
|
"x-f5xc-example": "value",
|
|
13028
|
+
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
|
|
12573
13029
|
"minLength": 0,
|
|
12574
13030
|
"maxLength": 6,
|
|
12575
13031
|
"x-f5xc-required-for": {
|
|
@@ -12580,9 +13036,10 @@
|
|
|
12580
13036
|
},
|
|
12581
13037
|
"x-original-maxLength": 1024,
|
|
12582
13038
|
"x-reconciled-from-discovery": true,
|
|
12583
|
-
"x-reconciled-at": "2026-01-
|
|
13039
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688864+00:00"
|
|
12584
13040
|
}
|
|
12585
13041
|
},
|
|
13042
|
+
"x-f5xc-description-short": "Adds a new comment to an existing customer support ticket.",
|
|
12586
13043
|
"x-f5xc-minimum-configuration": {
|
|
12587
13044
|
"description": "Minimum configuration for customer_supportCommentRequest",
|
|
12588
13045
|
"required_fields": [
|
|
@@ -12609,6 +13066,7 @@
|
|
|
12609
13066
|
"$ref": "#/components/schemas/schemacustomer_supportErrorCode"
|
|
12610
13067
|
}
|
|
12611
13068
|
},
|
|
13069
|
+
"x-f5xc-description-short": "Gives details of result of adding a customer support ticket.",
|
|
12612
13070
|
"x-f5xc-minimum-configuration": {
|
|
12613
13071
|
"description": "Minimum configuration for customer_supportCommentResponse",
|
|
12614
13072
|
"required_fields": [
|
|
@@ -12638,6 +13096,7 @@
|
|
|
12638
13096
|
"x-displayname": "Attachment IDs.",
|
|
12639
13097
|
"x-ves-example": "12345",
|
|
12640
13098
|
"x-f5xc-example": "12345",
|
|
13099
|
+
"x-f5xc-description-short": "Third party ID of any attachment related to this ticket comment.",
|
|
12641
13100
|
"x-f5xc-required-for": {
|
|
12642
13101
|
"minimum_config": false,
|
|
12643
13102
|
"create": false,
|
|
@@ -12654,6 +13113,7 @@
|
|
|
12654
13113
|
"$ref": "#/components/schemas/customer_supportAttachmentType"
|
|
12655
13114
|
},
|
|
12656
13115
|
"x-displayname": "Attachments details.",
|
|
13116
|
+
"x-f5xc-description-short": "Information about any attachments (such as screenshots, plain text files) the comment can have.",
|
|
12657
13117
|
"x-f5xc-required-for": {
|
|
12658
13118
|
"minimum_config": false,
|
|
12659
13119
|
"create": false,
|
|
@@ -12744,6 +13204,8 @@
|
|
|
12744
13204
|
}
|
|
12745
13205
|
}
|
|
12746
13206
|
},
|
|
13207
|
+
"x-f5xc-description-short": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself.",
|
|
13208
|
+
"x-f5xc-description-medium": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself. Customers usually download all comments on an issue which resembles a conversation on an issue.",
|
|
12747
13209
|
"x-f5xc-minimum-configuration": {
|
|
12748
13210
|
"description": "Minimum configuration for customer_supportCommentType",
|
|
12749
13211
|
"required_fields": [
|
|
@@ -12831,6 +13293,7 @@
|
|
|
12831
13293
|
"x-displayname": "Name",
|
|
12832
13294
|
"x-ves-example": "Value",
|
|
12833
13295
|
"x-f5xc-example": "value",
|
|
13296
|
+
"x-f5xc-description-short": "The name of the customer support ticket object to be escalated.",
|
|
12834
13297
|
"minLength": 0,
|
|
12835
13298
|
"maxLength": 16,
|
|
12836
13299
|
"x-f5xc-required-for": {
|
|
@@ -12841,7 +13304,7 @@
|
|
|
12841
13304
|
},
|
|
12842
13305
|
"x-original-maxLength": 1024,
|
|
12843
13306
|
"x-reconciled-from-discovery": true,
|
|
12844
|
-
"x-reconciled-at": "2026-01-
|
|
13307
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688888+00:00"
|
|
12845
13308
|
},
|
|
12846
13309
|
"namespace": {
|
|
12847
13310
|
"type": "string",
|
|
@@ -12850,6 +13313,7 @@
|
|
|
12850
13313
|
"x-displayname": "Namespace",
|
|
12851
13314
|
"x-ves-example": "Value",
|
|
12852
13315
|
"x-f5xc-example": "value",
|
|
13316
|
+
"x-f5xc-description-short": "The namespace in which the support ticket object is present in.",
|
|
12853
13317
|
"minLength": 0,
|
|
12854
13318
|
"maxLength": 6,
|
|
12855
13319
|
"x-f5xc-required-for": {
|
|
@@ -12860,9 +13324,10 @@
|
|
|
12860
13324
|
},
|
|
12861
13325
|
"x-original-maxLength": 1024,
|
|
12862
13326
|
"x-reconciled-from-discovery": true,
|
|
12863
|
-
"x-reconciled-at": "2026-01-
|
|
13327
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688892+00:00"
|
|
12864
13328
|
}
|
|
12865
13329
|
},
|
|
13330
|
+
"x-f5xc-description-short": "Changes priority of an existing customer support ticket.",
|
|
12866
13331
|
"x-f5xc-minimum-configuration": {
|
|
12867
13332
|
"description": "Minimum configuration for customer_supportEscalationRequest",
|
|
12868
13333
|
"required_fields": [
|
|
@@ -12887,6 +13352,7 @@
|
|
|
12887
13352
|
"$ref": "#/components/schemas/schemacustomer_supportErrorCode"
|
|
12888
13353
|
}
|
|
12889
13354
|
},
|
|
13355
|
+
"x-f5xc-description-short": "Any error that may occurred during escalating of a ticket.",
|
|
12890
13356
|
"x-f5xc-minimum-configuration": {
|
|
12891
13357
|
"description": "Minimum configuration for customer_supportEscalationResponse",
|
|
12892
13358
|
"required_fields": [
|
|
@@ -12917,6 +13383,7 @@
|
|
|
12917
13383
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
12918
13384
|
},
|
|
12919
13385
|
"x-displayname": "Deleted Referred Objects.",
|
|
13386
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
12920
13387
|
"x-f5xc-required-for": {
|
|
12921
13388
|
"minimum_config": false,
|
|
12922
13389
|
"create": false,
|
|
@@ -12932,6 +13399,7 @@
|
|
|
12932
13399
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
12933
13400
|
},
|
|
12934
13401
|
"x-displayname": "Disabled Referred Objects.",
|
|
13402
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
12935
13403
|
"x-f5xc-required-for": {
|
|
12936
13404
|
"minimum_config": false,
|
|
12937
13405
|
"create": false,
|
|
@@ -12950,6 +13418,7 @@
|
|
|
12950
13418
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
12951
13419
|
},
|
|
12952
13420
|
"x-displayname": "Referring Objects.",
|
|
13421
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
12953
13422
|
"x-f5xc-required-for": {
|
|
12954
13423
|
"minimum_config": false,
|
|
12955
13424
|
"create": false,
|
|
@@ -12968,6 +13437,8 @@
|
|
|
12968
13437
|
"$ref": "#/components/schemas/customer_supportStatusObject"
|
|
12969
13438
|
},
|
|
12970
13439
|
"x-displayname": "Status",
|
|
13440
|
+
"x-f5xc-example": "active",
|
|
13441
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
12971
13442
|
"x-f5xc-required-for": {
|
|
12972
13443
|
"minimum_config": false,
|
|
12973
13444
|
"create": false,
|
|
@@ -12977,7 +13448,7 @@
|
|
|
12977
13448
|
"maxLength": 17,
|
|
12978
13449
|
"minLength": 17,
|
|
12979
13450
|
"x-reconciled-from-discovery": true,
|
|
12980
|
-
"x-reconciled-at": "2026-01-
|
|
13451
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688907+00:00"
|
|
12981
13452
|
},
|
|
12982
13453
|
"system_metadata": {
|
|
12983
13454
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -13015,6 +13486,8 @@
|
|
|
13015
13486
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
13016
13487
|
],
|
|
13017
13488
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
13489
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
13490
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
13018
13491
|
"x-f5xc-minimum-configuration": {
|
|
13019
13492
|
"description": "Minimum configuration for customer_supportGetResponseFormatCode",
|
|
13020
13493
|
"required_fields": [],
|
|
@@ -13040,6 +13513,7 @@
|
|
|
13040
13513
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
13041
13514
|
},
|
|
13042
13515
|
"x-displayname": "Errors",
|
|
13516
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
13043
13517
|
"x-f5xc-required-for": {
|
|
13044
13518
|
"minimum_config": false,
|
|
13045
13519
|
"create": false,
|
|
@@ -13055,6 +13529,8 @@
|
|
|
13055
13529
|
"$ref": "#/components/schemas/customer_supportListResponseItem"
|
|
13056
13530
|
},
|
|
13057
13531
|
"x-displayname": "Items",
|
|
13532
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
13533
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
13058
13534
|
"x-f5xc-required-for": {
|
|
13059
13535
|
"minimum_config": false,
|
|
13060
13536
|
"create": false,
|
|
@@ -13088,6 +13564,8 @@
|
|
|
13088
13564
|
"description": "The set of annotations present on this customer_support.",
|
|
13089
13565
|
"title": "Annotations.",
|
|
13090
13566
|
"x-displayname": "Annotations.",
|
|
13567
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13568
|
+
"x-f5xc-description-short": "The set of annotations present on this customer_support.",
|
|
13091
13569
|
"x-f5xc-required-for": {
|
|
13092
13570
|
"minimum_config": false,
|
|
13093
13571
|
"create": false,
|
|
@@ -13100,6 +13578,7 @@
|
|
|
13100
13578
|
"description": "The description set for this customer_support.",
|
|
13101
13579
|
"title": "Description.",
|
|
13102
13580
|
"x-displayname": "Description.",
|
|
13581
|
+
"x-f5xc-description-short": "The description set for this customer_support.",
|
|
13103
13582
|
"minLength": 0,
|
|
13104
13583
|
"maxLength": 0,
|
|
13105
13584
|
"x-f5xc-required-for": {
|
|
@@ -13110,7 +13589,7 @@
|
|
|
13110
13589
|
},
|
|
13111
13590
|
"x-original-maxLength": 1024,
|
|
13112
13591
|
"x-reconciled-from-discovery": true,
|
|
13113
|
-
"x-reconciled-at": "2026-01-
|
|
13592
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688919+00:00"
|
|
13114
13593
|
},
|
|
13115
13594
|
"disabled": {
|
|
13116
13595
|
"type": "boolean",
|
|
@@ -13118,6 +13597,8 @@
|
|
|
13118
13597
|
"title": "Disabled",
|
|
13119
13598
|
"format": "boolean",
|
|
13120
13599
|
"x-displayname": "Disabled",
|
|
13600
|
+
"x-f5xc-example": "True",
|
|
13601
|
+
"x-f5xc-description-short": "Value of true indicates customer_support is administratively disabled.",
|
|
13121
13602
|
"x-f5xc-required-for": {
|
|
13122
13603
|
"minimum_config": false,
|
|
13123
13604
|
"create": false,
|
|
@@ -13133,6 +13614,8 @@
|
|
|
13133
13614
|
"description": "The set of labels present on this customer_support.",
|
|
13134
13615
|
"title": "Labels",
|
|
13135
13616
|
"x-displayname": "Labels",
|
|
13617
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13618
|
+
"x-f5xc-description-short": "The set of labels present on this customer_support.",
|
|
13136
13619
|
"x-f5xc-required-for": {
|
|
13137
13620
|
"minimum_config": false,
|
|
13138
13621
|
"create": false,
|
|
@@ -13160,7 +13643,7 @@
|
|
|
13160
13643
|
},
|
|
13161
13644
|
"x-original-maxLength": 1024,
|
|
13162
13645
|
"x-reconciled-from-discovery": true,
|
|
13163
|
-
"x-reconciled-at": "2026-01-
|
|
13646
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688929+00:00"
|
|
13164
13647
|
},
|
|
13165
13648
|
"namespace": {
|
|
13166
13649
|
"type": "string",
|
|
@@ -13179,7 +13662,7 @@
|
|
|
13179
13662
|
},
|
|
13180
13663
|
"x-original-maxLength": 1024,
|
|
13181
13664
|
"x-reconciled-from-discovery": true,
|
|
13182
|
-
"x-reconciled-at": "2026-01-
|
|
13665
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688934+00:00"
|
|
13183
13666
|
},
|
|
13184
13667
|
"owner_view": {
|
|
13185
13668
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -13192,6 +13675,7 @@
|
|
|
13192
13675
|
"$ref": "#/components/schemas/customer_supportStatusObject"
|
|
13193
13676
|
},
|
|
13194
13677
|
"x-displayname": "Status",
|
|
13678
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
13195
13679
|
"x-f5xc-required-for": {
|
|
13196
13680
|
"minimum_config": false,
|
|
13197
13681
|
"create": false,
|
|
@@ -13220,7 +13704,7 @@
|
|
|
13220
13704
|
"x-field-mutability": "read-only",
|
|
13221
13705
|
"x-original-maxLength": 1024,
|
|
13222
13706
|
"x-reconciled-from-discovery": true,
|
|
13223
|
-
"x-reconciled-at": "2026-01-
|
|
13707
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688941+00:00"
|
|
13224
13708
|
},
|
|
13225
13709
|
"uid": {
|
|
13226
13710
|
"type": "string",
|
|
@@ -13229,6 +13713,7 @@
|
|
|
13229
13713
|
"x-displayname": "UID",
|
|
13230
13714
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
13231
13715
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
13716
|
+
"x-f5xc-description-short": "The unique uid of this customer_support.",
|
|
13232
13717
|
"minLength": 0,
|
|
13233
13718
|
"maxLength": 36,
|
|
13234
13719
|
"x-f5xc-required-for": {
|
|
@@ -13241,9 +13726,11 @@
|
|
|
13241
13726
|
"x-original-maxLength": 1024,
|
|
13242
13727
|
"format": "uuid",
|
|
13243
13728
|
"x-reconciled-from-discovery": true,
|
|
13244
|
-
"x-reconciled-at": "2026-01-
|
|
13729
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688948+00:00"
|
|
13245
13730
|
}
|
|
13246
13731
|
},
|
|
13732
|
+
"x-f5xc-description-short": "By default a summary of customer_support is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
13733
|
+
"x-f5xc-description-medium": "By default a summary of customer_support is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
13247
13734
|
"x-f5xc-minimum-configuration": {
|
|
13248
13735
|
"description": "Minimum configuration for customer_supportListResponseItem",
|
|
13249
13736
|
"required_fields": [
|
|
@@ -13299,6 +13786,8 @@
|
|
|
13299
13786
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
13300
13787
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
13301
13788
|
},
|
|
13789
|
+
"x-f5xc-example": "10",
|
|
13790
|
+
"x-f5xc-description-short": "List of priorities for filtering the customer support ticket list. Required: YES.",
|
|
13302
13791
|
"x-f5xc-required-for": {
|
|
13303
13792
|
"minimum_config": false,
|
|
13304
13793
|
"create": false,
|
|
@@ -13330,6 +13819,8 @@
|
|
|
13330
13819
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
13331
13820
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
13332
13821
|
},
|
|
13822
|
+
"x-f5xc-example": "active",
|
|
13823
|
+
"x-f5xc-description-short": "List of status for filtering the customer support ticket list. Required: YES.",
|
|
13333
13824
|
"x-f5xc-required-for": {
|
|
13334
13825
|
"minimum_config": false,
|
|
13335
13826
|
"create": false,
|
|
@@ -13339,9 +13830,11 @@
|
|
|
13339
13830
|
"maxLength": 17,
|
|
13340
13831
|
"minLength": 17,
|
|
13341
13832
|
"x-reconciled-from-discovery": true,
|
|
13342
|
-
"x-reconciled-at": "2026-01-
|
|
13833
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688955+00:00"
|
|
13343
13834
|
}
|
|
13344
13835
|
},
|
|
13836
|
+
"x-f5xc-description-short": "Input message of the 'ListCTSupportTickets' RPC. Fields can be used to control scope and filtering of collection.",
|
|
13837
|
+
"x-f5xc-description-medium": "Input message of the 'ListCTSupportTickets' RPC. Fields can be used to control scope and filtering of collection.",
|
|
13345
13838
|
"x-f5xc-minimum-configuration": {
|
|
13346
13839
|
"description": "Minimum configuration for customer_supportListSupportRequest",
|
|
13347
13840
|
"required_fields": [
|
|
@@ -13370,6 +13863,7 @@
|
|
|
13370
13863
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
13371
13864
|
},
|
|
13372
13865
|
"x-displayname": "Errors",
|
|
13866
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
13373
13867
|
"x-f5xc-required-for": {
|
|
13374
13868
|
"minimum_config": false,
|
|
13375
13869
|
"create": false,
|
|
@@ -13385,6 +13879,8 @@
|
|
|
13385
13879
|
"$ref": "#/components/schemas/customer_supportListResponseItem"
|
|
13386
13880
|
},
|
|
13387
13881
|
"x-displayname": "Items",
|
|
13882
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
13883
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
13388
13884
|
"x-f5xc-required-for": {
|
|
13389
13885
|
"minimum_config": false,
|
|
13390
13886
|
"create": false,
|
|
@@ -13393,6 +13889,7 @@
|
|
|
13393
13889
|
}
|
|
13394
13890
|
}
|
|
13395
13891
|
},
|
|
13892
|
+
"x-f5xc-description-short": "Output message of 'ListCTSupportTickets' RPC.",
|
|
13396
13893
|
"x-f5xc-minimum-configuration": {
|
|
13397
13894
|
"description": "Minimum configuration for customer_supportListSupportResponse",
|
|
13398
13895
|
"required_fields": [
|
|
@@ -13420,6 +13917,7 @@
|
|
|
13420
13917
|
"x-displayname": "Name",
|
|
13421
13918
|
"x-ves-example": "Value",
|
|
13422
13919
|
"x-f5xc-example": "value",
|
|
13920
|
+
"x-f5xc-description-short": "The name of the customer support ticket object to have its priority changed.",
|
|
13423
13921
|
"minLength": 0,
|
|
13424
13922
|
"maxLength": 16,
|
|
13425
13923
|
"x-f5xc-required-for": {
|
|
@@ -13430,7 +13928,7 @@
|
|
|
13430
13928
|
},
|
|
13431
13929
|
"x-original-maxLength": 1024,
|
|
13432
13930
|
"x-reconciled-from-discovery": true,
|
|
13433
|
-
"x-reconciled-at": "2026-01-
|
|
13931
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688963+00:00"
|
|
13434
13932
|
},
|
|
13435
13933
|
"namespace": {
|
|
13436
13934
|
"type": "string",
|
|
@@ -13439,6 +13937,7 @@
|
|
|
13439
13937
|
"x-displayname": "Namespace",
|
|
13440
13938
|
"x-ves-example": "Value",
|
|
13441
13939
|
"x-f5xc-example": "value",
|
|
13940
|
+
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
|
|
13442
13941
|
"minLength": 0,
|
|
13443
13942
|
"maxLength": 6,
|
|
13444
13943
|
"x-f5xc-required-for": {
|
|
@@ -13449,12 +13948,13 @@
|
|
|
13449
13948
|
},
|
|
13450
13949
|
"x-original-maxLength": 1024,
|
|
13451
13950
|
"x-reconciled-from-discovery": true,
|
|
13452
|
-
"x-reconciled-at": "2026-01-
|
|
13951
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688968+00:00"
|
|
13453
13952
|
},
|
|
13454
13953
|
"priority": {
|
|
13455
13954
|
"$ref": "#/components/schemas/customer_supportSupportTicketPriority"
|
|
13456
13955
|
}
|
|
13457
13956
|
},
|
|
13957
|
+
"x-f5xc-description-short": "Changes priority of an existing customer support ticket.",
|
|
13458
13958
|
"x-f5xc-minimum-configuration": {
|
|
13459
13959
|
"description": "Minimum configuration for customer_supportPriorityRequest",
|
|
13460
13960
|
"required_fields": [
|
|
@@ -13480,6 +13980,7 @@
|
|
|
13480
13980
|
"$ref": "#/components/schemas/schemacustomer_supportErrorCode"
|
|
13481
13981
|
}
|
|
13482
13982
|
},
|
|
13983
|
+
"x-f5xc-description-short": "Gives details of result of changing priority a customer support ticket.",
|
|
13483
13984
|
"x-f5xc-minimum-configuration": {
|
|
13484
13985
|
"description": "Minimum configuration for customer_supportPriorityResponse",
|
|
13485
13986
|
"required_fields": [
|
|
@@ -13507,6 +14008,8 @@
|
|
|
13507
14008
|
"$ref": "#/components/schemas/customer_supportAttachmentType"
|
|
13508
14009
|
},
|
|
13509
14010
|
"x-displayname": "Attachments details.",
|
|
14011
|
+
"x-f5xc-description-short": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
|
|
14012
|
+
"x-f5xc-description-medium": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
|
|
13510
14013
|
"x-f5xc-required-for": {
|
|
13511
14014
|
"minimum_config": false,
|
|
13512
14015
|
"create": false,
|
|
@@ -13521,6 +14024,7 @@
|
|
|
13521
14024
|
"x-displayname": "Description.",
|
|
13522
14025
|
"x-ves-example": "Requesting a tax exemption status review as we'RE a not-for-profit organisation.",
|
|
13523
14026
|
"x-f5xc-example": "requesting a tax exemption status review as we're a not-for-profit organisation",
|
|
14027
|
+
"x-f5xc-description-short": "Description introducing reasons for tax exemption status verification.",
|
|
13524
14028
|
"minLength": 0,
|
|
13525
14029
|
"maxLength": 1024,
|
|
13526
14030
|
"x-f5xc-required-for": {
|
|
@@ -13531,6 +14035,8 @@
|
|
|
13531
14035
|
}
|
|
13532
14036
|
}
|
|
13533
14037
|
},
|
|
14038
|
+
"x-f5xc-description-short": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S.",
|
|
14039
|
+
"x-f5xc-description-medium": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S. Only).",
|
|
13534
14040
|
"x-f5xc-minimum-configuration": {
|
|
13535
14041
|
"description": "Minimum configuration for customer_supportRaiseTaxExemptVerificationSupportTicketRequest",
|
|
13536
14042
|
"required_fields": [
|
|
@@ -13559,6 +14065,7 @@
|
|
|
13559
14065
|
"description": "X-displayName : \"Name\"\nname of the ticket created on the back of the request.",
|
|
13560
14066
|
"title": "Name of ticket.",
|
|
13561
14067
|
"x-f5xc-example": "example-resource",
|
|
14068
|
+
"x-f5xc-description-short": "X-displayName : \"Name\" name of the ticket created on the back of the request.",
|
|
13562
14069
|
"minLength": 0,
|
|
13563
14070
|
"maxLength": 16,
|
|
13564
14071
|
"x-f5xc-required-for": {
|
|
@@ -13569,9 +14076,11 @@
|
|
|
13569
14076
|
},
|
|
13570
14077
|
"x-original-maxLength": 1024,
|
|
13571
14078
|
"x-reconciled-from-discovery": true,
|
|
13572
|
-
"x-reconciled-at": "2026-01-
|
|
14079
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688980+00:00"
|
|
13573
14080
|
}
|
|
13574
14081
|
},
|
|
14082
|
+
"x-f5xc-description-short": "Any error that may occurred during tax status verification request.",
|
|
14083
|
+
"x-f5xc-description-medium": "Any error that may occurred during tax status verification request. Note that the verification process itself takes a lot of time (days) - this message only indicates the reception of the request.",
|
|
13575
14084
|
"x-f5xc-minimum-configuration": {
|
|
13576
14085
|
"description": "Minimum configuration for customer_supportRaiseTaxExemptVerificationSupportTicketResponse",
|
|
13577
14086
|
"required_fields": [
|
|
@@ -13599,6 +14108,7 @@
|
|
|
13599
14108
|
"x-displayname": "Name",
|
|
13600
14109
|
"x-ves-example": "Value",
|
|
13601
14110
|
"x-f5xc-example": "value",
|
|
14111
|
+
"x-f5xc-description-short": "The name of the customer support ticket object to be open again.",
|
|
13602
14112
|
"minLength": 0,
|
|
13603
14113
|
"maxLength": 16,
|
|
13604
14114
|
"x-f5xc-required-for": {
|
|
@@ -13609,7 +14119,7 @@
|
|
|
13609
14119
|
},
|
|
13610
14120
|
"x-original-maxLength": 1024,
|
|
13611
14121
|
"x-reconciled-from-discovery": true,
|
|
13612
|
-
"x-reconciled-at": "2026-01-
|
|
14122
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688984+00:00"
|
|
13613
14123
|
},
|
|
13614
14124
|
"namespace": {
|
|
13615
14125
|
"type": "string",
|
|
@@ -13618,6 +14128,7 @@
|
|
|
13618
14128
|
"x-displayname": "Namespace",
|
|
13619
14129
|
"x-ves-example": "Value",
|
|
13620
14130
|
"x-f5xc-example": "value",
|
|
14131
|
+
"x-f5xc-description-short": "The namespace in which the support ticket object is present.",
|
|
13621
14132
|
"minLength": 0,
|
|
13622
14133
|
"maxLength": 6,
|
|
13623
14134
|
"x-f5xc-required-for": {
|
|
@@ -13628,9 +14139,10 @@
|
|
|
13628
14139
|
},
|
|
13629
14140
|
"x-original-maxLength": 1024,
|
|
13630
14141
|
"x-reconciled-from-discovery": true,
|
|
13631
|
-
"x-reconciled-at": "2026-01-
|
|
14142
|
+
"x-reconciled-at": "2026-01-07T15:28:26.688989+00:00"
|
|
13632
14143
|
}
|
|
13633
14144
|
},
|
|
14145
|
+
"x-f5xc-description-short": "Reopens a closed existing customer support ticket.",
|
|
13634
14146
|
"x-f5xc-minimum-configuration": {
|
|
13635
14147
|
"description": "Minimum configuration for customer_supportReopenRequest",
|
|
13636
14148
|
"required_fields": [
|
|
@@ -13655,6 +14167,7 @@
|
|
|
13655
14167
|
"$ref": "#/components/schemas/schemacustomer_supportErrorCode"
|
|
13656
14168
|
}
|
|
13657
14169
|
},
|
|
14170
|
+
"x-f5xc-description-short": "Gives details of result of reopening a customer support ticket.",
|
|
13658
14171
|
"x-f5xc-minimum-configuration": {
|
|
13659
14172
|
"description": "Minimum configuration for customer_supportReopenResponse",
|
|
13660
14173
|
"required_fields": [
|
|
@@ -13708,6 +14221,7 @@
|
|
|
13708
14221
|
}
|
|
13709
14222
|
}
|
|
13710
14223
|
},
|
|
14224
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
13711
14225
|
"x-f5xc-minimum-configuration": {
|
|
13712
14226
|
"description": "Minimum configuration for customer_supportStatusObject",
|
|
13713
14227
|
"required_fields": [
|
|
@@ -13759,6 +14273,8 @@
|
|
|
13759
14273
|
"default": "SS_UNKNOWN",
|
|
13760
14274
|
"x-displayname": "Support Service.",
|
|
13761
14275
|
"x-ves-proto-enum": "ves.io.schema.customer_support.SupportService",
|
|
14276
|
+
"x-f5xc-description-short": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application...",
|
|
14277
|
+
"x-f5xc-description-medium": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application Traffic Insight Support Service Audit Logs & Alerts Support Service Authentication Intelligence Support Service Billing Support Service Client Side Defense...",
|
|
13762
14278
|
"x-f5xc-minimum-configuration": {
|
|
13763
14279
|
"description": "Minimum configuration for customer_supportSupportService",
|
|
13764
14280
|
"required_fields": [],
|
|
@@ -13782,6 +14298,8 @@
|
|
|
13782
14298
|
"default": "PRIORITY_UNKNOWN",
|
|
13783
14299
|
"x-displayname": "Priority",
|
|
13784
14300
|
"x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketPriority",
|
|
14301
|
+
"x-f5xc-description-short": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues.",
|
|
14302
|
+
"x-f5xc-description-medium": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues. Unknown/empty priority Normal priority issue High priority issue Urgent priority issue.",
|
|
13785
14303
|
"x-f5xc-minimum-configuration": {
|
|
13786
14304
|
"description": "Minimum configuration for customer_supportSupportTicketPriority",
|
|
13787
14305
|
"required_fields": [],
|
|
@@ -13809,6 +14327,8 @@
|
|
|
13809
14327
|
"default": "STATUS_UNKNOWN",
|
|
13810
14328
|
"x-displayname": "Support Ticket Status.",
|
|
13811
14329
|
"x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketStatus",
|
|
14330
|
+
"x-f5xc-description-short": "State of the ticket so the customers know if the problem is being looked into Unknown or empty support ticket status Indicates a new ticket...",
|
|
14331
|
+
"x-f5xc-description-medium": "State of the ticket so the customers know if the problem is being looked into Unknown or empty support ticket status Indicates a new ticket, waiting to be assigned to an agent Indicates an open issues, actively being looked into Indicates a pending issue, an open issue not actively being looked...",
|
|
13812
14332
|
"x-f5xc-minimum-configuration": {
|
|
13813
14333
|
"description": "Minimum configuration for customer_supportSupportTicketStatus",
|
|
13814
14334
|
"required_fields": [],
|
|
@@ -13836,6 +14356,8 @@
|
|
|
13836
14356
|
"default": "TYPE_UNKNOWN",
|
|
13837
14357
|
"x-displayname": "Support Ticket.",
|
|
13838
14358
|
"x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketType",
|
|
14359
|
+
"x-f5xc-description-short": "Several types of issues are supported, such as problems, questions. Unknown or empty ticket type Indicates a problem (e.g.",
|
|
14360
|
+
"x-f5xc-description-medium": "Several types of issues are supported, such as problems, questions. Unknown or empty ticket type Indicates a problem (e.g. Misconfiguration) Indicates a task (a request to do something) Indicates a question (billing, services related) Indicates an incident (something is not working) Indicates a...",
|
|
13839
14361
|
"x-f5xc-minimum-configuration": {
|
|
13840
14362
|
"description": "Minimum configuration for customer_supportSupportTicketType",
|
|
13841
14363
|
"required_fields": [],
|
|
@@ -13880,6 +14402,8 @@
|
|
|
13880
14402
|
"default": "TOPIC_UNKNOWN",
|
|
13881
14403
|
"x-displayname": "Support Topic.",
|
|
13882
14404
|
"x-ves-proto-enum": "ves.io.schema.customer_support.SupportTopic",
|
|
14405
|
+
"x-f5xc-description-short": "Support Topic indicates the list of topics for service tickets Unknown/empty priority ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST...",
|
|
14406
|
+
"x-f5xc-description-medium": "Support Topic indicates the list of topics for service tickets Unknown/empty priority ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST ACCOUNT_SUPPORT_TOPIC_ACCOUNT ACCOUNT_SUPPORT_TOPIC_BILLING ACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE ACCOUNT_SUPPORT_TOPIC_PUBLIC_IP ACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE...",
|
|
13883
14407
|
"x-f5xc-minimum-configuration": {
|
|
13884
14408
|
"description": "Minimum configuration for customer_supportSupportTopic",
|
|
13885
14409
|
"required_fields": [],
|
|
@@ -13908,6 +14432,8 @@
|
|
|
13908
14432
|
"default": "EOK",
|
|
13909
14433
|
"x-displayname": "Error Code.",
|
|
13910
14434
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
14435
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
14436
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
13911
14437
|
"x-f5xc-minimum-configuration": {
|
|
13912
14438
|
"description": "Minimum configuration for ioschemaErrorCode",
|
|
13913
14439
|
"required_fields": [],
|
|
@@ -13925,6 +14451,8 @@
|
|
|
13925
14451
|
"type_url": {
|
|
13926
14452
|
"type": "string",
|
|
13927
14453
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.",
|
|
14454
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
14455
|
+
"x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
|
|
13928
14456
|
"minLength": 0,
|
|
13929
14457
|
"maxLength": 1024,
|
|
13930
14458
|
"x-f5xc-required-for": {
|
|
@@ -13948,9 +14476,11 @@
|
|
|
13948
14476
|
},
|
|
13949
14477
|
"x-original-maxLength": 1024,
|
|
13950
14478
|
"x-reconciled-from-discovery": true,
|
|
13951
|
-
"x-reconciled-at": "2026-01-
|
|
14479
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689002+00:00"
|
|
13952
14480
|
}
|
|
13953
14481
|
},
|
|
14482
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
14483
|
+
"x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
|
|
13954
14484
|
"x-f5xc-minimum-configuration": {
|
|
13955
14485
|
"description": "Minimum configuration for protobufAny",
|
|
13956
14486
|
"required_fields": [
|
|
@@ -13976,6 +14506,8 @@
|
|
|
13976
14506
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
13977
14507
|
"title": "Hostname",
|
|
13978
14508
|
"x-displayname": "Hostname",
|
|
14509
|
+
"x-f5xc-example": "example-resource",
|
|
14510
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
13979
14511
|
"minLength": 0,
|
|
13980
14512
|
"maxLength": 1024,
|
|
13981
14513
|
"x-f5xc-required-for": {
|
|
@@ -14007,6 +14539,8 @@
|
|
|
14007
14539
|
"x-displayname": "Reason",
|
|
14008
14540
|
"x-ves-example": "Value",
|
|
14009
14541
|
"x-f5xc-example": "value",
|
|
14542
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
14543
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
14010
14544
|
"minLength": 0,
|
|
14011
14545
|
"maxLength": 43,
|
|
14012
14546
|
"x-f5xc-required-for": {
|
|
@@ -14017,13 +14551,15 @@
|
|
|
14017
14551
|
},
|
|
14018
14552
|
"x-original-maxLength": 1024,
|
|
14019
14553
|
"x-reconciled-from-discovery": true,
|
|
14020
|
-
"x-reconciled-at": "2026-01-
|
|
14554
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689009+00:00"
|
|
14021
14555
|
},
|
|
14022
14556
|
"service_name": {
|
|
14023
14557
|
"type": "string",
|
|
14024
14558
|
"description": "Name of the service that sent the status.",
|
|
14025
14559
|
"title": "Service name.",
|
|
14026
14560
|
"x-displayname": "Service Name.",
|
|
14561
|
+
"x-f5xc-example": "example-resource",
|
|
14562
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
14027
14563
|
"minLength": 0,
|
|
14028
14564
|
"maxLength": 1024,
|
|
14029
14565
|
"x-f5xc-required-for": {
|
|
@@ -14046,6 +14582,8 @@
|
|
|
14046
14582
|
"x-validation-rules": {
|
|
14047
14583
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
14048
14584
|
},
|
|
14585
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
14586
|
+
"x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
|
|
14049
14587
|
"minLength": 0,
|
|
14050
14588
|
"maxLength": 17,
|
|
14051
14589
|
"x-f5xc-required-for": {
|
|
@@ -14056,7 +14594,7 @@
|
|
|
14056
14594
|
},
|
|
14057
14595
|
"x-original-maxLength": 1024,
|
|
14058
14596
|
"x-reconciled-from-discovery": true,
|
|
14059
|
-
"x-reconciled-at": "2026-01-
|
|
14597
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689015+00:00"
|
|
14060
14598
|
},
|
|
14061
14599
|
"type": {
|
|
14062
14600
|
"type": "string",
|
|
@@ -14071,6 +14609,8 @@
|
|
|
14071
14609
|
"x-validation-rules": {
|
|
14072
14610
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
14073
14611
|
},
|
|
14612
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
14613
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
14074
14614
|
"minLength": 0,
|
|
14075
14615
|
"maxLength": 1024,
|
|
14076
14616
|
"x-f5xc-required-for": {
|
|
@@ -14081,6 +14621,8 @@
|
|
|
14081
14621
|
}
|
|
14082
14622
|
}
|
|
14083
14623
|
},
|
|
14624
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
14625
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
14084
14626
|
"x-f5xc-minimum-configuration": {
|
|
14085
14627
|
"description": "Minimum configuration for schemaConditionType",
|
|
14086
14628
|
"required_fields": [
|
|
@@ -14128,6 +14670,7 @@
|
|
|
14128
14670
|
}
|
|
14129
14671
|
}
|
|
14130
14672
|
},
|
|
14673
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
14131
14674
|
"x-f5xc-minimum-configuration": {
|
|
14132
14675
|
"description": "Minimum configuration for schemaErrorType",
|
|
14133
14676
|
"required_fields": [
|
|
@@ -14155,6 +14698,7 @@
|
|
|
14155
14698
|
"title": "Name",
|
|
14156
14699
|
"x-displayname": "Name",
|
|
14157
14700
|
"x-f5xc-example": "example-resource",
|
|
14701
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
14158
14702
|
"minLength": 0,
|
|
14159
14703
|
"maxLength": 16,
|
|
14160
14704
|
"x-f5xc-required-for": {
|
|
@@ -14165,9 +14709,10 @@
|
|
|
14165
14709
|
},
|
|
14166
14710
|
"x-original-maxLength": 1024,
|
|
14167
14711
|
"x-reconciled-from-discovery": true,
|
|
14168
|
-
"x-reconciled-at": "2026-01-
|
|
14712
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689026+00:00"
|
|
14169
14713
|
}
|
|
14170
14714
|
},
|
|
14715
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
14171
14716
|
"x-f5xc-minimum-configuration": {
|
|
14172
14717
|
"description": "Minimum configuration for schemaInitializerType",
|
|
14173
14718
|
"required_fields": [
|
|
@@ -14195,6 +14740,8 @@
|
|
|
14195
14740
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
14196
14741
|
},
|
|
14197
14742
|
"x-displayname": "Pending",
|
|
14743
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
14744
|
+
"x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
|
|
14198
14745
|
"x-f5xc-required-for": {
|
|
14199
14746
|
"minimum_config": false,
|
|
14200
14747
|
"create": false,
|
|
@@ -14206,6 +14753,7 @@
|
|
|
14206
14753
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
14207
14754
|
}
|
|
14208
14755
|
},
|
|
14756
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
14209
14757
|
"x-f5xc-minimum-configuration": {
|
|
14210
14758
|
"description": "Minimum configuration for schemaInitializersType",
|
|
14211
14759
|
"required_fields": [
|
|
@@ -14244,6 +14792,8 @@
|
|
|
14244
14792
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
14245
14793
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
14246
14794
|
},
|
|
14795
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
14796
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
14247
14797
|
"x-f5xc-required-for": {
|
|
14248
14798
|
"minimum_config": false,
|
|
14249
14799
|
"create": false,
|
|
@@ -14265,6 +14815,7 @@
|
|
|
14265
14815
|
"x-validation-rules": {
|
|
14266
14816
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
14267
14817
|
},
|
|
14818
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
14268
14819
|
"minLength": 0,
|
|
14269
14820
|
"x-f5xc-required-for": {
|
|
14270
14821
|
"minimum_config": false,
|
|
@@ -14274,7 +14825,7 @@
|
|
|
14274
14825
|
},
|
|
14275
14826
|
"x-original-maxLength": 1200,
|
|
14276
14827
|
"x-reconciled-from-discovery": true,
|
|
14277
|
-
"x-reconciled-at": "2026-01-
|
|
14828
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689035+00:00"
|
|
14278
14829
|
},
|
|
14279
14830
|
"disable": {
|
|
14280
14831
|
"type": "boolean",
|
|
@@ -14283,6 +14834,7 @@
|
|
|
14283
14834
|
"format": "boolean",
|
|
14284
14835
|
"x-displayname": "Disable",
|
|
14285
14836
|
"x-f5xc-example": "true",
|
|
14837
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
14286
14838
|
"x-f5xc-required-for": {
|
|
14287
14839
|
"minimum_config": false,
|
|
14288
14840
|
"create": false,
|
|
@@ -14296,6 +14848,8 @@
|
|
|
14296
14848
|
"title": "Labels",
|
|
14297
14849
|
"x-displayname": "Labels",
|
|
14298
14850
|
"x-f5xc-example": "value",
|
|
14851
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
14852
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
14299
14853
|
"x-f5xc-required-for": {
|
|
14300
14854
|
"minimum_config": false,
|
|
14301
14855
|
"create": false,
|
|
@@ -14317,6 +14871,8 @@
|
|
|
14317
14871
|
"x-validation-rules": {
|
|
14318
14872
|
"ves.io.schema.rules.message.required": "true"
|
|
14319
14873
|
},
|
|
14874
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
14875
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
14320
14876
|
"minLength": 0,
|
|
14321
14877
|
"maxLength": 16,
|
|
14322
14878
|
"x-f5xc-required-for": {
|
|
@@ -14327,7 +14883,7 @@
|
|
|
14327
14883
|
},
|
|
14328
14884
|
"x-original-maxLength": 1024,
|
|
14329
14885
|
"x-reconciled-from-discovery": true,
|
|
14330
|
-
"x-reconciled-at": "2026-01-
|
|
14886
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689044+00:00"
|
|
14331
14887
|
},
|
|
14332
14888
|
"namespace": {
|
|
14333
14889
|
"type": "string",
|
|
@@ -14336,6 +14892,8 @@
|
|
|
14336
14892
|
"x-displayname": "Namespace",
|
|
14337
14893
|
"x-ves-example": "Staging",
|
|
14338
14894
|
"x-f5xc-example": "staging",
|
|
14895
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
14896
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
14339
14897
|
"minLength": 0,
|
|
14340
14898
|
"maxLength": 6,
|
|
14341
14899
|
"x-f5xc-required-for": {
|
|
@@ -14346,9 +14904,10 @@
|
|
|
14346
14904
|
},
|
|
14347
14905
|
"x-original-maxLength": 1024,
|
|
14348
14906
|
"x-reconciled-from-discovery": true,
|
|
14349
|
-
"x-reconciled-at": "2026-01-
|
|
14907
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689048+00:00"
|
|
14350
14908
|
}
|
|
14351
14909
|
},
|
|
14910
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
14352
14911
|
"x-f5xc-minimum-configuration": {
|
|
14353
14912
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
14354
14913
|
"required_fields": [
|
|
@@ -14392,6 +14951,8 @@
|
|
|
14392
14951
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
14393
14952
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
14394
14953
|
},
|
|
14954
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
14955
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
14395
14956
|
"x-f5xc-required-for": {
|
|
14396
14957
|
"minimum_config": false,
|
|
14397
14958
|
"create": false,
|
|
@@ -14413,6 +14974,7 @@
|
|
|
14413
14974
|
"x-validation-rules": {
|
|
14414
14975
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
14415
14976
|
},
|
|
14977
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
14416
14978
|
"minLength": 0,
|
|
14417
14979
|
"x-f5xc-required-for": {
|
|
14418
14980
|
"minimum_config": false,
|
|
@@ -14422,7 +14984,7 @@
|
|
|
14422
14984
|
},
|
|
14423
14985
|
"x-original-maxLength": 1200,
|
|
14424
14986
|
"x-reconciled-from-discovery": true,
|
|
14425
|
-
"x-reconciled-at": "2026-01-
|
|
14987
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689055+00:00"
|
|
14426
14988
|
},
|
|
14427
14989
|
"disable": {
|
|
14428
14990
|
"type": "boolean",
|
|
@@ -14432,6 +14994,7 @@
|
|
|
14432
14994
|
"x-displayname": "Disable",
|
|
14433
14995
|
"x-ves-example": "True",
|
|
14434
14996
|
"x-f5xc-example": "true",
|
|
14997
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
14435
14998
|
"x-f5xc-required-for": {
|
|
14436
14999
|
"minimum_config": false,
|
|
14437
15000
|
"create": false,
|
|
@@ -14446,6 +15009,8 @@
|
|
|
14446
15009
|
"x-displayname": "Labels",
|
|
14447
15010
|
"x-ves-example": "Value",
|
|
14448
15011
|
"x-f5xc-example": "value",
|
|
15012
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
15013
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
14449
15014
|
"x-f5xc-required-for": {
|
|
14450
15015
|
"minimum_config": false,
|
|
14451
15016
|
"create": false,
|
|
@@ -14467,6 +15032,8 @@
|
|
|
14467
15032
|
"x-validation-rules": {
|
|
14468
15033
|
"ves.io.schema.rules.message.required": "true"
|
|
14469
15034
|
},
|
|
15035
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
15036
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
14470
15037
|
"minLength": 0,
|
|
14471
15038
|
"maxLength": 16,
|
|
14472
15039
|
"x-f5xc-required-for": {
|
|
@@ -14477,7 +15044,7 @@
|
|
|
14477
15044
|
},
|
|
14478
15045
|
"x-original-maxLength": 1024,
|
|
14479
15046
|
"x-reconciled-from-discovery": true,
|
|
14480
|
-
"x-reconciled-at": "2026-01-
|
|
15047
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689063+00:00"
|
|
14481
15048
|
},
|
|
14482
15049
|
"namespace": {
|
|
14483
15050
|
"type": "string",
|
|
@@ -14486,6 +15053,8 @@
|
|
|
14486
15053
|
"x-displayname": "Namespace",
|
|
14487
15054
|
"x-ves-example": "Staging",
|
|
14488
15055
|
"x-f5xc-example": "staging",
|
|
15056
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
15057
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
14489
15058
|
"minLength": 0,
|
|
14490
15059
|
"maxLength": 6,
|
|
14491
15060
|
"x-f5xc-required-for": {
|
|
@@ -14496,9 +15065,10 @@
|
|
|
14496
15065
|
},
|
|
14497
15066
|
"x-original-maxLength": 1024,
|
|
14498
15067
|
"x-reconciled-from-discovery": true,
|
|
14499
|
-
"x-reconciled-at": "2026-01-
|
|
15068
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689067+00:00"
|
|
14500
15069
|
}
|
|
14501
15070
|
},
|
|
15071
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
14502
15072
|
"x-f5xc-minimum-configuration": {
|
|
14503
15073
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
14504
15074
|
"required_fields": [
|
|
@@ -14530,6 +15100,8 @@
|
|
|
14530
15100
|
"x-displayname": "Kind",
|
|
14531
15101
|
"x-ves-example": "Virtual_site.",
|
|
14532
15102
|
"x-f5xc-example": "virtual_site",
|
|
15103
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
15104
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
14533
15105
|
"minLength": 0,
|
|
14534
15106
|
"maxLength": 14,
|
|
14535
15107
|
"x-f5xc-required-for": {
|
|
@@ -14541,7 +15113,7 @@
|
|
|
14541
15113
|
"readOnly": true,
|
|
14542
15114
|
"x-original-maxLength": 1024,
|
|
14543
15115
|
"x-reconciled-from-discovery": true,
|
|
14544
|
-
"x-reconciled-at": "2026-01-
|
|
15116
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689071+00:00"
|
|
14545
15117
|
},
|
|
14546
15118
|
"name": {
|
|
14547
15119
|
"type": "string",
|
|
@@ -14550,6 +15122,8 @@
|
|
|
14550
15122
|
"x-displayname": "Name",
|
|
14551
15123
|
"x-ves-example": "Contactus-route.",
|
|
14552
15124
|
"x-f5xc-example": "contactus-route",
|
|
15125
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
15126
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
14553
15127
|
"minLength": 0,
|
|
14554
15128
|
"maxLength": 16,
|
|
14555
15129
|
"x-f5xc-required-for": {
|
|
@@ -14560,7 +15134,7 @@
|
|
|
14560
15134
|
},
|
|
14561
15135
|
"x-original-maxLength": 1024,
|
|
14562
15136
|
"x-reconciled-from-discovery": true,
|
|
14563
|
-
"x-reconciled-at": "2026-01-
|
|
15137
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689076+00:00"
|
|
14564
15138
|
},
|
|
14565
15139
|
"namespace": {
|
|
14566
15140
|
"type": "string",
|
|
@@ -14569,6 +15143,8 @@
|
|
|
14569
15143
|
"x-displayname": "Namespace",
|
|
14570
15144
|
"x-ves-example": "Ns1",
|
|
14571
15145
|
"x-f5xc-example": "ns1",
|
|
15146
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
15147
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
14572
15148
|
"minLength": 0,
|
|
14573
15149
|
"maxLength": 6,
|
|
14574
15150
|
"x-f5xc-required-for": {
|
|
@@ -14579,7 +15155,7 @@
|
|
|
14579
15155
|
},
|
|
14580
15156
|
"x-original-maxLength": 1024,
|
|
14581
15157
|
"x-reconciled-from-discovery": true,
|
|
14582
|
-
"x-reconciled-at": "2026-01-
|
|
15158
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689080+00:00"
|
|
14583
15159
|
},
|
|
14584
15160
|
"tenant": {
|
|
14585
15161
|
"type": "string",
|
|
@@ -14588,6 +15164,8 @@
|
|
|
14588
15164
|
"x-displayname": "Tenant",
|
|
14589
15165
|
"x-ves-example": "Example-corp.",
|
|
14590
15166
|
"x-f5xc-example": "example-corp",
|
|
15167
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
15168
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
14591
15169
|
"minLength": 0,
|
|
14592
15170
|
"maxLength": 18,
|
|
14593
15171
|
"x-f5xc-required-for": {
|
|
@@ -14600,7 +15178,7 @@
|
|
|
14600
15178
|
"x-field-mutability": "read-only",
|
|
14601
15179
|
"x-original-maxLength": 1024,
|
|
14602
15180
|
"x-reconciled-from-discovery": true,
|
|
14603
|
-
"x-reconciled-at": "2026-01-
|
|
15181
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689084+00:00"
|
|
14604
15182
|
},
|
|
14605
15183
|
"uid": {
|
|
14606
15184
|
"type": "string",
|
|
@@ -14609,6 +15187,8 @@
|
|
|
14609
15187
|
"x-displayname": "UID",
|
|
14610
15188
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
14611
15189
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
15190
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
15191
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
14612
15192
|
"minLength": 0,
|
|
14613
15193
|
"maxLength": 36,
|
|
14614
15194
|
"x-f5xc-required-for": {
|
|
@@ -14622,9 +15202,11 @@
|
|
|
14622
15202
|
"x-original-maxLength": 1024,
|
|
14623
15203
|
"format": "uuid",
|
|
14624
15204
|
"x-reconciled-from-discovery": true,
|
|
14625
|
-
"x-reconciled-at": "2026-01-
|
|
15205
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689090+00:00"
|
|
14626
15206
|
}
|
|
14627
15207
|
},
|
|
15208
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
15209
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
14628
15210
|
"x-f5xc-minimum-configuration": {
|
|
14629
15211
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
14630
15212
|
"required_fields": [
|
|
@@ -14654,6 +15236,8 @@
|
|
|
14654
15236
|
"title": "Creation_timestamp.",
|
|
14655
15237
|
"format": "date-time",
|
|
14656
15238
|
"x-displayname": "Creation Timestamp.",
|
|
15239
|
+
"x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
15240
|
+
"x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
14657
15241
|
"minLength": 0,
|
|
14658
15242
|
"maxLength": 1024,
|
|
14659
15243
|
"x-f5xc-required-for": {
|
|
@@ -14671,6 +15255,8 @@
|
|
|
14671
15255
|
"x-displayname": "Creator Class.",
|
|
14672
15256
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
14673
15257
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
15258
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
15259
|
+
"x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
|
|
14674
15260
|
"minLength": 0,
|
|
14675
15261
|
"maxLength": 1024,
|
|
14676
15262
|
"x-f5xc-required-for": {
|
|
@@ -14688,6 +15274,8 @@
|
|
|
14688
15274
|
"x-displayname": "Creator ID.",
|
|
14689
15275
|
"x-ves-example": "Ver-instance-1.",
|
|
14690
15276
|
"x-f5xc-example": "ver-instance-1",
|
|
15277
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
15278
|
+
"x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
|
|
14691
15279
|
"minLength": 0,
|
|
14692
15280
|
"maxLength": 1024,
|
|
14693
15281
|
"x-f5xc-required-for": {
|
|
@@ -14706,6 +15294,8 @@
|
|
|
14706
15294
|
"description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
|
|
14707
15295
|
"title": "Status_id",
|
|
14708
15296
|
"x-displayname": "Status ID",
|
|
15297
|
+
"x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
|
|
15298
|
+
"x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
|
|
14709
15299
|
"minLength": 0,
|
|
14710
15300
|
"maxLength": 1024,
|
|
14711
15301
|
"x-f5xc-required-for": {
|
|
@@ -14723,6 +15313,7 @@
|
|
|
14723
15313
|
"x-displayname": "UID",
|
|
14724
15314
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
14725
15315
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
15316
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
14726
15317
|
"minLength": 0,
|
|
14727
15318
|
"maxLength": 36,
|
|
14728
15319
|
"x-f5xc-required-for": {
|
|
@@ -14735,13 +15326,14 @@
|
|
|
14735
15326
|
"x-original-maxLength": 1024,
|
|
14736
15327
|
"format": "uuid",
|
|
14737
15328
|
"x-reconciled-from-discovery": true,
|
|
14738
|
-
"x-reconciled-at": "2026-01-
|
|
15329
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689102+00:00"
|
|
14739
15330
|
},
|
|
14740
15331
|
"vtrp_id": {
|
|
14741
15332
|
"type": "string",
|
|
14742
15333
|
"description": "Origin of this status exchanged by VTRP.",
|
|
14743
15334
|
"title": "Vtrp_id",
|
|
14744
15335
|
"x-displayname": "VTRP ID",
|
|
15336
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
14745
15337
|
"minLength": 0,
|
|
14746
15338
|
"maxLength": 1024,
|
|
14747
15339
|
"x-f5xc-required-for": {
|
|
@@ -14758,6 +15350,7 @@
|
|
|
14758
15350
|
"title": "Vtrp_stale.",
|
|
14759
15351
|
"format": "boolean",
|
|
14760
15352
|
"x-displayname": "VTRP Stale.",
|
|
15353
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
14761
15354
|
"x-f5xc-required-for": {
|
|
14762
15355
|
"minimum_config": false,
|
|
14763
15356
|
"create": false,
|
|
@@ -14766,6 +15359,7 @@
|
|
|
14766
15359
|
}
|
|
14767
15360
|
}
|
|
14768
15361
|
},
|
|
15362
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
14769
15363
|
"x-f5xc-minimum-configuration": {
|
|
14770
15364
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
14771
15365
|
"required_fields": [
|
|
@@ -14796,6 +15390,8 @@
|
|
|
14796
15390
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
14797
15391
|
"x-displayname": "Status Publish Type.",
|
|
14798
15392
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
15393
|
+
"x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
|
|
15394
|
+
"x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
|
|
14799
15395
|
"x-f5xc-minimum-configuration": {
|
|
14800
15396
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
14801
15397
|
"required_fields": [],
|
|
@@ -14821,6 +15417,7 @@
|
|
|
14821
15417
|
"x-displayname": "Code",
|
|
14822
15418
|
"x-ves-example": "0",
|
|
14823
15419
|
"x-f5xc-example": "0",
|
|
15420
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
14824
15421
|
"minimum": 0,
|
|
14825
15422
|
"maximum": 2147483647,
|
|
14826
15423
|
"x-f5xc-required-for": {
|
|
@@ -14837,6 +15434,8 @@
|
|
|
14837
15434
|
"x-displayname": "Reason",
|
|
14838
15435
|
"x-ves-example": "Value",
|
|
14839
15436
|
"x-f5xc-example": "value",
|
|
15437
|
+
"x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
15438
|
+
"x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
14840
15439
|
"minLength": 0,
|
|
14841
15440
|
"maxLength": 43,
|
|
14842
15441
|
"x-f5xc-required-for": {
|
|
@@ -14847,7 +15446,7 @@
|
|
|
14847
15446
|
},
|
|
14848
15447
|
"x-original-maxLength": 1024,
|
|
14849
15448
|
"x-reconciled-from-discovery": true,
|
|
14850
|
-
"x-reconciled-at": "2026-01-
|
|
15449
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689111+00:00"
|
|
14851
15450
|
},
|
|
14852
15451
|
"status": {
|
|
14853
15452
|
"type": "string",
|
|
@@ -14856,6 +15455,7 @@
|
|
|
14856
15455
|
"x-displayname": "Status",
|
|
14857
15456
|
"x-ves-example": "Value",
|
|
14858
15457
|
"x-f5xc-example": "value",
|
|
15458
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
14859
15459
|
"minLength": 0,
|
|
14860
15460
|
"maxLength": 17,
|
|
14861
15461
|
"x-f5xc-required-for": {
|
|
@@ -14866,9 +15466,10 @@
|
|
|
14866
15466
|
},
|
|
14867
15467
|
"x-original-maxLength": 1024,
|
|
14868
15468
|
"x-reconciled-from-discovery": true,
|
|
14869
|
-
"x-reconciled-at": "2026-01-
|
|
15469
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689115+00:00"
|
|
14870
15470
|
}
|
|
14871
15471
|
},
|
|
15472
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
14872
15473
|
"x-f5xc-minimum-configuration": {
|
|
14873
15474
|
"description": "Minimum configuration for schemaStatusType",
|
|
14874
15475
|
"required_fields": [
|
|
@@ -14896,6 +15497,8 @@
|
|
|
14896
15497
|
"title": "Creation_timestamp.",
|
|
14897
15498
|
"format": "date-time",
|
|
14898
15499
|
"x-displayname": "Creation Timestamp.",
|
|
15500
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
15501
|
+
"x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
|
|
14899
15502
|
"minLength": 0,
|
|
14900
15503
|
"maxLength": 1024,
|
|
14901
15504
|
"x-f5xc-required-for": {
|
|
@@ -14913,6 +15516,7 @@
|
|
|
14913
15516
|
"x-displayname": "Creator Class.",
|
|
14914
15517
|
"x-ves-example": "Prism",
|
|
14915
15518
|
"x-f5xc-example": "value",
|
|
15519
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
14916
15520
|
"minLength": 0,
|
|
14917
15521
|
"maxLength": 1024,
|
|
14918
15522
|
"x-f5xc-required-for": {
|
|
@@ -14930,6 +15534,7 @@
|
|
|
14930
15534
|
"x-displayname": "Creator ID.",
|
|
14931
15535
|
"x-ves-example": "Admin@example-corp.com.",
|
|
14932
15536
|
"x-f5xc-example": "value",
|
|
15537
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
14933
15538
|
"minLength": 0,
|
|
14934
15539
|
"maxLength": 1024,
|
|
14935
15540
|
"x-f5xc-required-for": {
|
|
@@ -14946,6 +15551,8 @@
|
|
|
14946
15551
|
"title": "Deletion_timestamp.",
|
|
14947
15552
|
"format": "date-time",
|
|
14948
15553
|
"x-displayname": "Deletion Timestamp.",
|
|
15554
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
15555
|
+
"x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
|
|
14949
15556
|
"minLength": 0,
|
|
14950
15557
|
"maxLength": 1024,
|
|
14951
15558
|
"x-f5xc-required-for": {
|
|
@@ -14965,6 +15572,8 @@
|
|
|
14965
15572
|
"x-displayname": "Finalizers.",
|
|
14966
15573
|
"x-ves-example": "Value",
|
|
14967
15574
|
"x-f5xc-example": "value",
|
|
15575
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
15576
|
+
"x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
|
|
14968
15577
|
"x-f5xc-required-for": {
|
|
14969
15578
|
"minimum_config": false,
|
|
14970
15579
|
"create": false,
|
|
@@ -14982,6 +15591,8 @@
|
|
|
14982
15591
|
"x-displayname": "Labels",
|
|
14983
15592
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
14984
15593
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
15594
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
|
|
15595
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
|
|
14985
15596
|
"x-f5xc-required-for": {
|
|
14986
15597
|
"minimum_config": false,
|
|
14987
15598
|
"create": false,
|
|
@@ -14995,6 +15606,8 @@
|
|
|
14995
15606
|
"title": "Modification_timestamp.",
|
|
14996
15607
|
"format": "date-time",
|
|
14997
15608
|
"x-displayname": "Modification Timestamp.",
|
|
15609
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
15610
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
14998
15611
|
"minLength": 0,
|
|
14999
15612
|
"maxLength": 1024,
|
|
15000
15613
|
"x-f5xc-required-for": {
|
|
@@ -15013,6 +15626,8 @@
|
|
|
15013
15626
|
"x-displayname": "Object Index.",
|
|
15014
15627
|
"x-ves-example": "0",
|
|
15015
15628
|
"x-f5xc-example": "0",
|
|
15629
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
15630
|
+
"x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
|
|
15016
15631
|
"minimum": 0,
|
|
15017
15632
|
"maximum": 2147483647,
|
|
15018
15633
|
"x-f5xc-required-for": {
|
|
@@ -15033,6 +15648,8 @@
|
|
|
15033
15648
|
"x-displayname": "Tenant",
|
|
15034
15649
|
"x-ves-example": "Example-corp.",
|
|
15035
15650
|
"x-f5xc-example": "example-corp",
|
|
15651
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
15652
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
15036
15653
|
"minLength": 0,
|
|
15037
15654
|
"maxLength": 18,
|
|
15038
15655
|
"x-f5xc-required-for": {
|
|
@@ -15044,7 +15661,7 @@
|
|
|
15044
15661
|
"x-field-mutability": "read-only",
|
|
15045
15662
|
"x-original-maxLength": 1024,
|
|
15046
15663
|
"x-reconciled-from-discovery": true,
|
|
15047
|
-
"x-reconciled-at": "2026-01-
|
|
15664
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689134+00:00"
|
|
15048
15665
|
},
|
|
15049
15666
|
"uid": {
|
|
15050
15667
|
"type": "string",
|
|
@@ -15053,6 +15670,8 @@
|
|
|
15053
15670
|
"x-displayname": "UID",
|
|
15054
15671
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
15055
15672
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
15673
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
15674
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
|
|
15056
15675
|
"minLength": 0,
|
|
15057
15676
|
"maxLength": 36,
|
|
15058
15677
|
"x-f5xc-required-for": {
|
|
@@ -15065,9 +15684,11 @@
|
|
|
15065
15684
|
"x-original-maxLength": 1024,
|
|
15066
15685
|
"format": "uuid",
|
|
15067
15686
|
"x-reconciled-from-discovery": true,
|
|
15068
|
-
"x-reconciled-at": "2026-01-
|
|
15687
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689139+00:00"
|
|
15069
15688
|
}
|
|
15070
15689
|
},
|
|
15690
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
15691
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
15071
15692
|
"x-f5xc-minimum-configuration": {
|
|
15072
15693
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
15073
15694
|
"required_fields": [
|
|
@@ -15115,7 +15736,7 @@
|
|
|
15115
15736
|
},
|
|
15116
15737
|
"x-original-maxLength": 1024,
|
|
15117
15738
|
"x-reconciled-from-discovery": true,
|
|
15118
|
-
"x-reconciled-at": "2026-01-
|
|
15739
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689144+00:00"
|
|
15119
15740
|
},
|
|
15120
15741
|
"name": {
|
|
15121
15742
|
"type": "string",
|
|
@@ -15124,6 +15745,8 @@
|
|
|
15124
15745
|
"x-displayname": "Name",
|
|
15125
15746
|
"x-ves-example": "Contactus-route.",
|
|
15126
15747
|
"x-f5xc-example": "contactus-route",
|
|
15748
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
15749
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
15127
15750
|
"minLength": 0,
|
|
15128
15751
|
"maxLength": 16,
|
|
15129
15752
|
"x-f5xc-required-for": {
|
|
@@ -15134,7 +15757,7 @@
|
|
|
15134
15757
|
},
|
|
15135
15758
|
"x-original-maxLength": 1024,
|
|
15136
15759
|
"x-reconciled-from-discovery": true,
|
|
15137
|
-
"x-reconciled-at": "2026-01-
|
|
15760
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689148+00:00"
|
|
15138
15761
|
},
|
|
15139
15762
|
"namespace": {
|
|
15140
15763
|
"type": "string",
|
|
@@ -15143,6 +15766,8 @@
|
|
|
15143
15766
|
"x-displayname": "Namespace",
|
|
15144
15767
|
"x-ves-example": "Ns1",
|
|
15145
15768
|
"x-f5xc-example": "ns1",
|
|
15769
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
15770
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
15146
15771
|
"minLength": 0,
|
|
15147
15772
|
"maxLength": 6,
|
|
15148
15773
|
"x-f5xc-required-for": {
|
|
@@ -15153,7 +15778,7 @@
|
|
|
15153
15778
|
},
|
|
15154
15779
|
"x-original-maxLength": 1024,
|
|
15155
15780
|
"x-reconciled-from-discovery": true,
|
|
15156
|
-
"x-reconciled-at": "2026-01-
|
|
15781
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689152+00:00"
|
|
15157
15782
|
},
|
|
15158
15783
|
"uid": {
|
|
15159
15784
|
"type": "string",
|
|
@@ -15174,9 +15799,10 @@
|
|
|
15174
15799
|
"x-original-maxLength": 1024,
|
|
15175
15800
|
"format": "uuid",
|
|
15176
15801
|
"x-reconciled-from-discovery": true,
|
|
15177
|
-
"x-reconciled-at": "2026-01-
|
|
15802
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689157+00:00"
|
|
15178
15803
|
}
|
|
15179
15804
|
},
|
|
15805
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
15180
15806
|
"x-f5xc-minimum-configuration": {
|
|
15181
15807
|
"description": "Minimum configuration for schemaViewRefType",
|
|
15182
15808
|
"required_fields": [
|
|
@@ -15207,6 +15833,8 @@
|
|
|
15207
15833
|
"x-ves-deprecated": "Replaced by 'topic'",
|
|
15208
15834
|
"x-ves-example": "Infrastructure.",
|
|
15209
15835
|
"x-f5xc-example": "infrastructure",
|
|
15836
|
+
"x-f5xc-description-short": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
|
|
15837
|
+
"x-f5xc-description-medium": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
|
|
15210
15838
|
"minLength": 0,
|
|
15211
15839
|
"maxLength": 1024,
|
|
15212
15840
|
"x-f5xc-required-for": {
|
|
@@ -15224,6 +15852,8 @@
|
|
|
15224
15852
|
},
|
|
15225
15853
|
"x-displayname": "Comments",
|
|
15226
15854
|
"x-f5xc-example": "[\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]",
|
|
15855
|
+
"x-f5xc-description-short": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
|
|
15856
|
+
"x-f5xc-description-medium": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
|
|
15227
15857
|
"x-f5xc-required-for": {
|
|
15228
15858
|
"minimum_config": false,
|
|
15229
15859
|
"create": false,
|
|
@@ -15237,6 +15867,7 @@
|
|
|
15237
15867
|
"x-displayname": "Description.",
|
|
15238
15868
|
"x-ves-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John.",
|
|
15239
15869
|
"x-f5xc-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John",
|
|
15870
|
+
"x-f5xc-description-short": "Customer's description of the issue (free text).",
|
|
15240
15871
|
"minLength": 0,
|
|
15241
15872
|
"maxLength": 0,
|
|
15242
15873
|
"x-f5xc-required-for": {
|
|
@@ -15247,13 +15878,14 @@
|
|
|
15247
15878
|
},
|
|
15248
15879
|
"x-original-maxLength": 1024,
|
|
15249
15880
|
"x-reconciled-from-discovery": true,
|
|
15250
|
-
"x-reconciled-at": "2026-01-
|
|
15881
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689165+00:00"
|
|
15251
15882
|
},
|
|
15252
15883
|
"ongoing": {
|
|
15253
15884
|
"type": "boolean",
|
|
15254
15885
|
"description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
|
|
15255
15886
|
"format": "boolean",
|
|
15256
15887
|
"x-displayname": "Ongoing",
|
|
15888
|
+
"x-f5xc-description-short": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
|
|
15257
15889
|
"x-f5xc-required-for": {
|
|
15258
15890
|
"minimum_config": false,
|
|
15259
15891
|
"create": false,
|
|
@@ -15270,6 +15902,7 @@
|
|
|
15270
15902
|
"x-displayname": "Product Data.",
|
|
15271
15903
|
"x-ves-example": "Happening in the loreimpsum namespace and impacts most of our sites.",
|
|
15272
15904
|
"x-f5xc-example": "Happening in the loreimpsum namespace and impacts most of our sites",
|
|
15905
|
+
"x-f5xc-description-short": "Product data is a free text field that can be used to describe the issue in more detail.",
|
|
15273
15906
|
"minLength": 0,
|
|
15274
15907
|
"maxLength": 1024,
|
|
15275
15908
|
"x-f5xc-required-for": {
|
|
@@ -15286,6 +15919,7 @@
|
|
|
15286
15919
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
15287
15920
|
},
|
|
15288
15921
|
"x-displayname": "Ticket which this one relates to.",
|
|
15922
|
+
"x-f5xc-description-short": "Optional reference to any original ticket in case the ticket being created is a followup.",
|
|
15289
15923
|
"x-f5xc-required-for": {
|
|
15290
15924
|
"minimum_config": false,
|
|
15291
15925
|
"create": false,
|
|
@@ -15320,6 +15954,7 @@
|
|
|
15320
15954
|
"x-displayname": "Timeline",
|
|
15321
15955
|
"x-ves-example": "Both LBs have been down since noon on Jan 5, 2022.",
|
|
15322
15956
|
"x-f5xc-example": "Both LBs have been down since noon on Jan 5, 2022.",
|
|
15957
|
+
"x-f5xc-description-short": "Timeline is a free text field that can be used to describe the issue in more detail.",
|
|
15323
15958
|
"minLength": 0,
|
|
15324
15959
|
"maxLength": 1024,
|
|
15325
15960
|
"x-f5xc-required-for": {
|
|
@@ -15338,6 +15973,7 @@
|
|
|
15338
15973
|
"x-displayname": "Third Party ID.",
|
|
15339
15974
|
"x-ves-example": "123",
|
|
15340
15975
|
"x-f5xc-example": "123",
|
|
15976
|
+
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
|
|
15341
15977
|
"minLength": 0,
|
|
15342
15978
|
"maxLength": 1024,
|
|
15343
15979
|
"x-f5xc-required-for": {
|
|
@@ -15352,6 +15988,7 @@
|
|
|
15352
15988
|
"$ref": "#/components/schemas/customer_supportSupportTicketType"
|
|
15353
15989
|
}
|
|
15354
15990
|
},
|
|
15991
|
+
"x-f5xc-description-short": "Creates a new customer support ticket in our customer support provider system.",
|
|
15355
15992
|
"x-f5xc-minimum-configuration": {
|
|
15356
15993
|
"description": "Minimum configuration for schemacustomer_supportCreateSpecType",
|
|
15357
15994
|
"required_fields": [
|
|
@@ -15392,6 +16029,8 @@
|
|
|
15392
16029
|
"default": "EUNKNOWN",
|
|
15393
16030
|
"x-displayname": "Error Code.",
|
|
15394
16031
|
"x-ves-proto-enum": "ves.io.schema.customer_support.ErrorCode",
|
|
16032
|
+
"x-f5xc-description-short": "ErrorCode is used to know the specific reason for customer support operation failures - EUNKNOWN: an unknown error occurred - EOK: Successful...",
|
|
16033
|
+
"x-f5xc-description-medium": "ErrorCode is used to know the specific reason for customer support operation failures - EUNKNOWN: an unknown error occurred - EOK: Successful operation - E_NOT_CLOSED: Customer support ticket not closed - E_NOT_OPEN: Customer support ticket not open - E_NOT_ELIGIBLE: Customer is not eligible for...",
|
|
15395
16034
|
"x-f5xc-minimum-configuration": {
|
|
15396
16035
|
"description": "Minimum configuration for schemacustomer_supportErrorCode",
|
|
15397
16036
|
"required_fields": [],
|
|
@@ -15432,6 +16071,8 @@
|
|
|
15432
16071
|
"x-ves-deprecated": "Replaced by 'topic'",
|
|
15433
16072
|
"x-ves-example": "Infrastructure.",
|
|
15434
16073
|
"x-f5xc-example": "infrastructure",
|
|
16074
|
+
"x-f5xc-description-short": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
|
|
16075
|
+
"x-f5xc-description-medium": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
|
|
15435
16076
|
"minLength": 0,
|
|
15436
16077
|
"maxLength": 1024,
|
|
15437
16078
|
"x-f5xc-required-for": {
|
|
@@ -15449,6 +16090,8 @@
|
|
|
15449
16090
|
},
|
|
15450
16091
|
"x-displayname": "Comments",
|
|
15451
16092
|
"x-f5xc-example": "[\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]",
|
|
16093
|
+
"x-f5xc-description-short": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
|
|
16094
|
+
"x-f5xc-description-medium": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
|
|
15452
16095
|
"x-f5xc-required-for": {
|
|
15453
16096
|
"minimum_config": false,
|
|
15454
16097
|
"create": false,
|
|
@@ -15482,6 +16125,8 @@
|
|
|
15482
16125
|
"x-displayname": "Custom Fields.",
|
|
15483
16126
|
"x-ves-example": "Custom-field-ID:custom-field-value.",
|
|
15484
16127
|
"x-f5xc-example": "custom-field-id:custom-field-value",
|
|
16128
|
+
"x-f5xc-description-short": "Any custom fields (read only). Custom fields have to be defined first before they'RE used.",
|
|
16129
|
+
"x-f5xc-description-medium": "Any custom fields (read only). Custom fields have to be defined first before they'RE used. Custom fields have no direct impact on the issue but help to better categorize issues.",
|
|
15485
16130
|
"x-f5xc-required-for": {
|
|
15486
16131
|
"minimum_config": false,
|
|
15487
16132
|
"create": false,
|
|
@@ -15495,6 +16140,7 @@
|
|
|
15495
16140
|
"x-displayname": "Description.",
|
|
15496
16141
|
"x-ves-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John.",
|
|
15497
16142
|
"x-f5xc-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John",
|
|
16143
|
+
"x-f5xc-description-short": "Customer's description of the issue (free text).",
|
|
15498
16144
|
"minLength": 0,
|
|
15499
16145
|
"maxLength": 0,
|
|
15500
16146
|
"x-f5xc-required-for": {
|
|
@@ -15505,13 +16151,15 @@
|
|
|
15505
16151
|
},
|
|
15506
16152
|
"x-original-maxLength": 1024,
|
|
15507
16153
|
"x-reconciled-from-discovery": true,
|
|
15508
|
-
"x-reconciled-at": "2026-01-
|
|
16154
|
+
"x-reconciled-at": "2026-01-07T15:28:26.689190+00:00"
|
|
15509
16155
|
},
|
|
15510
16156
|
"escalated": {
|
|
15511
16157
|
"type": "boolean",
|
|
15512
16158
|
"description": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.\nOnly existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated.",
|
|
15513
16159
|
"format": "boolean",
|
|
15514
16160
|
"x-displayname": "Escalated",
|
|
16161
|
+
"x-f5xc-description-short": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.",
|
|
16162
|
+
"x-f5xc-description-medium": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it. Only existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated.",
|
|
15515
16163
|
"x-f5xc-required-for": {
|
|
15516
16164
|
"minimum_config": false,
|
|
15517
16165
|
"create": false,
|
|
@@ -15526,6 +16174,8 @@
|
|
|
15526
16174
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
15527
16175
|
},
|
|
15528
16176
|
"x-displayname": "Followup tickets.",
|
|
16177
|
+
"x-f5xc-description-short": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket.",
|
|
16178
|
+
"x-f5xc-description-medium": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket. Used in situations when the original ticket has been closed but the issue occurred again or a new problem occurred in relation to this closed ticket.",
|
|
15529
16179
|
"x-f5xc-required-for": {
|
|
15530
16180
|
"minimum_config": false,
|
|
15531
16181
|
"create": false,
|
|
@@ -15538,6 +16188,7 @@
|
|
|
15538
16188
|
"description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
|
|
15539
16189
|
"format": "boolean",
|
|
15540
16190
|
"x-displayname": "Ongoing",
|
|
16191
|
+
"x-f5xc-description-short": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
|
|
15541
16192
|
"x-f5xc-required-for": {
|
|
15542
16193
|
"minimum_config": false,
|
|
15543
16194
|
"create": false,
|
|
@@ -15554,6 +16205,7 @@
|
|
|
15554
16205
|
"x-displayname": "Product Data.",
|
|
15555
16206
|
"x-ves-example": "Happening in the loreimpsum namespace and impacts most of our sites.",
|
|
15556
16207
|
"x-f5xc-example": "Happening in the loreimpsum namespace and impacts most of our sites",
|
|
16208
|
+
"x-f5xc-description-short": "Product data is a free text field that can be used to describe the issue in more detail.",
|
|
15557
16209
|
"minLength": 0,
|
|
15558
16210
|
"maxLength": 1024,
|
|
15559
16211
|
"x-f5xc-required-for": {
|
|
@@ -15570,6 +16222,7 @@
|
|
|
15570
16222
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
15571
16223
|
},
|
|
15572
16224
|
"x-displayname": "Ticket which this one relates to.",
|
|
16225
|
+
"x-f5xc-description-short": "Optional reference to any original ticket in case the ticket being created is a followup.",
|
|
15573
16226
|
"x-f5xc-required-for": {
|
|
15574
16227
|
"minimum_config": false,
|
|
15575
16228
|
"create": false,
|
|
@@ -15607,6 +16260,7 @@
|
|
|
15607
16260
|
"x-displayname": "Tags",
|
|
15608
16261
|
"x-ves-example": "UAM,UI",
|
|
15609
16262
|
"x-f5xc-example": "UAM,UI",
|
|
16263
|
+
"x-f5xc-description-short": "Tags help to further categorize issues (read-only field).",
|
|
15610
16264
|
"x-f5xc-required-for": {
|
|
15611
16265
|
"minimum_config": false,
|
|
15612
16266
|
"create": false,
|
|
@@ -15620,6 +16274,7 @@
|
|
|
15620
16274
|
"x-displayname": "Timeline",
|
|
15621
16275
|
"x-ves-example": "Both LBs have been down since noon on Jan 5, 2022.",
|
|
15622
16276
|
"x-f5xc-example": "Both LBs have been down since noon on Jan 5, 2022.",
|
|
16277
|
+
"x-f5xc-description-short": "Timeline is a free text field that can be used to describe the issue in more detail.",
|
|
15623
16278
|
"minLength": 0,
|
|
15624
16279
|
"maxLength": 1024,
|
|
15625
16280
|
"x-f5xc-required-for": {
|
|
@@ -15638,6 +16293,7 @@
|
|
|
15638
16293
|
"x-displayname": "Third Party ID.",
|
|
15639
16294
|
"x-ves-example": "123",
|
|
15640
16295
|
"x-f5xc-example": "123",
|
|
16296
|
+
"x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
|
|
15641
16297
|
"minLength": 0,
|
|
15642
16298
|
"maxLength": 1024,
|
|
15643
16299
|
"x-f5xc-required-for": {
|
|
@@ -15689,6 +16345,7 @@
|
|
|
15689
16345
|
"x-displayname": "Via",
|
|
15690
16346
|
"x-ves-example": "['channel':'web', 'source': '{}']",
|
|
15691
16347
|
"x-f5xc-example": "['channel':'web', 'source''{}']",
|
|
16348
|
+
"x-f5xc-description-short": "Via describes the way of a ticket reaching us (read-only).",
|
|
15692
16349
|
"x-f5xc-required-for": {
|
|
15693
16350
|
"minimum_config": false,
|
|
15694
16351
|
"create": false,
|
|
@@ -15697,6 +16354,8 @@
|
|
|
15697
16354
|
}
|
|
15698
16355
|
}
|
|
15699
16356
|
},
|
|
16357
|
+
"x-f5xc-description-short": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.",
|
|
16358
|
+
"x-f5xc-description-medium": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.",
|
|
15700
16359
|
"x-f5xc-minimum-configuration": {
|
|
15701
16360
|
"description": "Minimum configuration for schemacustomer_supportGetSpecType",
|
|
15702
16361
|
"required_fields": [
|
|
@@ -15738,6 +16397,7 @@
|
|
|
15738
16397
|
"content_type": {
|
|
15739
16398
|
"type": "string",
|
|
15740
16399
|
"description": "The HTTP Content-Type header value specifying the content type of the body.",
|
|
16400
|
+
"x-f5xc-description-short": "The HTTP Content-Type header value specifying the content type of the body.",
|
|
15741
16401
|
"minLength": 0,
|
|
15742
16402
|
"maxLength": 1024,
|
|
15743
16403
|
"x-f5xc-required-for": {
|
|
@@ -15751,6 +16411,8 @@
|
|
|
15751
16411
|
"type": "string",
|
|
15752
16412
|
"description": "The HTTP request/response body as raw binary.",
|
|
15753
16413
|
"format": "byte",
|
|
16414
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16415
|
+
"x-f5xc-description-short": "The HTTP request/response body as raw binary.",
|
|
15754
16416
|
"minLength": 0,
|
|
15755
16417
|
"maxLength": 1024,
|
|
15756
16418
|
"x-f5xc-required-for": {
|
|
@@ -15766,6 +16428,7 @@
|
|
|
15766
16428
|
"items": {
|
|
15767
16429
|
"$ref": "#/components/schemas/protobufAny"
|
|
15768
16430
|
},
|
|
16431
|
+
"x-f5xc-description-short": "Application specific response metadata. Must be set in the first response for streaming APIs.",
|
|
15769
16432
|
"x-f5xc-required-for": {
|
|
15770
16433
|
"minimum_config": false,
|
|
15771
16434
|
"create": false,
|
|
@@ -15774,6 +16437,8 @@
|
|
|
15774
16437
|
}
|
|
15775
16438
|
}
|
|
15776
16439
|
},
|
|
16440
|
+
"x-f5xc-description-short": "Message that represents an arbitrary HTTP body.",
|
|
16441
|
+
"x-f5xc-description-medium": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response.",
|
|
15777
16442
|
"x-f5xc-minimum-configuration": {
|
|
15778
16443
|
"description": "Minimum configuration for apiHttpBody",
|
|
15779
16444
|
"required_fields": [
|
|
@@ -15802,6 +16467,7 @@
|
|
|
15802
16467
|
"x-displayname": "User",
|
|
15803
16468
|
"x-ves-example": "Console-user.",
|
|
15804
16469
|
"x-f5xc-example": "console-user",
|
|
16470
|
+
"x-f5xc-description-short": "Name of the console user who runs this command.",
|
|
15805
16471
|
"minLength": 0,
|
|
15806
16472
|
"maxLength": 1024,
|
|
15807
16473
|
"x-f5xc-required-for": {
|
|
@@ -15897,6 +16563,7 @@
|
|
|
15897
16563
|
"x-displayname": "Collect Start Time.",
|
|
15898
16564
|
"x-ves-example": "2024-06-18T0012.",
|
|
15899
16565
|
"x-f5xc-example": "2024-06-18T0012",
|
|
16566
|
+
"x-f5xc-description-short": "The UTC timestamp when the collection start.",
|
|
15900
16567
|
"minLength": 0,
|
|
15901
16568
|
"maxLength": 1024,
|
|
15902
16569
|
"x-f5xc-required-for": {
|
|
@@ -15944,6 +16611,7 @@
|
|
|
15944
16611
|
"x-displayname": "Debug Bundle Validity.",
|
|
15945
16612
|
"x-ves-example": "2024-06-18T2237.",
|
|
15946
16613
|
"x-f5xc-example": "2024-06-18T2237",
|
|
16614
|
+
"x-f5xc-description-short": "The UTC timestamp of the validity of debug bundle.",
|
|
15947
16615
|
"minLength": 0,
|
|
15948
16616
|
"maxLength": 1024,
|
|
15949
16617
|
"x-f5xc-required-for": {
|
|
@@ -15977,6 +16645,7 @@
|
|
|
15977
16645
|
"description": "X-displayName: \"Status\"\nThe map of curl status with key = node name, value = OK / Error.",
|
|
15978
16646
|
"title": "Status",
|
|
15979
16647
|
"x-f5xc-example": "map<node-name, OK>",
|
|
16648
|
+
"x-f5xc-description-short": "X-displayName: \"Status\" The map of curl status with key = node name, value = OK / Error.",
|
|
15980
16649
|
"x-f5xc-required-for": {
|
|
15981
16650
|
"minimum_config": false,
|
|
15982
16651
|
"create": false,
|
|
@@ -15986,7 +16655,7 @@
|
|
|
15986
16655
|
"maxLength": 17,
|
|
15987
16656
|
"minLength": 17,
|
|
15988
16657
|
"x-reconciled-from-discovery": true,
|
|
15989
|
-
"x-reconciled-at": "2026-01-
|
|
16658
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752579+00:00"
|
|
15990
16659
|
}
|
|
15991
16660
|
},
|
|
15992
16661
|
"x-f5xc-minimum-configuration": {
|
|
@@ -16009,6 +16678,7 @@
|
|
|
16009
16678
|
"description": "X-displayName: \"ARP Result\"\nFull response of address resolution protocol \"ARP -an\" on host.",
|
|
16010
16679
|
"title": "ARP Result.",
|
|
16011
16680
|
"x-f5xc-example": "? (169.254.0.11) at 06:4d:57:fb:c4:07 [ether]...",
|
|
16681
|
+
"x-f5xc-description-short": "X-displayName: \"ARP Result\" Full response of address resolution protocol \"ARP -an\" on host.",
|
|
16012
16682
|
"minLength": 0,
|
|
16013
16683
|
"maxLength": 1024,
|
|
16014
16684
|
"x-f5xc-required-for": {
|
|
@@ -16025,6 +16695,7 @@
|
|
|
16025
16695
|
"items": {
|
|
16026
16696
|
"$ref": "#/components/schemas/debugHostPingResponse"
|
|
16027
16697
|
},
|
|
16698
|
+
"x-f5xc-description-short": "X-displayName: \"DNS Connectivity\" Ping DNS (from /etc/resolv.conf) to check connectivity.",
|
|
16028
16699
|
"x-f5xc-required-for": {
|
|
16029
16700
|
"minimum_config": false,
|
|
16030
16701
|
"create": false,
|
|
@@ -16040,6 +16711,7 @@
|
|
|
16040
16711
|
"type": "string"
|
|
16041
16712
|
},
|
|
16042
16713
|
"x-f5xc-example": "@192.168.0.2 https://downloads.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioioioio\\n; (1 server found)...",
|
|
16714
|
+
"x-f5xc-description-short": "X-displayName: \"DNS Query Result\" Dig DNS to resolve DNS for domains.",
|
|
16043
16715
|
"x-f5xc-required-for": {
|
|
16044
16716
|
"minimum_config": false,
|
|
16045
16717
|
"create": false,
|
|
@@ -16052,6 +16724,7 @@
|
|
|
16052
16724
|
"description": "X-displayName: \"Domain Curl Result\"\nThe curl status for all required domains from all nodes.",
|
|
16053
16725
|
"title": "Domain Curl Result.",
|
|
16054
16726
|
"x-f5xc-example": "map<domain-url, curl-status>",
|
|
16727
|
+
"x-f5xc-description-short": "X-displayName: \"Domain Curl Result\" The curl status for all required domains from all nodes.",
|
|
16055
16728
|
"x-f5xc-required-for": {
|
|
16056
16729
|
"minimum_config": false,
|
|
16057
16730
|
"create": false,
|
|
@@ -16064,6 +16737,8 @@
|
|
|
16064
16737
|
"description": "X-displayName: \"Errors\"\nThe map of errors with key = diagnosis command, value = all error messages for that command.",
|
|
16065
16738
|
"title": "Errors",
|
|
16066
16739
|
"x-f5xc-example": "map<command, error-messages>",
|
|
16740
|
+
"x-f5xc-description-short": "X-displayName: \"Errors\" The map of errors with key = diagnosis command, value = all error messages for that command.",
|
|
16741
|
+
"x-f5xc-description-medium": "X-displayName: \"Errors\" The map of errors with key = diagnosis command, value = all error messages for that command.",
|
|
16067
16742
|
"x-f5xc-required-for": {
|
|
16068
16743
|
"minimum_config": false,
|
|
16069
16744
|
"create": false,
|
|
@@ -16079,6 +16754,7 @@
|
|
|
16079
16754
|
"description": "X-displayName: \"Interface Config\"\nFull response of interface configuration \"ifconfig -a\" on host.",
|
|
16080
16755
|
"title": "Interface Config.",
|
|
16081
16756
|
"x-f5xc-example": "argo-end: flags=4163\\u003cUP,BROADCAST,...",
|
|
16757
|
+
"x-f5xc-description-short": "X-displayName: \"Interface Config\" Full response of interface configuration \"ifconfig -a\" on host.",
|
|
16082
16758
|
"minLength": 0,
|
|
16083
16759
|
"maxLength": 1024,
|
|
16084
16760
|
"x-f5xc-required-for": {
|
|
@@ -16093,6 +16769,7 @@
|
|
|
16093
16769
|
"description": "X-displayName: \"Node Name\"\nName of the node.",
|
|
16094
16770
|
"title": "Node Name",
|
|
16095
16771
|
"x-f5xc-example": "master-0",
|
|
16772
|
+
"x-f5xc-description-short": "X-displayName: \"Node Name\" Name of the node.",
|
|
16096
16773
|
"minLength": 0,
|
|
16097
16774
|
"maxLength": 1024,
|
|
16098
16775
|
"x-f5xc-required-for": {
|
|
@@ -16109,6 +16786,7 @@
|
|
|
16109
16786
|
"items": {
|
|
16110
16787
|
"$ref": "#/components/schemas/debugHostPingResponse"
|
|
16111
16788
|
},
|
|
16789
|
+
"x-f5xc-description-short": "X-displayName: \"Nodes Connectivity\" Ping nodes (if multiple) to check connectivity.",
|
|
16112
16790
|
"x-f5xc-required-for": {
|
|
16113
16791
|
"minimum_config": false,
|
|
16114
16792
|
"create": false,
|
|
@@ -16121,6 +16799,7 @@
|
|
|
16121
16799
|
"description": "X-displayName: \"NTP Sync Status\"\nFull response from \"timedatectl status\" on host.",
|
|
16122
16800
|
"title": "NTP Sync Status.",
|
|
16123
16801
|
"x-f5xc-example": "System clock synchronized: yes...",
|
|
16802
|
+
"x-f5xc-description-short": "X-displayName: \"NTP Sync Status\" Full response from \"timedatectl status\" on host.",
|
|
16124
16803
|
"minLength": 0,
|
|
16125
16804
|
"maxLength": 1024,
|
|
16126
16805
|
"x-f5xc-required-for": {
|
|
@@ -16135,6 +16814,8 @@
|
|
|
16135
16814
|
"description": "X-displayName: \"Registration Status\"\nIndicate whether registration is success or failed with some error.",
|
|
16136
16815
|
"title": "Registration Status.",
|
|
16137
16816
|
"x-f5xc-example": "OK",
|
|
16817
|
+
"x-f5xc-description-short": "X-displayName: \"Registration Status\" Indicate whether registration is success or failed with some error.",
|
|
16818
|
+
"x-f5xc-description-medium": "X-displayName: \"Registration Status\" Indicate whether registration is success or failed with some error.",
|
|
16138
16819
|
"minLength": 0,
|
|
16139
16820
|
"maxLength": 1024,
|
|
16140
16821
|
"x-f5xc-required-for": {
|
|
@@ -16149,6 +16830,7 @@
|
|
|
16149
16830
|
"description": "X-displayName: \"Resolv Conf\"\nFull response of /etc/resolv.conf information.",
|
|
16150
16831
|
"title": "Resolv Conf.",
|
|
16151
16832
|
"x-f5xc-example": "nameserver 192.168.0.2...",
|
|
16833
|
+
"x-f5xc-description-short": "X-displayName: \"Resolv Conf\" Full response of /etc/resolv.conf information.",
|
|
16152
16834
|
"minLength": 0,
|
|
16153
16835
|
"maxLength": 1024,
|
|
16154
16836
|
"x-f5xc-required-for": {
|
|
@@ -16163,6 +16845,7 @@
|
|
|
16163
16845
|
"description": "X-displayName: \"Route Result\"\nFull response from \"route -n\" on host.",
|
|
16164
16846
|
"title": "Route Result.",
|
|
16165
16847
|
"x-f5xc-example": "Kernel IP routing table...",
|
|
16848
|
+
"x-f5xc-description-short": "X-displayName: \"Route Result\" Full response from \"route -n\" on host.",
|
|
16166
16849
|
"minLength": 0,
|
|
16167
16850
|
"maxLength": 1024,
|
|
16168
16851
|
"x-f5xc-required-for": {
|
|
@@ -16211,6 +16894,8 @@
|
|
|
16211
16894
|
"x-displayname": "Curl Responses.",
|
|
16212
16895
|
"x-ves-example": "Map<domain-URL, curl-status>",
|
|
16213
16896
|
"x-f5xc-example": "map<domain-url, curl-status>",
|
|
16897
|
+
"x-f5xc-description-short": "The subset from full diagnosis response of Domain Curl Result for all required domains from all nodes.",
|
|
16898
|
+
"x-f5xc-description-medium": "The subset from full diagnosis response of Domain Curl Result for all required domains from all nodes.",
|
|
16214
16899
|
"x-f5xc-required-for": {
|
|
16215
16900
|
"minimum_config": false,
|
|
16216
16901
|
"create": false,
|
|
@@ -16225,6 +16910,7 @@
|
|
|
16225
16910
|
"x-displayname": "Registration Status.",
|
|
16226
16911
|
"x-ves-example": "Map<node-name, registration-status>",
|
|
16227
16912
|
"x-f5xc-example": "map<node-name, registration-status>",
|
|
16913
|
+
"x-f5xc-description-short": "The subset from full diagnosis response of Registration Status from all nodes.",
|
|
16228
16914
|
"x-f5xc-required-for": {
|
|
16229
16915
|
"minimum_config": false,
|
|
16230
16916
|
"create": false,
|
|
@@ -16239,6 +16925,7 @@
|
|
|
16239
16925
|
"x-displayname": "Responses",
|
|
16240
16926
|
"x-ves-example": "Map<node-name, diganosis-response-object>",
|
|
16241
16927
|
"x-f5xc-example": "map<node-name, diganosis-response-object>",
|
|
16928
|
+
"x-f5xc-description-short": "The full diagnosis response of all nodes.",
|
|
16242
16929
|
"x-f5xc-required-for": {
|
|
16243
16930
|
"minimum_config": false,
|
|
16244
16931
|
"create": false,
|
|
@@ -16325,6 +17012,7 @@
|
|
|
16325
17012
|
"x-displayname": "User",
|
|
16326
17013
|
"x-ves-example": "Console-user.",
|
|
16327
17014
|
"x-f5xc-example": "console-user",
|
|
17015
|
+
"x-f5xc-description-short": "Name of the console user who runs this command.",
|
|
16328
17016
|
"minLength": 0,
|
|
16329
17017
|
"maxLength": 1024,
|
|
16330
17018
|
"x-f5xc-required-for": {
|
|
@@ -16341,6 +17029,7 @@
|
|
|
16341
17029
|
"x-displayname": "Namespace",
|
|
16342
17030
|
"x-ves-example": "Value",
|
|
16343
17031
|
"x-f5xc-example": "value",
|
|
17032
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
16344
17033
|
"minLength": 0,
|
|
16345
17034
|
"maxLength": 6,
|
|
16346
17035
|
"x-f5xc-required-for": {
|
|
@@ -16351,7 +17040,7 @@
|
|
|
16351
17040
|
},
|
|
16352
17041
|
"x-original-maxLength": 1024,
|
|
16353
17042
|
"x-reconciled-from-discovery": true,
|
|
16354
|
-
"x-reconciled-at": "2026-01-
|
|
17043
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752616+00:00"
|
|
16355
17044
|
},
|
|
16356
17045
|
"node": {
|
|
16357
17046
|
"type": "string",
|
|
@@ -16386,6 +17075,7 @@
|
|
|
16386
17075
|
}
|
|
16387
17076
|
}
|
|
16388
17077
|
},
|
|
17078
|
+
"x-f5xc-description-short": "Request to execute CLI command on a specific node in site.",
|
|
16389
17079
|
"x-f5xc-minimum-configuration": {
|
|
16390
17080
|
"description": "Minimum configuration for debugExecRequest",
|
|
16391
17081
|
"required_fields": [
|
|
@@ -16482,6 +17172,7 @@
|
|
|
16482
17172
|
"description": "Hostname of the node.",
|
|
16483
17173
|
"title": "Hostname",
|
|
16484
17174
|
"x-displayname": "Hostname",
|
|
17175
|
+
"x-f5xc-example": "example-resource",
|
|
16485
17176
|
"minLength": 0,
|
|
16486
17177
|
"maxLength": 1024,
|
|
16487
17178
|
"x-f5xc-required-for": {
|
|
@@ -16497,6 +17188,7 @@
|
|
|
16497
17188
|
"title": "Factory Password Changed.",
|
|
16498
17189
|
"format": "boolean",
|
|
16499
17190
|
"x-displayname": "Factory Password Changed.",
|
|
17191
|
+
"x-f5xc-description-short": "If the factory password changed on host.",
|
|
16500
17192
|
"x-f5xc-required-for": {
|
|
16501
17193
|
"minimum_config": false,
|
|
16502
17194
|
"create": false,
|
|
@@ -16539,6 +17231,7 @@
|
|
|
16539
17231
|
"description": "Public IP gives vhost0 or other primary IP.",
|
|
16540
17232
|
"title": "Public IP",
|
|
16541
17233
|
"x-displayname": "Public IP",
|
|
17234
|
+
"x-f5xc-description-short": "Public IP gives vhost0 or other primary IP.",
|
|
16542
17235
|
"minLength": 0,
|
|
16543
17236
|
"maxLength": 1024,
|
|
16544
17237
|
"x-f5xc-required-for": {
|
|
@@ -16585,6 +17278,7 @@
|
|
|
16585
17278
|
"description": "VPM version running on host.",
|
|
16586
17279
|
"title": "VPM Version.",
|
|
16587
17280
|
"x-displayname": "VPM version.",
|
|
17281
|
+
"x-f5xc-example": "v1.2.3",
|
|
16588
17282
|
"minLength": 0,
|
|
16589
17283
|
"maxLength": 1,
|
|
16590
17284
|
"x-f5xc-required-for": {
|
|
@@ -16595,7 +17289,7 @@
|
|
|
16595
17289
|
},
|
|
16596
17290
|
"x-original-maxLength": 1024,
|
|
16597
17291
|
"x-reconciled-from-discovery": true,
|
|
16598
|
-
"x-reconciled-at": "2026-01-
|
|
17292
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752641+00:00"
|
|
16599
17293
|
},
|
|
16600
17294
|
"wifi_support": {
|
|
16601
17295
|
"type": "boolean",
|
|
@@ -16665,6 +17359,7 @@
|
|
|
16665
17359
|
"x-displayname": "Destination.",
|
|
16666
17360
|
"x-ves-example": "google.com.",
|
|
16667
17361
|
"x-f5xc-example": "google.com",
|
|
17362
|
+
"x-f5xc-description-short": "Destination to ping can be IP Address or DNS name.",
|
|
16668
17363
|
"minLength": 0,
|
|
16669
17364
|
"maxLength": 1024,
|
|
16670
17365
|
"x-f5xc-required-for": {
|
|
@@ -16682,6 +17377,7 @@
|
|
|
16682
17377
|
"x-displayname": "Interval",
|
|
16683
17378
|
"x-ves-example": "1000",
|
|
16684
17379
|
"x-f5xc-example": "1000",
|
|
17380
|
+
"x-f5xc-description-short": "Interval is the wait time between each packet send. Default is 1s (1000ms).",
|
|
16685
17381
|
"minimum": 0,
|
|
16686
17382
|
"maximum": 2147483647,
|
|
16687
17383
|
"x-f5xc-required-for": {
|
|
@@ -16715,6 +17411,7 @@
|
|
|
16715
17411
|
"x-displayname": "Namespace",
|
|
16716
17412
|
"x-ves-example": "Value",
|
|
16717
17413
|
"x-f5xc-example": "value",
|
|
17414
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
16718
17415
|
"minLength": 0,
|
|
16719
17416
|
"maxLength": 6,
|
|
16720
17417
|
"x-f5xc-required-for": {
|
|
@@ -16725,7 +17422,7 @@
|
|
|
16725
17422
|
},
|
|
16726
17423
|
"x-original-maxLength": 1024,
|
|
16727
17424
|
"x-reconciled-from-discovery": true,
|
|
16728
|
-
"x-reconciled-at": "2026-01-
|
|
17425
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752653+00:00"
|
|
16729
17426
|
},
|
|
16730
17427
|
"node": {
|
|
16731
17428
|
"type": "string",
|
|
@@ -16808,6 +17505,7 @@
|
|
|
16808
17505
|
"x-displayname": "Destination IP.",
|
|
16809
17506
|
"x-ves-example": "8.8.8.8",
|
|
16810
17507
|
"x-f5xc-example": "8.8.8.8",
|
|
17508
|
+
"x-f5xc-description-short": "Destination IP is the address of the host being pinged.",
|
|
16811
17509
|
"minLength": 0,
|
|
16812
17510
|
"maxLength": 1024,
|
|
16813
17511
|
"x-f5xc-required-for": {
|
|
@@ -16874,6 +17572,7 @@
|
|
|
16874
17572
|
"x-displayname": "Packets Received.",
|
|
16875
17573
|
"x-ves-example": "5",
|
|
16876
17574
|
"x-f5xc-example": "5",
|
|
17575
|
+
"x-f5xc-description-short": "Received is the number of packets received.",
|
|
16877
17576
|
"minimum": 0,
|
|
16878
17577
|
"maximum": 2147483647,
|
|
16879
17578
|
"x-f5xc-required-for": {
|
|
@@ -16907,6 +17606,7 @@
|
|
|
16907
17606
|
"x-displayname": "Standard Deviation RTT.",
|
|
16908
17607
|
"x-ves-example": "30.619µs",
|
|
16909
17608
|
"x-f5xc-example": "30.619µs",
|
|
17609
|
+
"x-f5xc-description-short": "StdDevRtt is the standard deviation of the round-trip times.",
|
|
16910
17610
|
"minLength": 0,
|
|
16911
17611
|
"maxLength": 1024,
|
|
16912
17612
|
"x-f5xc-required-for": {
|
|
@@ -16917,6 +17617,7 @@
|
|
|
16917
17617
|
}
|
|
16918
17618
|
}
|
|
16919
17619
|
},
|
|
17620
|
+
"x-f5xc-description-short": "Response to initiated ping from the site.",
|
|
16920
17621
|
"x-f5xc-minimum-configuration": {
|
|
16921
17622
|
"description": "Minimum configuration for debugHostPingResponse",
|
|
16922
17623
|
"required_fields": [
|
|
@@ -17019,6 +17720,7 @@
|
|
|
17019
17720
|
"x-displayname": "Namespace",
|
|
17020
17721
|
"x-ves-example": "Value",
|
|
17021
17722
|
"x-f5xc-example": "value",
|
|
17723
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
17022
17724
|
"minLength": 0,
|
|
17023
17725
|
"maxLength": 6,
|
|
17024
17726
|
"x-f5xc-required-for": {
|
|
@@ -17029,7 +17731,7 @@
|
|
|
17029
17731
|
},
|
|
17030
17732
|
"x-original-maxLength": 1024,
|
|
17031
17733
|
"x-reconciled-from-discovery": true,
|
|
17032
|
-
"x-reconciled-at": "2026-01-
|
|
17734
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752675+00:00"
|
|
17033
17735
|
},
|
|
17034
17736
|
"node": {
|
|
17035
17737
|
"type": "string",
|
|
@@ -17064,6 +17766,7 @@
|
|
|
17064
17766
|
}
|
|
17065
17767
|
}
|
|
17066
17768
|
},
|
|
17769
|
+
"x-f5xc-description-short": "Request to reboot specific node in site.",
|
|
17067
17770
|
"x-f5xc-minimum-configuration": {
|
|
17068
17771
|
"description": "Minimum configuration for debugRebootRequest",
|
|
17069
17772
|
"required_fields": [
|
|
@@ -17118,7 +17821,7 @@
|
|
|
17118
17821
|
},
|
|
17119
17822
|
"x-original-maxLength": 1024,
|
|
17120
17823
|
"x-reconciled-from-discovery": true,
|
|
17121
|
-
"x-reconciled-at": "2026-01-
|
|
17824
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752683+00:00"
|
|
17122
17825
|
},
|
|
17123
17826
|
"node": {
|
|
17124
17827
|
"type": "string",
|
|
@@ -17153,9 +17856,10 @@
|
|
|
17153
17856
|
},
|
|
17154
17857
|
"x-original-maxLength": 1024,
|
|
17155
17858
|
"x-reconciled-from-discovery": true,
|
|
17156
|
-
"x-reconciled-at": "2026-01-
|
|
17859
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752689+00:00"
|
|
17157
17860
|
}
|
|
17158
17861
|
},
|
|
17862
|
+
"x-f5xc-description-short": "Name and formal displayed name of the service.",
|
|
17159
17863
|
"x-f5xc-minimum-configuration": {
|
|
17160
17864
|
"description": "Minimum configuration for debugService",
|
|
17161
17865
|
"required_fields": [
|
|
@@ -17184,6 +17888,7 @@
|
|
|
17184
17888
|
"x-displayname": "Namespace",
|
|
17185
17889
|
"x-ves-example": "Value",
|
|
17186
17890
|
"x-f5xc-example": "value",
|
|
17891
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
17187
17892
|
"minLength": 0,
|
|
17188
17893
|
"maxLength": 6,
|
|
17189
17894
|
"x-f5xc-required-for": {
|
|
@@ -17194,7 +17899,7 @@
|
|
|
17194
17899
|
},
|
|
17195
17900
|
"x-original-maxLength": 1024,
|
|
17196
17901
|
"x-reconciled-from-discovery": true,
|
|
17197
|
-
"x-reconciled-at": "2026-01-
|
|
17902
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752693+00:00"
|
|
17198
17903
|
},
|
|
17199
17904
|
"node": {
|
|
17200
17905
|
"type": "string",
|
|
@@ -17245,6 +17950,7 @@
|
|
|
17245
17950
|
}
|
|
17246
17951
|
}
|
|
17247
17952
|
},
|
|
17953
|
+
"x-f5xc-description-short": "Request to soft restart reloads VER instance on the node.",
|
|
17248
17954
|
"x-f5xc-minimum-configuration": {
|
|
17249
17955
|
"description": "Minimum configuration for debugSoftRestartRequest",
|
|
17250
17956
|
"required_fields": [
|
|
@@ -17316,7 +18022,7 @@
|
|
|
17316
18022
|
},
|
|
17317
18023
|
"x-original-maxLength": 1024,
|
|
17318
18024
|
"x-reconciled-from-discovery": true,
|
|
17319
|
-
"x-reconciled-at": "2026-01-
|
|
18025
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752703+00:00"
|
|
17320
18026
|
},
|
|
17321
18027
|
"node": {
|
|
17322
18028
|
"type": "string",
|
|
@@ -17351,7 +18057,7 @@
|
|
|
17351
18057
|
},
|
|
17352
18058
|
"x-original-maxLength": 1024,
|
|
17353
18059
|
"x-reconciled-from-discovery": true,
|
|
17354
|
-
"x-reconciled-at": "2026-01-
|
|
18060
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752709+00:00"
|
|
17355
18061
|
}
|
|
17356
18062
|
},
|
|
17357
18063
|
"x-f5xc-minimum-configuration": {
|
|
@@ -17384,6 +18090,7 @@
|
|
|
17384
18090
|
"$ref": "#/components/schemas/debugStatus"
|
|
17385
18091
|
},
|
|
17386
18092
|
"x-displayname": "Status",
|
|
18093
|
+
"x-f5xc-example": "active",
|
|
17387
18094
|
"x-f5xc-required-for": {
|
|
17388
18095
|
"minimum_config": false,
|
|
17389
18096
|
"create": false,
|
|
@@ -17393,7 +18100,7 @@
|
|
|
17393
18100
|
"maxLength": 17,
|
|
17394
18101
|
"minLength": 17,
|
|
17395
18102
|
"x-reconciled-from-discovery": true,
|
|
17396
|
-
"x-reconciled-at": "2026-01-
|
|
18103
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752714+00:00"
|
|
17397
18104
|
}
|
|
17398
18105
|
},
|
|
17399
18106
|
"x-f5xc-minimum-configuration": {
|
|
@@ -17423,6 +18130,8 @@
|
|
|
17423
18130
|
"default": "WAITING_FOR_CONFIG",
|
|
17424
18131
|
"x-displayname": "Site State.",
|
|
17425
18132
|
"x-ves-proto-enum": "ves.io.schema.operate.debug.VpmState",
|
|
18133
|
+
"x-f5xc-description-short": "State of Site defines in which operational state site itself is. Site is waiting for input configuration.",
|
|
18134
|
+
"x-f5xc-description-medium": "State of Site defines in which operational state site itself is. Site is waiting for input configuration. Site is waiting for approval. Site is in provisioning state. Site is in provisioned.",
|
|
17426
18135
|
"x-f5xc-minimum-configuration": {
|
|
17427
18136
|
"description": "Minimum configuration for debugVpmState",
|
|
17428
18137
|
"required_fields": [],
|
|
@@ -17448,6 +18157,8 @@
|
|
|
17448
18157
|
"x-displayname": "Decryption Provider.",
|
|
17449
18158
|
"x-ves-example": "Value",
|
|
17450
18159
|
"x-f5xc-example": "value",
|
|
18160
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
18161
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
17451
18162
|
"minLength": 0,
|
|
17452
18163
|
"maxLength": 1024,
|
|
17453
18164
|
"x-f5xc-required-for": {
|
|
@@ -17473,6 +18184,8 @@
|
|
|
17473
18184
|
"ves.io.schema.rules.message.required": "true",
|
|
17474
18185
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
17475
18186
|
},
|
|
18187
|
+
"x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
18188
|
+
"x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
17476
18189
|
"minLength": 0,
|
|
17477
18190
|
"maxLength": 4,
|
|
17478
18191
|
"x-f5xc-required-for": {
|
|
@@ -17483,7 +18196,7 @@
|
|
|
17483
18196
|
},
|
|
17484
18197
|
"x-original-maxLength": 1024,
|
|
17485
18198
|
"x-reconciled-from-discovery": true,
|
|
17486
|
-
"x-reconciled-at": "2026-01-
|
|
18199
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752728+00:00"
|
|
17487
18200
|
},
|
|
17488
18201
|
"store_provider": {
|
|
17489
18202
|
"type": "string",
|
|
@@ -17492,6 +18205,8 @@
|
|
|
17492
18205
|
"x-displayname": "Store Provider.",
|
|
17493
18206
|
"x-ves-example": "Value",
|
|
17494
18207
|
"x-f5xc-example": "value",
|
|
18208
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
18209
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
17495
18210
|
"minLength": 0,
|
|
17496
18211
|
"maxLength": 1024,
|
|
17497
18212
|
"x-f5xc-required-for": {
|
|
@@ -17502,6 +18217,7 @@
|
|
|
17502
18217
|
}
|
|
17503
18218
|
}
|
|
17504
18219
|
},
|
|
18220
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
17505
18221
|
"x-f5xc-minimum-configuration": {
|
|
17506
18222
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
17507
18223
|
"required_fields": [
|
|
@@ -17531,6 +18247,8 @@
|
|
|
17531
18247
|
"x-displayname": "Provider",
|
|
17532
18248
|
"x-ves-example": "Box-provider.",
|
|
17533
18249
|
"x-f5xc-example": "box-provider",
|
|
18250
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
18251
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
17534
18252
|
"minLength": 0,
|
|
17535
18253
|
"maxLength": 8,
|
|
17536
18254
|
"x-f5xc-required-for": {
|
|
@@ -17541,7 +18259,7 @@
|
|
|
17541
18259
|
},
|
|
17542
18260
|
"x-original-maxLength": 1024,
|
|
17543
18261
|
"x-reconciled-from-discovery": true,
|
|
17544
|
-
"x-reconciled-at": "2026-01-
|
|
18262
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752734+00:00"
|
|
17545
18263
|
},
|
|
17546
18264
|
"url": {
|
|
17547
18265
|
"type": "string",
|
|
@@ -17562,6 +18280,8 @@
|
|
|
17562
18280
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
17563
18281
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
17564
18282
|
},
|
|
18283
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
18284
|
+
"x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
|
|
17565
18285
|
"format": "uri",
|
|
17566
18286
|
"minLength": 0,
|
|
17567
18287
|
"x-f5xc-required-for": {
|
|
@@ -17572,6 +18292,7 @@
|
|
|
17572
18292
|
}
|
|
17573
18293
|
}
|
|
17574
18294
|
},
|
|
18295
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
17575
18296
|
"x-f5xc-minimum-configuration": {
|
|
17576
18297
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
17577
18298
|
"required_fields": [
|
|
@@ -17594,6 +18315,8 @@
|
|
|
17594
18315
|
"EncodingBase64"
|
|
17595
18316
|
],
|
|
17596
18317
|
"default": "EncodingNone",
|
|
18318
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
18319
|
+
"x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
|
|
17597
18320
|
"x-f5xc-minimum-configuration": {
|
|
17598
18321
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
17599
18322
|
"required_fields": [],
|
|
@@ -17619,6 +18342,7 @@
|
|
|
17619
18342
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
17620
18343
|
}
|
|
17621
18344
|
},
|
|
18345
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
17622
18346
|
"x-f5xc-minimum-configuration": {
|
|
17623
18347
|
"description": "Minimum configuration for schemaSecretType",
|
|
17624
18348
|
"required_fields": [
|
|
@@ -17642,6 +18366,8 @@
|
|
|
17642
18366
|
"description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
|
|
17643
18367
|
"title": "Key",
|
|
17644
18368
|
"x-f5xc-example": "key_pem",
|
|
18369
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
18370
|
+
"x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
|
|
17645
18371
|
"minLength": 0,
|
|
17646
18372
|
"maxLength": 16,
|
|
17647
18373
|
"x-f5xc-required-for": {
|
|
@@ -17652,13 +18378,14 @@
|
|
|
17652
18378
|
},
|
|
17653
18379
|
"x-original-maxLength": 1024,
|
|
17654
18380
|
"x-reconciled-from-discovery": true,
|
|
17655
|
-
"x-reconciled-at": "2026-01-
|
|
18381
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752745+00:00"
|
|
17656
18382
|
},
|
|
17657
18383
|
"location": {
|
|
17658
18384
|
"type": "string",
|
|
17659
18385
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
17660
18386
|
"title": "Location",
|
|
17661
18387
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
18388
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
17662
18389
|
"minLength": 0,
|
|
17663
18390
|
"maxLength": 4,
|
|
17664
18391
|
"x-f5xc-required-for": {
|
|
@@ -17669,13 +18396,15 @@
|
|
|
17669
18396
|
},
|
|
17670
18397
|
"x-original-maxLength": 1024,
|
|
17671
18398
|
"x-reconciled-from-discovery": true,
|
|
17672
|
-
"x-reconciled-at": "2026-01-
|
|
18399
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752750+00:00"
|
|
17673
18400
|
},
|
|
17674
18401
|
"provider": {
|
|
17675
18402
|
"type": "string",
|
|
17676
18403
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
17677
18404
|
"title": "Provider",
|
|
17678
18405
|
"x-f5xc-example": "vault-vh-provider",
|
|
18406
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
18407
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
17679
18408
|
"minLength": 0,
|
|
17680
18409
|
"maxLength": 8,
|
|
17681
18410
|
"x-f5xc-required-for": {
|
|
@@ -17686,7 +18415,7 @@
|
|
|
17686
18415
|
},
|
|
17687
18416
|
"x-original-maxLength": 1024,
|
|
17688
18417
|
"x-reconciled-from-discovery": true,
|
|
17689
|
-
"x-reconciled-at": "2026-01-
|
|
18418
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752754+00:00"
|
|
17690
18419
|
},
|
|
17691
18420
|
"secret_encoding": {
|
|
17692
18421
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -17697,6 +18426,8 @@
|
|
|
17697
18426
|
"title": "Version",
|
|
17698
18427
|
"format": "int64",
|
|
17699
18428
|
"x-f5xc-example": "1",
|
|
18429
|
+
"x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
|
|
18430
|
+
"x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
|
|
17700
18431
|
"minimum": 0,
|
|
17701
18432
|
"maximum": 2147483647,
|
|
17702
18433
|
"x-f5xc-required-for": {
|
|
@@ -17708,9 +18439,11 @@
|
|
|
17708
18439
|
"maxLength": 1,
|
|
17709
18440
|
"minLength": 1,
|
|
17710
18441
|
"x-reconciled-from-discovery": true,
|
|
17711
|
-
"x-reconciled-at": "2026-01-
|
|
18442
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752760+00:00"
|
|
17712
18443
|
}
|
|
17713
18444
|
},
|
|
18445
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
18446
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
17714
18447
|
"x-f5xc-minimum-configuration": {
|
|
17715
18448
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
17716
18449
|
"required_fields": [
|
|
@@ -17737,6 +18470,7 @@
|
|
|
17737
18470
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
17738
18471
|
"title": "Name",
|
|
17739
18472
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
18473
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
17740
18474
|
"minLength": 0,
|
|
17741
18475
|
"maxLength": 16,
|
|
17742
18476
|
"x-f5xc-required-for": {
|
|
@@ -17747,9 +18481,10 @@
|
|
|
17747
18481
|
},
|
|
17748
18482
|
"x-original-maxLength": 1024,
|
|
17749
18483
|
"x-reconciled-from-discovery": true,
|
|
17750
|
-
"x-reconciled-at": "2026-01-
|
|
18484
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752765+00:00"
|
|
17751
18485
|
}
|
|
17752
18486
|
},
|
|
18487
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
17753
18488
|
"x-f5xc-minimum-configuration": {
|
|
17754
18489
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
17755
18490
|
"required_fields": [
|
|
@@ -17776,6 +18511,7 @@
|
|
|
17776
18511
|
"x-displayname": "Date",
|
|
17777
18512
|
"x-ves-example": "Value",
|
|
17778
18513
|
"x-f5xc-example": "value",
|
|
18514
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_date.",
|
|
17779
18515
|
"minLength": 0,
|
|
17780
18516
|
"maxLength": 1024,
|
|
17781
18517
|
"x-f5xc-required-for": {
|
|
@@ -17792,6 +18528,7 @@
|
|
|
17792
18528
|
"x-displayname": "Vendor",
|
|
17793
18529
|
"x-ves-example": "Value",
|
|
17794
18530
|
"x-f5xc-example": "value",
|
|
18531
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_vendor.",
|
|
17795
18532
|
"minLength": 0,
|
|
17796
18533
|
"maxLength": 1024,
|
|
17797
18534
|
"x-f5xc-required-for": {
|
|
@@ -17808,6 +18545,7 @@
|
|
|
17808
18545
|
"x-displayname": "Version",
|
|
17809
18546
|
"x-ves-example": "Value",
|
|
17810
18547
|
"x-f5xc-example": "value",
|
|
18548
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_version.",
|
|
17811
18549
|
"minLength": 0,
|
|
17812
18550
|
"maxLength": 1,
|
|
17813
18551
|
"x-f5xc-required-for": {
|
|
@@ -17818,7 +18556,7 @@
|
|
|
17818
18556
|
},
|
|
17819
18557
|
"x-original-maxLength": 1024,
|
|
17820
18558
|
"x-reconciled-from-discovery": true,
|
|
17821
|
-
"x-reconciled-at": "2026-01-
|
|
18559
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752773+00:00"
|
|
17822
18560
|
}
|
|
17823
18561
|
},
|
|
17824
18562
|
"x-f5xc-minimum-configuration": {
|
|
@@ -17849,6 +18587,7 @@
|
|
|
17849
18587
|
"x-displayname": "Asset Tag",
|
|
17850
18588
|
"x-ves-example": "Value",
|
|
17851
18589
|
"x-f5xc-example": "value",
|
|
18590
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_asset_tag.",
|
|
17852
18591
|
"minLength": 0,
|
|
17853
18592
|
"maxLength": 1024,
|
|
17854
18593
|
"x-f5xc-required-for": {
|
|
@@ -17865,6 +18604,7 @@
|
|
|
17865
18604
|
"x-displayname": "Name",
|
|
17866
18605
|
"x-ves-example": "Value",
|
|
17867
18606
|
"x-f5xc-example": "value",
|
|
18607
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_name.",
|
|
17868
18608
|
"minLength": 0,
|
|
17869
18609
|
"maxLength": 16,
|
|
17870
18610
|
"x-f5xc-required-for": {
|
|
@@ -17875,7 +18615,7 @@
|
|
|
17875
18615
|
},
|
|
17876
18616
|
"x-original-maxLength": 1024,
|
|
17877
18617
|
"x-reconciled-from-discovery": true,
|
|
17878
|
-
"x-reconciled-at": "2026-01-
|
|
18618
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752779+00:00"
|
|
17879
18619
|
},
|
|
17880
18620
|
"serial": {
|
|
17881
18621
|
"type": "string",
|
|
@@ -17884,6 +18624,7 @@
|
|
|
17884
18624
|
"x-displayname": "Serial Number.",
|
|
17885
18625
|
"x-ves-example": "Value",
|
|
17886
18626
|
"x-f5xc-example": "value",
|
|
18627
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_serial.",
|
|
17887
18628
|
"minLength": 0,
|
|
17888
18629
|
"maxLength": 1024,
|
|
17889
18630
|
"x-f5xc-required-for": {
|
|
@@ -17900,6 +18641,7 @@
|
|
|
17900
18641
|
"x-displayname": "Vendor",
|
|
17901
18642
|
"x-ves-example": "Value",
|
|
17902
18643
|
"x-f5xc-example": "value",
|
|
18644
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_vendor.",
|
|
17903
18645
|
"minLength": 0,
|
|
17904
18646
|
"maxLength": 1024,
|
|
17905
18647
|
"x-f5xc-required-for": {
|
|
@@ -17916,6 +18658,7 @@
|
|
|
17916
18658
|
"x-displayname": "Version",
|
|
17917
18659
|
"x-ves-example": "Value",
|
|
17918
18660
|
"x-f5xc-example": "value",
|
|
18661
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_version.",
|
|
17919
18662
|
"minLength": 0,
|
|
17920
18663
|
"maxLength": 1,
|
|
17921
18664
|
"x-f5xc-required-for": {
|
|
@@ -17926,7 +18669,7 @@
|
|
|
17926
18669
|
},
|
|
17927
18670
|
"x-original-maxLength": 1024,
|
|
17928
18671
|
"x-reconciled-from-discovery": true,
|
|
17929
|
-
"x-reconciled-at": "2026-01-
|
|
18672
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752786+00:00"
|
|
17930
18673
|
}
|
|
17931
18674
|
},
|
|
17932
18675
|
"x-f5xc-minimum-configuration": {
|
|
@@ -17959,6 +18702,7 @@
|
|
|
17959
18702
|
"x-displayname": "Asset Tag",
|
|
17960
18703
|
"x-ves-example": "Value",
|
|
17961
18704
|
"x-f5xc-example": "value",
|
|
18705
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_asset_tag.",
|
|
17962
18706
|
"minLength": 0,
|
|
17963
18707
|
"maxLength": 1024,
|
|
17964
18708
|
"x-f5xc-required-for": {
|
|
@@ -17975,6 +18719,7 @@
|
|
|
17975
18719
|
"x-displayname": "Serial Number.",
|
|
17976
18720
|
"x-ves-example": "Value",
|
|
17977
18721
|
"x-f5xc-example": "value",
|
|
18722
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_serial.",
|
|
17978
18723
|
"minLength": 0,
|
|
17979
18724
|
"maxLength": 1024,
|
|
17980
18725
|
"x-f5xc-required-for": {
|
|
@@ -17992,6 +18737,7 @@
|
|
|
17992
18737
|
"x-displayname": "Type",
|
|
17993
18738
|
"x-ves-example": "0",
|
|
17994
18739
|
"x-f5xc-example": "0",
|
|
18740
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_type.",
|
|
17995
18741
|
"minimum": 0,
|
|
17996
18742
|
"maximum": 2147483647,
|
|
17997
18743
|
"x-f5xc-required-for": {
|
|
@@ -18008,6 +18754,7 @@
|
|
|
18008
18754
|
"x-displayname": "Vendor",
|
|
18009
18755
|
"x-ves-example": "Value",
|
|
18010
18756
|
"x-f5xc-example": "value",
|
|
18757
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_vendor.",
|
|
18011
18758
|
"minLength": 0,
|
|
18012
18759
|
"maxLength": 1024,
|
|
18013
18760
|
"x-f5xc-required-for": {
|
|
@@ -18024,6 +18771,7 @@
|
|
|
18024
18771
|
"x-displayname": "Version",
|
|
18025
18772
|
"x-ves-example": "Value",
|
|
18026
18773
|
"x-f5xc-example": "value",
|
|
18774
|
+
"x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_version.",
|
|
18027
18775
|
"minLength": 0,
|
|
18028
18776
|
"maxLength": 1,
|
|
18029
18777
|
"x-f5xc-required-for": {
|
|
@@ -18034,7 +18782,7 @@
|
|
|
18034
18782
|
},
|
|
18035
18783
|
"x-original-maxLength": 1024,
|
|
18036
18784
|
"x-reconciled-from-discovery": true,
|
|
18037
|
-
"x-reconciled-at": "2026-01-
|
|
18785
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752795+00:00"
|
|
18038
18786
|
}
|
|
18039
18787
|
},
|
|
18040
18788
|
"x-f5xc-minimum-configuration": {
|
|
@@ -18392,7 +19140,7 @@
|
|
|
18392
19140
|
},
|
|
18393
19141
|
"x-original-maxLength": 1024,
|
|
18394
19142
|
"x-reconciled-from-discovery": true,
|
|
18395
|
-
"x-reconciled-at": "2026-01-
|
|
19143
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752823+00:00"
|
|
18396
19144
|
}
|
|
18397
19145
|
},
|
|
18398
19146
|
"x-f5xc-minimum-configuration": {
|
|
@@ -18422,6 +19170,8 @@
|
|
|
18422
19170
|
"default": "QUALITY_UNKNOWN",
|
|
18423
19171
|
"x-displayname": "Link quality.",
|
|
18424
19172
|
"x-ves-proto-enum": "ves.io.schema.site.LinkQuality",
|
|
19173
|
+
"x-f5xc-description-short": "Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled.",
|
|
19174
|
+
"x-f5xc-description-medium": "Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled.",
|
|
18425
19175
|
"x-f5xc-minimum-configuration": {
|
|
18426
19176
|
"description": "Minimum configuration for siteLinkQuality",
|
|
18427
19177
|
"required_fields": [],
|
|
@@ -18448,6 +19198,8 @@
|
|
|
18448
19198
|
"default": "LINK_TYPE_UNKNOWN",
|
|
18449
19199
|
"x-displayname": "Link type",
|
|
18450
19200
|
"x-ves-proto-enum": "ves.io.schema.site.LinkType",
|
|
19201
|
+
"x-f5xc-description-short": "Link type of interface determined operationally Link type unknown Link type ethernet WiFi link of type 802.11ac WiFi link of type 802.11bgn Link...",
|
|
19202
|
+
"x-f5xc-description-medium": "Link type of interface determined operationally Link type unknown Link type ethernet WiFi link of type 802.11ac WiFi link of type 802.11bgn Link type 4G WiFi link Wan link.",
|
|
18451
19203
|
"x-f5xc-minimum-configuration": {
|
|
18452
19204
|
"description": "Minimum configuration for siteLinkType",
|
|
18453
19205
|
"required_fields": [],
|
|
@@ -18609,7 +19361,7 @@
|
|
|
18609
19361
|
},
|
|
18610
19362
|
"x-original-maxLength": 1024,
|
|
18611
19363
|
"x-reconciled-from-discovery": true,
|
|
18612
|
-
"x-reconciled-at": "2026-01-
|
|
19364
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752839+00:00"
|
|
18613
19365
|
},
|
|
18614
19366
|
"port": {
|
|
18615
19367
|
"type": "string",
|
|
@@ -18706,7 +19458,7 @@
|
|
|
18706
19458
|
},
|
|
18707
19459
|
"x-original-maxLength": 1024,
|
|
18708
19460
|
"x-reconciled-from-discovery": true,
|
|
18709
|
-
"x-reconciled-at": "2026-01-
|
|
19461
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752848+00:00"
|
|
18710
19462
|
},
|
|
18711
19463
|
"release": {
|
|
18712
19464
|
"type": "string",
|
|
@@ -18757,7 +19509,7 @@
|
|
|
18757
19509
|
},
|
|
18758
19510
|
"x-original-maxLength": 1024,
|
|
18759
19511
|
"x-reconciled-from-discovery": true,
|
|
18760
|
-
"x-reconciled-at": "2026-01-
|
|
19512
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752855+00:00"
|
|
18761
19513
|
}
|
|
18762
19514
|
},
|
|
18763
19515
|
"x-f5xc-minimum-configuration": {
|
|
@@ -18812,6 +19564,7 @@
|
|
|
18812
19564
|
"$ref": "#/components/schemas/siteNetworkDevice"
|
|
18813
19565
|
},
|
|
18814
19566
|
"x-displayname": "Network",
|
|
19567
|
+
"x-f5xc-example": "192.0.2.0/24",
|
|
18815
19568
|
"x-f5xc-required-for": {
|
|
18816
19569
|
"minimum_config": false,
|
|
18817
19570
|
"create": false,
|
|
@@ -18833,6 +19586,7 @@
|
|
|
18833
19586
|
"x-validation-rules": {
|
|
18834
19587
|
"ves.io.schema.rules.int32.gte": "0"
|
|
18835
19588
|
},
|
|
19589
|
+
"x-f5xc-description-short": "Non-uniform memory access (NUMA) nodes count.",
|
|
18836
19590
|
"minimum": 0,
|
|
18837
19591
|
"maximum": 2147483647,
|
|
18838
19592
|
"x-f5xc-required-for": {
|
|
@@ -18879,6 +19633,7 @@
|
|
|
18879
19633
|
}
|
|
18880
19634
|
}
|
|
18881
19635
|
},
|
|
19636
|
+
"x-f5xc-description-short": "OsInfo holds information about host OS and HW.",
|
|
18882
19637
|
"x-f5xc-minimum-configuration": {
|
|
18883
19638
|
"description": "Minimum configuration for siteOsInfo",
|
|
18884
19639
|
"required_fields": [
|
|
@@ -18927,7 +19682,7 @@
|
|
|
18927
19682
|
},
|
|
18928
19683
|
"x-original-maxLength": 1024,
|
|
18929
19684
|
"x-reconciled-from-discovery": true,
|
|
18930
|
-
"x-reconciled-at": "2026-01-
|
|
19685
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752875+00:00"
|
|
18931
19686
|
},
|
|
18932
19687
|
"serial": {
|
|
18933
19688
|
"type": "string",
|
|
@@ -18936,6 +19691,8 @@
|
|
|
18936
19691
|
"x-displayname": "Serial Number.",
|
|
18937
19692
|
"x-ves-example": "Ec254b6d-9676-1a51-8b10-21370dbdc3e5.",
|
|
18938
19693
|
"x-f5xc-example": "ec254b6d-9676-1a51-8b10-21370dbdc3e5",
|
|
19694
|
+
"x-f5xc-description-short": "Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5.",
|
|
19695
|
+
"x-f5xc-description-medium": "Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/ID/product_serial.",
|
|
18939
19696
|
"minLength": 0,
|
|
18940
19697
|
"maxLength": 1024,
|
|
18941
19698
|
"x-f5xc-required-for": {
|
|
@@ -18968,6 +19725,7 @@
|
|
|
18968
19725
|
"x-displayname": "Version",
|
|
18969
19726
|
"x-ves-example": "Value",
|
|
18970
19727
|
"x-f5xc-example": "value",
|
|
19728
|
+
"x-f5xc-description-short": "Version name. Info taken from /sys/class/dmi/ID/product_version.",
|
|
18971
19729
|
"minLength": 0,
|
|
18972
19730
|
"maxLength": 1,
|
|
18973
19731
|
"x-f5xc-required-for": {
|
|
@@ -18978,7 +19736,7 @@
|
|
|
18978
19736
|
},
|
|
18979
19737
|
"x-original-maxLength": 1024,
|
|
18980
19738
|
"x-reconciled-from-discovery": true,
|
|
18981
|
-
"x-reconciled-at": "2026-01-
|
|
19739
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752882+00:00"
|
|
18982
19740
|
}
|
|
18983
19741
|
},
|
|
18984
19742
|
"x-f5xc-minimum-configuration": {
|
|
@@ -19052,7 +19810,7 @@
|
|
|
19052
19810
|
},
|
|
19053
19811
|
"x-original-maxLength": 1024,
|
|
19054
19812
|
"x-reconciled-from-discovery": true,
|
|
19055
|
-
"x-reconciled-at": "2026-01-
|
|
19813
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752890+00:00"
|
|
19056
19814
|
},
|
|
19057
19815
|
"serial": {
|
|
19058
19816
|
"type": "string",
|
|
@@ -19136,6 +19894,7 @@
|
|
|
19136
19894
|
"x-displayname": "Address",
|
|
19137
19895
|
"x-ves-example": "4",
|
|
19138
19896
|
"x-f5xc-example": "4",
|
|
19897
|
+
"x-f5xc-description-short": "Address of the device on the bus in decimal.",
|
|
19139
19898
|
"minimum": 0,
|
|
19140
19899
|
"maximum": 2147483647,
|
|
19141
19900
|
"x-f5xc-required-for": {
|
|
@@ -19168,6 +19927,7 @@
|
|
|
19168
19927
|
"x-displayname": "Protocol",
|
|
19169
19928
|
"x-ves-example": "0002",
|
|
19170
19929
|
"x-f5xc-example": "0002",
|
|
19930
|
+
"x-f5xc-description-short": "The protocol (within the sub-class) of this device.",
|
|
19171
19931
|
"minLength": 0,
|
|
19172
19932
|
"maxLength": 1024,
|
|
19173
19933
|
"x-f5xc-required-for": {
|
|
@@ -19184,6 +19944,7 @@
|
|
|
19184
19944
|
"x-displayname": "Subclass",
|
|
19185
19945
|
"x-ves-example": "Hub",
|
|
19186
19946
|
"x-f5xc-example": "hub",
|
|
19947
|
+
"x-f5xc-description-short": "The sub-class (within the class) of this device.",
|
|
19187
19948
|
"minLength": 0,
|
|
19188
19949
|
"maxLength": 1024,
|
|
19189
19950
|
"x-f5xc-required-for": {
|
|
@@ -19250,6 +20011,7 @@
|
|
|
19250
20011
|
"x-displayname": "Bus",
|
|
19251
20012
|
"x-ves-example": "1",
|
|
19252
20013
|
"x-f5xc-example": "1",
|
|
20014
|
+
"x-f5xc-description-short": "The bus on which the device was detected in decimal.",
|
|
19253
20015
|
"minimum": 0,
|
|
19254
20016
|
"maximum": 2147483647,
|
|
19255
20017
|
"x-f5xc-required-for": {
|
|
@@ -19276,7 +20038,7 @@
|
|
|
19276
20038
|
},
|
|
19277
20039
|
"x-original-maxLength": 1024,
|
|
19278
20040
|
"x-reconciled-from-discovery": true,
|
|
19279
|
-
"x-reconciled-at": "2026-01-
|
|
20041
|
+
"x-reconciled-at": "2026-01-07T15:28:32.752911+00:00"
|
|
19280
20042
|
},
|
|
19281
20043
|
"i_manufacturer": {
|
|
19282
20044
|
"type": "string",
|
|
@@ -19317,6 +20079,7 @@
|
|
|
19317
20079
|
"x-displayname": "ISerialNumber.",
|
|
19318
20080
|
"x-ves-example": "0000:00:14.0.",
|
|
19319
20081
|
"x-f5xc-example": "0000:00:14.0",
|
|
20082
|
+
"x-f5xc-description-short": "Index of Serial Number String Descriptor.",
|
|
19320
20083
|
"minLength": 0,
|
|
19321
20084
|
"maxLength": 1024,
|
|
19322
20085
|
"x-f5xc-required-for": {
|
|
@@ -19333,6 +20096,7 @@
|
|
|
19333
20096
|
"x-displayname": "Product ID.",
|
|
19334
20097
|
"x-ves-example": "0x0002",
|
|
19335
20098
|
"x-f5xc-example": "0x0002",
|
|
20099
|
+
"x-f5xc-description-short": "Product ID (Assigned by Manufacturer) in hex.",
|
|
19336
20100
|
"minLength": 0,
|
|
19337
20101
|
"maxLength": 1024,
|
|
19338
20102
|
"x-f5xc-required-for": {
|
|
@@ -19366,6 +20130,7 @@
|
|
|
19366
20130
|
"x-displayname": "Port",
|
|
19367
20131
|
"x-ves-example": "3",
|
|
19368
20132
|
"x-f5xc-example": "3",
|
|
20133
|
+
"x-f5xc-description-short": "Port on which the device was detected in decimal.",
|
|
19369
20134
|
"minimum": 1,
|
|
19370
20135
|
"maximum": 65535,
|
|
19371
20136
|
"x-f5xc-required-for": {
|
|
@@ -19382,6 +20147,7 @@
|
|
|
19382
20147
|
"x-displayname": "Product name.",
|
|
19383
20148
|
"x-ves-example": "NetVista Full Width Keyboard.",
|
|
19384
20149
|
"x-f5xc-example": "NetVista Full Width Keyboard",
|
|
20150
|
+
"x-f5xc-description-short": "Product ID translated to name (if available).",
|
|
19385
20151
|
"minLength": 0,
|
|
19386
20152
|
"maxLength": 1024,
|
|
19387
20153
|
"x-f5xc-required-for": {
|
|
@@ -19398,6 +20164,7 @@
|
|
|
19398
20164
|
"x-displayname": "Speed",
|
|
19399
20165
|
"x-ves-example": "High",
|
|
19400
20166
|
"x-f5xc-example": "high",
|
|
20167
|
+
"x-f5xc-description-short": "The negotiated operating speed for the device.",
|
|
19401
20168
|
"minLength": 0,
|
|
19402
20169
|
"maxLength": 1024,
|
|
19403
20170
|
"x-f5xc-required-for": {
|
|
@@ -19417,6 +20184,7 @@
|
|
|
19417
20184
|
"x-displayname": "Vendor name.",
|
|
19418
20185
|
"x-ves-example": "IBM Corp.",
|
|
19419
20186
|
"x-f5xc-example": "IBM Corp.",
|
|
20187
|
+
"x-f5xc-description-short": "Vendor ID translated to name (if available).",
|
|
19420
20188
|
"minLength": 0,
|
|
19421
20189
|
"maxLength": 1024,
|
|
19422
20190
|
"x-f5xc-required-for": {
|
|
@@ -19470,6 +20238,8 @@
|
|
|
19470
20238
|
"default": "UNKNOWN_USB",
|
|
19471
20239
|
"x-displayname": "USB Type",
|
|
19472
20240
|
"x-ves-proto-enum": "ves.io.schema.site.UsbType",
|
|
20241
|
+
"x-f5xc-description-short": "Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be...",
|
|
20242
|
+
"x-f5xc-description-medium": "Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be matched by USB rules.",
|
|
19473
20243
|
"x-f5xc-minimum-configuration": {
|
|
19474
20244
|
"description": "Minimum configuration for siteUsbType",
|
|
19475
20245
|
"required_fields": [],
|
|
@@ -19492,6 +20262,7 @@
|
|
|
19492
20262
|
"description": "Option key.",
|
|
19493
20263
|
"title": "Key",
|
|
19494
20264
|
"x-displayname": "Key",
|
|
20265
|
+
"x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
|
|
19495
20266
|
"minLength": 0,
|
|
19496
20267
|
"maxLength": 16,
|
|
19497
20268
|
"x-f5xc-required-for": {
|
|
@@ -19502,7 +20273,7 @@
|
|
|
19502
20273
|
},
|
|
19503
20274
|
"x-original-maxLength": 1024,
|
|
19504
20275
|
"x-reconciled-from-discovery": true,
|
|
19505
|
-
"x-reconciled-at": "2026-01-
|
|
20276
|
+
"x-reconciled-at": "2026-01-07T15:28:33.001972+00:00"
|
|
19506
20277
|
},
|
|
19507
20278
|
"value": {
|
|
19508
20279
|
"type": "string",
|
|
@@ -19519,9 +20290,10 @@
|
|
|
19519
20290
|
},
|
|
19520
20291
|
"x-original-maxLength": 1024,
|
|
19521
20292
|
"x-reconciled-from-discovery": true,
|
|
19522
|
-
"x-reconciled-at": "2026-01-
|
|
20293
|
+
"x-reconciled-at": "2026-01-07T15:28:33.001979+00:00"
|
|
19523
20294
|
}
|
|
19524
20295
|
},
|
|
20296
|
+
"x-f5xc-description-short": "DHCP Option information as a (key, value) pair.",
|
|
19525
20297
|
"x-f5xc-minimum-configuration": {
|
|
19526
20298
|
"description": "Minimum configuration for dhcpDhcpKeyValuePair",
|
|
19527
20299
|
"required_fields": [
|
|
@@ -19574,7 +20346,7 @@
|
|
|
19574
20346
|
},
|
|
19575
20347
|
"x-original-maxLength": 1024,
|
|
19576
20348
|
"x-reconciled-from-discovery": true,
|
|
19577
|
-
"x-reconciled-at": "2026-01-
|
|
20349
|
+
"x-reconciled-at": "2026-01-07T15:28:33.001988+00:00"
|
|
19578
20350
|
},
|
|
19579
20351
|
"expiry": {
|
|
19580
20352
|
"type": "string",
|
|
@@ -19596,6 +20368,7 @@
|
|
|
19596
20368
|
"description": "Host name of the client.",
|
|
19597
20369
|
"title": "Host Name",
|
|
19598
20370
|
"x-displayname": "Host Name",
|
|
20371
|
+
"x-f5xc-example": "example-resource",
|
|
19599
20372
|
"minLength": 0,
|
|
19600
20373
|
"maxLength": 1024,
|
|
19601
20374
|
"x-f5xc-required-for": {
|
|
@@ -19610,6 +20383,7 @@
|
|
|
19610
20383
|
"description": "Name of the ver interface to which the client is connected.",
|
|
19611
20384
|
"title": "Interface",
|
|
19612
20385
|
"x-displayname": "Interface",
|
|
20386
|
+
"x-f5xc-description-short": "Name of the ver interface to which the client is connected.",
|
|
19613
20387
|
"minLength": 0,
|
|
19614
20388
|
"maxLength": 1024,
|
|
19615
20389
|
"x-f5xc-required-for": {
|
|
@@ -19686,6 +20460,7 @@
|
|
|
19686
20460
|
"description": "Subnet of the client.",
|
|
19687
20461
|
"title": "Subnet",
|
|
19688
20462
|
"x-displayname": "Subnet",
|
|
20463
|
+
"x-f5xc-example": "192.0.2.0/24",
|
|
19689
20464
|
"minLength": 0,
|
|
19690
20465
|
"maxLength": 1024,
|
|
19691
20466
|
"x-f5xc-required-for": {
|
|
@@ -19696,6 +20471,7 @@
|
|
|
19696
20471
|
}
|
|
19697
20472
|
}
|
|
19698
20473
|
},
|
|
20474
|
+
"x-f5xc-description-short": "Information about DHCP lease given by VER DHCP server.",
|
|
19699
20475
|
"x-f5xc-minimum-configuration": {
|
|
19700
20476
|
"description": "Minimum configuration for dhcpDhcpLeaseInfo",
|
|
19701
20477
|
"required_fields": [
|
|
@@ -19755,6 +20531,7 @@
|
|
|
19755
20531
|
}
|
|
19756
20532
|
}
|
|
19757
20533
|
},
|
|
20534
|
+
"x-f5xc-description-short": "Active list of DHCP leases that have been leased by VER DHCP server.",
|
|
19758
20535
|
"x-f5xc-minimum-configuration": {
|
|
19759
20536
|
"description": "Minimum configuration for dhcpDhcpLeases",
|
|
19760
20537
|
"required_fields": [
|
|
@@ -19781,6 +20558,7 @@
|
|
|
19781
20558
|
"title": "Address Count.",
|
|
19782
20559
|
"format": "int64",
|
|
19783
20560
|
"x-displayname": "Address Count.",
|
|
20561
|
+
"x-f5xc-description-short": "Number of addresses in the subnet that DHCP can lease.",
|
|
19784
20562
|
"minimum": 0,
|
|
19785
20563
|
"maximum": 2147483647,
|
|
19786
20564
|
"x-f5xc-required-for": {
|
|
@@ -19796,6 +20574,7 @@
|
|
|
19796
20574
|
"title": "Free Addresses.",
|
|
19797
20575
|
"format": "int64",
|
|
19798
20576
|
"x-displayname": "Free Addresses.",
|
|
20577
|
+
"x-f5xc-description-short": "Number of addresses in the subnet that are free (not allocated).",
|
|
19799
20578
|
"minimum": 0,
|
|
19800
20579
|
"maximum": 2147483647,
|
|
19801
20580
|
"x-f5xc-required-for": {
|
|
@@ -19810,6 +20589,7 @@
|
|
|
19810
20589
|
"description": "Name of the ver interface to which the subnet is assigned.",
|
|
19811
20590
|
"title": "Interface",
|
|
19812
20591
|
"x-displayname": "Interface",
|
|
20592
|
+
"x-f5xc-description-short": "Name of the ver interface to which the subnet is assigned.",
|
|
19813
20593
|
"minLength": 0,
|
|
19814
20594
|
"maxLength": 1024,
|
|
19815
20595
|
"x-f5xc-required-for": {
|
|
@@ -19824,6 +20604,7 @@
|
|
|
19824
20604
|
"description": "Subnet address.",
|
|
19825
20605
|
"title": "Subnet",
|
|
19826
20606
|
"x-displayname": "Subnet",
|
|
20607
|
+
"x-f5xc-example": "192.0.2.0/24",
|
|
19827
20608
|
"minLength": 0,
|
|
19828
20609
|
"maxLength": 1024,
|
|
19829
20610
|
"x-f5xc-required-for": {
|
|
@@ -19864,6 +20645,7 @@
|
|
|
19864
20645
|
"x-displayname": "Connected",
|
|
19865
20646
|
"x-ves-example": "True",
|
|
19866
20647
|
"x-f5xc-example": "true",
|
|
20648
|
+
"x-f5xc-description-short": "Whether the device is connected to LTE network.",
|
|
19867
20649
|
"x-f5xc-required-for": {
|
|
19868
20650
|
"minimum_config": false,
|
|
19869
20651
|
"create": false,
|
|
@@ -19878,6 +20660,7 @@
|
|
|
19878
20660
|
"x-displayname": "Network Operator.",
|
|
19879
20661
|
"x-ves-example": "T-Mobile",
|
|
19880
20662
|
"x-f5xc-example": "T-Mobile",
|
|
20663
|
+
"x-f5xc-description-short": "Network Operator to which is device connected.",
|
|
19881
20664
|
"minLength": 0,
|
|
19882
20665
|
"maxLength": 1024,
|
|
19883
20666
|
"x-f5xc-required-for": {
|
|
@@ -19920,6 +20703,7 @@
|
|
|
19920
20703
|
"x-displayname": "Uptime",
|
|
19921
20704
|
"x-ves-example": "4380",
|
|
19922
20705
|
"x-f5xc-example": "4380",
|
|
20706
|
+
"x-f5xc-description-short": "Number of seconds the device is connected to network.",
|
|
19923
20707
|
"minimum": 0,
|
|
19924
20708
|
"maximum": 2147483647,
|
|
19925
20709
|
"x-f5xc-required-for": {
|
|
@@ -19962,6 +20746,7 @@
|
|
|
19962
20746
|
"x-displayname": "APN",
|
|
19963
20747
|
"x-ves-example": "Internet",
|
|
19964
20748
|
"x-f5xc-example": "internet",
|
|
20749
|
+
"x-f5xc-description-short": "Access Point Name is the name of a gateway between a mobile network and another computer network.",
|
|
19965
20750
|
"minLength": 0,
|
|
19966
20751
|
"maxLength": 1024,
|
|
19967
20752
|
"x-f5xc-required-for": {
|
|
@@ -20011,6 +20796,7 @@
|
|
|
20011
20796
|
"x-displayname": "Primary",
|
|
20012
20797
|
"x-ves-example": "True",
|
|
20013
20798
|
"x-f5xc-example": "true",
|
|
20799
|
+
"x-f5xc-description-short": "LTE interface is used as Primary Site Local Outside.",
|
|
20014
20800
|
"x-f5xc-required-for": {
|
|
20015
20801
|
"minimum_config": false,
|
|
20016
20802
|
"create": false,
|
|
@@ -20065,6 +20851,7 @@
|
|
|
20065
20851
|
"x-displayname": "Namespace",
|
|
20066
20852
|
"x-ves-example": "Value",
|
|
20067
20853
|
"x-f5xc-example": "value",
|
|
20854
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
20068
20855
|
"minLength": 0,
|
|
20069
20856
|
"maxLength": 6,
|
|
20070
20857
|
"x-f5xc-required-for": {
|
|
@@ -20075,7 +20862,7 @@
|
|
|
20075
20862
|
},
|
|
20076
20863
|
"x-original-maxLength": 1024,
|
|
20077
20864
|
"x-reconciled-from-discovery": true,
|
|
20078
|
-
"x-reconciled-at": "2026-01-
|
|
20865
|
+
"x-reconciled-at": "2026-01-07T15:28:53.702416+00:00"
|
|
20079
20866
|
},
|
|
20080
20867
|
"node": {
|
|
20081
20868
|
"type": "string",
|
|
@@ -20174,6 +20961,7 @@
|
|
|
20174
20961
|
"$ref": "#/components/schemas/lteLte"
|
|
20175
20962
|
}
|
|
20176
20963
|
},
|
|
20964
|
+
"x-f5xc-description-short": "Runtime LTE information obtained from site.",
|
|
20177
20965
|
"x-f5xc-minimum-configuration": {
|
|
20178
20966
|
"description": "Minimum configuration for lteLteInfoResponse",
|
|
20179
20967
|
"required_fields": [
|
|
@@ -20203,6 +20991,7 @@
|
|
|
20203
20991
|
"x-displayname": "Namespace",
|
|
20204
20992
|
"x-ves-example": "Value",
|
|
20205
20993
|
"x-f5xc-example": "value",
|
|
20994
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
20206
20995
|
"minLength": 0,
|
|
20207
20996
|
"maxLength": 6,
|
|
20208
20997
|
"x-f5xc-required-for": {
|
|
@@ -20213,7 +21002,7 @@
|
|
|
20213
21002
|
},
|
|
20214
21003
|
"x-original-maxLength": 1024,
|
|
20215
21004
|
"x-reconciled-from-discovery": true,
|
|
20216
|
-
"x-reconciled-at": "2026-01-
|
|
21005
|
+
"x-reconciled-at": "2026-01-07T15:28:53.702431+00:00"
|
|
20217
21006
|
},
|
|
20218
21007
|
"node": {
|
|
20219
21008
|
"type": "string",
|
|
@@ -20324,6 +21113,7 @@
|
|
|
20324
21113
|
"x-displayname": "RSSI",
|
|
20325
21114
|
"x-ves-example": "-79",
|
|
20326
21115
|
"x-f5xc-example": "-79",
|
|
21116
|
+
"x-f5xc-description-short": "The Received Signal Strength Indication.",
|
|
20327
21117
|
"x-f5xc-required-for": {
|
|
20328
21118
|
"minimum_config": false,
|
|
20329
21119
|
"create": false,
|
|
@@ -20339,6 +21129,7 @@
|
|
|
20339
21129
|
"x-displayname": "SINR",
|
|
20340
21130
|
"x-ves-example": "12.200000000000001.",
|
|
20341
21131
|
"x-f5xc-example": "12.200000000000001",
|
|
21132
|
+
"x-f5xc-description-short": "The Signal to Interference plus Noise Ratio.",
|
|
20342
21133
|
"x-f5xc-required-for": {
|
|
20343
21134
|
"minimum_config": false,
|
|
20344
21135
|
"create": false,
|
|
@@ -20376,6 +21167,8 @@
|
|
|
20376
21167
|
"default": "UNKNOWN",
|
|
20377
21168
|
"x-displayname": "Signal Strength.",
|
|
20378
21169
|
"x-ves-proto-enum": "ves.io.schema.operate.lte.SignalStrength",
|
|
21170
|
+
"x-f5xc-description-short": "Current Signal Strength - UNKNOWN: UNKNOWN RSSI not received - EXCELLENT: EXCELLENT RSSI greater then -65 - GOOD: GOOD RSSI between -65 and -75 ...",
|
|
21171
|
+
"x-f5xc-description-medium": "Current Signal Strength - UNKNOWN: UNKNOWN RSSI not received - EXCELLENT: EXCELLENT RSSI greater then -65 - GOOD: GOOD RSSI between -65 and -75 - FAIR: FAIR RSSI between -75 and -85 - POOR: POOR RSSI lower then -85.",
|
|
20379
21172
|
"x-f5xc-minimum-configuration": {
|
|
20380
21173
|
"description": "Minimum configuration for lteSignalStrength",
|
|
20381
21174
|
"required_fields": [],
|
|
@@ -20414,6 +21207,7 @@
|
|
|
20414
21207
|
"x-displayname": "IMEI",
|
|
20415
21208
|
"x-ves-example": "867698041438378.",
|
|
20416
21209
|
"x-f5xc-example": "867698041438378",
|
|
21210
|
+
"x-f5xc-description-short": "The International Mobile Equipment Identity.",
|
|
20417
21211
|
"minLength": 0,
|
|
20418
21212
|
"maxLength": 1024,
|
|
20419
21213
|
"x-f5xc-required-for": {
|
|
@@ -20428,6 +21222,7 @@
|
|
|
20428
21222
|
"description": "The International Mobile Subscriber Identity.",
|
|
20429
21223
|
"title": "IMSI",
|
|
20430
21224
|
"x-displayname": "IMSI",
|
|
21225
|
+
"x-f5xc-description-short": "The International Mobile Subscriber Identity.",
|
|
20431
21226
|
"minLength": 0,
|
|
20432
21227
|
"maxLength": 1024,
|
|
20433
21228
|
"x-f5xc-required-for": {
|
|
@@ -20519,6 +21314,7 @@
|
|
|
20519
21314
|
"ves.io.schema.rules.uint32.gte": "300",
|
|
20520
21315
|
"ves.io.schema.rules.uint32.lte": "10000"
|
|
20521
21316
|
},
|
|
21317
|
+
"x-f5xc-description-short": "Interval between ping requests, in milliseconds.",
|
|
20522
21318
|
"minimum": 0,
|
|
20523
21319
|
"maximum": 2147483647,
|
|
20524
21320
|
"x-f5xc-required-for": {
|
|
@@ -20538,6 +21334,7 @@
|
|
|
20538
21334
|
"x-displayname": "Namespace",
|
|
20539
21335
|
"x-ves-example": "System",
|
|
20540
21336
|
"x-f5xc-example": "system",
|
|
21337
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
20541
21338
|
"minLength": 0,
|
|
20542
21339
|
"maxLength": 6,
|
|
20543
21340
|
"x-f5xc-required-for": {
|
|
@@ -20548,7 +21345,7 @@
|
|
|
20548
21345
|
},
|
|
20549
21346
|
"x-original-maxLength": 1024,
|
|
20550
21347
|
"x-reconciled-from-discovery": true,
|
|
20551
|
-
"x-reconciled-at": "2026-01-
|
|
21348
|
+
"x-reconciled-at": "2026-01-07T15:29:06.248230+00:00"
|
|
20552
21349
|
},
|
|
20553
21350
|
"node": {
|
|
20554
21351
|
"type": "string",
|
|
@@ -20570,6 +21367,7 @@
|
|
|
20570
21367
|
"ves.io.schema.rules.string.max_len": "64",
|
|
20571
21368
|
"ves.io.schema.rules.string.min_len": "1"
|
|
20572
21369
|
},
|
|
21370
|
+
"x-f5xc-description-short": "Name of the node from which ping is initiated Required: YES.",
|
|
20573
21371
|
"x-f5xc-required-for": {
|
|
20574
21372
|
"minimum_config": false,
|
|
20575
21373
|
"create": false,
|
|
@@ -20609,6 +21407,7 @@
|
|
|
20609
21407
|
"x-displayname": "Site Name",
|
|
20610
21408
|
"x-ves-example": "Value",
|
|
20611
21409
|
"x-f5xc-example": "value",
|
|
21410
|
+
"x-f5xc-description-short": "Name of the site from which ping is initiated.",
|
|
20612
21411
|
"minLength": 0,
|
|
20613
21412
|
"maxLength": 1024,
|
|
20614
21413
|
"x-f5xc-required-for": {
|
|
@@ -20803,6 +21602,7 @@
|
|
|
20803
21602
|
"title": "Empty",
|
|
20804
21603
|
"x-displayname": "Empty",
|
|
20805
21604
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
21605
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
20806
21606
|
"x-f5xc-minimum-configuration": {
|
|
20807
21607
|
"description": "Minimum configuration for schemaEmpty",
|
|
20808
21608
|
"required_fields": [],
|
|
@@ -20837,6 +21637,7 @@
|
|
|
20837
21637
|
"ves.io.schema.rules.string.hostname": "true",
|
|
20838
21638
|
"ves.io.schema.rules.string.max_len": "256"
|
|
20839
21639
|
},
|
|
21640
|
+
"x-f5xc-description-short": "Exclusive with [IP] DNS name of the host.",
|
|
20840
21641
|
"minLength": 0,
|
|
20841
21642
|
"x-f5xc-required-for": {
|
|
20842
21643
|
"minimum_config": false,
|
|
@@ -20858,6 +21659,7 @@
|
|
|
20858
21659
|
"x-validation-rules": {
|
|
20859
21660
|
"ves.io.schema.rules.string.ip": "true"
|
|
20860
21661
|
},
|
|
21662
|
+
"x-f5xc-description-short": "Exclusive with [hostname] IP address of the host.",
|
|
20861
21663
|
"minLength": 0,
|
|
20862
21664
|
"maxLength": 1024,
|
|
20863
21665
|
"x-f5xc-required-for": {
|
|
@@ -20868,6 +21670,7 @@
|
|
|
20868
21670
|
}
|
|
20869
21671
|
}
|
|
20870
21672
|
},
|
|
21673
|
+
"x-f5xc-description-short": "Host Identifier identifies a host, either by its DNS name (hostname) or by its IP address.",
|
|
20871
21674
|
"x-f5xc-minimum-configuration": {
|
|
20872
21675
|
"description": "Minimum configuration for schemaHostIdentifier",
|
|
20873
21676
|
"required_fields": [
|
|
@@ -20909,6 +21712,7 @@
|
|
|
20909
21712
|
"ves.io.schema.rules.string.max_len": "256",
|
|
20910
21713
|
"ves.io.schema.rules.string.min_len": "1"
|
|
20911
21714
|
},
|
|
21715
|
+
"x-f5xc-description-short": "Exclusive with [any_intf] Name of the chosen interface on the node.",
|
|
20912
21716
|
"x-f5xc-required-for": {
|
|
20913
21717
|
"minimum_config": false,
|
|
20914
21718
|
"create": false,
|
|
@@ -20917,6 +21721,7 @@
|
|
|
20917
21721
|
}
|
|
20918
21722
|
}
|
|
20919
21723
|
},
|
|
21724
|
+
"x-f5xc-description-short": "Interface Identifier identifies one or all interfaces on a node.",
|
|
20920
21725
|
"x-f5xc-minimum-configuration": {
|
|
20921
21726
|
"description": "Minimum configuration for schemaInterfaceIdentifier",
|
|
20922
21727
|
"required_fields": [
|
|
@@ -20948,6 +21753,8 @@
|
|
|
20948
21753
|
"default": "EOK",
|
|
20949
21754
|
"x-displayname": "Error Code.",
|
|
20950
21755
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
21756
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
21757
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
20951
21758
|
"x-f5xc-minimum-configuration": {
|
|
20952
21759
|
"description": "Minimum configuration for schemaErrorCode",
|
|
20953
21760
|
"required_fields": [],
|
|
@@ -20983,6 +21790,7 @@
|
|
|
20983
21790
|
"ves.io.schema.rules.string.max_len": "256",
|
|
20984
21791
|
"ves.io.schema.rules.string.min_len": "1"
|
|
20985
21792
|
},
|
|
21793
|
+
"x-f5xc-description-short": "Exclusive with [pod vn vn_type] Name of the chosen interface on the node.",
|
|
20986
21794
|
"x-f5xc-required-for": {
|
|
20987
21795
|
"minimum_config": false,
|
|
20988
21796
|
"create": false,
|
|
@@ -21007,6 +21815,7 @@
|
|
|
21007
21815
|
"ves.io.schema.rules.string.max_len": "256",
|
|
21008
21816
|
"ves.io.schema.rules.string.min_len": "1"
|
|
21009
21817
|
},
|
|
21818
|
+
"x-f5xc-description-short": "Exclusive with [intf vn vn_type] Name of the pod whose interface on the node is chosen.",
|
|
21010
21819
|
"x-f5xc-required-for": {
|
|
21011
21820
|
"minimum_config": false,
|
|
21012
21821
|
"create": false,
|
|
@@ -21031,6 +21840,7 @@
|
|
|
21031
21840
|
"ves.io.schema.rules.string.max_len": "256",
|
|
21032
21841
|
"ves.io.schema.rules.string.min_len": "1"
|
|
21033
21842
|
},
|
|
21843
|
+
"x-f5xc-description-short": "Exclusive with [intf pod vn_type] Name of chosen Virtual Network.",
|
|
21034
21844
|
"x-f5xc-required-for": {
|
|
21035
21845
|
"minimum_config": false,
|
|
21036
21846
|
"create": false,
|
|
@@ -21079,6 +21889,8 @@
|
|
|
21079
21889
|
"default": "VIRTUAL_NETWORK_SITE_LOCAL",
|
|
21080
21890
|
"x-displayname": "Virtual Network Type.",
|
|
21081
21891
|
"x-ves-proto-enum": "ves.io.schema.VirtualNetworkType",
|
|
21892
|
+
"x-f5xc-description-short": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public...",
|
|
21893
|
+
"x-f5xc-description-medium": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to...",
|
|
21082
21894
|
"x-f5xc-minimum-configuration": {
|
|
21083
21895
|
"description": "Minimum configuration for schemaVirtualNetworkType",
|
|
21084
21896
|
"required_fields": [],
|
|
@@ -21107,6 +21919,7 @@
|
|
|
21107
21919
|
"x-displayname": "Namespace",
|
|
21108
21920
|
"x-ves-example": "System",
|
|
21109
21921
|
"x-f5xc-example": "system",
|
|
21922
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
21110
21923
|
"minLength": 0,
|
|
21111
21924
|
"maxLength": 6,
|
|
21112
21925
|
"x-f5xc-required-for": {
|
|
@@ -21117,7 +21930,7 @@
|
|
|
21117
21930
|
},
|
|
21118
21931
|
"x-original-maxLength": 1024,
|
|
21119
21932
|
"x-reconciled-from-discovery": true,
|
|
21120
|
-
"x-reconciled-at": "2026-01-
|
|
21933
|
+
"x-reconciled-at": "2026-01-07T15:29:31.510043+00:00"
|
|
21121
21934
|
},
|
|
21122
21935
|
"node": {
|
|
21123
21936
|
"type": "string",
|
|
@@ -21139,6 +21952,7 @@
|
|
|
21139
21952
|
"ves.io.schema.rules.string.max_len": "64",
|
|
21140
21953
|
"ves.io.schema.rules.string.min_len": "1"
|
|
21141
21954
|
},
|
|
21955
|
+
"x-f5xc-description-short": "Name of the node on which Tcpdump was run Required: YES.",
|
|
21142
21956
|
"x-f5xc-required-for": {
|
|
21143
21957
|
"minimum_config": false,
|
|
21144
21958
|
"create": false,
|
|
@@ -21153,6 +21967,7 @@
|
|
|
21153
21967
|
"x-displayname": "Site Name",
|
|
21154
21968
|
"x-ves-example": "Value",
|
|
21155
21969
|
"x-f5xc-example": "value",
|
|
21970
|
+
"x-f5xc-description-short": "Name of the site on which Tcpdump was run.",
|
|
21156
21971
|
"minLength": 0,
|
|
21157
21972
|
"maxLength": 1024,
|
|
21158
21973
|
"x-f5xc-required-for": {
|
|
@@ -21163,6 +21978,7 @@
|
|
|
21163
21978
|
}
|
|
21164
21979
|
}
|
|
21165
21980
|
},
|
|
21981
|
+
"x-f5xc-description-short": "Request to fetch captured pcap data from an earlier Tcpdump request.",
|
|
21166
21982
|
"x-f5xc-minimum-configuration": {
|
|
21167
21983
|
"description": "Minimum configuration for tcpdumpFetchRequest",
|
|
21168
21984
|
"required_fields": [
|
|
@@ -21194,6 +22010,7 @@
|
|
|
21194
22010
|
"description": "Timestamp of last packet capture on the Interface.",
|
|
21195
22011
|
"title": "Last Capture Timestamp.",
|
|
21196
22012
|
"x-displayname": "Last Capture Timestamp.",
|
|
22013
|
+
"x-f5xc-description-short": "Timestamp of last packet capture on the Interface.",
|
|
21197
22014
|
"minLength": 0,
|
|
21198
22015
|
"maxLength": 1024,
|
|
21199
22016
|
"x-f5xc-required-for": {
|
|
@@ -21207,6 +22024,7 @@
|
|
|
21207
22024
|
"$ref": "#/components/schemas/tcpdumpTcpdumpStatus"
|
|
21208
22025
|
}
|
|
21209
22026
|
},
|
|
22027
|
+
"x-f5xc-description-short": "Status of tcpdump capture on an interface.",
|
|
21210
22028
|
"x-f5xc-minimum-configuration": {
|
|
21211
22029
|
"description": "Minimum configuration for tcpdumpInterfaceTcpdumpStatus",
|
|
21212
22030
|
"required_fields": [
|
|
@@ -21236,6 +22054,7 @@
|
|
|
21236
22054
|
"x-displayname": "Namespace",
|
|
21237
22055
|
"x-ves-example": "System",
|
|
21238
22056
|
"x-f5xc-example": "system",
|
|
22057
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
21239
22058
|
"minLength": 0,
|
|
21240
22059
|
"maxLength": 6,
|
|
21241
22060
|
"x-f5xc-required-for": {
|
|
@@ -21246,7 +22065,7 @@
|
|
|
21246
22065
|
},
|
|
21247
22066
|
"x-original-maxLength": 1024,
|
|
21248
22067
|
"x-reconciled-from-discovery": true,
|
|
21249
|
-
"x-reconciled-at": "2026-01-
|
|
22068
|
+
"x-reconciled-at": "2026-01-07T15:29:31.510055+00:00"
|
|
21250
22069
|
},
|
|
21251
22070
|
"node": {
|
|
21252
22071
|
"type": "string",
|
|
@@ -21268,6 +22087,7 @@
|
|
|
21268
22087
|
"ves.io.schema.rules.string.max_len": "64",
|
|
21269
22088
|
"ves.io.schema.rules.string.min_len": "1"
|
|
21270
22089
|
},
|
|
22090
|
+
"x-f5xc-description-short": "Name of the node on which Tcpdump status is requested Required: YES.",
|
|
21271
22091
|
"x-f5xc-required-for": {
|
|
21272
22092
|
"minimum_config": false,
|
|
21273
22093
|
"create": false,
|
|
@@ -21282,6 +22102,7 @@
|
|
|
21282
22102
|
"x-displayname": "Site Name",
|
|
21283
22103
|
"x-ves-example": "Value",
|
|
21284
22104
|
"x-f5xc-example": "value",
|
|
22105
|
+
"x-f5xc-description-short": "Name of the site on which Tcpdump status is requested.",
|
|
21285
22106
|
"minLength": 0,
|
|
21286
22107
|
"maxLength": 1024,
|
|
21287
22108
|
"x-f5xc-required-for": {
|
|
@@ -21292,6 +22113,7 @@
|
|
|
21292
22113
|
}
|
|
21293
22114
|
}
|
|
21294
22115
|
},
|
|
22116
|
+
"x-f5xc-description-short": "Request to list Tcpdump capture status on a node.",
|
|
21295
22117
|
"x-f5xc-minimum-configuration": {
|
|
21296
22118
|
"description": "Minimum configuration for tcpdumpListRequest",
|
|
21297
22119
|
"required_fields": [
|
|
@@ -21322,6 +22144,7 @@
|
|
|
21322
22144
|
"$ref": "#/components/schemas/tcpdumpInterfaceTcpdumpStatus"
|
|
21323
22145
|
},
|
|
21324
22146
|
"x-displayname": "Interface Tcpdump Status.",
|
|
22147
|
+
"x-f5xc-description-short": "List of Interfaces along with their last run tcpdump status.",
|
|
21325
22148
|
"x-f5xc-required-for": {
|
|
21326
22149
|
"minimum_config": false,
|
|
21327
22150
|
"create": false,
|
|
@@ -21330,6 +22153,7 @@
|
|
|
21330
22153
|
}
|
|
21331
22154
|
}
|
|
21332
22155
|
},
|
|
22156
|
+
"x-f5xc-description-short": "List of Tcpdump capture status on a node.",
|
|
21333
22157
|
"x-f5xc-minimum-configuration": {
|
|
21334
22158
|
"description": "Minimum configuration for tcpdumpListResponse",
|
|
21335
22159
|
"required_fields": [
|
|
@@ -21380,6 +22204,7 @@
|
|
|
21380
22204
|
"x-validation-rules": {
|
|
21381
22205
|
"ves.io.schema.rules.uint32.lte": "32768"
|
|
21382
22206
|
},
|
|
22207
|
+
"x-f5xc-description-short": "Maximum packets to be captured. Packet capture will end once this number of packets are captured.",
|
|
21383
22208
|
"minimum": 0,
|
|
21384
22209
|
"maximum": 2147483647,
|
|
21385
22210
|
"x-f5xc-required-for": {
|
|
@@ -21406,6 +22231,8 @@
|
|
|
21406
22231
|
"x-validation-rules": {
|
|
21407
22232
|
"ves.io.schema.rules.uint32.lte": "1800"
|
|
21408
22233
|
},
|
|
22234
|
+
"x-f5xc-description-short": "Maximum time period, in seconds, for which packets are to be captured on the interface.",
|
|
22235
|
+
"x-f5xc-description-medium": "Maximum time period, in seconds, for which packets are to be captured on the interface. Packet capture will end after this time period, irrespective of the number of packets captured.",
|
|
21409
22236
|
"minimum": 0,
|
|
21410
22237
|
"maximum": 2147483647,
|
|
21411
22238
|
"x-f5xc-required-for": {
|
|
@@ -21422,6 +22249,7 @@
|
|
|
21422
22249
|
"x-displayname": "Namespace",
|
|
21423
22250
|
"x-ves-example": "System",
|
|
21424
22251
|
"x-f5xc-example": "system",
|
|
22252
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
21425
22253
|
"minLength": 0,
|
|
21426
22254
|
"maxLength": 6,
|
|
21427
22255
|
"x-f5xc-required-for": {
|
|
@@ -21432,7 +22260,7 @@
|
|
|
21432
22260
|
},
|
|
21433
22261
|
"x-original-maxLength": 1024,
|
|
21434
22262
|
"x-reconciled-from-discovery": true,
|
|
21435
|
-
"x-reconciled-at": "2026-01-
|
|
22263
|
+
"x-reconciled-at": "2026-01-07T15:29:31.510069+00:00"
|
|
21436
22264
|
},
|
|
21437
22265
|
"node": {
|
|
21438
22266
|
"type": "string",
|
|
@@ -21454,6 +22282,7 @@
|
|
|
21454
22282
|
"ves.io.schema.rules.string.max_len": "64",
|
|
21455
22283
|
"ves.io.schema.rules.string.min_len": "1"
|
|
21456
22284
|
},
|
|
22285
|
+
"x-f5xc-description-short": "Name of the node on which tcpdump is initiated Required: YES.",
|
|
21457
22286
|
"x-f5xc-required-for": {
|
|
21458
22287
|
"minimum_config": false,
|
|
21459
22288
|
"create": false,
|
|
@@ -21478,6 +22307,8 @@
|
|
|
21478
22307
|
"ves.io.schema.rules.string.max_len": "256",
|
|
21479
22308
|
"ves.io.schema.rules.string.min_len": "1"
|
|
21480
22309
|
},
|
|
22310
|
+
"x-f5xc-description-short": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump. These filter rules will be in the same format as linux tcpdump filter rules.",
|
|
22311
|
+
"x-f5xc-description-medium": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump. These filter rules will be in the same format as linux tcpdump filter rules.",
|
|
21481
22312
|
"x-f5xc-required-for": {
|
|
21482
22313
|
"minimum_config": false,
|
|
21483
22314
|
"create": false,
|
|
@@ -21492,6 +22323,7 @@
|
|
|
21492
22323
|
"x-displayname": "Site Name",
|
|
21493
22324
|
"x-ves-example": "Value",
|
|
21494
22325
|
"x-f5xc-example": "value",
|
|
22326
|
+
"x-f5xc-description-short": "Name of the site on which tcpdump is to be run.",
|
|
21495
22327
|
"minLength": 0,
|
|
21496
22328
|
"maxLength": 1024,
|
|
21497
22329
|
"x-f5xc-required-for": {
|
|
@@ -21502,6 +22334,7 @@
|
|
|
21502
22334
|
}
|
|
21503
22335
|
}
|
|
21504
22336
|
},
|
|
22337
|
+
"x-f5xc-description-short": "Request to run tcpdump on a ver interface.",
|
|
21505
22338
|
"x-f5xc-minimum-configuration": {
|
|
21506
22339
|
"description": "Minimum configuration for tcpdumpTcpdumpRequest",
|
|
21507
22340
|
"required_fields": [
|
|
@@ -21536,6 +22369,7 @@
|
|
|
21536
22369
|
"x-displayname": "Count",
|
|
21537
22370
|
"x-ves-example": "600",
|
|
21538
22371
|
"x-f5xc-example": "600",
|
|
22372
|
+
"x-f5xc-description-short": "Packet capture will end once count reaches, irrespective of time duration is still present.",
|
|
21539
22373
|
"minimum": 0,
|
|
21540
22374
|
"maximum": 2147483647,
|
|
21541
22375
|
"x-f5xc-required-for": {
|
|
@@ -21553,6 +22387,8 @@
|
|
|
21553
22387
|
"x-displayname": "Duration",
|
|
21554
22388
|
"x-ves-example": "120",
|
|
21555
22389
|
"x-f5xc-example": "120",
|
|
22390
|
+
"x-f5xc-description-short": "Duration in seconds, for which packets are captured on the interface.",
|
|
22391
|
+
"x-f5xc-description-medium": "Duration in seconds, for which packets are captured on the interface. Packet capture will end after this duration, irrespective of the number of packets captured.",
|
|
21556
22392
|
"minimum": 0,
|
|
21557
22393
|
"maximum": 2147483647,
|
|
21558
22394
|
"x-f5xc-required-for": {
|
|
@@ -21572,6 +22408,7 @@
|
|
|
21572
22408
|
"x-displayname": "Interface Name.",
|
|
21573
22409
|
"x-ves-example": "Eth0",
|
|
21574
22410
|
"x-f5xc-example": "eth0",
|
|
22411
|
+
"x-f5xc-description-short": "Interface Name on which tcpdump is triggered.",
|
|
21575
22412
|
"minLength": 0,
|
|
21576
22413
|
"maxLength": 1024,
|
|
21577
22414
|
"x-f5xc-required-for": {
|
|
@@ -21588,6 +22425,7 @@
|
|
|
21588
22425
|
"x-displayname": "Node Name",
|
|
21589
22426
|
"x-ves-example": "Master-0",
|
|
21590
22427
|
"x-f5xc-example": "master-0",
|
|
22428
|
+
"x-f5xc-description-short": "Name of the node on which tcpdump is initiated.",
|
|
21591
22429
|
"minLength": 0,
|
|
21592
22430
|
"maxLength": 1024,
|
|
21593
22431
|
"x-f5xc-required-for": {
|
|
@@ -21614,7 +22452,7 @@
|
|
|
21614
22452
|
},
|
|
21615
22453
|
"x-original-maxLength": 1024,
|
|
21616
22454
|
"x-reconciled-from-discovery": true,
|
|
21617
|
-
"x-reconciled-at": "2026-01-
|
|
22455
|
+
"x-reconciled-at": "2026-01-07T15:29:31.510085+00:00"
|
|
21618
22456
|
}
|
|
21619
22457
|
},
|
|
21620
22458
|
"x-f5xc-minimum-configuration": {
|
|
@@ -21647,6 +22485,8 @@
|
|
|
21647
22485
|
"default": "RUNNING",
|
|
21648
22486
|
"x-displayname": "Tcpdump Status.",
|
|
21649
22487
|
"x-ves-proto-enum": "ves.io.schema.operate.tcpdump.TcpdumpStatus",
|
|
22488
|
+
"x-f5xc-description-short": "Shows the status of tcpdump command on an interface Tcpdump capture on the interface is currently running Tcpdump capture on the interface is done...",
|
|
22489
|
+
"x-f5xc-description-medium": "Shows the status of tcpdump command on an interface Tcpdump capture on the interface is currently running Tcpdump capture on the interface is done Tcpdump capture on the interface failed Tcpdump capture on the interface has not been initiated.",
|
|
21650
22490
|
"x-f5xc-minimum-configuration": {
|
|
21651
22491
|
"description": "Minimum configuration for tcpdumpTcpdumpStatus",
|
|
21652
22492
|
"required_fields": [],
|
|
@@ -21683,6 +22523,8 @@
|
|
|
21683
22523
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
21684
22524
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
21685
22525
|
},
|
|
22526
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
22527
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
21686
22528
|
"x-f5xc-required-for": {
|
|
21687
22529
|
"minimum_config": false,
|
|
21688
22530
|
"create": false,
|
|
@@ -21704,6 +22546,7 @@
|
|
|
21704
22546
|
"x-validation-rules": {
|
|
21705
22547
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
21706
22548
|
},
|
|
22549
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
21707
22550
|
"minLength": 0,
|
|
21708
22551
|
"x-f5xc-required-for": {
|
|
21709
22552
|
"minimum_config": false,
|
|
@@ -21713,7 +22556,7 @@
|
|
|
21713
22556
|
},
|
|
21714
22557
|
"x-original-maxLength": 1200,
|
|
21715
22558
|
"x-reconciled-from-discovery": true,
|
|
21716
|
-
"x-reconciled-at": "2026-01-
|
|
22559
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083328+00:00"
|
|
21717
22560
|
},
|
|
21718
22561
|
"disable": {
|
|
21719
22562
|
"type": "boolean",
|
|
@@ -21722,6 +22565,7 @@
|
|
|
21722
22565
|
"format": "boolean",
|
|
21723
22566
|
"x-displayname": "Disable",
|
|
21724
22567
|
"x-f5xc-example": "true",
|
|
22568
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
21725
22569
|
"x-f5xc-required-for": {
|
|
21726
22570
|
"minimum_config": false,
|
|
21727
22571
|
"create": false,
|
|
@@ -21736,6 +22580,8 @@
|
|
|
21736
22580
|
"x-displayname": "Labels",
|
|
21737
22581
|
"x-ves-example": "Value",
|
|
21738
22582
|
"x-f5xc-example": "value",
|
|
22583
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
22584
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
21739
22585
|
"x-f5xc-required-for": {
|
|
21740
22586
|
"minimum_config": false,
|
|
21741
22587
|
"create": false,
|
|
@@ -21756,6 +22602,8 @@
|
|
|
21756
22602
|
"x-validation-rules": {
|
|
21757
22603
|
"ves.io.schema.rules.message.required": "true"
|
|
21758
22604
|
},
|
|
22605
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
22606
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
21759
22607
|
"minLength": 0,
|
|
21760
22608
|
"maxLength": 16,
|
|
21761
22609
|
"x-f5xc-required-for": {
|
|
@@ -21766,7 +22614,7 @@
|
|
|
21766
22614
|
},
|
|
21767
22615
|
"x-original-maxLength": 1024,
|
|
21768
22616
|
"x-reconciled-from-discovery": true,
|
|
21769
|
-
"x-reconciled-at": "2026-01-
|
|
22617
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083336+00:00"
|
|
21770
22618
|
},
|
|
21771
22619
|
"namespace": {
|
|
21772
22620
|
"type": "string",
|
|
@@ -21775,6 +22623,8 @@
|
|
|
21775
22623
|
"x-displayname": "Namespace",
|
|
21776
22624
|
"x-ves-example": "Staging",
|
|
21777
22625
|
"x-f5xc-example": "staging",
|
|
22626
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
22627
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
21778
22628
|
"minLength": 0,
|
|
21779
22629
|
"maxLength": 6,
|
|
21780
22630
|
"x-f5xc-required-for": {
|
|
@@ -21785,9 +22635,10 @@
|
|
|
21785
22635
|
},
|
|
21786
22636
|
"x-original-maxLength": 1024,
|
|
21787
22637
|
"x-reconciled-from-discovery": true,
|
|
21788
|
-
"x-reconciled-at": "2026-01-
|
|
22638
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083340+00:00"
|
|
21789
22639
|
}
|
|
21790
22640
|
},
|
|
22641
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
21791
22642
|
"x-f5xc-minimum-configuration": {
|
|
21792
22643
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
21793
22644
|
"required_fields": [
|
|
@@ -21836,6 +22687,7 @@
|
|
|
21836
22687
|
"x-displayname": "Icon URL",
|
|
21837
22688
|
"x-ves-example": "https://example.atlassian.net/REST/API/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium.",
|
|
21838
22689
|
"x-f5xc-example": "https://example.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium",
|
|
22690
|
+
"x-f5xc-description-short": "Externally accessible URL for the avatar of the issue type.",
|
|
21839
22691
|
"minLength": 0,
|
|
21840
22692
|
"maxLength": 1024,
|
|
21841
22693
|
"x-f5xc-required-for": {
|
|
@@ -21870,6 +22722,7 @@
|
|
|
21870
22722
|
"x-displayname": "Name",
|
|
21871
22723
|
"x-ves-example": "Bug",
|
|
21872
22724
|
"x-f5xc-example": "Bug",
|
|
22725
|
+
"x-f5xc-description-short": "Name (human readable) of the Jira issue type.",
|
|
21873
22726
|
"minLength": 0,
|
|
21874
22727
|
"maxLength": 16,
|
|
21875
22728
|
"x-f5xc-required-for": {
|
|
@@ -21880,9 +22733,11 @@
|
|
|
21880
22733
|
},
|
|
21881
22734
|
"x-original-maxLength": 1024,
|
|
21882
22735
|
"x-reconciled-from-discovery": true,
|
|
21883
|
-
"x-reconciled-at": "2026-01-
|
|
22736
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083434+00:00"
|
|
21884
22737
|
}
|
|
21885
22738
|
},
|
|
22739
|
+
"x-f5xc-description-short": "Issue (ticket) type information that's specific to Jira - modeled after the JIRA REST API response format.",
|
|
22740
|
+
"x-f5xc-description-medium": "Issue (ticket) type information that's specific to Jira - modeled after the JIRA REST API response format.",
|
|
21886
22741
|
"x-f5xc-minimum-configuration": {
|
|
21887
22742
|
"description": "Minimum configuration for ticket_managementJiraIssueType",
|
|
21888
22743
|
"required_fields": [
|
|
@@ -21931,6 +22786,7 @@
|
|
|
21931
22786
|
"$ref": "#/components/schemas/ticket_managementJiraIssueType"
|
|
21932
22787
|
},
|
|
21933
22788
|
"x-displayname": "Issue Types.",
|
|
22789
|
+
"x-f5xc-description-short": "Returns available issue types for the project.",
|
|
21934
22790
|
"x-f5xc-required-for": {
|
|
21935
22791
|
"minimum_config": false,
|
|
21936
22792
|
"create": false,
|
|
@@ -21955,7 +22811,7 @@
|
|
|
21955
22811
|
},
|
|
21956
22812
|
"x-original-maxLength": 1024,
|
|
21957
22813
|
"x-reconciled-from-discovery": true,
|
|
21958
|
-
"x-reconciled-at": "2026-01-
|
|
22814
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083441+00:00"
|
|
21959
22815
|
},
|
|
21960
22816
|
"name": {
|
|
21961
22817
|
"type": "string",
|
|
@@ -21964,6 +22820,7 @@
|
|
|
21964
22820
|
"x-displayname": "Name",
|
|
21965
22821
|
"x-ves-example": "Test project.",
|
|
21966
22822
|
"x-f5xc-example": "Test project",
|
|
22823
|
+
"x-f5xc-description-short": "Human readable name as it would appear in the external ticket tracking system's UI.",
|
|
21967
22824
|
"minLength": 0,
|
|
21968
22825
|
"maxLength": 16,
|
|
21969
22826
|
"x-f5xc-required-for": {
|
|
@@ -21974,9 +22831,11 @@
|
|
|
21974
22831
|
},
|
|
21975
22832
|
"x-original-maxLength": 1024,
|
|
21976
22833
|
"x-reconciled-from-discovery": true,
|
|
21977
|
-
"x-reconciled-at": "2026-01-
|
|
22834
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083446+00:00"
|
|
21978
22835
|
}
|
|
21979
22836
|
},
|
|
22837
|
+
"x-f5xc-description-short": "Contains fields and information that are specific to Jira projects - modeled after the JIRA REST API response format.",
|
|
22838
|
+
"x-f5xc-description-medium": "Contains fields and information that are specific to Jira projects - modeled after the JIRA REST API response format.",
|
|
21980
22839
|
"x-f5xc-minimum-configuration": {
|
|
21981
22840
|
"description": "Minimum configuration for ticket_managementJiraProject",
|
|
21982
22841
|
"required_fields": [
|
|
@@ -22084,6 +22943,7 @@
|
|
|
22084
22943
|
"title": "Fail_if_referred.",
|
|
22085
22944
|
"format": "boolean",
|
|
22086
22945
|
"x-displayname": "Fail-If-Referred.",
|
|
22946
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
22087
22947
|
"x-f5xc-required-for": {
|
|
22088
22948
|
"minimum_config": false,
|
|
22089
22949
|
"create": false,
|
|
@@ -22108,7 +22968,7 @@
|
|
|
22108
22968
|
},
|
|
22109
22969
|
"x-original-maxLength": 1024,
|
|
22110
22970
|
"x-reconciled-from-discovery": true,
|
|
22111
|
-
"x-reconciled-at": "2026-01-
|
|
22971
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083460+00:00"
|
|
22112
22972
|
},
|
|
22113
22973
|
"namespace": {
|
|
22114
22974
|
"type": "string",
|
|
@@ -22117,6 +22977,7 @@
|
|
|
22117
22977
|
"x-displayname": "Namespace",
|
|
22118
22978
|
"x-ves-example": "Ns1",
|
|
22119
22979
|
"x-f5xc-example": "ns1",
|
|
22980
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
22120
22981
|
"minLength": 0,
|
|
22121
22982
|
"maxLength": 6,
|
|
22122
22983
|
"x-f5xc-required-for": {
|
|
@@ -22127,7 +22988,7 @@
|
|
|
22127
22988
|
},
|
|
22128
22989
|
"x-original-maxLength": 1024,
|
|
22129
22990
|
"x-reconciled-from-discovery": true,
|
|
22130
|
-
"x-reconciled-at": "2026-01-
|
|
22991
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083464+00:00"
|
|
22131
22992
|
}
|
|
22132
22993
|
},
|
|
22133
22994
|
"x-f5xc-minimum-configuration": {
|
|
@@ -22162,6 +23023,7 @@
|
|
|
22162
23023
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
22163
23024
|
},
|
|
22164
23025
|
"x-displayname": "Deleted Referred Objects.",
|
|
23026
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
22165
23027
|
"x-f5xc-required-for": {
|
|
22166
23028
|
"minimum_config": false,
|
|
22167
23029
|
"create": false,
|
|
@@ -22177,6 +23039,7 @@
|
|
|
22177
23039
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
22178
23040
|
},
|
|
22179
23041
|
"x-displayname": "Disabled Referred Objects.",
|
|
23042
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
22180
23043
|
"x-f5xc-required-for": {
|
|
22181
23044
|
"minimum_config": false,
|
|
22182
23045
|
"create": false,
|
|
@@ -22195,6 +23058,7 @@
|
|
|
22195
23058
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
22196
23059
|
},
|
|
22197
23060
|
"x-displayname": "Referring Objects.",
|
|
23061
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
22198
23062
|
"x-f5xc-required-for": {
|
|
22199
23063
|
"minimum_config": false,
|
|
22200
23064
|
"create": false,
|
|
@@ -22244,6 +23108,8 @@
|
|
|
22244
23108
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
22245
23109
|
],
|
|
22246
23110
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
23111
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
23112
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
22247
23113
|
"x-f5xc-minimum-configuration": {
|
|
22248
23114
|
"description": "Minimum configuration for ticket_tracking_systemGetResponseFormatCode",
|
|
22249
23115
|
"required_fields": [],
|
|
@@ -22266,6 +23132,7 @@
|
|
|
22266
23132
|
"$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
|
|
22267
23133
|
}
|
|
22268
23134
|
},
|
|
23135
|
+
"x-f5xc-description-short": "GET attributes of a Ticket Tracking System.",
|
|
22269
23136
|
"x-f5xc-minimum-configuration": {
|
|
22270
23137
|
"description": "Minimum configuration for ticket_tracking_systemGetSpecType",
|
|
22271
23138
|
"required_fields": [
|
|
@@ -22303,6 +23170,7 @@
|
|
|
22303
23170
|
"ves.io.schema.rules.string.email": "true",
|
|
22304
23171
|
"ves.io.schema.rules.string.min_len": "1"
|
|
22305
23172
|
},
|
|
23173
|
+
"x-f5xc-description-short": "Username (email) for the Atlassian account Required: YES.",
|
|
22306
23174
|
"maxLength": 1024,
|
|
22307
23175
|
"x-f5xc-required-for": {
|
|
22308
23176
|
"minimum_config": false,
|
|
@@ -22326,6 +23194,8 @@
|
|
|
22326
23194
|
"ves.io.schema.rules.message.required": "true",
|
|
22327
23195
|
"ves.io.schema.rules.string.max_len": "512"
|
|
22328
23196
|
},
|
|
23197
|
+
"x-f5xc-description-short": "API Token (password) specified by the customer in plaintext to be used for Basic Auth.",
|
|
23198
|
+
"x-f5xc-description-medium": "API Token (password) specified by the customer in plaintext to be used for Basic Auth. This value is purely used for user input and is not persisted in the database. It will be converted to a blindfolded and encrypted form before saving.",
|
|
22329
23199
|
"minLength": 0,
|
|
22330
23200
|
"x-f5xc-required-for": {
|
|
22331
23201
|
"minimum_config": false,
|
|
@@ -22353,6 +23223,7 @@
|
|
|
22353
23223
|
"ves.io.schema.rules.string.hostname": "true",
|
|
22354
23224
|
"ves.io.schema.rules.string.min_len": "1"
|
|
22355
23225
|
},
|
|
23226
|
+
"x-f5xc-description-short": "Valid hostname for the Atlassian organization, as defined by RFC 1034 Required: YES.",
|
|
22356
23227
|
"maxLength": 1024,
|
|
22357
23228
|
"x-f5xc-required-for": {
|
|
22358
23229
|
"minimum_config": false,
|
|
@@ -22362,6 +23233,8 @@
|
|
|
22362
23233
|
}
|
|
22363
23234
|
}
|
|
22364
23235
|
},
|
|
23236
|
+
"x-f5xc-description-short": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/ This message represents what is stored in...",
|
|
23237
|
+
"x-f5xc-description-medium": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/ This message represents what is stored in the XC database. To see the API format, refer to the JiraAdhocRestApiConfigurationSpec message.",
|
|
22365
23238
|
"x-f5xc-minimum-configuration": {
|
|
22366
23239
|
"description": "Minimum configuration for ticket_tracking_systemJiraAdhocRestApiConfigurationType",
|
|
22367
23240
|
"required_fields": [
|
|
@@ -22410,6 +23283,7 @@
|
|
|
22410
23283
|
"description": "The name (identifier) of the ticket tracking system for the request.",
|
|
22411
23284
|
"title": "Ticket_tracking_system.",
|
|
22412
23285
|
"x-displayname": "Ticket Tracking System.",
|
|
23286
|
+
"x-f5xc-description-short": "The name (identifier) of the ticket tracking system for the request.",
|
|
22413
23287
|
"minLength": 0,
|
|
22414
23288
|
"maxLength": 1024,
|
|
22415
23289
|
"x-f5xc-required-for": {
|
|
@@ -22446,6 +23320,7 @@
|
|
|
22446
23320
|
"$ref": "#/components/schemas/ticket_managementJiraProject"
|
|
22447
23321
|
},
|
|
22448
23322
|
"x-displayname": "Projects",
|
|
23323
|
+
"x-f5xc-description-short": "List of Jira projects that are available in the specified ticket tracking system.",
|
|
22449
23324
|
"x-f5xc-required-for": {
|
|
22450
23325
|
"minimum_config": false,
|
|
22451
23326
|
"create": false,
|
|
@@ -22458,6 +23333,7 @@
|
|
|
22458
23333
|
"description": "The name (identifier) of the ticket tracking system for the request.",
|
|
22459
23334
|
"title": "Ticket_tracking_system.",
|
|
22460
23335
|
"x-displayname": "Ticket Tracking System.",
|
|
23336
|
+
"x-f5xc-description-short": "The name (identifier) of the ticket tracking system for the request.",
|
|
22461
23337
|
"minLength": 0,
|
|
22462
23338
|
"maxLength": 1024,
|
|
22463
23339
|
"x-f5xc-required-for": {
|
|
@@ -22496,6 +23372,7 @@
|
|
|
22496
23372
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
22497
23373
|
},
|
|
22498
23374
|
"x-displayname": "Errors",
|
|
23375
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
22499
23376
|
"x-f5xc-required-for": {
|
|
22500
23377
|
"minimum_config": false,
|
|
22501
23378
|
"create": false,
|
|
@@ -22511,6 +23388,8 @@
|
|
|
22511
23388
|
"$ref": "#/components/schemas/ticket_tracking_systemListResponseItem"
|
|
22512
23389
|
},
|
|
22513
23390
|
"x-displayname": "Items",
|
|
23391
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
23392
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
22514
23393
|
"x-f5xc-required-for": {
|
|
22515
23394
|
"minimum_config": false,
|
|
22516
23395
|
"create": false,
|
|
@@ -22544,6 +23423,8 @@
|
|
|
22544
23423
|
"description": "The set of annotations present on this ticket_tracking_system.",
|
|
22545
23424
|
"title": "Annotations.",
|
|
22546
23425
|
"x-displayname": "Annotations.",
|
|
23426
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
23427
|
+
"x-f5xc-description-short": "The set of annotations present on this ticket_tracking_system.",
|
|
22547
23428
|
"x-f5xc-required-for": {
|
|
22548
23429
|
"minimum_config": false,
|
|
22549
23430
|
"create": false,
|
|
@@ -22556,6 +23437,7 @@
|
|
|
22556
23437
|
"description": "The description set for this ticket_tracking_system.",
|
|
22557
23438
|
"title": "Description.",
|
|
22558
23439
|
"x-displayname": "Description.",
|
|
23440
|
+
"x-f5xc-description-short": "The description set for this ticket_tracking_system.",
|
|
22559
23441
|
"minLength": 0,
|
|
22560
23442
|
"maxLength": 0,
|
|
22561
23443
|
"x-f5xc-required-for": {
|
|
@@ -22566,7 +23448,7 @@
|
|
|
22566
23448
|
},
|
|
22567
23449
|
"x-original-maxLength": 1024,
|
|
22568
23450
|
"x-reconciled-from-discovery": true,
|
|
22569
|
-
"x-reconciled-at": "2026-01-
|
|
23451
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083497+00:00"
|
|
22570
23452
|
},
|
|
22571
23453
|
"disabled": {
|
|
22572
23454
|
"type": "boolean",
|
|
@@ -22574,6 +23456,8 @@
|
|
|
22574
23456
|
"title": "Disabled",
|
|
22575
23457
|
"format": "boolean",
|
|
22576
23458
|
"x-displayname": "Disabled",
|
|
23459
|
+
"x-f5xc-example": "True",
|
|
23460
|
+
"x-f5xc-description-short": "Value of true indicates ticket_tracking_system is administratively disabled.",
|
|
22577
23461
|
"x-f5xc-required-for": {
|
|
22578
23462
|
"minimum_config": false,
|
|
22579
23463
|
"create": false,
|
|
@@ -22589,6 +23473,8 @@
|
|
|
22589
23473
|
"description": "The set of labels present on this ticket_tracking_system.",
|
|
22590
23474
|
"title": "Labels",
|
|
22591
23475
|
"x-displayname": "Labels",
|
|
23476
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
23477
|
+
"x-f5xc-description-short": "The set of labels present on this ticket_tracking_system.",
|
|
22592
23478
|
"x-f5xc-required-for": {
|
|
22593
23479
|
"minimum_config": false,
|
|
22594
23480
|
"create": false,
|
|
@@ -22606,6 +23492,7 @@
|
|
|
22606
23492
|
"x-displayname": "Name",
|
|
22607
23493
|
"x-ves-example": "Name",
|
|
22608
23494
|
"x-f5xc-example": "name",
|
|
23495
|
+
"x-f5xc-description-short": "The name of this ticket_tracking_system.",
|
|
22609
23496
|
"minLength": 0,
|
|
22610
23497
|
"maxLength": 16,
|
|
22611
23498
|
"x-f5xc-required-for": {
|
|
@@ -22616,7 +23503,7 @@
|
|
|
22616
23503
|
},
|
|
22617
23504
|
"x-original-maxLength": 1024,
|
|
22618
23505
|
"x-reconciled-from-discovery": true,
|
|
22619
|
-
"x-reconciled-at": "2026-01-
|
|
23506
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083518+00:00"
|
|
22620
23507
|
},
|
|
22621
23508
|
"namespace": {
|
|
22622
23509
|
"type": "string",
|
|
@@ -22635,7 +23522,7 @@
|
|
|
22635
23522
|
},
|
|
22636
23523
|
"x-original-maxLength": 1024,
|
|
22637
23524
|
"x-reconciled-from-discovery": true,
|
|
22638
|
-
"x-reconciled-at": "2026-01-
|
|
23525
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083523+00:00"
|
|
22639
23526
|
},
|
|
22640
23527
|
"owner_view": {
|
|
22641
23528
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -22661,7 +23548,7 @@
|
|
|
22661
23548
|
"x-field-mutability": "read-only",
|
|
22662
23549
|
"x-original-maxLength": 1024,
|
|
22663
23550
|
"x-reconciled-from-discovery": true,
|
|
22664
|
-
"x-reconciled-at": "2026-01-
|
|
23551
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083529+00:00"
|
|
22665
23552
|
},
|
|
22666
23553
|
"uid": {
|
|
22667
23554
|
"type": "string",
|
|
@@ -22670,6 +23557,7 @@
|
|
|
22670
23557
|
"x-displayname": "UID",
|
|
22671
23558
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
22672
23559
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
23560
|
+
"x-f5xc-description-short": "The unique uid of this ticket_tracking_system.",
|
|
22673
23561
|
"minLength": 0,
|
|
22674
23562
|
"maxLength": 36,
|
|
22675
23563
|
"x-f5xc-required-for": {
|
|
@@ -22682,9 +23570,11 @@
|
|
|
22682
23570
|
"x-original-maxLength": 1024,
|
|
22683
23571
|
"format": "uuid",
|
|
22684
23572
|
"x-reconciled-from-discovery": true,
|
|
22685
|
-
"x-reconciled-at": "2026-01-
|
|
23573
|
+
"x-reconciled-at": "2026-01-07T15:29:34.083535+00:00"
|
|
22686
23574
|
}
|
|
22687
23575
|
},
|
|
23576
|
+
"x-f5xc-description-short": "By default a summary of ticket_tracking_system is returned in 'List'.",
|
|
23577
|
+
"x-f5xc-description-medium": "By default a summary of ticket_tracking_system is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
22688
23578
|
"x-f5xc-minimum-configuration": {
|
|
22689
23579
|
"description": "Minimum configuration for ticket_tracking_systemListResponseItem",
|
|
22690
23580
|
"required_fields": [
|
|
@@ -22760,6 +23650,7 @@
|
|
|
22760
23650
|
"$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
|
|
22761
23651
|
}
|
|
22762
23652
|
},
|
|
23653
|
+
"x-f5xc-description-short": "Replaces attributes of a Ticket Tracking System.",
|
|
22763
23654
|
"x-f5xc-minimum-configuration": {
|
|
22764
23655
|
"description": "Minimum configuration for ticket_tracking_systemReplaceSpecType",
|
|
22765
23656
|
"required_fields": [
|
|
@@ -22784,6 +23675,8 @@
|
|
|
22784
23675
|
"$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
|
|
22785
23676
|
}
|
|
22786
23677
|
},
|
|
23678
|
+
"x-f5xc-description-short": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
|
|
23679
|
+
"x-f5xc-description-medium": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
|
|
22787
23680
|
"x-f5xc-minimum-configuration": {
|
|
22788
23681
|
"description": "Minimum configuration for ticket_tracking_systemValidateTicketTrackingSystemRequest",
|
|
22789
23682
|
"required_fields": [
|
|
@@ -22811,6 +23704,8 @@
|
|
|
22811
23704
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
22812
23705
|
},
|
|
22813
23706
|
"x-displayname": "Errors",
|
|
23707
|
+
"x-f5xc-description-short": "Errors related to ticket tracking system creation - such as issues with validation of credentials + organization domain.",
|
|
23708
|
+
"x-f5xc-description-medium": "Errors related to ticket tracking system creation - such as issues with validation of credentials + organization domain.",
|
|
22814
23709
|
"x-f5xc-required-for": {
|
|
22815
23710
|
"minimum_config": false,
|
|
22816
23711
|
"create": false,
|
|
@@ -22819,6 +23714,8 @@
|
|
|
22819
23714
|
}
|
|
22820
23715
|
}
|
|
22821
23716
|
},
|
|
23717
|
+
"x-f5xc-description-short": "Response message when validating a Ticket Tracking System's credentials / organization through the custom API Empty errors means the validation...",
|
|
23718
|
+
"x-f5xc-description-medium": "Response message when validating a Ticket Tracking System's credentials / organization through the custom API Empty errors means the validation succeeded.",
|
|
22822
23719
|
"x-f5xc-minimum-configuration": {
|
|
22823
23720
|
"description": "Minimum configuration for ticket_tracking_systemValidateTicketTrackingSystemResponse",
|
|
22824
23721
|
"required_fields": [
|
|
@@ -22845,6 +23742,7 @@
|
|
|
22845
23742
|
"x-displayname": "Namespace",
|
|
22846
23743
|
"x-ves-example": "Value",
|
|
22847
23744
|
"x-f5xc-example": "value",
|
|
23745
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
22848
23746
|
"minLength": 0,
|
|
22849
23747
|
"maxLength": 6,
|
|
22850
23748
|
"x-f5xc-required-for": {
|
|
@@ -22855,7 +23753,7 @@
|
|
|
22855
23753
|
},
|
|
22856
23754
|
"x-original-maxLength": 1024,
|
|
22857
23755
|
"x-reconciled-from-discovery": true,
|
|
22858
|
-
"x-reconciled-at": "2026-01-
|
|
23756
|
+
"x-reconciled-at": "2026-01-07T15:29:36.624611+00:00"
|
|
22859
23757
|
},
|
|
22860
23758
|
"node": {
|
|
22861
23759
|
"type": "string",
|
|
@@ -22881,6 +23779,7 @@
|
|
|
22881
23779
|
"$ref": "#/components/schemas/usb_policyRule"
|
|
22882
23780
|
},
|
|
22883
23781
|
"x-displayname": "USB Enablement Rules.",
|
|
23782
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
22884
23783
|
"x-f5xc-required-for": {
|
|
22885
23784
|
"minimum_config": false,
|
|
22886
23785
|
"create": false,
|
|
@@ -22935,6 +23834,7 @@
|
|
|
22935
23834
|
"$ref": "#/components/schemas/usb_policyRule"
|
|
22936
23835
|
},
|
|
22937
23836
|
"x-displayname": "USB Enablement Rules.",
|
|
23837
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
22938
23838
|
"x-f5xc-required-for": {
|
|
22939
23839
|
"minimum_config": false,
|
|
22940
23840
|
"create": false,
|
|
@@ -22969,6 +23869,7 @@
|
|
|
22969
23869
|
"format": "boolean",
|
|
22970
23870
|
"x-displayname": "USB Allow List Enable.",
|
|
22971
23871
|
"x-f5xc-example": "false",
|
|
23872
|
+
"x-f5xc-description-short": "Enablement of USB rules list. If enabled, all new connected USB devices must be authorized.",
|
|
22972
23873
|
"x-f5xc-required-for": {
|
|
22973
23874
|
"minimum_config": false,
|
|
22974
23875
|
"create": false,
|
|
@@ -23003,6 +23904,7 @@
|
|
|
23003
23904
|
"x-displayname": "Namespace",
|
|
23004
23905
|
"x-ves-example": "Value",
|
|
23005
23906
|
"x-f5xc-example": "value",
|
|
23907
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
23006
23908
|
"minLength": 0,
|
|
23007
23909
|
"maxLength": 6,
|
|
23008
23910
|
"x-f5xc-required-for": {
|
|
@@ -23013,7 +23915,7 @@
|
|
|
23013
23915
|
},
|
|
23014
23916
|
"x-original-maxLength": 1024,
|
|
23015
23917
|
"x-reconciled-from-discovery": true,
|
|
23016
|
-
"x-reconciled-at": "2026-01-
|
|
23918
|
+
"x-reconciled-at": "2026-01-07T15:29:36.624626+00:00"
|
|
23017
23919
|
},
|
|
23018
23920
|
"node": {
|
|
23019
23921
|
"type": "string",
|
|
@@ -23039,6 +23941,7 @@
|
|
|
23039
23941
|
"$ref": "#/components/schemas/usb_policyRule"
|
|
23040
23942
|
},
|
|
23041
23943
|
"x-displayname": "USB Enablement Rules.",
|
|
23944
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
23042
23945
|
"x-f5xc-required-for": {
|
|
23043
23946
|
"minimum_config": false,
|
|
23044
23947
|
"create": false,
|
|
@@ -23093,6 +23996,7 @@
|
|
|
23093
23996
|
"$ref": "#/components/schemas/usb_policyRule"
|
|
23094
23997
|
},
|
|
23095
23998
|
"x-displayname": "USB Enablement Rules.",
|
|
23999
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
23096
24000
|
"x-f5xc-required-for": {
|
|
23097
24001
|
"minimum_config": false,
|
|
23098
24002
|
"create": false,
|
|
@@ -23101,6 +24005,7 @@
|
|
|
23101
24005
|
}
|
|
23102
24006
|
}
|
|
23103
24007
|
},
|
|
24008
|
+
"x-f5xc-description-short": "Response to DELETE USB Enablement Rules.",
|
|
23104
24009
|
"x-f5xc-minimum-configuration": {
|
|
23105
24010
|
"description": "Minimum configuration for usbUsbDeleteRulesResponse",
|
|
23106
24011
|
"required_fields": [
|
|
@@ -23150,6 +24055,7 @@
|
|
|
23150
24055
|
"x-displayname": "Namespace",
|
|
23151
24056
|
"x-ves-example": "Value",
|
|
23152
24057
|
"x-f5xc-example": "value",
|
|
24058
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
23153
24059
|
"minLength": 0,
|
|
23154
24060
|
"maxLength": 6,
|
|
23155
24061
|
"x-f5xc-required-for": {
|
|
@@ -23160,7 +24066,7 @@
|
|
|
23160
24066
|
},
|
|
23161
24067
|
"x-original-maxLength": 1024,
|
|
23162
24068
|
"x-reconciled-from-discovery": true,
|
|
23163
|
-
"x-reconciled-at": "2026-01-
|
|
24069
|
+
"x-reconciled-at": "2026-01-07T15:29:36.624640+00:00"
|
|
23164
24070
|
},
|
|
23165
24071
|
"node": {
|
|
23166
24072
|
"type": "string",
|
|
@@ -23240,6 +24146,7 @@
|
|
|
23240
24146
|
"$ref": "#/components/schemas/usb_policyRule"
|
|
23241
24147
|
},
|
|
23242
24148
|
"x-displayname": "USB Enablement Rule.",
|
|
24149
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
23243
24150
|
"x-f5xc-required-for": {
|
|
23244
24151
|
"minimum_config": false,
|
|
23245
24152
|
"create": false,
|
|
@@ -23277,6 +24184,7 @@
|
|
|
23277
24184
|
"x-displayname": "Namespace",
|
|
23278
24185
|
"x-ves-example": "Value",
|
|
23279
24186
|
"x-f5xc-example": "value",
|
|
24187
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
23280
24188
|
"minLength": 0,
|
|
23281
24189
|
"maxLength": 6,
|
|
23282
24190
|
"x-f5xc-required-for": {
|
|
@@ -23287,7 +24195,7 @@
|
|
|
23287
24195
|
},
|
|
23288
24196
|
"x-original-maxLength": 1024,
|
|
23289
24197
|
"x-reconciled-from-discovery": true,
|
|
23290
|
-
"x-reconciled-at": "2026-01-
|
|
24198
|
+
"x-reconciled-at": "2026-01-07T15:29:36.624651+00:00"
|
|
23291
24199
|
},
|
|
23292
24200
|
"node": {
|
|
23293
24201
|
"type": "string",
|
|
@@ -23383,6 +24291,7 @@
|
|
|
23383
24291
|
"x-displayname": "Protocol",
|
|
23384
24292
|
"x-ves-example": "0002",
|
|
23385
24293
|
"x-f5xc-example": "0002",
|
|
24294
|
+
"x-f5xc-description-short": "The protocol (within the sub-class) of this device.",
|
|
23386
24295
|
"minLength": 0,
|
|
23387
24296
|
"maxLength": 1024,
|
|
23388
24297
|
"x-f5xc-required-for": {
|
|
@@ -23399,6 +24308,7 @@
|
|
|
23399
24308
|
"x-displayname": "Subclass",
|
|
23400
24309
|
"x-ves-example": "Hub",
|
|
23401
24310
|
"x-f5xc-example": "hub",
|
|
24311
|
+
"x-f5xc-description-short": "The sub-class (within the class) of this device.",
|
|
23402
24312
|
"minLength": 0,
|
|
23403
24313
|
"maxLength": 1024,
|
|
23404
24314
|
"x-f5xc-required-for": {
|
|
@@ -23415,6 +24325,7 @@
|
|
|
23415
24325
|
"x-displayname": "ISerialNumber.",
|
|
23416
24326
|
"x-ves-example": "0000:00:14.0.",
|
|
23417
24327
|
"x-f5xc-example": "0000:00:14.0",
|
|
24328
|
+
"x-f5xc-description-short": "Index of Serial Number String Descriptor.",
|
|
23418
24329
|
"minLength": 0,
|
|
23419
24330
|
"maxLength": 1024,
|
|
23420
24331
|
"x-f5xc-required-for": {
|
|
@@ -23431,6 +24342,7 @@
|
|
|
23431
24342
|
"x-displayname": "Product ID.",
|
|
23432
24343
|
"x-ves-example": "0x0002",
|
|
23433
24344
|
"x-f5xc-example": "0x0002",
|
|
24345
|
+
"x-f5xc-description-short": "Product ID (Assigned by Manufacturer) in hex.",
|
|
23434
24346
|
"minLength": 0,
|
|
23435
24347
|
"maxLength": 1024,
|
|
23436
24348
|
"x-f5xc-required-for": {
|
|
@@ -23488,6 +24400,8 @@
|
|
|
23488
24400
|
"default": "UNAVAILABLE",
|
|
23489
24401
|
"x-displayname": "Signal Strength.",
|
|
23490
24402
|
"x-ves-proto-enum": "ves.io.schema.operate.wifi.SignalStrength",
|
|
24403
|
+
"x-f5xc-description-short": "Current Signal Strength - UNAVAILABLE: UNAVAILABLE Signal not received - EXCELLENT: EXCELLENT dBm greater then -50 - GOOD: GOOD dBm between -50...",
|
|
24404
|
+
"x-f5xc-description-medium": "Current Signal Strength - UNAVAILABLE: UNAVAILABLE Signal not received - EXCELLENT: EXCELLENT dBm greater then -50 - GOOD: GOOD dBm between -50 and -60 - FAIR: FAIR dBm between -60 and -70 - POOR: POOR dBm lower then -70.",
|
|
23491
24405
|
"x-f5xc-minimum-configuration": {
|
|
23492
24406
|
"description": "Minimum configuration for wifiSignalStrength",
|
|
23493
24407
|
"required_fields": [],
|
|
@@ -23512,6 +24426,8 @@
|
|
|
23512
24426
|
"x-displayname": "BSSID",
|
|
23513
24427
|
"x-ves-example": "02:18:5a:2e:ef:61.",
|
|
23514
24428
|
"x-f5xc-example": "02:18:5a:2e:ef:61",
|
|
24429
|
+
"x-f5xc-description-short": "The BSS service set identifier. In infrastructure mode, this is the hardware address of the wireless access point that a client is associated with.",
|
|
24430
|
+
"x-f5xc-description-medium": "The BSS service set identifier. In infrastructure mode, this is the hardware address of the wireless access point that a client is associated with.",
|
|
23515
24431
|
"minLength": 0,
|
|
23516
24432
|
"maxLength": 1024,
|
|
23517
24433
|
"x-f5xc-required-for": {
|
|
@@ -23529,6 +24445,7 @@
|
|
|
23529
24445
|
"x-displayname": "Connected",
|
|
23530
24446
|
"x-ves-example": "True",
|
|
23531
24447
|
"x-f5xc-example": "true",
|
|
24448
|
+
"x-f5xc-description-short": "Whether the device is connected to wifi.",
|
|
23532
24449
|
"x-f5xc-required-for": {
|
|
23533
24450
|
"minimum_config": false,
|
|
23534
24451
|
"create": false,
|
|
@@ -23561,6 +24478,7 @@
|
|
|
23561
24478
|
"x-displayname": "Receive bitrate.",
|
|
23562
24479
|
"x-ves-example": "702000000",
|
|
23563
24480
|
"x-f5xc-example": "702000000",
|
|
24481
|
+
"x-f5xc-description-short": "The current data receive bitrate, in bits/second.",
|
|
23564
24482
|
"minimum": 0,
|
|
23565
24483
|
"maximum": 2147483647,
|
|
23566
24484
|
"x-f5xc-required-for": {
|
|
@@ -23578,6 +24496,7 @@
|
|
|
23578
24496
|
"x-displayname": "Signal",
|
|
23579
24497
|
"x-ves-example": "-53",
|
|
23580
24498
|
"x-f5xc-example": "-53",
|
|
24499
|
+
"x-f5xc-description-short": "The signal strength of this station's connection, in dBm.",
|
|
23581
24500
|
"minimum": 0,
|
|
23582
24501
|
"maximum": 2147483647,
|
|
23583
24502
|
"x-f5xc-required-for": {
|
|
@@ -23597,6 +24516,7 @@
|
|
|
23597
24516
|
"x-displayname": "SSID",
|
|
23598
24517
|
"x-ves-example": "F5 Distributed Cloud-Guest.",
|
|
23599
24518
|
"x-f5xc-example": "F5 Distributed Cloud-Guest",
|
|
24519
|
+
"x-f5xc-description-short": "The service set identifier, or \"network name\" of the BSS.",
|
|
23600
24520
|
"minLength": 0,
|
|
23601
24521
|
"maxLength": 1024,
|
|
23602
24522
|
"x-f5xc-required-for": {
|
|
@@ -23614,6 +24534,7 @@
|
|
|
23614
24534
|
"x-displayname": "Transmit bitrate.",
|
|
23615
24535
|
"x-ves-example": "866700000",
|
|
23616
24536
|
"x-f5xc-example": "866700000",
|
|
24537
|
+
"x-f5xc-description-short": "The current data transmit bitrate, in bits/second.",
|
|
23617
24538
|
"minimum": 0,
|
|
23618
24539
|
"maximum": 2147483647,
|
|
23619
24540
|
"x-f5xc-required-for": {
|
|
@@ -23661,6 +24582,7 @@
|
|
|
23661
24582
|
"x-displayname": "SSID",
|
|
23662
24583
|
"x-ves-example": "F5 Distributed Cloud-Guest.",
|
|
23663
24584
|
"x-f5xc-example": "F5 Distributed Cloud-Guest",
|
|
24585
|
+
"x-f5xc-description-short": "The service set identifier, or \"network name\" of the BSS.",
|
|
23664
24586
|
"minLength": 0,
|
|
23665
24587
|
"maxLength": 1024,
|
|
23666
24588
|
"x-f5xc-required-for": {
|
|
@@ -23702,6 +24624,7 @@
|
|
|
23702
24624
|
"x-displayname": "Namespace",
|
|
23703
24625
|
"x-ves-example": "Value",
|
|
23704
24626
|
"x-f5xc-example": "value",
|
|
24627
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
23705
24628
|
"minLength": 0,
|
|
23706
24629
|
"maxLength": 6,
|
|
23707
24630
|
"x-f5xc-required-for": {
|
|
@@ -23712,7 +24635,7 @@
|
|
|
23712
24635
|
},
|
|
23713
24636
|
"x-original-maxLength": 1024,
|
|
23714
24637
|
"x-reconciled-from-discovery": true,
|
|
23715
|
-
"x-reconciled-at": "2026-01-
|
|
24638
|
+
"x-reconciled-at": "2026-01-07T15:29:45.467759+00:00"
|
|
23716
24639
|
},
|
|
23717
24640
|
"node": {
|
|
23718
24641
|
"type": "string",
|
|
@@ -23811,6 +24734,7 @@
|
|
|
23811
24734
|
"$ref": "#/components/schemas/wifiWifi"
|
|
23812
24735
|
}
|
|
23813
24736
|
},
|
|
24737
|
+
"x-f5xc-description-short": "Runtime WIFI information obtained from site.",
|
|
23814
24738
|
"x-f5xc-minimum-configuration": {
|
|
23815
24739
|
"description": "Minimum configuration for wifiWifiInfoResponse",
|
|
23816
24740
|
"required_fields": [
|
|
@@ -23840,6 +24764,7 @@
|
|
|
23840
24764
|
"x-displayname": "SSID",
|
|
23841
24765
|
"x-ves-example": "F5 Distributed Cloud-Guest.",
|
|
23842
24766
|
"x-f5xc-example": "F5 Distributed Cloud-Guest",
|
|
24767
|
+
"x-f5xc-description-short": "The service set identifier, or \"network name\" of the BSS.",
|
|
23843
24768
|
"minLength": 0,
|
|
23844
24769
|
"maxLength": 1024,
|
|
23845
24770
|
"x-f5xc-required-for": {
|
|
@@ -23878,6 +24803,7 @@
|
|
|
23878
24803
|
"$ref": "#/components/schemas/wifiWifiItem"
|
|
23879
24804
|
},
|
|
23880
24805
|
"x-displayname": "WIFI item",
|
|
24806
|
+
"x-f5xc-description-short": "List of available WIFI networks to connect from wifi scan.",
|
|
23881
24807
|
"x-f5xc-required-for": {
|
|
23882
24808
|
"minimum_config": false,
|
|
23883
24809
|
"create": false,
|
|
@@ -23911,6 +24837,8 @@
|
|
|
23911
24837
|
"default": "UNKNOWN",
|
|
23912
24838
|
"x-displayname": "Wifi Security Mechanism.",
|
|
23913
24839
|
"x-ves-proto-enum": "ves.io.schema.operate.wifi.WifiSecurity",
|
|
24840
|
+
"x-f5xc-description-short": "WifiSecurity mechanism of authentication - UNKNOWN: UNKNOWN Unknown mechanims is not available to GET - NONE: NONE None represent no...",
|
|
24841
|
+
"x-f5xc-description-medium": "WifiSecurity mechanism of authentication - UNKNOWN: UNKNOWN Unknown mechanims is not available to GET - NONE: NONE None represent no authentication used - WPA2_PERSONAL: WPA2_PERSONAL WPA2 Personal (PSK) passprase should be used for wifi setup - WPA2_ENTERPRISE: WPA2_ENTERPRISE WPA2 Enterprise...",
|
|
23914
24842
|
"x-f5xc-minimum-configuration": {
|
|
23915
24843
|
"description": "Minimum configuration for wifiWifiSecurity",
|
|
23916
24844
|
"required_fields": [],
|
|
@@ -23990,6 +24918,7 @@
|
|
|
23990
24918
|
"x-displayname": "Namespace",
|
|
23991
24919
|
"x-ves-example": "Value",
|
|
23992
24920
|
"x-f5xc-example": "value",
|
|
24921
|
+
"x-f5xc-description-short": "Namespace for which the request is sent (system).",
|
|
23993
24922
|
"minLength": 0,
|
|
23994
24923
|
"maxLength": 6,
|
|
23995
24924
|
"x-f5xc-required-for": {
|
|
@@ -24000,7 +24929,7 @@
|
|
|
24000
24929
|
},
|
|
24001
24930
|
"x-original-maxLength": 1024,
|
|
24002
24931
|
"x-reconciled-from-discovery": true,
|
|
24003
|
-
"x-reconciled-at": "2026-01-
|
|
24932
|
+
"x-reconciled-at": "2026-01-07T15:29:45.467780+00:00"
|
|
24004
24933
|
},
|
|
24005
24934
|
"node": {
|
|
24006
24935
|
"type": "string",
|