@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
package/specs/domains/bigip.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Bigip",
|
|
5
5
|
"description": "On-premises appliance connector enabling iRule lifecycle operations and data group replication. APM policy coordination, virtual server configuration binding, and CNE linkage. Telemetry aggregation and health status monitoring across hybrid infrastructure deployments.",
|
|
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": "Legacy device orchestration with iRule scripts and data group synchronization. Virtual server bindings and metrics collection.",
|
|
16
|
-
"x-f5xc-cli-domain": "bigip"
|
|
16
|
+
"x-f5xc-cli-domain": "bigip",
|
|
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
|
{
|
|
@@ -280,6 +330,13 @@
|
|
|
280
330
|
"latency": "low",
|
|
281
331
|
"resource_usage": "low"
|
|
282
332
|
}
|
|
333
|
+
},
|
|
334
|
+
"x-f5xc-discovered-response-time": {
|
|
335
|
+
"p50_ms": 1000,
|
|
336
|
+
"p95_ms": 3000,
|
|
337
|
+
"p99_ms": 8000,
|
|
338
|
+
"sample_count": 0,
|
|
339
|
+
"source": "estimate"
|
|
283
340
|
}
|
|
284
341
|
},
|
|
285
342
|
"x-displayname": "BIG-IP APM as a Service.",
|
|
@@ -502,6 +559,13 @@
|
|
|
502
559
|
"latency": "low",
|
|
503
560
|
"resource_usage": "low"
|
|
504
561
|
}
|
|
562
|
+
},
|
|
563
|
+
"x-f5xc-discovered-response-time": {
|
|
564
|
+
"p50_ms": 800,
|
|
565
|
+
"p95_ms": 2500,
|
|
566
|
+
"p99_ms": 6000,
|
|
567
|
+
"sample_count": 0,
|
|
568
|
+
"source": "estimate"
|
|
505
569
|
}
|
|
506
570
|
},
|
|
507
571
|
"x-displayname": "BIG-IP APM as a Service.",
|
|
@@ -729,6 +793,13 @@
|
|
|
729
793
|
"latency": "moderate",
|
|
730
794
|
"resource_usage": "moderate"
|
|
731
795
|
}
|
|
796
|
+
},
|
|
797
|
+
"x-f5xc-discovered-response-time": {
|
|
798
|
+
"p50_ms": 200,
|
|
799
|
+
"p95_ms": 800,
|
|
800
|
+
"p99_ms": 2000,
|
|
801
|
+
"sample_count": 0,
|
|
802
|
+
"source": "estimate"
|
|
732
803
|
}
|
|
733
804
|
},
|
|
734
805
|
"x-displayname": "BIG-IP APM as a Service.",
|
|
@@ -950,6 +1021,13 @@
|
|
|
950
1021
|
"latency": "low",
|
|
951
1022
|
"resource_usage": "low"
|
|
952
1023
|
}
|
|
1024
|
+
},
|
|
1025
|
+
"x-f5xc-discovered-response-time": {
|
|
1026
|
+
"p50_ms": 200,
|
|
1027
|
+
"p95_ms": 800,
|
|
1028
|
+
"p99_ms": 2000,
|
|
1029
|
+
"sample_count": 0,
|
|
1030
|
+
"source": "estimate"
|
|
953
1031
|
}
|
|
954
1032
|
},
|
|
955
1033
|
"delete": {
|
|
@@ -1169,6 +1247,13 @@
|
|
|
1169
1247
|
"latency": "high",
|
|
1170
1248
|
"resource_usage": "moderate"
|
|
1171
1249
|
}
|
|
1250
|
+
},
|
|
1251
|
+
"x-f5xc-discovered-response-time": {
|
|
1252
|
+
"p50_ms": 500,
|
|
1253
|
+
"p95_ms": 1500,
|
|
1254
|
+
"p99_ms": 4000,
|
|
1255
|
+
"sample_count": 0,
|
|
1256
|
+
"source": "estimate"
|
|
1172
1257
|
}
|
|
1173
1258
|
},
|
|
1174
1259
|
"x-displayname": "BIG-IP APM as a Service.",
|
|
@@ -1383,6 +1468,13 @@
|
|
|
1383
1468
|
"latency": "low",
|
|
1384
1469
|
"resource_usage": "low"
|
|
1385
1470
|
}
|
|
1471
|
+
},
|
|
1472
|
+
"x-f5xc-discovered-response-time": {
|
|
1473
|
+
"p50_ms": 1000,
|
|
1474
|
+
"p95_ms": 3000,
|
|
1475
|
+
"p99_ms": 8000,
|
|
1476
|
+
"sample_count": 0,
|
|
1477
|
+
"source": "estimate"
|
|
1386
1478
|
}
|
|
1387
1479
|
},
|
|
1388
1480
|
"x-displayname": "BIG-IP APM as a Service.",
|
|
@@ -1598,6 +1690,13 @@
|
|
|
1598
1690
|
"latency": "low",
|
|
1599
1691
|
"resource_usage": "low"
|
|
1600
1692
|
}
|
|
1693
|
+
},
|
|
1694
|
+
"x-f5xc-discovered-response-time": {
|
|
1695
|
+
"p50_ms": 1000,
|
|
1696
|
+
"p95_ms": 3000,
|
|
1697
|
+
"p99_ms": 8000,
|
|
1698
|
+
"sample_count": 0,
|
|
1699
|
+
"source": "estimate"
|
|
1601
1700
|
}
|
|
1602
1701
|
},
|
|
1603
1702
|
"x-displayname": "BIG-IP iRule as a Service.",
|
|
@@ -1821,6 +1920,13 @@
|
|
|
1821
1920
|
"latency": "low",
|
|
1822
1921
|
"resource_usage": "low"
|
|
1823
1922
|
}
|
|
1923
|
+
},
|
|
1924
|
+
"x-f5xc-discovered-response-time": {
|
|
1925
|
+
"p50_ms": 800,
|
|
1926
|
+
"p95_ms": 2500,
|
|
1927
|
+
"p99_ms": 6000,
|
|
1928
|
+
"sample_count": 0,
|
|
1929
|
+
"source": "estimate"
|
|
1824
1930
|
}
|
|
1825
1931
|
},
|
|
1826
1932
|
"x-displayname": "BIG-IP iRule as a Service.",
|
|
@@ -2049,6 +2155,13 @@
|
|
|
2049
2155
|
"latency": "moderate",
|
|
2050
2156
|
"resource_usage": "moderate"
|
|
2051
2157
|
}
|
|
2158
|
+
},
|
|
2159
|
+
"x-f5xc-discovered-response-time": {
|
|
2160
|
+
"p50_ms": 200,
|
|
2161
|
+
"p95_ms": 800,
|
|
2162
|
+
"p99_ms": 2000,
|
|
2163
|
+
"sample_count": 0,
|
|
2164
|
+
"source": "estimate"
|
|
2052
2165
|
}
|
|
2053
2166
|
},
|
|
2054
2167
|
"x-displayname": "BIG-IP iRule as a Service.",
|
|
@@ -2271,6 +2384,13 @@
|
|
|
2271
2384
|
"latency": "low",
|
|
2272
2385
|
"resource_usage": "low"
|
|
2273
2386
|
}
|
|
2387
|
+
},
|
|
2388
|
+
"x-f5xc-discovered-response-time": {
|
|
2389
|
+
"p50_ms": 200,
|
|
2390
|
+
"p95_ms": 800,
|
|
2391
|
+
"p99_ms": 2000,
|
|
2392
|
+
"sample_count": 0,
|
|
2393
|
+
"source": "estimate"
|
|
2274
2394
|
}
|
|
2275
2395
|
},
|
|
2276
2396
|
"delete": {
|
|
@@ -2491,6 +2611,13 @@
|
|
|
2491
2611
|
"latency": "high",
|
|
2492
2612
|
"resource_usage": "moderate"
|
|
2493
2613
|
}
|
|
2614
|
+
},
|
|
2615
|
+
"x-f5xc-discovered-response-time": {
|
|
2616
|
+
"p50_ms": 500,
|
|
2617
|
+
"p95_ms": 1500,
|
|
2618
|
+
"p99_ms": 4000,
|
|
2619
|
+
"sample_count": 0,
|
|
2620
|
+
"source": "estimate"
|
|
2494
2621
|
}
|
|
2495
2622
|
},
|
|
2496
2623
|
"x-displayname": "BIG-IP iRule as a Service.",
|
|
@@ -2713,6 +2840,13 @@
|
|
|
2713
2840
|
"latency": "low",
|
|
2714
2841
|
"resource_usage": "low"
|
|
2715
2842
|
}
|
|
2843
|
+
},
|
|
2844
|
+
"x-f5xc-discovered-response-time": {
|
|
2845
|
+
"p50_ms": 800,
|
|
2846
|
+
"p95_ms": 2500,
|
|
2847
|
+
"p99_ms": 6000,
|
|
2848
|
+
"sample_count": 0,
|
|
2849
|
+
"source": "estimate"
|
|
2716
2850
|
}
|
|
2717
2851
|
},
|
|
2718
2852
|
"x-displayname": "BIG-IP virtual server.",
|
|
@@ -2942,7 +3076,15 @@
|
|
|
2942
3076
|
}
|
|
2943
3077
|
},
|
|
2944
3078
|
"x-discovered-response-time-ms": 152.67,
|
|
2945
|
-
"x-discovered-sample-size": 1
|
|
3079
|
+
"x-discovered-sample-size": 1,
|
|
3080
|
+
"x-f5xc-discovered-response-time": {
|
|
3081
|
+
"p50_ms": 152.67,
|
|
3082
|
+
"p95_ms": 305.34,
|
|
3083
|
+
"p99_ms": 458.01,
|
|
3084
|
+
"sample_count": 1,
|
|
3085
|
+
"source": "discovery",
|
|
3086
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
3087
|
+
}
|
|
2946
3088
|
},
|
|
2947
3089
|
"x-displayname": "BIG-IP virtual server.",
|
|
2948
3090
|
"x-ves-proto-service": "ves.io.schema.views.bigip_virtual_server.API",
|
|
@@ -3156,6 +3298,13 @@
|
|
|
3156
3298
|
"latency": "low",
|
|
3157
3299
|
"resource_usage": "low"
|
|
3158
3300
|
}
|
|
3301
|
+
},
|
|
3302
|
+
"x-f5xc-discovered-response-time": {
|
|
3303
|
+
"p50_ms": 1000,
|
|
3304
|
+
"p95_ms": 3000,
|
|
3305
|
+
"p99_ms": 8000,
|
|
3306
|
+
"sample_count": 0,
|
|
3307
|
+
"source": "estimate"
|
|
3159
3308
|
}
|
|
3160
3309
|
},
|
|
3161
3310
|
"x-displayname": "BIG-IP virtual server.",
|
|
@@ -3376,6 +3525,13 @@
|
|
|
3376
3525
|
"latency": "low",
|
|
3377
3526
|
"resource_usage": "low"
|
|
3378
3527
|
}
|
|
3528
|
+
},
|
|
3529
|
+
"x-f5xc-discovered-response-time": {
|
|
3530
|
+
"p50_ms": 200,
|
|
3531
|
+
"p95_ms": 800,
|
|
3532
|
+
"p99_ms": 2000,
|
|
3533
|
+
"sample_count": 0,
|
|
3534
|
+
"source": "estimate"
|
|
3379
3535
|
}
|
|
3380
3536
|
},
|
|
3381
3537
|
"x-displayname": "BIG-IP virtual server.",
|
|
@@ -3591,6 +3747,13 @@
|
|
|
3591
3747
|
"latency": "low",
|
|
3592
3748
|
"resource_usage": "low"
|
|
3593
3749
|
}
|
|
3750
|
+
},
|
|
3751
|
+
"x-f5xc-discovered-response-time": {
|
|
3752
|
+
"p50_ms": 1000,
|
|
3753
|
+
"p95_ms": 3000,
|
|
3754
|
+
"p99_ms": 8000,
|
|
3755
|
+
"sample_count": 0,
|
|
3756
|
+
"source": "estimate"
|
|
3594
3757
|
}
|
|
3595
3758
|
},
|
|
3596
3759
|
"x-displayname": "Configure iRule.",
|
|
@@ -3814,6 +3977,13 @@
|
|
|
3814
3977
|
"latency": "low",
|
|
3815
3978
|
"resource_usage": "low"
|
|
3816
3979
|
}
|
|
3980
|
+
},
|
|
3981
|
+
"x-f5xc-discovered-response-time": {
|
|
3982
|
+
"p50_ms": 800,
|
|
3983
|
+
"p95_ms": 2500,
|
|
3984
|
+
"p99_ms": 6000,
|
|
3985
|
+
"sample_count": 0,
|
|
3986
|
+
"source": "estimate"
|
|
3817
3987
|
}
|
|
3818
3988
|
},
|
|
3819
3989
|
"x-displayname": "Configure iRule.",
|
|
@@ -4044,7 +4214,15 @@
|
|
|
4044
4214
|
}
|
|
4045
4215
|
},
|
|
4046
4216
|
"x-discovered-response-time-ms": 157.12,
|
|
4047
|
-
"x-discovered-sample-size": 1
|
|
4217
|
+
"x-discovered-sample-size": 1,
|
|
4218
|
+
"x-f5xc-discovered-response-time": {
|
|
4219
|
+
"p50_ms": 157.12,
|
|
4220
|
+
"p95_ms": 314.24,
|
|
4221
|
+
"p99_ms": 471.36,
|
|
4222
|
+
"sample_count": 1,
|
|
4223
|
+
"source": "discovery",
|
|
4224
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
4225
|
+
}
|
|
4048
4226
|
},
|
|
4049
4227
|
"x-displayname": "Configure iRule.",
|
|
4050
4228
|
"x-ves-proto-service": "ves.io.schema.bigcne.irule.API",
|
|
@@ -4265,6 +4443,13 @@
|
|
|
4265
4443
|
"latency": "low",
|
|
4266
4444
|
"resource_usage": "low"
|
|
4267
4445
|
}
|
|
4446
|
+
},
|
|
4447
|
+
"x-f5xc-discovered-response-time": {
|
|
4448
|
+
"p50_ms": 200,
|
|
4449
|
+
"p95_ms": 800,
|
|
4450
|
+
"p99_ms": 2000,
|
|
4451
|
+
"sample_count": 0,
|
|
4452
|
+
"source": "estimate"
|
|
4268
4453
|
}
|
|
4269
4454
|
},
|
|
4270
4455
|
"delete": {
|
|
@@ -4485,6 +4670,13 @@
|
|
|
4485
4670
|
"latency": "high",
|
|
4486
4671
|
"resource_usage": "moderate"
|
|
4487
4672
|
}
|
|
4673
|
+
},
|
|
4674
|
+
"x-f5xc-discovered-response-time": {
|
|
4675
|
+
"p50_ms": 500,
|
|
4676
|
+
"p95_ms": 1500,
|
|
4677
|
+
"p99_ms": 4000,
|
|
4678
|
+
"sample_count": 0,
|
|
4679
|
+
"source": "estimate"
|
|
4488
4680
|
}
|
|
4489
4681
|
},
|
|
4490
4682
|
"x-displayname": "Configure iRule.",
|
|
@@ -4699,6 +4891,13 @@
|
|
|
4699
4891
|
"latency": "low",
|
|
4700
4892
|
"resource_usage": "low"
|
|
4701
4893
|
}
|
|
4894
|
+
},
|
|
4895
|
+
"x-f5xc-discovered-response-time": {
|
|
4896
|
+
"p50_ms": 1000,
|
|
4897
|
+
"p95_ms": 3000,
|
|
4898
|
+
"p99_ms": 8000,
|
|
4899
|
+
"sample_count": 0,
|
|
4900
|
+
"source": "estimate"
|
|
4702
4901
|
}
|
|
4703
4902
|
},
|
|
4704
4903
|
"x-displayname": "Data Group.",
|
|
@@ -4921,6 +5120,13 @@
|
|
|
4921
5120
|
"latency": "low",
|
|
4922
5121
|
"resource_usage": "low"
|
|
4923
5122
|
}
|
|
5123
|
+
},
|
|
5124
|
+
"x-f5xc-discovered-response-time": {
|
|
5125
|
+
"p50_ms": 800,
|
|
5126
|
+
"p95_ms": 2500,
|
|
5127
|
+
"p99_ms": 6000,
|
|
5128
|
+
"sample_count": 0,
|
|
5129
|
+
"source": "estimate"
|
|
4924
5130
|
}
|
|
4925
5131
|
},
|
|
4926
5132
|
"x-displayname": "Data Group.",
|
|
@@ -5150,7 +5356,15 @@
|
|
|
5150
5356
|
}
|
|
5151
5357
|
},
|
|
5152
5358
|
"x-discovered-response-time-ms": 154.24,
|
|
5153
|
-
"x-discovered-sample-size": 1
|
|
5359
|
+
"x-discovered-sample-size": 1,
|
|
5360
|
+
"x-f5xc-discovered-response-time": {
|
|
5361
|
+
"p50_ms": 154.24,
|
|
5362
|
+
"p95_ms": 308.48,
|
|
5363
|
+
"p99_ms": 462.72,
|
|
5364
|
+
"sample_count": 1,
|
|
5365
|
+
"source": "discovery",
|
|
5366
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
5367
|
+
}
|
|
5154
5368
|
},
|
|
5155
5369
|
"x-displayname": "Data Group.",
|
|
5156
5370
|
"x-ves-proto-service": "ves.io.schema.bigcne.data_group.API",
|
|
@@ -5370,6 +5584,13 @@
|
|
|
5370
5584
|
"latency": "low",
|
|
5371
5585
|
"resource_usage": "low"
|
|
5372
5586
|
}
|
|
5587
|
+
},
|
|
5588
|
+
"x-f5xc-discovered-response-time": {
|
|
5589
|
+
"p50_ms": 200,
|
|
5590
|
+
"p95_ms": 800,
|
|
5591
|
+
"p99_ms": 2000,
|
|
5592
|
+
"sample_count": 0,
|
|
5593
|
+
"source": "estimate"
|
|
5373
5594
|
}
|
|
5374
5595
|
},
|
|
5375
5596
|
"delete": {
|
|
@@ -5589,6 +5810,13 @@
|
|
|
5589
5810
|
"latency": "high",
|
|
5590
5811
|
"resource_usage": "moderate"
|
|
5591
5812
|
}
|
|
5813
|
+
},
|
|
5814
|
+
"x-f5xc-discovered-response-time": {
|
|
5815
|
+
"p50_ms": 500,
|
|
5816
|
+
"p95_ms": 1500,
|
|
5817
|
+
"p99_ms": 4000,
|
|
5818
|
+
"sample_count": 0,
|
|
5819
|
+
"source": "estimate"
|
|
5592
5820
|
}
|
|
5593
5821
|
},
|
|
5594
5822
|
"x-displayname": "Data Group.",
|
|
@@ -5633,6 +5861,8 @@
|
|
|
5633
5861
|
"ves.io.schema.rules.map.max_pairs": "5",
|
|
5634
5862
|
"ves.io.schema.rules.map.values.string.max_len": "255"
|
|
5635
5863
|
},
|
|
5864
|
+
"x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.",
|
|
5865
|
+
"x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.",
|
|
5636
5866
|
"x-f5xc-required-for": {
|
|
5637
5867
|
"minimum_config": false,
|
|
5638
5868
|
"create": false,
|
|
@@ -5641,6 +5871,7 @@
|
|
|
5641
5871
|
}
|
|
5642
5872
|
}
|
|
5643
5873
|
},
|
|
5874
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP specification for AWS TGW Site.",
|
|
5644
5875
|
"x-f5xc-minimum-configuration": {
|
|
5645
5876
|
"description": "Minimum configuration for apmAPMBigIpAWSReplaceType",
|
|
5646
5877
|
"required_fields": [
|
|
@@ -5681,6 +5912,7 @@
|
|
|
5681
5912
|
"ves.io.schema.rules.message.required": "true",
|
|
5682
5913
|
"ves.io.schema.rules.string.max_len": "256"
|
|
5683
5914
|
},
|
|
5915
|
+
"x-f5xc-description-short": "Admin Username for BIG-IP Required: YES.",
|
|
5684
5916
|
"minLength": 0,
|
|
5685
5917
|
"x-f5xc-required-for": {
|
|
5686
5918
|
"minimum_config": false,
|
|
@@ -5716,6 +5948,7 @@
|
|
|
5716
5948
|
"ves.io.schema.rules.repeated.max_items": "2",
|
|
5717
5949
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
5718
5950
|
},
|
|
5951
|
+
"x-f5xc-description-short": "Specify how and where the service nodes are spawned Required: YES.",
|
|
5719
5952
|
"x-f5xc-required-for": {
|
|
5720
5953
|
"minimum_config": false,
|
|
5721
5954
|
"create": false,
|
|
@@ -5743,6 +5976,7 @@
|
|
|
5743
5976
|
"ves.io.schema.rules.string.max_len": "8192",
|
|
5744
5977
|
"ves.io.schema.rules.string.min_len": "1"
|
|
5745
5978
|
},
|
|
5979
|
+
"x-f5xc-description-short": "Public SSH key for accessing the BIG-IP nodes. Required: YES.",
|
|
5746
5980
|
"x-f5xc-required-for": {
|
|
5747
5981
|
"minimum_config": false,
|
|
5748
5982
|
"create": false,
|
|
@@ -5767,6 +6001,8 @@
|
|
|
5767
6001
|
"ves.io.schema.rules.map.max_pairs": "5",
|
|
5768
6002
|
"ves.io.schema.rules.map.values.string.max_len": "255"
|
|
5769
6003
|
},
|
|
6004
|
+
"x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.",
|
|
6005
|
+
"x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.",
|
|
5770
6006
|
"x-f5xc-required-for": {
|
|
5771
6007
|
"minimum_config": false,
|
|
5772
6008
|
"create": false,
|
|
@@ -5775,6 +6011,7 @@
|
|
|
5775
6011
|
}
|
|
5776
6012
|
}
|
|
5777
6013
|
},
|
|
6014
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP configuration for AWS TGW Site using BIG-IP APM service.",
|
|
5778
6015
|
"x-f5xc-minimum-configuration": {
|
|
5779
6016
|
"description": "Minimum configuration for apmAPMBigIpAWSType",
|
|
5780
6017
|
"required_fields": [
|
|
@@ -5808,6 +6045,7 @@
|
|
|
5808
6045
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
5809
6046
|
}
|
|
5810
6047
|
},
|
|
6048
|
+
"x-f5xc-description-short": "Select the flavor of BIG-IP AWS Marketplace to launch the instance on AWS TGW Site.",
|
|
5811
6049
|
"x-f5xc-minimum-configuration": {
|
|
5812
6050
|
"description": "Minimum configuration for apmAWSMarketPlaceImageTypeAPMaaS",
|
|
5813
6051
|
"required_fields": [
|
|
@@ -5836,6 +6074,7 @@
|
|
|
5836
6074
|
"$ref": "#/components/schemas/apmAWSMarketPlaceImageTypeAPMaaS"
|
|
5837
6075
|
}
|
|
5838
6076
|
},
|
|
6077
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP APM service to be deployed as external service on AWS Transit Gateway Site.",
|
|
5839
6078
|
"x-f5xc-minimum-configuration": {
|
|
5840
6079
|
"description": "Minimum configuration for apmAWSSiteTypeChoice",
|
|
5841
6080
|
"required_fields": [
|
|
@@ -5860,6 +6099,7 @@
|
|
|
5860
6099
|
"$ref": "#/components/schemas/apmAPMBigIpAWSReplaceType"
|
|
5861
6100
|
}
|
|
5862
6101
|
},
|
|
6102
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP service to be deployed on AWS Transit Gateway Site.",
|
|
5863
6103
|
"x-f5xc-minimum-configuration": {
|
|
5864
6104
|
"description": "Minimum configuration for apmAWSSiteTypeChoiceReplaceType",
|
|
5865
6105
|
"required_fields": [
|
|
@@ -5940,6 +6180,7 @@
|
|
|
5940
6180
|
"title": "Fail_if_referred.",
|
|
5941
6181
|
"format": "boolean",
|
|
5942
6182
|
"x-displayname": "Fail-If-Referred.",
|
|
6183
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
5943
6184
|
"x-f5xc-required-for": {
|
|
5944
6185
|
"minimum_config": false,
|
|
5945
6186
|
"create": false,
|
|
@@ -5964,7 +6205,7 @@
|
|
|
5964
6205
|
},
|
|
5965
6206
|
"x-original-maxLength": 1024,
|
|
5966
6207
|
"x-reconciled-from-discovery": true,
|
|
5967
|
-
"x-reconciled-at": "2026-01-
|
|
6208
|
+
"x-reconciled-at": "2026-01-07T15:27:57.791989+00:00"
|
|
5968
6209
|
},
|
|
5969
6210
|
"namespace": {
|
|
5970
6211
|
"type": "string",
|
|
@@ -5973,6 +6214,7 @@
|
|
|
5973
6214
|
"x-displayname": "Namespace",
|
|
5974
6215
|
"x-ves-example": "Ns1",
|
|
5975
6216
|
"x-f5xc-example": "ns1",
|
|
6217
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
5976
6218
|
"minLength": 0,
|
|
5977
6219
|
"maxLength": 6,
|
|
5978
6220
|
"x-f5xc-required-for": {
|
|
@@ -5983,7 +6225,7 @@
|
|
|
5983
6225
|
},
|
|
5984
6226
|
"x-original-maxLength": 1024,
|
|
5985
6227
|
"x-reconciled-from-discovery": true,
|
|
5986
|
-
"x-reconciled-at": "2026-01-
|
|
6228
|
+
"x-reconciled-at": "2026-01-07T15:27:57.791996+00:00"
|
|
5987
6229
|
}
|
|
5988
6230
|
},
|
|
5989
6231
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6006,6 +6248,7 @@
|
|
|
6006
6248
|
"title": "BIG-IP APM on App Stack Bare Metal Site.",
|
|
6007
6249
|
"x-displayname": "BIG-IP APM on App Stack Bare Metal Site.",
|
|
6008
6250
|
"x-ves-proto-message": "ves.io.schema.bigip.apm.F5BigIpAppStackBareMetalChoiceReplaceType",
|
|
6251
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP APM service to be deployed on App Stack Bare Metal Site.",
|
|
6009
6252
|
"x-f5xc-minimum-configuration": {
|
|
6010
6253
|
"description": "Minimum configuration for apmF5BigIpAppStackBareMetalChoiceReplaceType",
|
|
6011
6254
|
"required_fields": [],
|
|
@@ -6027,6 +6270,7 @@
|
|
|
6027
6270
|
"$ref": "#/components/schemas/nfv_serviceF5BigIpAppStackBareMetalType"
|
|
6028
6271
|
}
|
|
6029
6272
|
},
|
|
6273
|
+
"x-f5xc-description-short": "Virtual BIG-IP specification for App Stack Bare Metal Site.",
|
|
6030
6274
|
"x-f5xc-minimum-configuration": {
|
|
6031
6275
|
"description": "Minimum configuration for apmF5BigIpAppStackBareMetalTypeChoice",
|
|
6032
6276
|
"required_fields": [
|
|
@@ -6057,6 +6301,7 @@
|
|
|
6057
6301
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6058
6302
|
},
|
|
6059
6303
|
"x-displayname": "Deleted Referred Objects.",
|
|
6304
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6060
6305
|
"x-f5xc-required-for": {
|
|
6061
6306
|
"minimum_config": false,
|
|
6062
6307
|
"create": false,
|
|
@@ -6072,6 +6317,7 @@
|
|
|
6072
6317
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6073
6318
|
},
|
|
6074
6319
|
"x-displayname": "Disabled Referred Objects.",
|
|
6320
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6075
6321
|
"x-f5xc-required-for": {
|
|
6076
6322
|
"minimum_config": false,
|
|
6077
6323
|
"create": false,
|
|
@@ -6090,6 +6336,7 @@
|
|
|
6090
6336
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6091
6337
|
},
|
|
6092
6338
|
"x-displayname": "Referring Objects.",
|
|
6339
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6093
6340
|
"x-f5xc-required-for": {
|
|
6094
6341
|
"minimum_config": false,
|
|
6095
6342
|
"create": false,
|
|
@@ -6111,6 +6358,8 @@
|
|
|
6111
6358
|
"$ref": "#/components/schemas/apmStatusObject"
|
|
6112
6359
|
},
|
|
6113
6360
|
"x-displayname": "Status",
|
|
6361
|
+
"x-f5xc-example": "active",
|
|
6362
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6114
6363
|
"x-f5xc-required-for": {
|
|
6115
6364
|
"minimum_config": false,
|
|
6116
6365
|
"create": false,
|
|
@@ -6120,7 +6369,7 @@
|
|
|
6120
6369
|
"maxLength": 17,
|
|
6121
6370
|
"minLength": 17,
|
|
6122
6371
|
"x-reconciled-from-discovery": true,
|
|
6123
|
-
"x-reconciled-at": "2026-01-
|
|
6372
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792014+00:00"
|
|
6124
6373
|
},
|
|
6125
6374
|
"system_metadata": {
|
|
6126
6375
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6160,6 +6409,8 @@
|
|
|
6160
6409
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6161
6410
|
],
|
|
6162
6411
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6412
|
+
"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...",
|
|
6413
|
+
"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...",
|
|
6163
6414
|
"x-f5xc-minimum-configuration": {
|
|
6164
6415
|
"description": "Minimum configuration for apmGetResponseFormatCode",
|
|
6165
6416
|
"required_fields": [],
|
|
@@ -6185,6 +6436,7 @@
|
|
|
6185
6436
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6186
6437
|
},
|
|
6187
6438
|
"x-displayname": "Errors",
|
|
6439
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6188
6440
|
"x-f5xc-required-for": {
|
|
6189
6441
|
"minimum_config": false,
|
|
6190
6442
|
"create": false,
|
|
@@ -6200,6 +6452,8 @@
|
|
|
6200
6452
|
"$ref": "#/components/schemas/apmListResponseItem"
|
|
6201
6453
|
},
|
|
6202
6454
|
"x-displayname": "Items",
|
|
6455
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
6456
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6203
6457
|
"x-f5xc-required-for": {
|
|
6204
6458
|
"minimum_config": false,
|
|
6205
6459
|
"create": false,
|
|
@@ -6233,6 +6487,8 @@
|
|
|
6233
6487
|
"description": "The set of annotations present on this apm.",
|
|
6234
6488
|
"title": "Annotations.",
|
|
6235
6489
|
"x-displayname": "Annotations.",
|
|
6490
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6491
|
+
"x-f5xc-description-short": "The set of annotations present on this apm.",
|
|
6236
6492
|
"x-f5xc-required-for": {
|
|
6237
6493
|
"minimum_config": false,
|
|
6238
6494
|
"create": false,
|
|
@@ -6255,7 +6511,7 @@
|
|
|
6255
6511
|
},
|
|
6256
6512
|
"x-original-maxLength": 1024,
|
|
6257
6513
|
"x-reconciled-from-discovery": true,
|
|
6258
|
-
"x-reconciled-at": "2026-01-
|
|
6514
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792026+00:00"
|
|
6259
6515
|
},
|
|
6260
6516
|
"disabled": {
|
|
6261
6517
|
"type": "boolean",
|
|
@@ -6263,6 +6519,8 @@
|
|
|
6263
6519
|
"title": "Disabled",
|
|
6264
6520
|
"format": "boolean",
|
|
6265
6521
|
"x-displayname": "Disabled",
|
|
6522
|
+
"x-f5xc-example": "True",
|
|
6523
|
+
"x-f5xc-description-short": "Value of true indicates apm is administratively disabled.",
|
|
6266
6524
|
"x-f5xc-required-for": {
|
|
6267
6525
|
"minimum_config": false,
|
|
6268
6526
|
"create": false,
|
|
@@ -6278,6 +6536,7 @@
|
|
|
6278
6536
|
"description": "The set of labels present on this apm.",
|
|
6279
6537
|
"title": "Labels",
|
|
6280
6538
|
"x-displayname": "Labels",
|
|
6539
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6281
6540
|
"x-f5xc-required-for": {
|
|
6282
6541
|
"minimum_config": false,
|
|
6283
6542
|
"create": false,
|
|
@@ -6305,7 +6564,7 @@
|
|
|
6305
6564
|
},
|
|
6306
6565
|
"x-original-maxLength": 1024,
|
|
6307
6566
|
"x-reconciled-from-discovery": true,
|
|
6308
|
-
"x-reconciled-at": "2026-01-
|
|
6567
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792036+00:00"
|
|
6309
6568
|
},
|
|
6310
6569
|
"namespace": {
|
|
6311
6570
|
"type": "string",
|
|
@@ -6324,7 +6583,7 @@
|
|
|
6324
6583
|
},
|
|
6325
6584
|
"x-original-maxLength": 1024,
|
|
6326
6585
|
"x-reconciled-from-discovery": true,
|
|
6327
|
-
"x-reconciled-at": "2026-01-
|
|
6586
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792041+00:00"
|
|
6328
6587
|
},
|
|
6329
6588
|
"owner_view": {
|
|
6330
6589
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6337,6 +6596,7 @@
|
|
|
6337
6596
|
"$ref": "#/components/schemas/apmStatusObject"
|
|
6338
6597
|
},
|
|
6339
6598
|
"x-displayname": "Status",
|
|
6599
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6340
6600
|
"x-f5xc-required-for": {
|
|
6341
6601
|
"minimum_config": false,
|
|
6342
6602
|
"create": false,
|
|
@@ -6365,7 +6625,7 @@
|
|
|
6365
6625
|
"x-field-mutability": "read-only",
|
|
6366
6626
|
"x-original-maxLength": 1024,
|
|
6367
6627
|
"x-reconciled-from-discovery": true,
|
|
6368
|
-
"x-reconciled-at": "2026-01-
|
|
6628
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792048+00:00"
|
|
6369
6629
|
},
|
|
6370
6630
|
"uid": {
|
|
6371
6631
|
"type": "string",
|
|
@@ -6386,9 +6646,11 @@
|
|
|
6386
6646
|
"x-original-maxLength": 1024,
|
|
6387
6647
|
"format": "uuid",
|
|
6388
6648
|
"x-reconciled-from-discovery": true,
|
|
6389
|
-
"x-reconciled-at": "2026-01-
|
|
6649
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792054+00:00"
|
|
6390
6650
|
}
|
|
6391
6651
|
},
|
|
6652
|
+
"x-f5xc-description-short": "By default a summary of apm is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6653
|
+
"x-f5xc-description-medium": "By default a summary of apm is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6392
6654
|
"x-f5xc-minimum-configuration": {
|
|
6393
6655
|
"description": "Minimum configuration for apmListResponseItem",
|
|
6394
6656
|
"required_fields": [
|
|
@@ -6428,6 +6690,7 @@
|
|
|
6428
6690
|
"$ref": "#/components/schemas/bigipapmMetricTypeData"
|
|
6429
6691
|
},
|
|
6430
6692
|
"x-displayname": "Data",
|
|
6693
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6431
6694
|
"x-f5xc-required-for": {
|
|
6432
6695
|
"minimum_config": false,
|
|
6433
6696
|
"create": false,
|
|
@@ -6442,6 +6705,7 @@
|
|
|
6442
6705
|
"$ref": "#/components/schemas/schemaUnitType"
|
|
6443
6706
|
}
|
|
6444
6707
|
},
|
|
6708
|
+
"x-f5xc-description-short": "Metric data contains the metric type and the corresponding metric value.",
|
|
6445
6709
|
"x-f5xc-minimum-configuration": {
|
|
6446
6710
|
"description": "Minimum configuration for apmMetricData",
|
|
6447
6711
|
"required_fields": [
|
|
@@ -6498,6 +6762,8 @@
|
|
|
6498
6762
|
"x-validation-rules": {
|
|
6499
6763
|
"ves.io.schema.rules.string.query_time": "true"
|
|
6500
6764
|
},
|
|
6765
|
+
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
|
|
6766
|
+
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
6501
6767
|
"minLength": 0,
|
|
6502
6768
|
"maxLength": 1024,
|
|
6503
6769
|
"x-f5xc-required-for": {
|
|
@@ -6530,6 +6796,8 @@
|
|
|
6530
6796
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
6531
6797
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
6532
6798
|
},
|
|
6799
|
+
"x-f5xc-description-short": "Select fields to be returned in the response.",
|
|
6800
|
+
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {TX_THROUGHPUT_BYTES, CONNECTION_RATE, TX_THROUGHPUT_PACKETS, RX_THROUGHPUT_BYTES, RX_THROUGHPUT_PACKETS} can be specified. Required: YES.",
|
|
6533
6801
|
"x-f5xc-required-for": {
|
|
6534
6802
|
"minimum_config": false,
|
|
6535
6803
|
"create": false,
|
|
@@ -6544,6 +6812,8 @@
|
|
|
6544
6812
|
"x-displayname": "Filter",
|
|
6545
6813
|
"x-ves-example": "{HOSTNAME=\\\"WAF-1\\\"}",
|
|
6546
6814
|
"x-f5xc-example": "\"{HOSTNAME=\\\"WAF-1\\\"}\"",
|
|
6815
|
+
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
|
|
6816
|
+
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in MetricLabel {SITE, SERVICE, SERVICE_INSTANCE} can be specified in the filter. <value> := string <operator> :=...",
|
|
6547
6817
|
"minLength": 0,
|
|
6548
6818
|
"maxLength": 1024,
|
|
6549
6819
|
"x-f5xc-required-for": {
|
|
@@ -6561,6 +6831,7 @@
|
|
|
6561
6831
|
"$ref": "#/components/schemas/apmMetricLabel"
|
|
6562
6832
|
},
|
|
6563
6833
|
"x-displayname": "Group By",
|
|
6834
|
+
"x-f5xc-description-short": "Aggregate data by zero or more labels {SITE, SERVICE, SERVICE_INSTANCE}.",
|
|
6564
6835
|
"x-f5xc-required-for": {
|
|
6565
6836
|
"minimum_config": false,
|
|
6566
6837
|
"create": false,
|
|
@@ -6585,7 +6856,7 @@
|
|
|
6585
6856
|
},
|
|
6586
6857
|
"x-original-maxLength": 1024,
|
|
6587
6858
|
"x-reconciled-from-discovery": true,
|
|
6588
|
-
"x-reconciled-at": "2026-01-
|
|
6859
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792070+00:00"
|
|
6589
6860
|
},
|
|
6590
6861
|
"start_time": {
|
|
6591
6862
|
"type": "string",
|
|
@@ -6600,6 +6871,8 @@
|
|
|
6600
6871
|
"x-validation-rules": {
|
|
6601
6872
|
"ves.io.schema.rules.string.query_time": "true"
|
|
6602
6873
|
},
|
|
6874
|
+
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
|
|
6875
|
+
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
6603
6876
|
"minLength": 0,
|
|
6604
6877
|
"maxLength": 1024,
|
|
6605
6878
|
"x-f5xc-required-for": {
|
|
@@ -6622,6 +6895,8 @@
|
|
|
6622
6895
|
"x-validation-rules": {
|
|
6623
6896
|
"ves.io.schema.rules.string.query_step": "true"
|
|
6624
6897
|
},
|
|
6898
|
+
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
|
|
6899
|
+
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
|
|
6625
6900
|
"minLength": 0,
|
|
6626
6901
|
"maxLength": 1024,
|
|
6627
6902
|
"x-f5xc-required-for": {
|
|
@@ -6632,6 +6907,7 @@
|
|
|
6632
6907
|
}
|
|
6633
6908
|
}
|
|
6634
6909
|
},
|
|
6910
|
+
"x-f5xc-description-short": "Request to GET the metrics for BIG-IP APM services.",
|
|
6635
6911
|
"x-f5xc-minimum-configuration": {
|
|
6636
6912
|
"description": "Minimum configuration for apmMetricsRequest",
|
|
6637
6913
|
"required_fields": [
|
|
@@ -6665,6 +6941,8 @@
|
|
|
6665
6941
|
"$ref": "#/components/schemas/apmMetricData"
|
|
6666
6942
|
},
|
|
6667
6943
|
"x-displayname": "Data",
|
|
6944
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6945
|
+
"x-f5xc-description-short": "Data contains time-series metric data for BIG-IP APM services.",
|
|
6668
6946
|
"x-f5xc-required-for": {
|
|
6669
6947
|
"minimum_config": false,
|
|
6670
6948
|
"create": false,
|
|
@@ -6685,6 +6963,8 @@
|
|
|
6685
6963
|
"x-validation-rules": {
|
|
6686
6964
|
"ves.io.schema.rules.string.time_interval": "true"
|
|
6687
6965
|
},
|
|
6966
|
+
"x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
|
|
6967
|
+
"x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
6688
6968
|
"minLength": 0,
|
|
6689
6969
|
"maxLength": 1024,
|
|
6690
6970
|
"x-f5xc-required-for": {
|
|
@@ -6763,6 +7043,7 @@
|
|
|
6763
7043
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
6764
7044
|
},
|
|
6765
7045
|
"x-displayname": "Conditions.",
|
|
7046
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
6766
7047
|
"x-f5xc-required-for": {
|
|
6767
7048
|
"minimum_config": false,
|
|
6768
7049
|
"create": false,
|
|
@@ -6784,6 +7065,7 @@
|
|
|
6784
7065
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6785
7066
|
},
|
|
6786
7067
|
"x-displayname": "Config Object.",
|
|
7068
|
+
"x-f5xc-description-short": "Reference to the object for current status.",
|
|
6787
7069
|
"x-f5xc-required-for": {
|
|
6788
7070
|
"minimum_config": false,
|
|
6789
7071
|
"create": false,
|
|
@@ -6792,6 +7074,7 @@
|
|
|
6792
7074
|
}
|
|
6793
7075
|
}
|
|
6794
7076
|
},
|
|
7077
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
6795
7078
|
"x-f5xc-minimum-configuration": {
|
|
6796
7079
|
"description": "Minimum configuration for apmStatusObject",
|
|
6797
7080
|
"required_fields": [
|
|
@@ -6826,6 +7109,7 @@
|
|
|
6826
7109
|
"$ref": "#/components/schemas/nfv_serviceServiceHttpsManagementType"
|
|
6827
7110
|
}
|
|
6828
7111
|
},
|
|
7112
|
+
"x-f5xc-description-short": "Creates a new APM as a service with configured parameters.",
|
|
6829
7113
|
"x-f5xc-minimum-configuration": {
|
|
6830
7114
|
"description": "Minimum configuration for bigipapmCreateSpecType",
|
|
6831
7115
|
"required_fields": [
|
|
@@ -6881,6 +7165,8 @@
|
|
|
6881
7165
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
6882
7166
|
}
|
|
6883
7167
|
},
|
|
7168
|
+
"x-f5xc-description-short": "Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with a new destination address.",
|
|
7169
|
+
"x-f5xc-description-medium": "Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with a new destination address.",
|
|
6884
7170
|
"x-f5xc-minimum-configuration": {
|
|
6885
7171
|
"description": "Minimum configuration for bigipapmEndpointServiceReplaceType",
|
|
6886
7172
|
"required_fields": [
|
|
@@ -6937,6 +7223,7 @@
|
|
|
6937
7223
|
"ves.io.schema.rules.string.ip": "true",
|
|
6938
7224
|
"ves.io.schema.rules.string.not_in": "0.0.0.0"
|
|
6939
7225
|
},
|
|
7226
|
+
"x-f5xc-description-short": "Exclusive with [automatic_vip] Enter IP address for the default VIP.",
|
|
6940
7227
|
"minLength": 0,
|
|
6941
7228
|
"maxLength": 1024,
|
|
6942
7229
|
"x-f5xc-required-for": {
|
|
@@ -6971,6 +7258,8 @@
|
|
|
6971
7258
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
6972
7259
|
}
|
|
6973
7260
|
},
|
|
7261
|
+
"x-f5xc-description-short": "Endpoint Service is a type of service where the packets are destined to BIG-IP APM device and service modifies the destination with a new...",
|
|
7262
|
+
"x-f5xc-description-medium": "Endpoint Service is a type of service where the packets are destined to BIG-IP APM device and service modifies the destination with a new destination address.",
|
|
6974
7263
|
"x-f5xc-minimum-configuration": {
|
|
6975
7264
|
"description": "Minimum configuration for bigipapmEndpointServiceType",
|
|
6976
7265
|
"required_fields": [
|
|
@@ -7046,6 +7335,8 @@
|
|
|
7046
7335
|
"default": "CPU_UTILIZATION",
|
|
7047
7336
|
"x-displayname": "Metric Type.",
|
|
7048
7337
|
"x-ves-proto-enum": "ves.io.schema.bigip.apm.MetricType",
|
|
7338
|
+
"x-f5xc-description-short": "List of metric types x-unit: \"percent\" x-unit: \"count\" x-unit: \"count\" x-unit: \"count\" x-unit: \"Bps\" x-unit: \"Bps\" x-unit: \"per second\" x-unit...",
|
|
7339
|
+
"x-f5xc-description-medium": "List of metric types x-unit: \"percent\" x-unit: \"count\" x-unit: \"count\" x-unit: \"count\" x-unit: \"Bps\" x-unit: \"Bps\" x-unit: \"per second\" x-unit: \"count\" x-unit: \"count\" x-unit: \"percentage\".",
|
|
7049
7340
|
"x-f5xc-minimum-configuration": {
|
|
7050
7341
|
"description": "Minimum configuration for bigipapmMetricType",
|
|
7051
7342
|
"required_fields": [],
|
|
@@ -7068,6 +7359,8 @@
|
|
|
7068
7359
|
"description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"MetricLabel\"",
|
|
7069
7360
|
"title": "Key",
|
|
7070
7361
|
"x-displayname": "Key",
|
|
7362
|
+
"x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
|
|
7363
|
+
"x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"MetricLabel\".",
|
|
7071
7364
|
"x-f5xc-required-for": {
|
|
7072
7365
|
"minimum_config": false,
|
|
7073
7366
|
"create": false,
|
|
@@ -7077,7 +7370,7 @@
|
|
|
7077
7370
|
"maxLength": 16,
|
|
7078
7371
|
"minLength": 7,
|
|
7079
7372
|
"x-reconciled-from-discovery": true,
|
|
7080
|
-
"x-reconciled-at": "2026-01-
|
|
7373
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792122+00:00"
|
|
7081
7374
|
},
|
|
7082
7375
|
"value": {
|
|
7083
7376
|
"type": "array",
|
|
@@ -7096,9 +7389,11 @@
|
|
|
7096
7389
|
"maxLength": 15,
|
|
7097
7390
|
"minLength": 3,
|
|
7098
7391
|
"x-reconciled-from-discovery": true,
|
|
7099
|
-
"x-reconciled-at": "2026-01-
|
|
7392
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792128+00:00"
|
|
7100
7393
|
}
|
|
7101
7394
|
},
|
|
7395
|
+
"x-f5xc-description-short": "Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
|
|
7396
|
+
"x-f5xc-description-medium": "Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
|
|
7102
7397
|
"x-f5xc-minimum-configuration": {
|
|
7103
7398
|
"description": "Minimum configuration for bigipapmMetricTypeData",
|
|
7104
7399
|
"required_fields": [
|
|
@@ -7131,6 +7426,7 @@
|
|
|
7131
7426
|
"$ref": "#/components/schemas/nfv_serviceServiceHttpsManagementType"
|
|
7132
7427
|
}
|
|
7133
7428
|
},
|
|
7429
|
+
"x-f5xc-description-short": "Replaces configured APM Service with new set of parameters.",
|
|
7134
7430
|
"x-f5xc-minimum-configuration": {
|
|
7135
7431
|
"description": "Minimum configuration for bigipapmReplaceSpecType",
|
|
7136
7432
|
"required_fields": [
|
|
@@ -7151,6 +7447,7 @@
|
|
|
7151
7447
|
"title": "Empty",
|
|
7152
7448
|
"x-displayname": "Empty",
|
|
7153
7449
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
7450
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
7154
7451
|
"x-f5xc-minimum-configuration": {
|
|
7155
7452
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
7156
7453
|
"required_fields": [],
|
|
@@ -7175,6 +7472,8 @@
|
|
|
7175
7472
|
"x-displayname": "Kind",
|
|
7176
7473
|
"x-ves-example": "Virtual_site.",
|
|
7177
7474
|
"x-f5xc-example": "virtual_site",
|
|
7475
|
+
"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\")",
|
|
7476
|
+
"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\").",
|
|
7178
7477
|
"minLength": 0,
|
|
7179
7478
|
"maxLength": 14,
|
|
7180
7479
|
"x-f5xc-required-for": {
|
|
@@ -7186,7 +7485,7 @@
|
|
|
7186
7485
|
"readOnly": true,
|
|
7187
7486
|
"x-original-maxLength": 1024,
|
|
7188
7487
|
"x-reconciled-from-discovery": true,
|
|
7189
|
-
"x-reconciled-at": "2026-01-
|
|
7488
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792137+00:00"
|
|
7190
7489
|
},
|
|
7191
7490
|
"name": {
|
|
7192
7491
|
"type": "string",
|
|
@@ -7195,6 +7494,8 @@
|
|
|
7195
7494
|
"x-displayname": "Name",
|
|
7196
7495
|
"x-ves-example": "Contactus-route.",
|
|
7197
7496
|
"x-f5xc-example": "contactus-route",
|
|
7497
|
+
"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.",
|
|
7498
|
+
"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.",
|
|
7198
7499
|
"minLength": 0,
|
|
7199
7500
|
"maxLength": 16,
|
|
7200
7501
|
"x-f5xc-required-for": {
|
|
@@ -7205,7 +7506,7 @@
|
|
|
7205
7506
|
},
|
|
7206
7507
|
"x-original-maxLength": 1024,
|
|
7207
7508
|
"x-reconciled-from-discovery": true,
|
|
7208
|
-
"x-reconciled-at": "2026-01-
|
|
7509
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792141+00:00"
|
|
7209
7510
|
},
|
|
7210
7511
|
"namespace": {
|
|
7211
7512
|
"type": "string",
|
|
@@ -7214,6 +7515,8 @@
|
|
|
7214
7515
|
"x-displayname": "Namespace",
|
|
7215
7516
|
"x-ves-example": "Ns1",
|
|
7216
7517
|
"x-f5xc-example": "ns1",
|
|
7518
|
+
"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.",
|
|
7519
|
+
"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.",
|
|
7217
7520
|
"minLength": 0,
|
|
7218
7521
|
"maxLength": 6,
|
|
7219
7522
|
"x-f5xc-required-for": {
|
|
@@ -7224,7 +7527,7 @@
|
|
|
7224
7527
|
},
|
|
7225
7528
|
"x-original-maxLength": 1024,
|
|
7226
7529
|
"x-reconciled-from-discovery": true,
|
|
7227
|
-
"x-reconciled-at": "2026-01-
|
|
7530
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792145+00:00"
|
|
7228
7531
|
},
|
|
7229
7532
|
"tenant": {
|
|
7230
7533
|
"type": "string",
|
|
@@ -7233,6 +7536,8 @@
|
|
|
7233
7536
|
"x-displayname": "Tenant",
|
|
7234
7537
|
"x-ves-example": "Example-corp.",
|
|
7235
7538
|
"x-f5xc-example": "example-corp",
|
|
7539
|
+
"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.",
|
|
7540
|
+
"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.",
|
|
7236
7541
|
"minLength": 0,
|
|
7237
7542
|
"maxLength": 18,
|
|
7238
7543
|
"x-f5xc-required-for": {
|
|
@@ -7245,7 +7550,7 @@
|
|
|
7245
7550
|
"x-field-mutability": "read-only",
|
|
7246
7551
|
"x-original-maxLength": 1024,
|
|
7247
7552
|
"x-reconciled-from-discovery": true,
|
|
7248
|
-
"x-reconciled-at": "2026-01-
|
|
7553
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792150+00:00"
|
|
7249
7554
|
},
|
|
7250
7555
|
"uid": {
|
|
7251
7556
|
"type": "string",
|
|
@@ -7254,6 +7559,8 @@
|
|
|
7254
7559
|
"x-displayname": "UID",
|
|
7255
7560
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7256
7561
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7562
|
+
"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.",
|
|
7563
|
+
"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.",
|
|
7257
7564
|
"minLength": 0,
|
|
7258
7565
|
"maxLength": 36,
|
|
7259
7566
|
"x-f5xc-required-for": {
|
|
@@ -7267,9 +7574,11 @@
|
|
|
7267
7574
|
"x-original-maxLength": 1024,
|
|
7268
7575
|
"format": "uuid",
|
|
7269
7576
|
"x-reconciled-from-discovery": true,
|
|
7270
|
-
"x-reconciled-at": "2026-01-
|
|
7577
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792155+00:00"
|
|
7271
7578
|
}
|
|
7272
7579
|
},
|
|
7580
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
7581
|
+
"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...",
|
|
7273
7582
|
"x-f5xc-minimum-configuration": {
|
|
7274
7583
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
7275
7584
|
"required_fields": [
|
|
@@ -7298,6 +7607,8 @@
|
|
|
7298
7607
|
"default": "BM_8_GB_MEMORY",
|
|
7299
7608
|
"x-displayname": "Bare Metal ServiceNode Memory Size.",
|
|
7300
7609
|
"x-ves-proto-enum": "ves.io.schema.nfv_service.BMNodeMemorySize",
|
|
7610
|
+
"x-f5xc-description-short": "Enum to define amount of memory to be assigned to the node - BM_8_GB_MEMORY: 8 GB - BM_16_GB_MEMORY: 16 GB - BM_32_GB_MEMORY: 32 GB.",
|
|
7611
|
+
"x-f5xc-description-medium": "Enum to define amount of memory to be assigned to the node - BM_8_GB_MEMORY: 8 GB - BM_16_GB_MEMORY: 16 GB - BM_32_GB_MEMORY: 32 GB.",
|
|
7301
7612
|
"x-f5xc-minimum-configuration": {
|
|
7302
7613
|
"description": "Minimum configuration for nfv_serviceBMNodeMemorySize",
|
|
7303
7614
|
"required_fields": [],
|
|
@@ -7319,6 +7630,8 @@
|
|
|
7319
7630
|
"default": "BM_4_VCPU",
|
|
7320
7631
|
"x-displayname": "Bare Metal ServiceNode Virtual CPU Count.",
|
|
7321
7632
|
"x-ves-proto-enum": "ves.io.schema.nfv_service.BMNodeVirtualCpuCount",
|
|
7633
|
+
"x-f5xc-description-short": "Enum to define number of virtual CPU's to be assigned to the node - BM_4_VCPU: 4 virtual CPUs - BM_8_VCPU: 8 virtual CPUs.",
|
|
7634
|
+
"x-f5xc-description-medium": "Enum to define number of virtual CPU's to be assigned to the node - BM_4_VCPU: 4 virtual CPUs - BM_8_VCPU: 8 virtual CPUs.",
|
|
7322
7635
|
"x-f5xc-minimum-configuration": {
|
|
7323
7636
|
"description": "Minimum configuration for nfv_serviceBMNodeVirtualCpuCount",
|
|
7324
7637
|
"required_fields": [],
|
|
@@ -7357,6 +7670,7 @@
|
|
|
7357
7670
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7358
7671
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7359
7672
|
},
|
|
7673
|
+
"x-f5xc-description-short": "Name of Utility Pool on BIG-IQ Required: YES.",
|
|
7360
7674
|
"x-f5xc-required-for": {
|
|
7361
7675
|
"minimum_config": false,
|
|
7362
7676
|
"create": false,
|
|
@@ -7382,6 +7696,8 @@
|
|
|
7382
7696
|
"ves.io.schema.rules.string.ip": "true",
|
|
7383
7697
|
"ves.io.schema.rules.string.not_in": "0.0.0.0"
|
|
7384
7698
|
},
|
|
7699
|
+
"x-f5xc-description-short": "IP Address from the TCP Load Balancer which is configured to communicate with License Server Required: YES.",
|
|
7700
|
+
"x-f5xc-description-medium": "IP Address from the TCP Load Balancer which is configured to communicate with License Server Required: YES.",
|
|
7385
7701
|
"minLength": 0,
|
|
7386
7702
|
"maxLength": 1024,
|
|
7387
7703
|
"x-f5xc-required-for": {
|
|
@@ -7414,6 +7730,7 @@
|
|
|
7414
7730
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7415
7731
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7416
7732
|
},
|
|
7733
|
+
"x-f5xc-description-short": "License offering name aka SKU name Required: YES.",
|
|
7417
7734
|
"x-f5xc-required-for": {
|
|
7418
7735
|
"minimum_config": false,
|
|
7419
7736
|
"create": false,
|
|
@@ -7441,6 +7758,7 @@
|
|
|
7441
7758
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7442
7759
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7443
7760
|
},
|
|
7761
|
+
"x-f5xc-description-short": "User Name used to access BIG-IQ to activate the license Required: YES.",
|
|
7444
7762
|
"x-f5xc-required-for": {
|
|
7445
7763
|
"minimum_config": false,
|
|
7446
7764
|
"create": false,
|
|
@@ -7449,6 +7767,7 @@
|
|
|
7449
7767
|
}
|
|
7450
7768
|
}
|
|
7451
7769
|
},
|
|
7770
|
+
"x-f5xc-description-short": "Specification for BIG-IQ Instance, where and what.",
|
|
7452
7771
|
"x-f5xc-minimum-configuration": {
|
|
7453
7772
|
"description": "Minimum configuration for nfv_serviceBigIqInstanceType",
|
|
7454
7773
|
"required_fields": [
|
|
@@ -7515,6 +7834,7 @@
|
|
|
7515
7834
|
"ves.io.schema.rules.message.required": "true",
|
|
7516
7835
|
"ves.io.schema.rules.string.max_len": "256"
|
|
7517
7836
|
},
|
|
7837
|
+
"x-f5xc-description-short": "Admin Username for BIG-IP Required: YES.",
|
|
7518
7838
|
"minLength": 0,
|
|
7519
7839
|
"x-f5xc-required-for": {
|
|
7520
7840
|
"minimum_config": false,
|
|
@@ -7550,6 +7870,7 @@
|
|
|
7550
7870
|
"ves.io.schema.rules.repeated.max_items": "1",
|
|
7551
7871
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
7552
7872
|
},
|
|
7873
|
+
"x-f5xc-description-short": "Specify how and where the service nodes are spawned Required: YES.",
|
|
7553
7874
|
"x-f5xc-required-for": {
|
|
7554
7875
|
"minimum_config": false,
|
|
7555
7876
|
"create": false,
|
|
@@ -7572,6 +7893,7 @@
|
|
|
7572
7893
|
"ves.io.schema.rules.message.required": "true",
|
|
7573
7894
|
"ves.io.schema.rules.string.uri": "true"
|
|
7574
7895
|
},
|
|
7896
|
+
"x-f5xc-description-short": "Public URL where BIG-IP VE image (qcow2) is hosted Required: YES.",
|
|
7575
7897
|
"minLength": 0,
|
|
7576
7898
|
"maxLength": 1024,
|
|
7577
7899
|
"x-f5xc-required-for": {
|
|
@@ -7601,6 +7923,7 @@
|
|
|
7601
7923
|
"ves.io.schema.rules.string.max_len": "8192",
|
|
7602
7924
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7603
7925
|
},
|
|
7926
|
+
"x-f5xc-description-short": "Public SSH key for accessing the BIG-IP nodes. Required: YES.",
|
|
7604
7927
|
"x-f5xc-required-for": {
|
|
7605
7928
|
"minimum_config": false,
|
|
7606
7929
|
"create": false,
|
|
@@ -7609,6 +7932,7 @@
|
|
|
7609
7932
|
}
|
|
7610
7933
|
}
|
|
7611
7934
|
},
|
|
7935
|
+
"x-f5xc-description-short": "Virtual BIG-IP specification for App Stack bare metal.",
|
|
7612
7936
|
"x-f5xc-minimum-configuration": {
|
|
7613
7937
|
"description": "Minimum configuration for nfv_serviceF5BigIpAppStackBareMetalType",
|
|
7614
7938
|
"required_fields": [
|
|
@@ -7639,7 +7963,7 @@
|
|
|
7639
7963
|
},
|
|
7640
7964
|
"network_gateway": {
|
|
7641
7965
|
"type": "string",
|
|
7642
|
-
"description": "",
|
|
7966
|
+
"description": "Configuration parameter for network gateway",
|
|
7643
7967
|
"title": "BIG-IP Network Default Gateway.",
|
|
7644
7968
|
"x-displayname": "Default Gateway.",
|
|
7645
7969
|
"x-ves-example": "10.2.3.0",
|
|
@@ -7650,6 +7974,7 @@
|
|
|
7650
7974
|
"x-validation-rules": {
|
|
7651
7975
|
"ves.io.schema.rules.string.ipv4": "true"
|
|
7652
7976
|
},
|
|
7977
|
+
"x-f5xc-description-short": "Configuration parameter for network gateway.",
|
|
7653
7978
|
"minLength": 0,
|
|
7654
7979
|
"maxLength": 1024,
|
|
7655
7980
|
"x-f5xc-required-for": {
|
|
@@ -7747,6 +8072,8 @@
|
|
|
7747
8072
|
"ves.io.schema.rules.message.required": "true",
|
|
7748
8073
|
"ves.io.schema.rules.string.hostname": "true"
|
|
7749
8074
|
},
|
|
8075
|
+
"x-f5xc-description-short": "Domain suffix will be used along with node name to form URL to access node management Required: YES.",
|
|
8076
|
+
"x-f5xc-description-medium": "Domain suffix will be used along with node name to form URL to access node management Required: YES.",
|
|
7750
8077
|
"minLength": 0,
|
|
7751
8078
|
"maxLength": 1024,
|
|
7752
8079
|
"x-f5xc-required-for": {
|
|
@@ -7770,6 +8097,7 @@
|
|
|
7770
8097
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
7771
8098
|
"ves.io.schema.rules.uint32.lte": "65535"
|
|
7772
8099
|
},
|
|
8100
|
+
"x-f5xc-description-short": "Exclusive with [default_https_port] Enter TCP port number.",
|
|
7773
8101
|
"minimum": 0,
|
|
7774
8102
|
"maximum": 2147483647,
|
|
7775
8103
|
"x-f5xc-required-for": {
|
|
@@ -7828,6 +8156,8 @@
|
|
|
7828
8156
|
"ves.io.schema.rules.message.required": "true",
|
|
7829
8157
|
"ves.io.schema.rules.string.pattern": "^([a-z]{2})-([a-z0-9]{4,20})-([a-z0-9]{2})$"
|
|
7830
8158
|
},
|
|
8159
|
+
"x-f5xc-description-short": "The AWS Availability Zone must be consistent with the AWS Region chosen. Please select an AZ in the same Region as your TGW Site Required: YES.",
|
|
8160
|
+
"x-f5xc-description-medium": "The AWS Availability Zone must be consistent with the AWS Region chosen. Please select an AZ in the same Region as your TGW Site Required: YES.",
|
|
7831
8161
|
"minLength": 0,
|
|
7832
8162
|
"maxLength": 1024,
|
|
7833
8163
|
"x-f5xc-required-for": {
|
|
@@ -7862,6 +8192,7 @@
|
|
|
7862
8192
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7863
8193
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7864
8194
|
},
|
|
8195
|
+
"x-f5xc-description-short": "Node Name will be used to assign as hostname to the service Required: YES.",
|
|
7865
8196
|
"x-f5xc-required-for": {
|
|
7866
8197
|
"minimum_config": false,
|
|
7867
8198
|
"create": false,
|
|
@@ -7885,6 +8216,7 @@
|
|
|
7885
8216
|
"x-validation-rules": {
|
|
7886
8217
|
"ves.io.schema.rules.string.ipv4_prefix": "true"
|
|
7887
8218
|
},
|
|
8219
|
+
"x-f5xc-description-short": "Exclusive with [automatic_prefix] Enter IP prefix for the tunnel, it has to be /30.",
|
|
7888
8220
|
"minLength": 0,
|
|
7889
8221
|
"maxLength": 1024,
|
|
7890
8222
|
"x-f5xc-required-for": {
|
|
@@ -7895,6 +8227,7 @@
|
|
|
7895
8227
|
}
|
|
7896
8228
|
}
|
|
7897
8229
|
},
|
|
8230
|
+
"x-f5xc-description-short": "Specification for service nodes, how and where.",
|
|
7898
8231
|
"x-f5xc-minimum-configuration": {
|
|
7899
8232
|
"description": "Minimum configuration for nfv_serviceServiceNodesAWSType",
|
|
7900
8233
|
"required_fields": [
|
|
@@ -7954,6 +8287,7 @@
|
|
|
7954
8287
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7955
8288
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7956
8289
|
},
|
|
8290
|
+
"x-f5xc-description-short": "Node Name will be used to assign as hostname to the service Required: YES.",
|
|
7957
8291
|
"x-f5xc-required-for": {
|
|
7958
8292
|
"minimum_config": false,
|
|
7959
8293
|
"create": false,
|
|
@@ -7962,6 +8296,7 @@
|
|
|
7962
8296
|
}
|
|
7963
8297
|
}
|
|
7964
8298
|
},
|
|
8299
|
+
"x-f5xc-description-short": "Specification for service nodes, how and where.",
|
|
7965
8300
|
"x-f5xc-minimum-configuration": {
|
|
7966
8301
|
"description": "Minimum configuration for nfv_serviceServiceNodesBareMetalType",
|
|
7967
8302
|
"required_fields": [
|
|
@@ -7985,6 +8320,8 @@
|
|
|
7985
8320
|
"type_url": {
|
|
7986
8321
|
"type": "string",
|
|
7987
8322
|
"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.",
|
|
8323
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
8324
|
+
"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 ).",
|
|
7988
8325
|
"minLength": 0,
|
|
7989
8326
|
"maxLength": 1024,
|
|
7990
8327
|
"x-f5xc-required-for": {
|
|
@@ -8008,9 +8345,11 @@
|
|
|
8008
8345
|
},
|
|
8009
8346
|
"x-original-maxLength": 1024,
|
|
8010
8347
|
"x-reconciled-from-discovery": true,
|
|
8011
|
-
"x-reconciled-at": "2026-01-
|
|
8348
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792211+00:00"
|
|
8012
8349
|
}
|
|
8013
8350
|
},
|
|
8351
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
8352
|
+
"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...",
|
|
8014
8353
|
"x-f5xc-minimum-configuration": {
|
|
8015
8354
|
"description": "Minimum configuration for protobufAny",
|
|
8016
8355
|
"required_fields": [
|
|
@@ -8039,6 +8378,8 @@
|
|
|
8039
8378
|
"x-displayname": "Decryption Provider.",
|
|
8040
8379
|
"x-ves-example": "Value",
|
|
8041
8380
|
"x-f5xc-example": "value",
|
|
8381
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
8382
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
8042
8383
|
"minLength": 0,
|
|
8043
8384
|
"maxLength": 1024,
|
|
8044
8385
|
"x-f5xc-required-for": {
|
|
@@ -8064,6 +8405,8 @@
|
|
|
8064
8405
|
"ves.io.schema.rules.message.required": "true",
|
|
8065
8406
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8066
8407
|
},
|
|
8408
|
+
"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.",
|
|
8409
|
+
"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.",
|
|
8067
8410
|
"minLength": 0,
|
|
8068
8411
|
"maxLength": 4,
|
|
8069
8412
|
"x-f5xc-required-for": {
|
|
@@ -8074,7 +8417,7 @@
|
|
|
8074
8417
|
},
|
|
8075
8418
|
"x-original-maxLength": 1024,
|
|
8076
8419
|
"x-reconciled-from-discovery": true,
|
|
8077
|
-
"x-reconciled-at": "2026-01-
|
|
8420
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792218+00:00"
|
|
8078
8421
|
},
|
|
8079
8422
|
"store_provider": {
|
|
8080
8423
|
"type": "string",
|
|
@@ -8083,6 +8426,8 @@
|
|
|
8083
8426
|
"x-displayname": "Store Provider.",
|
|
8084
8427
|
"x-ves-example": "Value",
|
|
8085
8428
|
"x-f5xc-example": "value",
|
|
8429
|
+
"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...",
|
|
8430
|
+
"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:///.",
|
|
8086
8431
|
"minLength": 0,
|
|
8087
8432
|
"maxLength": 1024,
|
|
8088
8433
|
"x-f5xc-required-for": {
|
|
@@ -8093,6 +8438,7 @@
|
|
|
8093
8438
|
}
|
|
8094
8439
|
}
|
|
8095
8440
|
},
|
|
8441
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
8096
8442
|
"x-f5xc-minimum-configuration": {
|
|
8097
8443
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
8098
8444
|
"required_fields": [
|
|
@@ -8122,6 +8468,8 @@
|
|
|
8122
8468
|
"x-displayname": "Provider",
|
|
8123
8469
|
"x-ves-example": "Box-provider.",
|
|
8124
8470
|
"x-f5xc-example": "box-provider",
|
|
8471
|
+
"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...",
|
|
8472
|
+
"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:///.",
|
|
8125
8473
|
"minLength": 0,
|
|
8126
8474
|
"maxLength": 8,
|
|
8127
8475
|
"x-f5xc-required-for": {
|
|
@@ -8132,7 +8480,7 @@
|
|
|
8132
8480
|
},
|
|
8133
8481
|
"x-original-maxLength": 1024,
|
|
8134
8482
|
"x-reconciled-from-discovery": true,
|
|
8135
|
-
"x-reconciled-at": "2026-01-
|
|
8483
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792224+00:00"
|
|
8136
8484
|
},
|
|
8137
8485
|
"url": {
|
|
8138
8486
|
"type": "string",
|
|
@@ -8153,6 +8501,8 @@
|
|
|
8153
8501
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
8154
8502
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8155
8503
|
},
|
|
8504
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
8505
|
+
"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.",
|
|
8156
8506
|
"format": "uri",
|
|
8157
8507
|
"minLength": 0,
|
|
8158
8508
|
"x-f5xc-required-for": {
|
|
@@ -8163,6 +8513,7 @@
|
|
|
8163
8513
|
}
|
|
8164
8514
|
}
|
|
8165
8515
|
},
|
|
8516
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
8166
8517
|
"x-f5xc-minimum-configuration": {
|
|
8167
8518
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
8168
8519
|
"required_fields": [
|
|
@@ -8188,6 +8539,8 @@
|
|
|
8188
8539
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
8189
8540
|
"title": "Hostname",
|
|
8190
8541
|
"x-displayname": "Hostname",
|
|
8542
|
+
"x-f5xc-example": "example-resource",
|
|
8543
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
8191
8544
|
"minLength": 0,
|
|
8192
8545
|
"maxLength": 1024,
|
|
8193
8546
|
"x-f5xc-required-for": {
|
|
@@ -8219,6 +8572,8 @@
|
|
|
8219
8572
|
"x-displayname": "Reason",
|
|
8220
8573
|
"x-ves-example": "Value",
|
|
8221
8574
|
"x-f5xc-example": "value",
|
|
8575
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
8576
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
8222
8577
|
"minLength": 0,
|
|
8223
8578
|
"maxLength": 43,
|
|
8224
8579
|
"x-f5xc-required-for": {
|
|
@@ -8229,13 +8584,15 @@
|
|
|
8229
8584
|
},
|
|
8230
8585
|
"x-original-maxLength": 1024,
|
|
8231
8586
|
"x-reconciled-from-discovery": true,
|
|
8232
|
-
"x-reconciled-at": "2026-01-
|
|
8587
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792233+00:00"
|
|
8233
8588
|
},
|
|
8234
8589
|
"service_name": {
|
|
8235
8590
|
"type": "string",
|
|
8236
8591
|
"description": "Name of the service that sent the status.",
|
|
8237
8592
|
"title": "Service name.",
|
|
8238
8593
|
"x-displayname": "Service Name.",
|
|
8594
|
+
"x-f5xc-example": "example-resource",
|
|
8595
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
8239
8596
|
"minLength": 0,
|
|
8240
8597
|
"maxLength": 1024,
|
|
8241
8598
|
"x-f5xc-required-for": {
|
|
@@ -8258,6 +8615,8 @@
|
|
|
8258
8615
|
"x-validation-rules": {
|
|
8259
8616
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
8260
8617
|
},
|
|
8618
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
8619
|
+
"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...",
|
|
8261
8620
|
"minLength": 0,
|
|
8262
8621
|
"maxLength": 17,
|
|
8263
8622
|
"x-f5xc-required-for": {
|
|
@@ -8268,7 +8627,7 @@
|
|
|
8268
8627
|
},
|
|
8269
8628
|
"x-original-maxLength": 1024,
|
|
8270
8629
|
"x-reconciled-from-discovery": true,
|
|
8271
|
-
"x-reconciled-at": "2026-01-
|
|
8630
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792239+00:00"
|
|
8272
8631
|
},
|
|
8273
8632
|
"type": {
|
|
8274
8633
|
"type": "string",
|
|
@@ -8283,6 +8642,8 @@
|
|
|
8283
8642
|
"x-validation-rules": {
|
|
8284
8643
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
8285
8644
|
},
|
|
8645
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
8646
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
8286
8647
|
"minLength": 0,
|
|
8287
8648
|
"maxLength": 1024,
|
|
8288
8649
|
"x-f5xc-required-for": {
|
|
@@ -8293,6 +8654,8 @@
|
|
|
8293
8654
|
}
|
|
8294
8655
|
}
|
|
8295
8656
|
},
|
|
8657
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
8658
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
8296
8659
|
"x-f5xc-minimum-configuration": {
|
|
8297
8660
|
"description": "Minimum configuration for schemaConditionType",
|
|
8298
8661
|
"required_fields": [
|
|
@@ -8328,6 +8691,8 @@
|
|
|
8328
8691
|
"default": "EOK",
|
|
8329
8692
|
"x-displayname": "Error Code.",
|
|
8330
8693
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
8694
|
+
"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...",
|
|
8695
|
+
"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...",
|
|
8331
8696
|
"x-f5xc-minimum-configuration": {
|
|
8332
8697
|
"description": "Minimum configuration for schemaErrorCode",
|
|
8333
8698
|
"required_fields": [],
|
|
@@ -8368,6 +8733,7 @@
|
|
|
8368
8733
|
}
|
|
8369
8734
|
}
|
|
8370
8735
|
},
|
|
8736
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
8371
8737
|
"x-f5xc-minimum-configuration": {
|
|
8372
8738
|
"description": "Minimum configuration for schemaErrorType",
|
|
8373
8739
|
"required_fields": [
|
|
@@ -8394,6 +8760,8 @@
|
|
|
8394
8760
|
"default": "INVALID_HASH_ALGORITHM",
|
|
8395
8761
|
"x-displayname": "Hash Algorithm.",
|
|
8396
8762
|
"x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
|
|
8763
|
+
"x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
8764
|
+
"x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
8397
8765
|
"x-f5xc-minimum-configuration": {
|
|
8398
8766
|
"description": "Minimum configuration for schemaHashAlgorithm",
|
|
8399
8767
|
"required_fields": [],
|
|
@@ -8434,6 +8802,7 @@
|
|
|
8434
8802
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
8435
8803
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
8436
8804
|
},
|
|
8805
|
+
"x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
|
|
8437
8806
|
"x-f5xc-required-for": {
|
|
8438
8807
|
"minimum_config": false,
|
|
8439
8808
|
"create": false,
|
|
@@ -8442,6 +8811,7 @@
|
|
|
8442
8811
|
}
|
|
8443
8812
|
}
|
|
8444
8813
|
},
|
|
8814
|
+
"x-f5xc-description-short": "Specifies the hash algorithms to be used.",
|
|
8445
8815
|
"x-f5xc-minimum-configuration": {
|
|
8446
8816
|
"description": "Minimum configuration for schemaHashAlgorithms",
|
|
8447
8817
|
"required_fields": [
|
|
@@ -8467,6 +8837,7 @@
|
|
|
8467
8837
|
"title": "Name",
|
|
8468
8838
|
"x-displayname": "Name",
|
|
8469
8839
|
"x-f5xc-example": "example-resource",
|
|
8840
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
8470
8841
|
"minLength": 0,
|
|
8471
8842
|
"maxLength": 16,
|
|
8472
8843
|
"x-f5xc-required-for": {
|
|
@@ -8477,9 +8848,10 @@
|
|
|
8477
8848
|
},
|
|
8478
8849
|
"x-original-maxLength": 1024,
|
|
8479
8850
|
"x-reconciled-from-discovery": true,
|
|
8480
|
-
"x-reconciled-at": "2026-01-
|
|
8851
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792252+00:00"
|
|
8481
8852
|
}
|
|
8482
8853
|
},
|
|
8854
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
8483
8855
|
"x-f5xc-minimum-configuration": {
|
|
8484
8856
|
"description": "Minimum configuration for schemaInitializerType",
|
|
8485
8857
|
"required_fields": [
|
|
@@ -8507,6 +8879,8 @@
|
|
|
8507
8879
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
8508
8880
|
},
|
|
8509
8881
|
"x-displayname": "Pending",
|
|
8882
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
8883
|
+
"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.",
|
|
8510
8884
|
"x-f5xc-required-for": {
|
|
8511
8885
|
"minimum_config": false,
|
|
8512
8886
|
"create": false,
|
|
@@ -8518,6 +8892,7 @@
|
|
|
8518
8892
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
8519
8893
|
}
|
|
8520
8894
|
},
|
|
8895
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
8521
8896
|
"x-f5xc-minimum-configuration": {
|
|
8522
8897
|
"description": "Minimum configuration for schemaInitializersType",
|
|
8523
8898
|
"required_fields": [
|
|
@@ -8558,7 +8933,7 @@
|
|
|
8558
8933
|
},
|
|
8559
8934
|
"value": {
|
|
8560
8935
|
"type": "string",
|
|
8561
|
-
"description": "",
|
|
8936
|
+
"description": "Configuration parameter for value",
|
|
8562
8937
|
"title": "Value",
|
|
8563
8938
|
"x-displayname": "Value",
|
|
8564
8939
|
"x-ves-example": "15",
|
|
@@ -8573,9 +8948,10 @@
|
|
|
8573
8948
|
},
|
|
8574
8949
|
"x-original-maxLength": 1024,
|
|
8575
8950
|
"x-reconciled-from-discovery": true,
|
|
8576
|
-
"x-reconciled-at": "2026-01-
|
|
8951
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792262+00:00"
|
|
8577
8952
|
}
|
|
8578
8953
|
},
|
|
8954
|
+
"x-f5xc-description-short": "Metric data contains timestamp and the value.",
|
|
8579
8955
|
"x-f5xc-minimum-configuration": {
|
|
8580
8956
|
"description": "Minimum configuration for schemaMetricValue",
|
|
8581
8957
|
"required_fields": [
|
|
@@ -8615,6 +8991,8 @@
|
|
|
8615
8991
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8616
8992
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8617
8993
|
},
|
|
8994
|
+
"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.",
|
|
8995
|
+
"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.",
|
|
8618
8996
|
"x-f5xc-required-for": {
|
|
8619
8997
|
"minimum_config": false,
|
|
8620
8998
|
"create": false,
|
|
@@ -8636,6 +9014,7 @@
|
|
|
8636
9014
|
"x-validation-rules": {
|
|
8637
9015
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8638
9016
|
},
|
|
9017
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8639
9018
|
"minLength": 0,
|
|
8640
9019
|
"x-f5xc-required-for": {
|
|
8641
9020
|
"minimum_config": false,
|
|
@@ -8645,7 +9024,7 @@
|
|
|
8645
9024
|
},
|
|
8646
9025
|
"x-original-maxLength": 1200,
|
|
8647
9026
|
"x-reconciled-from-discovery": true,
|
|
8648
|
-
"x-reconciled-at": "2026-01-
|
|
9027
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792268+00:00"
|
|
8649
9028
|
},
|
|
8650
9029
|
"disable": {
|
|
8651
9030
|
"type": "boolean",
|
|
@@ -8654,6 +9033,7 @@
|
|
|
8654
9033
|
"format": "boolean",
|
|
8655
9034
|
"x-displayname": "Disable",
|
|
8656
9035
|
"x-f5xc-example": "true",
|
|
9036
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8657
9037
|
"x-f5xc-required-for": {
|
|
8658
9038
|
"minimum_config": false,
|
|
8659
9039
|
"create": false,
|
|
@@ -8667,6 +9047,8 @@
|
|
|
8667
9047
|
"title": "Labels",
|
|
8668
9048
|
"x-displayname": "Labels",
|
|
8669
9049
|
"x-f5xc-example": "value",
|
|
9050
|
+
"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.",
|
|
9051
|
+
"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.",
|
|
8670
9052
|
"x-f5xc-required-for": {
|
|
8671
9053
|
"minimum_config": false,
|
|
8672
9054
|
"create": false,
|
|
@@ -8688,6 +9070,8 @@
|
|
|
8688
9070
|
"x-validation-rules": {
|
|
8689
9071
|
"ves.io.schema.rules.message.required": "true"
|
|
8690
9072
|
},
|
|
9073
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
9074
|
+
"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.",
|
|
8691
9075
|
"minLength": 0,
|
|
8692
9076
|
"maxLength": 16,
|
|
8693
9077
|
"x-f5xc-required-for": {
|
|
@@ -8698,7 +9082,7 @@
|
|
|
8698
9082
|
},
|
|
8699
9083
|
"x-original-maxLength": 1024,
|
|
8700
9084
|
"x-reconciled-from-discovery": true,
|
|
8701
|
-
"x-reconciled-at": "2026-01-
|
|
9085
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792276+00:00"
|
|
8702
9086
|
},
|
|
8703
9087
|
"namespace": {
|
|
8704
9088
|
"type": "string",
|
|
@@ -8707,6 +9091,8 @@
|
|
|
8707
9091
|
"x-displayname": "Namespace",
|
|
8708
9092
|
"x-ves-example": "Staging",
|
|
8709
9093
|
"x-f5xc-example": "staging",
|
|
9094
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
9095
|
+
"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 \"\".",
|
|
8710
9096
|
"minLength": 0,
|
|
8711
9097
|
"maxLength": 6,
|
|
8712
9098
|
"x-f5xc-required-for": {
|
|
@@ -8717,9 +9103,10 @@
|
|
|
8717
9103
|
},
|
|
8718
9104
|
"x-original-maxLength": 1024,
|
|
8719
9105
|
"x-reconciled-from-discovery": true,
|
|
8720
|
-
"x-reconciled-at": "2026-01-
|
|
9106
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792280+00:00"
|
|
8721
9107
|
}
|
|
8722
9108
|
},
|
|
9109
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
8723
9110
|
"x-f5xc-minimum-configuration": {
|
|
8724
9111
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
8725
9112
|
"required_fields": [
|
|
@@ -8763,6 +9150,8 @@
|
|
|
8763
9150
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8764
9151
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8765
9152
|
},
|
|
9153
|
+
"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.",
|
|
9154
|
+
"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.",
|
|
8766
9155
|
"x-f5xc-required-for": {
|
|
8767
9156
|
"minimum_config": false,
|
|
8768
9157
|
"create": false,
|
|
@@ -8784,6 +9173,7 @@
|
|
|
8784
9173
|
"x-validation-rules": {
|
|
8785
9174
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8786
9175
|
},
|
|
9176
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8787
9177
|
"minLength": 0,
|
|
8788
9178
|
"x-f5xc-required-for": {
|
|
8789
9179
|
"minimum_config": false,
|
|
@@ -8793,7 +9183,7 @@
|
|
|
8793
9183
|
},
|
|
8794
9184
|
"x-original-maxLength": 1200,
|
|
8795
9185
|
"x-reconciled-from-discovery": true,
|
|
8796
|
-
"x-reconciled-at": "2026-01-
|
|
9186
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792286+00:00"
|
|
8797
9187
|
},
|
|
8798
9188
|
"disable": {
|
|
8799
9189
|
"type": "boolean",
|
|
@@ -8803,6 +9193,7 @@
|
|
|
8803
9193
|
"x-displayname": "Disable",
|
|
8804
9194
|
"x-ves-example": "True",
|
|
8805
9195
|
"x-f5xc-example": "true",
|
|
9196
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8806
9197
|
"x-f5xc-required-for": {
|
|
8807
9198
|
"minimum_config": false,
|
|
8808
9199
|
"create": false,
|
|
@@ -8817,6 +9208,8 @@
|
|
|
8817
9208
|
"x-displayname": "Labels",
|
|
8818
9209
|
"x-ves-example": "Value",
|
|
8819
9210
|
"x-f5xc-example": "value",
|
|
9211
|
+
"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.",
|
|
9212
|
+
"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.",
|
|
8820
9213
|
"x-f5xc-required-for": {
|
|
8821
9214
|
"minimum_config": false,
|
|
8822
9215
|
"create": false,
|
|
@@ -8838,6 +9231,8 @@
|
|
|
8838
9231
|
"x-validation-rules": {
|
|
8839
9232
|
"ves.io.schema.rules.message.required": "true"
|
|
8840
9233
|
},
|
|
9234
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
9235
|
+
"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.",
|
|
8841
9236
|
"minLength": 0,
|
|
8842
9237
|
"maxLength": 16,
|
|
8843
9238
|
"x-f5xc-required-for": {
|
|
@@ -8848,7 +9243,7 @@
|
|
|
8848
9243
|
},
|
|
8849
9244
|
"x-original-maxLength": 1024,
|
|
8850
9245
|
"x-reconciled-from-discovery": true,
|
|
8851
|
-
"x-reconciled-at": "2026-01-
|
|
9246
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792293+00:00"
|
|
8852
9247
|
},
|
|
8853
9248
|
"namespace": {
|
|
8854
9249
|
"type": "string",
|
|
@@ -8857,6 +9252,8 @@
|
|
|
8857
9252
|
"x-displayname": "Namespace",
|
|
8858
9253
|
"x-ves-example": "Staging",
|
|
8859
9254
|
"x-f5xc-example": "staging",
|
|
9255
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
9256
|
+
"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 \"\".",
|
|
8860
9257
|
"minLength": 0,
|
|
8861
9258
|
"maxLength": 6,
|
|
8862
9259
|
"x-f5xc-required-for": {
|
|
@@ -8867,9 +9264,10 @@
|
|
|
8867
9264
|
},
|
|
8868
9265
|
"x-original-maxLength": 1024,
|
|
8869
9266
|
"x-reconciled-from-discovery": true,
|
|
8870
|
-
"x-reconciled-at": "2026-01-
|
|
9267
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792297+00:00"
|
|
8871
9268
|
}
|
|
8872
9269
|
},
|
|
9270
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
8873
9271
|
"x-f5xc-minimum-configuration": {
|
|
8874
9272
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
8875
9273
|
"required_fields": [
|
|
@@ -8913,6 +9311,8 @@
|
|
|
8913
9311
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8914
9312
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8915
9313
|
},
|
|
9314
|
+
"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.",
|
|
9315
|
+
"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.",
|
|
8916
9316
|
"x-f5xc-required-for": {
|
|
8917
9317
|
"minimum_config": false,
|
|
8918
9318
|
"create": false,
|
|
@@ -8934,6 +9334,7 @@
|
|
|
8934
9334
|
"x-validation-rules": {
|
|
8935
9335
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8936
9336
|
},
|
|
9337
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8937
9338
|
"minLength": 0,
|
|
8938
9339
|
"x-f5xc-required-for": {
|
|
8939
9340
|
"minimum_config": false,
|
|
@@ -8943,7 +9344,7 @@
|
|
|
8943
9344
|
},
|
|
8944
9345
|
"x-original-maxLength": 1200,
|
|
8945
9346
|
"x-reconciled-from-discovery": true,
|
|
8946
|
-
"x-reconciled-at": "2026-01-
|
|
9347
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792303+00:00"
|
|
8947
9348
|
},
|
|
8948
9349
|
"disable": {
|
|
8949
9350
|
"type": "boolean",
|
|
@@ -8952,6 +9353,7 @@
|
|
|
8952
9353
|
"format": "boolean",
|
|
8953
9354
|
"x-displayname": "Disable",
|
|
8954
9355
|
"x-f5xc-example": "true",
|
|
9356
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8955
9357
|
"x-f5xc-required-for": {
|
|
8956
9358
|
"minimum_config": false,
|
|
8957
9359
|
"create": false,
|
|
@@ -8966,6 +9368,8 @@
|
|
|
8966
9368
|
"x-displayname": "Labels",
|
|
8967
9369
|
"x-ves-example": "Value",
|
|
8968
9370
|
"x-f5xc-example": "value",
|
|
9371
|
+
"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.",
|
|
9372
|
+
"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.",
|
|
8969
9373
|
"x-f5xc-required-for": {
|
|
8970
9374
|
"minimum_config": false,
|
|
8971
9375
|
"create": false,
|
|
@@ -8986,6 +9390,8 @@
|
|
|
8986
9390
|
"x-validation-rules": {
|
|
8987
9391
|
"ves.io.schema.rules.message.required": "true"
|
|
8988
9392
|
},
|
|
9393
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
9394
|
+
"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.",
|
|
8989
9395
|
"minLength": 0,
|
|
8990
9396
|
"maxLength": 16,
|
|
8991
9397
|
"x-f5xc-required-for": {
|
|
@@ -8996,7 +9402,7 @@
|
|
|
8996
9402
|
},
|
|
8997
9403
|
"x-original-maxLength": 1024,
|
|
8998
9404
|
"x-reconciled-from-discovery": true,
|
|
8999
|
-
"x-reconciled-at": "2026-01-
|
|
9405
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792310+00:00"
|
|
9000
9406
|
},
|
|
9001
9407
|
"namespace": {
|
|
9002
9408
|
"type": "string",
|
|
@@ -9005,6 +9411,8 @@
|
|
|
9005
9411
|
"x-displayname": "Namespace",
|
|
9006
9412
|
"x-ves-example": "Staging",
|
|
9007
9413
|
"x-f5xc-example": "staging",
|
|
9414
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
9415
|
+
"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 \"\".",
|
|
9008
9416
|
"minLength": 0,
|
|
9009
9417
|
"maxLength": 6,
|
|
9010
9418
|
"x-f5xc-required-for": {
|
|
@@ -9015,9 +9423,10 @@
|
|
|
9015
9423
|
},
|
|
9016
9424
|
"x-original-maxLength": 1024,
|
|
9017
9425
|
"x-reconciled-from-discovery": true,
|
|
9018
|
-
"x-reconciled-at": "2026-01-
|
|
9426
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792314+00:00"
|
|
9019
9427
|
}
|
|
9020
9428
|
},
|
|
9429
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
9021
9430
|
"x-f5xc-minimum-configuration": {
|
|
9022
9431
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
9023
9432
|
"required_fields": [
|
|
@@ -9064,6 +9473,8 @@
|
|
|
9064
9473
|
"ves.io.schema.rules.repeated.items.string.port_range": "true",
|
|
9065
9474
|
"ves.io.schema.rules.repeated.max_items": "128"
|
|
9066
9475
|
},
|
|
9476
|
+
"x-f5xc-description-short": "List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192 Required: YES.",
|
|
9477
|
+
"x-f5xc-description-medium": "List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192 Required: YES.",
|
|
9067
9478
|
"x-f5xc-required-for": {
|
|
9068
9479
|
"minimum_config": false,
|
|
9069
9480
|
"create": false,
|
|
@@ -9093,6 +9504,8 @@
|
|
|
9093
9504
|
"EncodingBase64"
|
|
9094
9505
|
],
|
|
9095
9506
|
"default": "EncodingNone",
|
|
9507
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
9508
|
+
"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.",
|
|
9096
9509
|
"x-f5xc-minimum-configuration": {
|
|
9097
9510
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
9098
9511
|
"required_fields": [],
|
|
@@ -9118,6 +9531,7 @@
|
|
|
9118
9531
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
9119
9532
|
}
|
|
9120
9533
|
},
|
|
9534
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
9121
9535
|
"x-f5xc-minimum-configuration": {
|
|
9122
9536
|
"description": "Minimum configuration for schemaSecretType",
|
|
9123
9537
|
"required_fields": [
|
|
@@ -9144,6 +9558,8 @@
|
|
|
9144
9558
|
"title": "Creation_timestamp.",
|
|
9145
9559
|
"format": "date-time",
|
|
9146
9560
|
"x-displayname": "Creation Timestamp.",
|
|
9561
|
+
"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.",
|
|
9562
|
+
"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.",
|
|
9147
9563
|
"minLength": 0,
|
|
9148
9564
|
"maxLength": 1024,
|
|
9149
9565
|
"x-f5xc-required-for": {
|
|
@@ -9161,6 +9577,8 @@
|
|
|
9161
9577
|
"x-displayname": "Creator Class.",
|
|
9162
9578
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
9163
9579
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
9580
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
9581
|
+
"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.",
|
|
9164
9582
|
"minLength": 0,
|
|
9165
9583
|
"maxLength": 1024,
|
|
9166
9584
|
"x-f5xc-required-for": {
|
|
@@ -9178,6 +9596,8 @@
|
|
|
9178
9596
|
"x-displayname": "Creator ID.",
|
|
9179
9597
|
"x-ves-example": "Ver-instance-1.",
|
|
9180
9598
|
"x-f5xc-example": "ver-instance-1",
|
|
9599
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
9600
|
+
"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.",
|
|
9181
9601
|
"minLength": 0,
|
|
9182
9602
|
"maxLength": 1024,
|
|
9183
9603
|
"x-f5xc-required-for": {
|
|
@@ -9196,6 +9616,8 @@
|
|
|
9196
9616
|
"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)",
|
|
9197
9617
|
"title": "Status_id",
|
|
9198
9618
|
"x-displayname": "Status ID",
|
|
9619
|
+
"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...",
|
|
9620
|
+
"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).",
|
|
9199
9621
|
"minLength": 0,
|
|
9200
9622
|
"maxLength": 1024,
|
|
9201
9623
|
"x-f5xc-required-for": {
|
|
@@ -9213,6 +9635,7 @@
|
|
|
9213
9635
|
"x-displayname": "UID",
|
|
9214
9636
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
9215
9637
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9638
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
9216
9639
|
"minLength": 0,
|
|
9217
9640
|
"maxLength": 36,
|
|
9218
9641
|
"x-f5xc-required-for": {
|
|
@@ -9225,13 +9648,14 @@
|
|
|
9225
9648
|
"x-original-maxLength": 1024,
|
|
9226
9649
|
"format": "uuid",
|
|
9227
9650
|
"x-reconciled-from-discovery": true,
|
|
9228
|
-
"x-reconciled-at": "2026-01-
|
|
9651
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792331+00:00"
|
|
9229
9652
|
},
|
|
9230
9653
|
"vtrp_id": {
|
|
9231
9654
|
"type": "string",
|
|
9232
9655
|
"description": "Origin of this status exchanged by VTRP.",
|
|
9233
9656
|
"title": "Vtrp_id",
|
|
9234
9657
|
"x-displayname": "VTRP ID",
|
|
9658
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
9235
9659
|
"minLength": 0,
|
|
9236
9660
|
"maxLength": 1024,
|
|
9237
9661
|
"x-f5xc-required-for": {
|
|
@@ -9248,6 +9672,7 @@
|
|
|
9248
9672
|
"title": "Vtrp_stale.",
|
|
9249
9673
|
"format": "boolean",
|
|
9250
9674
|
"x-displayname": "VTRP Stale.",
|
|
9675
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
9251
9676
|
"x-f5xc-required-for": {
|
|
9252
9677
|
"minimum_config": false,
|
|
9253
9678
|
"create": false,
|
|
@@ -9256,6 +9681,7 @@
|
|
|
9256
9681
|
}
|
|
9257
9682
|
}
|
|
9258
9683
|
},
|
|
9684
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
9259
9685
|
"x-f5xc-minimum-configuration": {
|
|
9260
9686
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
9261
9687
|
"required_fields": [
|
|
@@ -9286,6 +9712,8 @@
|
|
|
9286
9712
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
9287
9713
|
"x-displayname": "Status Publish Type.",
|
|
9288
9714
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
9715
|
+
"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.",
|
|
9716
|
+
"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.",
|
|
9289
9717
|
"x-f5xc-minimum-configuration": {
|
|
9290
9718
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
9291
9719
|
"required_fields": [],
|
|
@@ -9311,6 +9739,7 @@
|
|
|
9311
9739
|
"x-displayname": "Code",
|
|
9312
9740
|
"x-ves-example": "0",
|
|
9313
9741
|
"x-f5xc-example": "0",
|
|
9742
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
9314
9743
|
"minimum": 0,
|
|
9315
9744
|
"maximum": 2147483647,
|
|
9316
9745
|
"x-f5xc-required-for": {
|
|
@@ -9327,6 +9756,8 @@
|
|
|
9327
9756
|
"x-displayname": "Reason",
|
|
9328
9757
|
"x-ves-example": "Value",
|
|
9329
9758
|
"x-f5xc-example": "value",
|
|
9759
|
+
"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.",
|
|
9760
|
+
"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.",
|
|
9330
9761
|
"minLength": 0,
|
|
9331
9762
|
"maxLength": 43,
|
|
9332
9763
|
"x-f5xc-required-for": {
|
|
@@ -9337,7 +9768,7 @@
|
|
|
9337
9768
|
},
|
|
9338
9769
|
"x-original-maxLength": 1024,
|
|
9339
9770
|
"x-reconciled-from-discovery": true,
|
|
9340
|
-
"x-reconciled-at": "2026-01-
|
|
9771
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792340+00:00"
|
|
9341
9772
|
},
|
|
9342
9773
|
"status": {
|
|
9343
9774
|
"type": "string",
|
|
@@ -9346,6 +9777,7 @@
|
|
|
9346
9777
|
"x-displayname": "Status",
|
|
9347
9778
|
"x-ves-example": "Value",
|
|
9348
9779
|
"x-f5xc-example": "value",
|
|
9780
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
9349
9781
|
"minLength": 0,
|
|
9350
9782
|
"maxLength": 17,
|
|
9351
9783
|
"x-f5xc-required-for": {
|
|
@@ -9356,9 +9788,10 @@
|
|
|
9356
9788
|
},
|
|
9357
9789
|
"x-original-maxLength": 1024,
|
|
9358
9790
|
"x-reconciled-from-discovery": true,
|
|
9359
|
-
"x-reconciled-at": "2026-01-
|
|
9791
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792344+00:00"
|
|
9360
9792
|
}
|
|
9361
9793
|
},
|
|
9794
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
9362
9795
|
"x-f5xc-minimum-configuration": {
|
|
9363
9796
|
"description": "Minimum configuration for schemaStatusType",
|
|
9364
9797
|
"required_fields": [
|
|
@@ -9386,6 +9819,8 @@
|
|
|
9386
9819
|
"title": "Creation_timestamp.",
|
|
9387
9820
|
"format": "date-time",
|
|
9388
9821
|
"x-displayname": "Creation Timestamp.",
|
|
9822
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
9823
|
+
"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.",
|
|
9389
9824
|
"minLength": 0,
|
|
9390
9825
|
"maxLength": 1024,
|
|
9391
9826
|
"x-f5xc-required-for": {
|
|
@@ -9403,6 +9838,7 @@
|
|
|
9403
9838
|
"x-displayname": "Creator Class.",
|
|
9404
9839
|
"x-ves-example": "Prism",
|
|
9405
9840
|
"x-f5xc-example": "value",
|
|
9841
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
9406
9842
|
"minLength": 0,
|
|
9407
9843
|
"maxLength": 1024,
|
|
9408
9844
|
"x-f5xc-required-for": {
|
|
@@ -9420,6 +9856,7 @@
|
|
|
9420
9856
|
"x-displayname": "Creator ID.",
|
|
9421
9857
|
"x-ves-example": "Admin@example-corp.com.",
|
|
9422
9858
|
"x-f5xc-example": "value",
|
|
9859
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
9423
9860
|
"minLength": 0,
|
|
9424
9861
|
"maxLength": 1024,
|
|
9425
9862
|
"x-f5xc-required-for": {
|
|
@@ -9436,6 +9873,8 @@
|
|
|
9436
9873
|
"title": "Deletion_timestamp.",
|
|
9437
9874
|
"format": "date-time",
|
|
9438
9875
|
"x-displayname": "Deletion Timestamp.",
|
|
9876
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
9877
|
+
"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...",
|
|
9439
9878
|
"minLength": 0,
|
|
9440
9879
|
"maxLength": 1024,
|
|
9441
9880
|
"x-f5xc-required-for": {
|
|
@@ -9455,6 +9894,8 @@
|
|
|
9455
9894
|
"x-displayname": "Finalizers.",
|
|
9456
9895
|
"x-ves-example": "Value",
|
|
9457
9896
|
"x-f5xc-example": "value",
|
|
9897
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
9898
|
+
"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.",
|
|
9458
9899
|
"x-f5xc-required-for": {
|
|
9459
9900
|
"minimum_config": false,
|
|
9460
9901
|
"create": false,
|
|
@@ -9472,6 +9913,8 @@
|
|
|
9472
9913
|
"x-displayname": "Labels",
|
|
9473
9914
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
9474
9915
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
9916
|
+
"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.",
|
|
9917
|
+
"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).",
|
|
9475
9918
|
"x-f5xc-required-for": {
|
|
9476
9919
|
"minimum_config": false,
|
|
9477
9920
|
"create": false,
|
|
@@ -9485,6 +9928,8 @@
|
|
|
9485
9928
|
"title": "Modification_timestamp.",
|
|
9486
9929
|
"format": "date-time",
|
|
9487
9930
|
"x-displayname": "Modification Timestamp.",
|
|
9931
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
9932
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
9488
9933
|
"minLength": 0,
|
|
9489
9934
|
"maxLength": 1024,
|
|
9490
9935
|
"x-f5xc-required-for": {
|
|
@@ -9503,6 +9948,8 @@
|
|
|
9503
9948
|
"x-displayname": "Object Index.",
|
|
9504
9949
|
"x-ves-example": "0",
|
|
9505
9950
|
"x-f5xc-example": "0",
|
|
9951
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
9952
|
+
"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.",
|
|
9506
9953
|
"minimum": 0,
|
|
9507
9954
|
"maximum": 2147483647,
|
|
9508
9955
|
"x-f5xc-required-for": {
|
|
@@ -9523,6 +9970,8 @@
|
|
|
9523
9970
|
"x-displayname": "Tenant",
|
|
9524
9971
|
"x-ves-example": "Example-corp.",
|
|
9525
9972
|
"x-f5xc-example": "example-corp",
|
|
9973
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
9974
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
9526
9975
|
"minLength": 0,
|
|
9527
9976
|
"maxLength": 18,
|
|
9528
9977
|
"x-f5xc-required-for": {
|
|
@@ -9534,7 +9983,7 @@
|
|
|
9534
9983
|
"x-field-mutability": "read-only",
|
|
9535
9984
|
"x-original-maxLength": 1024,
|
|
9536
9985
|
"x-reconciled-from-discovery": true,
|
|
9537
|
-
"x-reconciled-at": "2026-01-
|
|
9986
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792362+00:00"
|
|
9538
9987
|
},
|
|
9539
9988
|
"uid": {
|
|
9540
9989
|
"type": "string",
|
|
@@ -9543,6 +9992,8 @@
|
|
|
9543
9992
|
"x-displayname": "UID",
|
|
9544
9993
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
9545
9994
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9995
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
9996
|
+
"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.",
|
|
9546
9997
|
"minLength": 0,
|
|
9547
9998
|
"maxLength": 36,
|
|
9548
9999
|
"x-f5xc-required-for": {
|
|
@@ -9555,9 +10006,11 @@
|
|
|
9555
10006
|
"x-original-maxLength": 1024,
|
|
9556
10007
|
"format": "uuid",
|
|
9557
10008
|
"x-reconciled-from-discovery": true,
|
|
9558
|
-
"x-reconciled-at": "2026-01-
|
|
10009
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792367+00:00"
|
|
9559
10010
|
}
|
|
9560
10011
|
},
|
|
10012
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
10013
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
9561
10014
|
"x-f5xc-minimum-configuration": {
|
|
9562
10015
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
9563
10016
|
"required_fields": [
|
|
@@ -9611,6 +10064,8 @@
|
|
|
9611
10064
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
9612
10065
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
9613
10066
|
},
|
|
10067
|
+
"x-f5xc-description-short": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
10068
|
+
"x-f5xc-description-medium": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
9614
10069
|
"x-f5xc-required-for": {
|
|
9615
10070
|
"minimum_config": false,
|
|
9616
10071
|
"create": false,
|
|
@@ -9638,7 +10093,7 @@
|
|
|
9638
10093
|
},
|
|
9639
10094
|
"x-original-maxLength": 1024,
|
|
9640
10095
|
"x-reconciled-from-discovery": true,
|
|
9641
|
-
"x-reconciled-at": "2026-01-
|
|
10096
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792374+00:00"
|
|
9642
10097
|
},
|
|
9643
10098
|
"disable_ocsp_stapling": {
|
|
9644
10099
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
@@ -9681,6 +10136,8 @@
|
|
|
9681
10136
|
"default": "TLS_AUTO",
|
|
9682
10137
|
"x-displayname": "TLS Protocol.",
|
|
9683
10138
|
"x-ves-proto-enum": "ves.io.schema.TlsProtocol",
|
|
10139
|
+
"x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
10140
|
+
"x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
9684
10141
|
"x-f5xc-minimum-configuration": {
|
|
9685
10142
|
"description": "Minimum configuration for schemaTlsProtocol",
|
|
9686
10143
|
"required_fields": [],
|
|
@@ -9703,6 +10160,7 @@
|
|
|
9703
10160
|
"default": "TREND_SENTIMENT_NONE",
|
|
9704
10161
|
"x-displayname": "Trend Sentiment.",
|
|
9705
10162
|
"x-ves-proto-enum": "ves.io.schema.TrendSentiment",
|
|
10163
|
+
"x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.",
|
|
9706
10164
|
"x-f5xc-minimum-configuration": {
|
|
9707
10165
|
"description": "Minimum configuration for schemaTrendSentiment",
|
|
9708
10166
|
"required_fields": [],
|
|
@@ -9727,6 +10185,7 @@
|
|
|
9727
10185
|
"x-displayname": "Description.",
|
|
9728
10186
|
"x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.",
|
|
9729
10187
|
"x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
|
|
10188
|
+
"x-f5xc-description-short": "Description of the method used to calculate trend.",
|
|
9730
10189
|
"minLength": 0,
|
|
9731
10190
|
"maxLength": 0,
|
|
9732
10191
|
"x-f5xc-required-for": {
|
|
@@ -9737,15 +10196,16 @@
|
|
|
9737
10196
|
},
|
|
9738
10197
|
"x-original-maxLength": 1024,
|
|
9739
10198
|
"x-reconciled-from-discovery": true,
|
|
9740
|
-
"x-reconciled-at": "2026-01-
|
|
10199
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792383+00:00"
|
|
9741
10200
|
},
|
|
9742
10201
|
"previous_value": {
|
|
9743
10202
|
"type": "string",
|
|
9744
|
-
"description": "",
|
|
10203
|
+
"description": "Configuration parameter for previous value",
|
|
9745
10204
|
"title": "Previous Value.",
|
|
9746
10205
|
"x-displayname": "Previous Value.",
|
|
9747
10206
|
"x-ves-example": "200.00",
|
|
9748
10207
|
"x-f5xc-example": "200.00",
|
|
10208
|
+
"x-f5xc-description-short": "Configuration parameter for previous value.",
|
|
9749
10209
|
"minLength": 0,
|
|
9750
10210
|
"maxLength": 1024,
|
|
9751
10211
|
"x-f5xc-required-for": {
|
|
@@ -9760,7 +10220,7 @@
|
|
|
9760
10220
|
},
|
|
9761
10221
|
"value": {
|
|
9762
10222
|
"type": "string",
|
|
9763
|
-
"description": "",
|
|
10223
|
+
"description": "Configuration parameter for value",
|
|
9764
10224
|
"title": "Value",
|
|
9765
10225
|
"x-displayname": "Value",
|
|
9766
10226
|
"x-ves-example": "-15",
|
|
@@ -9775,9 +10235,11 @@
|
|
|
9775
10235
|
},
|
|
9776
10236
|
"x-original-maxLength": 1024,
|
|
9777
10237
|
"x-reconciled-from-discovery": true,
|
|
9778
|
-
"x-reconciled-at": "2026-01-
|
|
10238
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792389+00:00"
|
|
9779
10239
|
}
|
|
9780
10240
|
},
|
|
10241
|
+
"x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
10242
|
+
"x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
9781
10243
|
"x-f5xc-minimum-configuration": {
|
|
9782
10244
|
"description": "Minimum configuration for schemaTrendValue",
|
|
9783
10245
|
"required_fields": [
|
|
@@ -9829,6 +10291,7 @@
|
|
|
9829
10291
|
"default": "UNIT_MILLISECONDS",
|
|
9830
10292
|
"x-displayname": "Unit",
|
|
9831
10293
|
"x-ves-proto-enum": "ves.io.schema.UnitType",
|
|
10294
|
+
"x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.",
|
|
9832
10295
|
"x-f5xc-minimum-configuration": {
|
|
9833
10296
|
"description": "Minimum configuration for schemaUnitType",
|
|
9834
10297
|
"required_fields": [],
|
|
@@ -9849,6 +10312,8 @@
|
|
|
9849
10312
|
"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.",
|
|
9850
10313
|
"title": "Key",
|
|
9851
10314
|
"x-f5xc-example": "key_pem",
|
|
10315
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
10316
|
+
"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.",
|
|
9852
10317
|
"minLength": 0,
|
|
9853
10318
|
"maxLength": 16,
|
|
9854
10319
|
"x-f5xc-required-for": {
|
|
@@ -9859,13 +10324,14 @@
|
|
|
9859
10324
|
},
|
|
9860
10325
|
"x-original-maxLength": 1024,
|
|
9861
10326
|
"x-reconciled-from-discovery": true,
|
|
9862
|
-
"x-reconciled-at": "2026-01-
|
|
10327
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792394+00:00"
|
|
9863
10328
|
},
|
|
9864
10329
|
"location": {
|
|
9865
10330
|
"type": "string",
|
|
9866
10331
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
9867
10332
|
"title": "Location",
|
|
9868
10333
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
10334
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
9869
10335
|
"minLength": 0,
|
|
9870
10336
|
"maxLength": 4,
|
|
9871
10337
|
"x-f5xc-required-for": {
|
|
@@ -9876,13 +10342,15 @@
|
|
|
9876
10342
|
},
|
|
9877
10343
|
"x-original-maxLength": 1024,
|
|
9878
10344
|
"x-reconciled-from-discovery": true,
|
|
9879
|
-
"x-reconciled-at": "2026-01-
|
|
10345
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792399+00:00"
|
|
9880
10346
|
},
|
|
9881
10347
|
"provider": {
|
|
9882
10348
|
"type": "string",
|
|
9883
10349
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
9884
10350
|
"title": "Provider",
|
|
9885
10351
|
"x-f5xc-example": "vault-vh-provider",
|
|
10352
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
10353
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
9886
10354
|
"minLength": 0,
|
|
9887
10355
|
"maxLength": 8,
|
|
9888
10356
|
"x-f5xc-required-for": {
|
|
@@ -9893,7 +10361,7 @@
|
|
|
9893
10361
|
},
|
|
9894
10362
|
"x-original-maxLength": 1024,
|
|
9895
10363
|
"x-reconciled-from-discovery": true,
|
|
9896
|
-
"x-reconciled-at": "2026-01-
|
|
10364
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792403+00:00"
|
|
9897
10365
|
},
|
|
9898
10366
|
"secret_encoding": {
|
|
9899
10367
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -9904,6 +10372,8 @@
|
|
|
9904
10372
|
"title": "Version",
|
|
9905
10373
|
"format": "int64",
|
|
9906
10374
|
"x-f5xc-example": "1",
|
|
10375
|
+
"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.",
|
|
10376
|
+
"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.",
|
|
9907
10377
|
"minimum": 0,
|
|
9908
10378
|
"maximum": 2147483647,
|
|
9909
10379
|
"x-f5xc-required-for": {
|
|
@@ -9915,9 +10385,11 @@
|
|
|
9915
10385
|
"maxLength": 1,
|
|
9916
10386
|
"minLength": 1,
|
|
9917
10387
|
"x-reconciled-from-discovery": true,
|
|
9918
|
-
"x-reconciled-at": "2026-01-
|
|
10388
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792409+00:00"
|
|
9919
10389
|
}
|
|
9920
10390
|
},
|
|
10391
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
10392
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
9921
10393
|
"x-f5xc-minimum-configuration": {
|
|
9922
10394
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
9923
10395
|
"required_fields": [
|
|
@@ -9958,7 +10430,7 @@
|
|
|
9958
10430
|
},
|
|
9959
10431
|
"x-original-maxLength": 1024,
|
|
9960
10432
|
"x-reconciled-from-discovery": true,
|
|
9961
|
-
"x-reconciled-at": "2026-01-
|
|
10433
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792414+00:00"
|
|
9962
10434
|
},
|
|
9963
10435
|
"name": {
|
|
9964
10436
|
"type": "string",
|
|
@@ -9967,6 +10439,8 @@
|
|
|
9967
10439
|
"x-displayname": "Name",
|
|
9968
10440
|
"x-ves-example": "Contactus-route.",
|
|
9969
10441
|
"x-f5xc-example": "contactus-route",
|
|
10442
|
+
"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.",
|
|
10443
|
+
"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.",
|
|
9970
10444
|
"minLength": 0,
|
|
9971
10445
|
"maxLength": 16,
|
|
9972
10446
|
"x-f5xc-required-for": {
|
|
@@ -9977,7 +10451,7 @@
|
|
|
9977
10451
|
},
|
|
9978
10452
|
"x-original-maxLength": 1024,
|
|
9979
10453
|
"x-reconciled-from-discovery": true,
|
|
9980
|
-
"x-reconciled-at": "2026-01-
|
|
10454
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792418+00:00"
|
|
9981
10455
|
},
|
|
9982
10456
|
"namespace": {
|
|
9983
10457
|
"type": "string",
|
|
@@ -9986,6 +10460,8 @@
|
|
|
9986
10460
|
"x-displayname": "Namespace",
|
|
9987
10461
|
"x-ves-example": "Ns1",
|
|
9988
10462
|
"x-f5xc-example": "ns1",
|
|
10463
|
+
"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.",
|
|
10464
|
+
"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.",
|
|
9989
10465
|
"minLength": 0,
|
|
9990
10466
|
"maxLength": 6,
|
|
9991
10467
|
"x-f5xc-required-for": {
|
|
@@ -9996,7 +10472,7 @@
|
|
|
9996
10472
|
},
|
|
9997
10473
|
"x-original-maxLength": 1024,
|
|
9998
10474
|
"x-reconciled-from-discovery": true,
|
|
9999
|
-
"x-reconciled-at": "2026-01-
|
|
10475
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792422+00:00"
|
|
10000
10476
|
},
|
|
10001
10477
|
"uid": {
|
|
10002
10478
|
"type": "string",
|
|
@@ -10017,9 +10493,10 @@
|
|
|
10017
10493
|
"x-original-maxLength": 1024,
|
|
10018
10494
|
"format": "uuid",
|
|
10019
10495
|
"x-reconciled-from-discovery": true,
|
|
10020
|
-
"x-reconciled-at": "2026-01-
|
|
10496
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792427+00:00"
|
|
10021
10497
|
}
|
|
10022
10498
|
},
|
|
10499
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
10023
10500
|
"x-f5xc-minimum-configuration": {
|
|
10024
10501
|
"description": "Minimum configuration for schemaViewRefType",
|
|
10025
10502
|
"required_fields": [
|
|
@@ -10045,6 +10522,7 @@
|
|
|
10045
10522
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
10046
10523
|
"title": "Name",
|
|
10047
10524
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
10525
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
10048
10526
|
"minLength": 0,
|
|
10049
10527
|
"maxLength": 16,
|
|
10050
10528
|
"x-f5xc-required-for": {
|
|
@@ -10055,9 +10533,10 @@
|
|
|
10055
10533
|
},
|
|
10056
10534
|
"x-original-maxLength": 1024,
|
|
10057
10535
|
"x-reconciled-from-discovery": true,
|
|
10058
|
-
"x-reconciled-at": "2026-01-
|
|
10536
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792431+00:00"
|
|
10059
10537
|
}
|
|
10060
10538
|
},
|
|
10539
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
10061
10540
|
"x-f5xc-minimum-configuration": {
|
|
10062
10541
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
10063
10542
|
"required_fields": [
|
|
@@ -10085,6 +10564,8 @@
|
|
|
10085
10564
|
"default": "XFCC_NONE",
|
|
10086
10565
|
"x-displayname": "XFCC Elements.",
|
|
10087
10566
|
"x-ves-proto-enum": "ves.io.schema.XfccElement",
|
|
10567
|
+
"x-f5xc-description-short": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format.",
|
|
10568
|
+
"x-f5xc-description-medium": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format. The entire client certificate chain (including the leaf certificate) in URL encoded PEM format. The Subject field of the current client certificate.",
|
|
10088
10569
|
"x-f5xc-minimum-configuration": {
|
|
10089
10570
|
"description": "Minimum configuration for schemaXfccElement",
|
|
10090
10571
|
"required_fields": [],
|
|
@@ -10122,6 +10603,8 @@
|
|
|
10122
10603
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
10123
10604
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
10124
10605
|
},
|
|
10606
|
+
"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.",
|
|
10607
|
+
"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. Required: YES.",
|
|
10125
10608
|
"x-f5xc-required-for": {
|
|
10126
10609
|
"minimum_config": false,
|
|
10127
10610
|
"create": false,
|
|
@@ -10130,7 +10613,7 @@
|
|
|
10130
10613
|
},
|
|
10131
10614
|
"x-original-maxLength": 128,
|
|
10132
10615
|
"x-reconciled-from-discovery": true,
|
|
10133
|
-
"x-reconciled-at": "2026-01-
|
|
10616
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792437+00:00"
|
|
10134
10617
|
},
|
|
10135
10618
|
"namespace": {
|
|
10136
10619
|
"type": "string",
|
|
@@ -10146,6 +10629,8 @@
|
|
|
10146
10629
|
"x-validation-rules": {
|
|
10147
10630
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
10148
10631
|
},
|
|
10632
|
+
"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.",
|
|
10633
|
+
"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.",
|
|
10149
10634
|
"minLength": 0,
|
|
10150
10635
|
"x-f5xc-required-for": {
|
|
10151
10636
|
"minimum_config": false,
|
|
@@ -10155,7 +10640,7 @@
|
|
|
10155
10640
|
},
|
|
10156
10641
|
"x-original-maxLength": 64,
|
|
10157
10642
|
"x-reconciled-from-discovery": true,
|
|
10158
|
-
"x-reconciled-at": "2026-01-
|
|
10643
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792441+00:00"
|
|
10159
10644
|
},
|
|
10160
10645
|
"tenant": {
|
|
10161
10646
|
"type": "string",
|
|
@@ -10171,6 +10656,8 @@
|
|
|
10171
10656
|
"x-validation-rules": {
|
|
10172
10657
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
10173
10658
|
},
|
|
10659
|
+
"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.",
|
|
10660
|
+
"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.",
|
|
10174
10661
|
"minLength": 0,
|
|
10175
10662
|
"x-f5xc-required-for": {
|
|
10176
10663
|
"minimum_config": false,
|
|
@@ -10182,9 +10669,11 @@
|
|
|
10182
10669
|
"x-field-mutability": "read-only",
|
|
10183
10670
|
"x-original-maxLength": 64,
|
|
10184
10671
|
"x-reconciled-from-discovery": true,
|
|
10185
|
-
"x-reconciled-at": "2026-01-
|
|
10672
|
+
"x-reconciled-at": "2026-01-07T15:27:57.792445+00:00"
|
|
10186
10673
|
}
|
|
10187
10674
|
},
|
|
10675
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
10676
|
+
"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.",
|
|
10188
10677
|
"x-f5xc-minimum-configuration": {
|
|
10189
10678
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
10190
10679
|
"required_fields": [
|
|
@@ -10274,6 +10763,8 @@
|
|
|
10274
10763
|
"title": "Modification_timestamp.",
|
|
10275
10764
|
"format": "date-time",
|
|
10276
10765
|
"x-displayname": "Modification Timestamp.",
|
|
10766
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
|
|
10767
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
|
|
10277
10768
|
"minLength": 0,
|
|
10278
10769
|
"maxLength": 1024,
|
|
10279
10770
|
"x-f5xc-required-for": {
|
|
@@ -10307,6 +10798,7 @@
|
|
|
10307
10798
|
"x-displayname": "Terraform Output.",
|
|
10308
10799
|
"x-ves-example": "Value",
|
|
10309
10800
|
"x-f5xc-example": "value",
|
|
10801
|
+
"x-f5xc-description-short": "The value of an \"output\" variable from the terraform state file.",
|
|
10310
10802
|
"minLength": 0,
|
|
10311
10803
|
"maxLength": 1024,
|
|
10312
10804
|
"x-f5xc-required-for": {
|
|
@@ -10424,6 +10916,8 @@
|
|
|
10424
10916
|
"UPGRADE_NOT_REQUIRED"
|
|
10425
10917
|
],
|
|
10426
10918
|
"default": "UPGRADE_SUCCESSFUL",
|
|
10919
|
+
"x-f5xc-description-short": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED...",
|
|
10920
|
+
"x-f5xc-description-medium": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\" - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\".",
|
|
10427
10921
|
"x-f5xc-minimum-configuration": {
|
|
10428
10922
|
"description": "Minimum configuration for terraform_parametersUpgradeState",
|
|
10429
10923
|
"required_fields": [],
|
|
@@ -10445,6 +10939,8 @@
|
|
|
10445
10939
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
10446
10940
|
}
|
|
10447
10941
|
},
|
|
10942
|
+
"x-f5xc-description-short": "Defines a way to advertise a load balancer on public.",
|
|
10943
|
+
"x-f5xc-description-medium": "Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
|
|
10448
10944
|
"x-f5xc-minimum-configuration": {
|
|
10449
10945
|
"description": "Minimum configuration for viewsAdvertisePublic",
|
|
10450
10946
|
"required_fields": [
|
|
@@ -10483,6 +10979,7 @@
|
|
|
10483
10979
|
"ves.io.schema.rules.string.ipv4_prefix": "true",
|
|
10484
10980
|
"ves.io.schema.rules.string.max_ip_prefix_length": "28"
|
|
10485
10981
|
},
|
|
10982
|
+
"x-f5xc-description-short": "IPv4 subnet prefix for this subnet Required: YES.",
|
|
10486
10983
|
"format": "ipv4",
|
|
10487
10984
|
"minLength": 0,
|
|
10488
10985
|
"maxLength": 1024,
|
|
@@ -10494,6 +10991,7 @@
|
|
|
10494
10991
|
}
|
|
10495
10992
|
}
|
|
10496
10993
|
},
|
|
10994
|
+
"x-f5xc-description-short": "Parameters for creating a new cloud subnet.",
|
|
10497
10995
|
"x-f5xc-minimum-configuration": {
|
|
10498
10996
|
"description": "Minimum configuration for viewsCloudSubnetParamType",
|
|
10499
10997
|
"required_fields": [
|
|
@@ -10530,6 +11028,7 @@
|
|
|
10530
11028
|
"ves.io.schema.rules.string.max_len": "64",
|
|
10531
11029
|
"ves.io.schema.rules.string.pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$"
|
|
10532
11030
|
},
|
|
11031
|
+
"x-f5xc-description-short": "Exclusive with [subnet_param] Information about existing subnet ID.",
|
|
10533
11032
|
"minLength": 0,
|
|
10534
11033
|
"x-f5xc-required-for": {
|
|
10535
11034
|
"minimum_config": false,
|
|
@@ -10585,6 +11084,7 @@
|
|
|
10585
11084
|
"ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
|
|
10586
11085
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
10587
11086
|
},
|
|
11087
|
+
"x-f5xc-description-short": "The TLS listener will only support the specified cipher list. Required: YES.",
|
|
10588
11088
|
"x-f5xc-required-for": {
|
|
10589
11089
|
"minimum_config": false,
|
|
10590
11090
|
"create": false,
|
|
@@ -10599,6 +11099,7 @@
|
|
|
10599
11099
|
"$ref": "#/components/schemas/schemaTlsProtocol"
|
|
10600
11100
|
}
|
|
10601
11101
|
},
|
|
11102
|
+
"x-f5xc-description-short": "Defines TLS protocol config including min/max versions and allowed ciphers.",
|
|
10602
11103
|
"x-f5xc-minimum-configuration": {
|
|
10603
11104
|
"description": "Minimum configuration for viewsCustomCiphers",
|
|
10604
11105
|
"required_fields": [
|
|
@@ -10645,6 +11146,8 @@
|
|
|
10645
11146
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
10646
11147
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
10647
11148
|
},
|
|
11149
|
+
"x-f5xc-description-short": "Users can add one or more certificates that share the same set of domains.",
|
|
11150
|
+
"x-f5xc-description-medium": "Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms Required: YES.",
|
|
10648
11151
|
"x-f5xc-required-for": {
|
|
10649
11152
|
"minimum_config": false,
|
|
10650
11153
|
"create": false,
|
|
@@ -10690,6 +11193,9 @@
|
|
|
10690
11193
|
"title": "Client_certificate_optional.",
|
|
10691
11194
|
"format": "boolean",
|
|
10692
11195
|
"x-displayname": "Client Certificate Optional.",
|
|
11196
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11197
|
+
"x-f5xc-description-short": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it.",
|
|
11198
|
+
"x-f5xc-description-medium": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated.",
|
|
10693
11199
|
"x-f5xc-required-for": {
|
|
10694
11200
|
"minimum_config": false,
|
|
10695
11201
|
"create": false,
|
|
@@ -10723,6 +11229,7 @@
|
|
|
10723
11229
|
"ves.io.schema.rules.string.min_bytes": "1",
|
|
10724
11230
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
10725
11231
|
},
|
|
11232
|
+
"x-f5xc-description-short": "Exclusive with [trusted_ca] Upload a Root CA Certificate specifically for this Load Balancer.",
|
|
10726
11233
|
"x-f5xc-required-for": {
|
|
10727
11234
|
"minimum_config": false,
|
|
10728
11235
|
"create": false,
|
|
@@ -10737,6 +11244,7 @@
|
|
|
10737
11244
|
"$ref": "#/components/schemas/viewsXfccHeaderKeys"
|
|
10738
11245
|
}
|
|
10739
11246
|
},
|
|
11247
|
+
"x-f5xc-description-short": "Validation context for downstream client TLS connections.",
|
|
10740
11248
|
"x-f5xc-minimum-configuration": {
|
|
10741
11249
|
"description": "Minimum configuration for viewsDownstreamTlsValidationContext",
|
|
10742
11250
|
"required_fields": [
|
|
@@ -10777,6 +11285,7 @@
|
|
|
10777
11285
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
10778
11286
|
}
|
|
10779
11287
|
},
|
|
11288
|
+
"x-f5xc-description-short": "Defines various OPTIONS to configure TLS configuration parameters.",
|
|
10780
11289
|
"x-f5xc-minimum-configuration": {
|
|
10781
11290
|
"description": "Minimum configuration for viewsTlsConfig",
|
|
10782
11291
|
"required_fields": [
|
|
@@ -10818,6 +11327,7 @@
|
|
|
10818
11327
|
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
|
|
10819
11328
|
"ves.io.schema.rules.repeated.items.enum.not_in": "[0]"
|
|
10820
11329
|
},
|
|
11330
|
+
"x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests Required: YES.",
|
|
10821
11331
|
"x-f5xc-required-for": {
|
|
10822
11332
|
"minimum_config": false,
|
|
10823
11333
|
"create": false,
|
|
@@ -10826,6 +11336,7 @@
|
|
|
10826
11336
|
}
|
|
10827
11337
|
}
|
|
10828
11338
|
},
|
|
11339
|
+
"x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests.",
|
|
10829
11340
|
"x-f5xc-minimum-configuration": {
|
|
10830
11341
|
"description": "Minimum configuration for viewsXfccHeaderKeys",
|
|
10831
11342
|
"required_fields": [
|
|
@@ -10914,6 +11425,7 @@
|
|
|
10914
11425
|
"ves.io.schema.rules.string.max_bytes": "1048576",
|
|
10915
11426
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
10916
11427
|
},
|
|
11428
|
+
"x-f5xc-description-short": "IRule code content, this content will be base64 encoded for preserving formating.",
|
|
10917
11429
|
"x-f5xc-required-for": {
|
|
10918
11430
|
"minimum_config": false,
|
|
10919
11431
|
"create": false,
|
|
@@ -10932,6 +11444,7 @@
|
|
|
10932
11444
|
"x-validation-rules": {
|
|
10933
11445
|
"ves.io.schema.rules.string.max_len": "256"
|
|
10934
11446
|
},
|
|
11447
|
+
"x-f5xc-example": "example-resource",
|
|
10935
11448
|
"minLength": 0,
|
|
10936
11449
|
"x-f5xc-required-for": {
|
|
10937
11450
|
"minimum_config": false,
|
|
@@ -10987,6 +11500,7 @@
|
|
|
10987
11500
|
"title": "Fail_if_referred.",
|
|
10988
11501
|
"format": "boolean",
|
|
10989
11502
|
"x-displayname": "Fail-If-Referred.",
|
|
11503
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
10990
11504
|
"x-f5xc-required-for": {
|
|
10991
11505
|
"minimum_config": false,
|
|
10992
11506
|
"create": false,
|
|
@@ -11011,7 +11525,7 @@
|
|
|
11011
11525
|
},
|
|
11012
11526
|
"x-original-maxLength": 1024,
|
|
11013
11527
|
"x-reconciled-from-discovery": true,
|
|
11014
|
-
"x-reconciled-at": "2026-01-
|
|
11528
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208680+00:00"
|
|
11015
11529
|
},
|
|
11016
11530
|
"namespace": {
|
|
11017
11531
|
"type": "string",
|
|
@@ -11020,6 +11534,7 @@
|
|
|
11020
11534
|
"x-displayname": "Namespace",
|
|
11021
11535
|
"x-ves-example": "Ns1",
|
|
11022
11536
|
"x-f5xc-example": "ns1",
|
|
11537
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
11023
11538
|
"minLength": 0,
|
|
11024
11539
|
"maxLength": 6,
|
|
11025
11540
|
"x-f5xc-required-for": {
|
|
@@ -11030,7 +11545,7 @@
|
|
|
11030
11545
|
},
|
|
11031
11546
|
"x-original-maxLength": 1024,
|
|
11032
11547
|
"x-reconciled-from-discovery": true,
|
|
11033
|
-
"x-reconciled-at": "2026-01-
|
|
11548
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208687+00:00"
|
|
11034
11549
|
}
|
|
11035
11550
|
},
|
|
11036
11551
|
"x-f5xc-minimum-configuration": {
|
|
@@ -11065,6 +11580,7 @@
|
|
|
11065
11580
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11066
11581
|
},
|
|
11067
11582
|
"x-displayname": "Deleted Referred Objects.",
|
|
11583
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
11068
11584
|
"x-f5xc-required-for": {
|
|
11069
11585
|
"minimum_config": false,
|
|
11070
11586
|
"create": false,
|
|
@@ -11080,6 +11596,7 @@
|
|
|
11080
11596
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11081
11597
|
},
|
|
11082
11598
|
"x-displayname": "Disabled Referred Objects.",
|
|
11599
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
11083
11600
|
"x-f5xc-required-for": {
|
|
11084
11601
|
"minimum_config": false,
|
|
11085
11602
|
"create": false,
|
|
@@ -11098,6 +11615,7 @@
|
|
|
11098
11615
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11099
11616
|
},
|
|
11100
11617
|
"x-displayname": "Referring Objects.",
|
|
11618
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
11101
11619
|
"x-f5xc-required-for": {
|
|
11102
11620
|
"minimum_config": false,
|
|
11103
11621
|
"create": false,
|
|
@@ -11119,6 +11637,8 @@
|
|
|
11119
11637
|
"$ref": "#/components/schemas/bigip_iruleStatusObject"
|
|
11120
11638
|
},
|
|
11121
11639
|
"x-displayname": "Status",
|
|
11640
|
+
"x-f5xc-example": "active",
|
|
11641
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11122
11642
|
"x-f5xc-required-for": {
|
|
11123
11643
|
"minimum_config": false,
|
|
11124
11644
|
"create": false,
|
|
@@ -11128,7 +11648,7 @@
|
|
|
11128
11648
|
"maxLength": 17,
|
|
11129
11649
|
"minLength": 17,
|
|
11130
11650
|
"x-reconciled-from-discovery": true,
|
|
11131
|
-
"x-reconciled-at": "2026-01-
|
|
11651
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208703+00:00"
|
|
11132
11652
|
},
|
|
11133
11653
|
"system_metadata": {
|
|
11134
11654
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -11168,6 +11688,8 @@
|
|
|
11168
11688
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
11169
11689
|
],
|
|
11170
11690
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
11691
|
+
"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...",
|
|
11692
|
+
"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...",
|
|
11171
11693
|
"x-f5xc-minimum-configuration": {
|
|
11172
11694
|
"description": "Minimum configuration for bigip_iruleGetResponseFormatCode",
|
|
11173
11695
|
"required_fields": [],
|
|
@@ -11199,6 +11721,7 @@
|
|
|
11199
11721
|
"ves.io.schema.rules.string.max_bytes": "1048576",
|
|
11200
11722
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
11201
11723
|
},
|
|
11724
|
+
"x-f5xc-description-short": "IRule code content, this content will be base64 encoded for preserving formating.",
|
|
11202
11725
|
"x-f5xc-required-for": {
|
|
11203
11726
|
"minimum_config": false,
|
|
11204
11727
|
"create": false,
|
|
@@ -11217,6 +11740,7 @@
|
|
|
11217
11740
|
"x-validation-rules": {
|
|
11218
11741
|
"ves.io.schema.rules.string.max_len": "256"
|
|
11219
11742
|
},
|
|
11743
|
+
"x-f5xc-example": "example-resource",
|
|
11220
11744
|
"minLength": 0,
|
|
11221
11745
|
"x-f5xc-required-for": {
|
|
11222
11746
|
"minimum_config": false,
|
|
@@ -11274,6 +11798,7 @@
|
|
|
11274
11798
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
11275
11799
|
},
|
|
11276
11800
|
"x-displayname": "Errors",
|
|
11801
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
11277
11802
|
"x-f5xc-required-for": {
|
|
11278
11803
|
"minimum_config": false,
|
|
11279
11804
|
"create": false,
|
|
@@ -11289,6 +11814,8 @@
|
|
|
11289
11814
|
"$ref": "#/components/schemas/bigip_iruleListResponseItem"
|
|
11290
11815
|
},
|
|
11291
11816
|
"x-displayname": "Items",
|
|
11817
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
11818
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
11292
11819
|
"x-f5xc-required-for": {
|
|
11293
11820
|
"minimum_config": false,
|
|
11294
11821
|
"create": false,
|
|
@@ -11322,6 +11849,8 @@
|
|
|
11322
11849
|
"description": "The set of annotations present on this bigip_irule.",
|
|
11323
11850
|
"title": "Annotations.",
|
|
11324
11851
|
"x-displayname": "Annotations.",
|
|
11852
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11853
|
+
"x-f5xc-description-short": "The set of annotations present on this bigip_irule.",
|
|
11325
11854
|
"x-f5xc-required-for": {
|
|
11326
11855
|
"minimum_config": false,
|
|
11327
11856
|
"create": false,
|
|
@@ -11334,6 +11863,7 @@
|
|
|
11334
11863
|
"description": "The description set for this bigip_irule.",
|
|
11335
11864
|
"title": "Description.",
|
|
11336
11865
|
"x-displayname": "Description.",
|
|
11866
|
+
"x-f5xc-description-short": "The description set for this bigip_irule.",
|
|
11337
11867
|
"minLength": 0,
|
|
11338
11868
|
"maxLength": 0,
|
|
11339
11869
|
"x-f5xc-required-for": {
|
|
@@ -11344,7 +11874,7 @@
|
|
|
11344
11874
|
},
|
|
11345
11875
|
"x-original-maxLength": 1024,
|
|
11346
11876
|
"x-reconciled-from-discovery": true,
|
|
11347
|
-
"x-reconciled-at": "2026-01-
|
|
11877
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208721+00:00"
|
|
11348
11878
|
},
|
|
11349
11879
|
"disabled": {
|
|
11350
11880
|
"type": "boolean",
|
|
@@ -11352,6 +11882,8 @@
|
|
|
11352
11882
|
"title": "Disabled",
|
|
11353
11883
|
"format": "boolean",
|
|
11354
11884
|
"x-displayname": "Disabled",
|
|
11885
|
+
"x-f5xc-example": "True",
|
|
11886
|
+
"x-f5xc-description-short": "Value of true indicates bigip_irule is administratively disabled.",
|
|
11355
11887
|
"x-f5xc-required-for": {
|
|
11356
11888
|
"minimum_config": false,
|
|
11357
11889
|
"create": false,
|
|
@@ -11367,6 +11899,8 @@
|
|
|
11367
11899
|
"description": "The set of labels present on this bigip_irule.",
|
|
11368
11900
|
"title": "Labels",
|
|
11369
11901
|
"x-displayname": "Labels",
|
|
11902
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11903
|
+
"x-f5xc-description-short": "The set of labels present on this bigip_irule.",
|
|
11370
11904
|
"x-f5xc-required-for": {
|
|
11371
11905
|
"minimum_config": false,
|
|
11372
11906
|
"create": false,
|
|
@@ -11394,7 +11928,7 @@
|
|
|
11394
11928
|
},
|
|
11395
11929
|
"x-original-maxLength": 1024,
|
|
11396
11930
|
"x-reconciled-from-discovery": true,
|
|
11397
|
-
"x-reconciled-at": "2026-01-
|
|
11931
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208731+00:00"
|
|
11398
11932
|
},
|
|
11399
11933
|
"namespace": {
|
|
11400
11934
|
"type": "string",
|
|
@@ -11413,7 +11947,7 @@
|
|
|
11413
11947
|
},
|
|
11414
11948
|
"x-original-maxLength": 1024,
|
|
11415
11949
|
"x-reconciled-from-discovery": true,
|
|
11416
|
-
"x-reconciled-at": "2026-01-
|
|
11950
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208735+00:00"
|
|
11417
11951
|
},
|
|
11418
11952
|
"owner_view": {
|
|
11419
11953
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -11426,6 +11960,7 @@
|
|
|
11426
11960
|
"$ref": "#/components/schemas/bigip_iruleStatusObject"
|
|
11427
11961
|
},
|
|
11428
11962
|
"x-displayname": "Status",
|
|
11963
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11429
11964
|
"x-f5xc-required-for": {
|
|
11430
11965
|
"minimum_config": false,
|
|
11431
11966
|
"create": false,
|
|
@@ -11454,7 +11989,7 @@
|
|
|
11454
11989
|
"x-field-mutability": "read-only",
|
|
11455
11990
|
"x-original-maxLength": 1024,
|
|
11456
11991
|
"x-reconciled-from-discovery": true,
|
|
11457
|
-
"x-reconciled-at": "2026-01-
|
|
11992
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208743+00:00"
|
|
11458
11993
|
},
|
|
11459
11994
|
"uid": {
|
|
11460
11995
|
"type": "string",
|
|
@@ -11475,9 +12010,11 @@
|
|
|
11475
12010
|
"x-original-maxLength": 1024,
|
|
11476
12011
|
"format": "uuid",
|
|
11477
12012
|
"x-reconciled-from-discovery": true,
|
|
11478
|
-
"x-reconciled-at": "2026-01-
|
|
12013
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208749+00:00"
|
|
11479
12014
|
}
|
|
11480
12015
|
},
|
|
12016
|
+
"x-f5xc-description-short": "By default a summary of bigip_irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
12017
|
+
"x-f5xc-description-medium": "By default a summary of bigip_irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
11481
12018
|
"x-f5xc-minimum-configuration": {
|
|
11482
12019
|
"description": "Minimum configuration for bigip_iruleListResponseItem",
|
|
11483
12020
|
"required_fields": [
|
|
@@ -11563,6 +12100,7 @@
|
|
|
11563
12100
|
"ves.io.schema.rules.string.max_bytes": "1048576",
|
|
11564
12101
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
11565
12102
|
},
|
|
12103
|
+
"x-f5xc-description-short": "IRule code content, this content will be base64 encoded for preserving formating.",
|
|
11566
12104
|
"x-f5xc-required-for": {
|
|
11567
12105
|
"minimum_config": false,
|
|
11568
12106
|
"create": false,
|
|
@@ -11581,6 +12119,7 @@
|
|
|
11581
12119
|
"x-validation-rules": {
|
|
11582
12120
|
"ves.io.schema.rules.string.max_len": "256"
|
|
11583
12121
|
},
|
|
12122
|
+
"x-f5xc-example": "example-resource",
|
|
11584
12123
|
"minLength": 0,
|
|
11585
12124
|
"x-f5xc-required-for": {
|
|
11586
12125
|
"minimum_config": false,
|
|
@@ -11638,6 +12177,7 @@
|
|
|
11638
12177
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
11639
12178
|
},
|
|
11640
12179
|
"x-displayname": "Conditions.",
|
|
12180
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
11641
12181
|
"x-f5xc-required-for": {
|
|
11642
12182
|
"minimum_config": false,
|
|
11643
12183
|
"create": false,
|
|
@@ -11656,6 +12196,7 @@
|
|
|
11656
12196
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11657
12197
|
},
|
|
11658
12198
|
"x-displayname": "Config Object.",
|
|
12199
|
+
"x-f5xc-description-short": "Reference to the object for current status.",
|
|
11659
12200
|
"x-f5xc-required-for": {
|
|
11660
12201
|
"minimum_config": false,
|
|
11661
12202
|
"create": false,
|
|
@@ -11664,6 +12205,7 @@
|
|
|
11664
12205
|
}
|
|
11665
12206
|
}
|
|
11666
12207
|
},
|
|
12208
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
11667
12209
|
"x-f5xc-minimum-configuration": {
|
|
11668
12210
|
"description": "Minimum configuration for bigip_iruleStatusObject",
|
|
11669
12211
|
"required_fields": [
|
|
@@ -11692,6 +12234,8 @@
|
|
|
11692
12234
|
"x-displayname": "Kind",
|
|
11693
12235
|
"x-ves-example": "Virtual_site.",
|
|
11694
12236
|
"x-f5xc-example": "virtual_site",
|
|
12237
|
+
"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\")",
|
|
12238
|
+
"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\").",
|
|
11695
12239
|
"minLength": 0,
|
|
11696
12240
|
"maxLength": 14,
|
|
11697
12241
|
"x-f5xc-required-for": {
|
|
@@ -11703,7 +12247,7 @@
|
|
|
11703
12247
|
"readOnly": true,
|
|
11704
12248
|
"x-original-maxLength": 1024,
|
|
11705
12249
|
"x-reconciled-from-discovery": true,
|
|
11706
|
-
"x-reconciled-at": "2026-01-
|
|
12250
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208836+00:00"
|
|
11707
12251
|
},
|
|
11708
12252
|
"name": {
|
|
11709
12253
|
"type": "string",
|
|
@@ -11712,6 +12256,8 @@
|
|
|
11712
12256
|
"x-displayname": "Name",
|
|
11713
12257
|
"x-ves-example": "Contactus-route.",
|
|
11714
12258
|
"x-f5xc-example": "contactus-route",
|
|
12259
|
+
"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.",
|
|
12260
|
+
"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.",
|
|
11715
12261
|
"minLength": 0,
|
|
11716
12262
|
"maxLength": 16,
|
|
11717
12263
|
"x-f5xc-required-for": {
|
|
@@ -11722,7 +12268,7 @@
|
|
|
11722
12268
|
},
|
|
11723
12269
|
"x-original-maxLength": 1024,
|
|
11724
12270
|
"x-reconciled-from-discovery": true,
|
|
11725
|
-
"x-reconciled-at": "2026-01-
|
|
12271
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208840+00:00"
|
|
11726
12272
|
},
|
|
11727
12273
|
"namespace": {
|
|
11728
12274
|
"type": "string",
|
|
@@ -11731,6 +12277,8 @@
|
|
|
11731
12277
|
"x-displayname": "Namespace",
|
|
11732
12278
|
"x-ves-example": "Ns1",
|
|
11733
12279
|
"x-f5xc-example": "ns1",
|
|
12280
|
+
"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.",
|
|
12281
|
+
"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.",
|
|
11734
12282
|
"minLength": 0,
|
|
11735
12283
|
"maxLength": 6,
|
|
11736
12284
|
"x-f5xc-required-for": {
|
|
@@ -11741,7 +12289,7 @@
|
|
|
11741
12289
|
},
|
|
11742
12290
|
"x-original-maxLength": 1024,
|
|
11743
12291
|
"x-reconciled-from-discovery": true,
|
|
11744
|
-
"x-reconciled-at": "2026-01-
|
|
12292
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208844+00:00"
|
|
11745
12293
|
},
|
|
11746
12294
|
"tenant": {
|
|
11747
12295
|
"type": "string",
|
|
@@ -11750,6 +12298,8 @@
|
|
|
11750
12298
|
"x-displayname": "Tenant",
|
|
11751
12299
|
"x-ves-example": "Example-corp.",
|
|
11752
12300
|
"x-f5xc-example": "example-corp",
|
|
12301
|
+
"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.",
|
|
12302
|
+
"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.",
|
|
11753
12303
|
"minLength": 0,
|
|
11754
12304
|
"maxLength": 18,
|
|
11755
12305
|
"x-f5xc-required-for": {
|
|
@@ -11762,7 +12312,7 @@
|
|
|
11762
12312
|
"x-field-mutability": "read-only",
|
|
11763
12313
|
"x-original-maxLength": 1024,
|
|
11764
12314
|
"x-reconciled-from-discovery": true,
|
|
11765
|
-
"x-reconciled-at": "2026-01-
|
|
12315
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208848+00:00"
|
|
11766
12316
|
},
|
|
11767
12317
|
"uid": {
|
|
11768
12318
|
"type": "string",
|
|
@@ -11771,6 +12321,8 @@
|
|
|
11771
12321
|
"x-displayname": "UID",
|
|
11772
12322
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
11773
12323
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12324
|
+
"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.",
|
|
12325
|
+
"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.",
|
|
11774
12326
|
"minLength": 0,
|
|
11775
12327
|
"maxLength": 36,
|
|
11776
12328
|
"x-f5xc-required-for": {
|
|
@@ -11784,9 +12336,11 @@
|
|
|
11784
12336
|
"x-original-maxLength": 1024,
|
|
11785
12337
|
"format": "uuid",
|
|
11786
12338
|
"x-reconciled-from-discovery": true,
|
|
11787
|
-
"x-reconciled-at": "2026-01-
|
|
12339
|
+
"x-reconciled-at": "2026-01-07T15:27:58.208853+00:00"
|
|
11788
12340
|
}
|
|
11789
12341
|
},
|
|
12342
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
12343
|
+
"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...",
|
|
11790
12344
|
"x-f5xc-minimum-configuration": {
|
|
11791
12345
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
11792
12346
|
"required_fields": [
|
|
@@ -11814,6 +12368,7 @@
|
|
|
11814
12368
|
"title": "API endpoint path.",
|
|
11815
12369
|
"x-f5xc-example": "/endpoint1",
|
|
11816
12370
|
"x-required": true,
|
|
12371
|
+
"x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
|
|
11817
12372
|
"minLength": 0,
|
|
11818
12373
|
"maxLength": 1024,
|
|
11819
12374
|
"x-f5xc-required-for": {
|
|
@@ -11831,6 +12386,7 @@
|
|
|
11831
12386
|
"$ref": "#/components/schemas/schemaHttpMethod"
|
|
11832
12387
|
},
|
|
11833
12388
|
"x-f5xc-example": "['GET', 'POST', 'DELETE']",
|
|
12389
|
+
"x-f5xc-description-short": "X-displayName: \"Methods\" List of methods values to match against. X-required.",
|
|
11834
12390
|
"x-f5xc-required-for": {
|
|
11835
12391
|
"minimum_config": false,
|
|
11836
12392
|
"create": false,
|
|
@@ -11840,6 +12396,7 @@
|
|
|
11840
12396
|
}
|
|
11841
12397
|
},
|
|
11842
12398
|
"x-required": true,
|
|
12399
|
+
"x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
|
|
11843
12400
|
"x-f5xc-minimum-configuration": {
|
|
11844
12401
|
"description": "Minimum configuration for app_typeAPIEndpoint",
|
|
11845
12402
|
"required_fields": [
|
|
@@ -11863,6 +12420,7 @@
|
|
|
11863
12420
|
"description": "X-displayName: \"Name\"\nx-required\nBuilt-in rule for sensitive data detection.",
|
|
11864
12421
|
"title": "Name",
|
|
11865
12422
|
"x-f5xc-example": "[EMAIL, CC]",
|
|
12423
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Built-in rule for sensitive data detection.",
|
|
11866
12424
|
"minLength": 0,
|
|
11867
12425
|
"maxLength": 16,
|
|
11868
12426
|
"x-f5xc-required-for": {
|
|
@@ -11873,10 +12431,11 @@
|
|
|
11873
12431
|
},
|
|
11874
12432
|
"x-original-maxLength": 1024,
|
|
11875
12433
|
"x-reconciled-from-discovery": true,
|
|
11876
|
-
"x-reconciled-at": "2026-01-
|
|
12434
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731745+00:00"
|
|
11877
12435
|
}
|
|
11878
12436
|
},
|
|
11879
12437
|
"x-f5xc-example": "[EMAIL, CC]",
|
|
12438
|
+
"x-f5xc-description-short": "X-displayName: \"Built-In Sensitive Data Type\" Message wrapper for built-in sensitive data type.",
|
|
11880
12439
|
"x-f5xc-minimum-configuration": {
|
|
11881
12440
|
"description": "Minimum configuration for app_typeBuiltInSensitiveDataType",
|
|
11882
12441
|
"required_fields": [
|
|
@@ -11917,6 +12476,8 @@
|
|
|
11917
12476
|
"description": "X-displayName: \"API Group\"\nThe rule is applied on the APIs that belong to specified api_group.\nAPI groups derived from API Definition swaggers.\nFor example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.\nCustom groups can be created if user tags paths or operations with \"x-F5 Distributed Cloud-API-group\" extensions inside swaggers.",
|
|
11918
12477
|
"title": "Api_group",
|
|
11919
12478
|
"x-f5xc-example": "oas-all-operations",
|
|
12479
|
+
"x-f5xc-description-short": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group.",
|
|
12480
|
+
"x-f5xc-description-medium": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group. API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.",
|
|
11920
12481
|
"minLength": 0,
|
|
11921
12482
|
"maxLength": 1024,
|
|
11922
12483
|
"x-f5xc-required-for": {
|
|
@@ -11931,6 +12492,8 @@
|
|
|
11931
12492
|
"description": "X-displayName: \"Base Path\"\nThe rule is applied only for the requests matching the specified base path.",
|
|
11932
12493
|
"title": "Base path",
|
|
11933
12494
|
"x-f5xc-example": "/v1",
|
|
12495
|
+
"x-f5xc-description-short": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
|
|
12496
|
+
"x-f5xc-description-medium": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
|
|
11934
12497
|
"minLength": 0,
|
|
11935
12498
|
"maxLength": 1024,
|
|
11936
12499
|
"x-f5xc-required-for": {
|
|
@@ -11954,6 +12517,7 @@
|
|
|
11954
12517
|
"description": "X-displayName: \"Specific Domain\"\nThe rule will apply for a specific domain.\nFor example: api.example.com.",
|
|
11955
12518
|
"title": "Domain",
|
|
11956
12519
|
"x-f5xc-example": "api.example.com",
|
|
12520
|
+
"x-f5xc-description-short": "X-displayName: \"Specific Domain\" The rule will apply for a specific domain. For",
|
|
11957
12521
|
"minLength": 0,
|
|
11958
12522
|
"maxLength": 1024,
|
|
11959
12523
|
"x-f5xc-required-for": {
|
|
@@ -11967,6 +12531,8 @@
|
|
|
11967
12531
|
"$ref": "#/components/schemas/app_typeValuePattern"
|
|
11968
12532
|
}
|
|
11969
12533
|
},
|
|
12534
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
|
|
12535
|
+
"x-f5xc-description-medium": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
|
|
11970
12536
|
"x-f5xc-minimum-configuration": {
|
|
11971
12537
|
"description": "Minimum configuration for app_typeCustomDataDetectionConfig",
|
|
11972
12538
|
"required_fields": [
|
|
@@ -12003,6 +12569,7 @@
|
|
|
12003
12569
|
"items": {
|
|
12004
12570
|
"$ref": "#/components/schemas/schemaHttpSections"
|
|
12005
12571
|
},
|
|
12572
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sections\" x-required Request & Response Sections.",
|
|
12006
12573
|
"x-f5xc-required-for": {
|
|
12007
12574
|
"minimum_config": false,
|
|
12008
12575
|
"create": false,
|
|
@@ -12011,6 +12578,7 @@
|
|
|
12011
12578
|
}
|
|
12012
12579
|
}
|
|
12013
12580
|
},
|
|
12581
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sections\" Request & Response Sections.",
|
|
12014
12582
|
"x-f5xc-minimum-configuration": {
|
|
12015
12583
|
"description": "Minimum configuration for app_typeCustomSections",
|
|
12016
12584
|
"required_fields": [
|
|
@@ -12038,6 +12606,7 @@
|
|
|
12038
12606
|
"$ref": "#/components/schemas/app_typeCustomSensitiveDataType"
|
|
12039
12607
|
}
|
|
12040
12608
|
},
|
|
12609
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Detection Rule\" Custom Sensitive Data Rule Definition.",
|
|
12041
12610
|
"x-f5xc-minimum-configuration": {
|
|
12042
12611
|
"description": "Minimum configuration for app_typeCustomSensitiveDataDetectionRule",
|
|
12043
12612
|
"required_fields": [
|
|
@@ -12063,6 +12632,7 @@
|
|
|
12063
12632
|
"title": "Sensitive data type.",
|
|
12064
12633
|
"x-f5xc-example": "EMAIL",
|
|
12065
12634
|
"x-required": true,
|
|
12635
|
+
"x-f5xc-description-short": "X-displayName: \"Type\" The request is labeled as specified sensitive data type.",
|
|
12066
12636
|
"minLength": 0,
|
|
12067
12637
|
"maxLength": 1024,
|
|
12068
12638
|
"x-f5xc-required-for": {
|
|
@@ -12073,6 +12643,8 @@
|
|
|
12073
12643
|
}
|
|
12074
12644
|
}
|
|
12075
12645
|
},
|
|
12646
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects.",
|
|
12647
|
+
"x-f5xc-description-medium": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects. E.g. Email, Credit Card etc.",
|
|
12076
12648
|
"x-f5xc-minimum-configuration": {
|
|
12077
12649
|
"description": "Minimum configuration for app_typeCustomSensitiveDataType",
|
|
12078
12650
|
"required_fields": [
|
|
@@ -12108,6 +12680,7 @@
|
|
|
12108
12680
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
12109
12681
|
"ves.io.schema.rules.uint32.lte": "7"
|
|
12110
12682
|
},
|
|
12683
|
+
"x-f5xc-description-short": "Inactive discovered API will be deleted after configured duration.",
|
|
12111
12684
|
"minimum": 0,
|
|
12112
12685
|
"maximum": 2147483647,
|
|
12113
12686
|
"x-f5xc-required-for": {
|
|
@@ -12141,6 +12714,7 @@
|
|
|
12141
12714
|
"description": "X-displayName: \"Exact Value\"\nSearch for values with exact match.",
|
|
12142
12715
|
"title": "Exact value.",
|
|
12143
12716
|
"x-f5xc-example": "x-volt-header",
|
|
12717
|
+
"x-f5xc-description-short": "X-displayName: \"Exact Value\" Search for values with exact match.",
|
|
12144
12718
|
"minLength": 0,
|
|
12145
12719
|
"maxLength": 1024,
|
|
12146
12720
|
"x-f5xc-required-for": {
|
|
@@ -12155,6 +12729,7 @@
|
|
|
12155
12729
|
"description": "X-displayName: \"Regex Value\"\nSearch for values matching this regular expression.",
|
|
12156
12730
|
"title": "Regex value.",
|
|
12157
12731
|
"x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
|
|
12732
|
+
"x-f5xc-description-short": "X-displayName: \"Regex Value\" Search for values matching this regular expression.",
|
|
12158
12733
|
"minLength": 0,
|
|
12159
12734
|
"maxLength": 1024,
|
|
12160
12735
|
"x-f5xc-required-for": {
|
|
@@ -12165,6 +12740,7 @@
|
|
|
12165
12740
|
}
|
|
12166
12741
|
}
|
|
12167
12742
|
},
|
|
12743
|
+
"x-f5xc-description-short": "X-displayName: \"Key Pattern\" Pattern to detect. Could be exact match or regex match.",
|
|
12168
12744
|
"x-f5xc-minimum-configuration": {
|
|
12169
12745
|
"description": "Minimum configuration for app_typeKeyPattern",
|
|
12170
12746
|
"required_fields": [
|
|
@@ -12190,6 +12766,8 @@
|
|
|
12190
12766
|
"$ref": "#/components/schemas/app_typeValuePattern"
|
|
12191
12767
|
}
|
|
12192
12768
|
},
|
|
12769
|
+
"x-f5xc-description-short": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
|
|
12770
|
+
"x-f5xc-description-medium": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
|
|
12193
12771
|
"x-f5xc-minimum-configuration": {
|
|
12194
12772
|
"description": "Minimum configuration for app_typeKeyValuePattern",
|
|
12195
12773
|
"required_fields": [
|
|
@@ -12215,6 +12793,9 @@
|
|
|
12215
12793
|
"items": {
|
|
12216
12794
|
"$ref": "#/components/schemas/app_typeCustomSensitiveDataDetectionRule"
|
|
12217
12795
|
},
|
|
12796
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12797
|
+
"x-f5xc-description-short": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
|
|
12798
|
+
"x-f5xc-description-medium": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
|
|
12218
12799
|
"x-f5xc-required-for": {
|
|
12219
12800
|
"minimum_config": false,
|
|
12220
12801
|
"create": false,
|
|
@@ -12230,6 +12811,8 @@
|
|
|
12230
12811
|
"$ref": "#/components/schemas/app_typeBuiltInSensitiveDataType"
|
|
12231
12812
|
},
|
|
12232
12813
|
"x-f5xc-example": "[EMAIL, CC]",
|
|
12814
|
+
"x-f5xc-description-short": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
|
|
12815
|
+
"x-f5xc-description-medium": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
|
|
12233
12816
|
"x-f5xc-required-for": {
|
|
12234
12817
|
"minimum_config": false,
|
|
12235
12818
|
"create": false,
|
|
@@ -12238,6 +12821,8 @@
|
|
|
12238
12821
|
}
|
|
12239
12822
|
}
|
|
12240
12823
|
},
|
|
12824
|
+
"x-f5xc-description-short": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
|
|
12825
|
+
"x-f5xc-description-medium": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
|
|
12241
12826
|
"x-f5xc-minimum-configuration": {
|
|
12242
12827
|
"description": "Minimum configuration for app_typeSensitiveDataDetectionRules",
|
|
12243
12828
|
"required_fields": [
|
|
@@ -12261,6 +12846,7 @@
|
|
|
12261
12846
|
"description": "X-displayName: \"Exact Value\"\nPattern value to be detected.",
|
|
12262
12847
|
"title": "Exact value.",
|
|
12263
12848
|
"x-f5xc-example": "x-volt-header",
|
|
12849
|
+
"x-f5xc-description-short": "X-displayName: \"Exact Value\" Pattern value to be detected.",
|
|
12264
12850
|
"minLength": 0,
|
|
12265
12851
|
"maxLength": 1024,
|
|
12266
12852
|
"x-f5xc-required-for": {
|
|
@@ -12275,6 +12861,7 @@
|
|
|
12275
12861
|
"description": "X-displayName: \"Regex Value\"\nRegular expression for this pattern.",
|
|
12276
12862
|
"title": "Regex value.",
|
|
12277
12863
|
"x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
|
|
12864
|
+
"x-f5xc-description-short": "X-displayName: \"Regex Value\" Regular expression for this pattern.",
|
|
12278
12865
|
"minLength": 0,
|
|
12279
12866
|
"maxLength": 1024,
|
|
12280
12867
|
"x-f5xc-required-for": {
|
|
@@ -12285,6 +12872,7 @@
|
|
|
12285
12872
|
}
|
|
12286
12873
|
}
|
|
12287
12874
|
},
|
|
12875
|
+
"x-f5xc-description-short": "X-displayName: \"Value Pattern\" Pattern to detect. Could be exact match or regex match.",
|
|
12288
12876
|
"x-f5xc-minimum-configuration": {
|
|
12289
12877
|
"description": "Minimum configuration for app_typeValuePattern",
|
|
12290
12878
|
"required_fields": [
|
|
@@ -12362,6 +12950,8 @@
|
|
|
12362
12950
|
"BLOCKING"
|
|
12363
12951
|
],
|
|
12364
12952
|
"default": "NONE",
|
|
12953
|
+
"x-f5xc-description-short": "BigIpVirtualServerAWAFEnforcementMode could be of type NONE, ALARM or BLOCKING.",
|
|
12954
|
+
"x-f5xc-description-medium": "BigIpVirtualServerAWAFEnforcementMode could be of type NONE, ALARM or BLOCKING. X-displayName: \"BIG-IP AWAF Enforcement Mode\" Specifies the Virtual Server AWAF enforcement mode - NONE: x-displayName: \"None\" No AWAF Policy attached - MONITORING: x-displayName: \"Monitoring\" AWAF Enforcement...",
|
|
12365
12955
|
"x-f5xc-minimum-configuration": {
|
|
12366
12956
|
"description": "Minimum configuration for bigip_virtual_serverBigIpVirtualServerAWAFEnforcementMode",
|
|
12367
12957
|
"required_fields": [],
|
|
@@ -12382,6 +12972,8 @@
|
|
|
12382
12972
|
"default": "INVALID_VIRTUAL_SERVER",
|
|
12383
12973
|
"x-displayname": "Virtual Server Type.",
|
|
12384
12974
|
"x-ves-proto-enum": "ves.io.schema.views.bigip_virtual_server.BigIpVirtualServerType",
|
|
12975
|
+
"x-f5xc-description-short": "VirtualServerType could be of type classic BIG-IP or BIG-IP-NEXT. BIG-IP-NEXT will be added later.",
|
|
12976
|
+
"x-f5xc-description-medium": "VirtualServerType could be of type classic BIG-IP or BIG-IP-NEXT. BIG-IP-NEXT will be added later. Specifies the virtual server type Invalid Virtual Server Type Classic BIG-IP Virtual Server.",
|
|
12385
12977
|
"x-f5xc-minimum-configuration": {
|
|
12386
12978
|
"description": "Minimum configuration for bigip_virtual_serverBigIpVirtualServerType",
|
|
12387
12979
|
"required_fields": [],
|
|
@@ -12407,6 +12999,7 @@
|
|
|
12407
12999
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12408
13000
|
},
|
|
12409
13001
|
"x-displayname": "Deleted Referred Objects.",
|
|
13002
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
12410
13003
|
"x-f5xc-required-for": {
|
|
12411
13004
|
"minimum_config": false,
|
|
12412
13005
|
"create": false,
|
|
@@ -12422,6 +13015,7 @@
|
|
|
12422
13015
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12423
13016
|
},
|
|
12424
13017
|
"x-displayname": "Disabled Referred Objects.",
|
|
13018
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
12425
13019
|
"x-f5xc-required-for": {
|
|
12426
13020
|
"minimum_config": false,
|
|
12427
13021
|
"create": false,
|
|
@@ -12440,6 +13034,7 @@
|
|
|
12440
13034
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12441
13035
|
},
|
|
12442
13036
|
"x-displayname": "Referring Objects.",
|
|
13037
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
12443
13038
|
"x-f5xc-required-for": {
|
|
12444
13039
|
"minimum_config": false,
|
|
12445
13040
|
"create": false,
|
|
@@ -12461,6 +13056,8 @@
|
|
|
12461
13056
|
"$ref": "#/components/schemas/bigip_virtual_serverStatusObject"
|
|
12462
13057
|
},
|
|
12463
13058
|
"x-displayname": "Status",
|
|
13059
|
+
"x-f5xc-example": "active",
|
|
13060
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
12464
13061
|
"x-f5xc-required-for": {
|
|
12465
13062
|
"minimum_config": false,
|
|
12466
13063
|
"create": false,
|
|
@@ -12470,7 +13067,7 @@
|
|
|
12470
13067
|
"maxLength": 17,
|
|
12471
13068
|
"minLength": 17,
|
|
12472
13069
|
"x-reconciled-from-discovery": true,
|
|
12473
|
-
"x-reconciled-at": "2026-01-
|
|
13070
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731802+00:00"
|
|
12474
13071
|
},
|
|
12475
13072
|
"system_metadata": {
|
|
12476
13073
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -12508,6 +13105,8 @@
|
|
|
12508
13105
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
12509
13106
|
],
|
|
12510
13107
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
13108
|
+
"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...",
|
|
13109
|
+
"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_REPLACE: x-displayName: \"Replace request format\" Response should...",
|
|
12511
13110
|
"x-f5xc-minimum-configuration": {
|
|
12512
13111
|
"description": "Minimum configuration for bigip_virtual_serverGetResponseFormatCode",
|
|
12513
13112
|
"required_fields": [],
|
|
@@ -12546,6 +13145,7 @@
|
|
|
12546
13145
|
"x-validation-rules": {
|
|
12547
13146
|
"ves.io.schema.rules.message.required": "true"
|
|
12548
13147
|
},
|
|
13148
|
+
"x-f5xc-description-short": "Namespace of the BIG-IP Load Balancer for current request Required: YES.",
|
|
12549
13149
|
"minLength": 0,
|
|
12550
13150
|
"maxLength": 6,
|
|
12551
13151
|
"x-f5xc-required-for": {
|
|
@@ -12556,9 +13156,10 @@
|
|
|
12556
13156
|
},
|
|
12557
13157
|
"x-original-maxLength": 1024,
|
|
12558
13158
|
"x-reconciled-from-discovery": true,
|
|
12559
|
-
"x-reconciled-at": "2026-01-
|
|
13159
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731812+00:00"
|
|
12560
13160
|
}
|
|
12561
13161
|
},
|
|
13162
|
+
"x-f5xc-description-short": "Request of GET Security Config Spec API.",
|
|
12562
13163
|
"x-f5xc-minimum-configuration": {
|
|
12563
13164
|
"description": "Minimum configuration for bigip_virtual_serverGetSecurityConfigReq",
|
|
12564
13165
|
"required_fields": [
|
|
@@ -12588,6 +13189,7 @@
|
|
|
12588
13189
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
12589
13190
|
},
|
|
12590
13191
|
"x-displayname": "Errors",
|
|
13192
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
12591
13193
|
"x-f5xc-required-for": {
|
|
12592
13194
|
"minimum_config": false,
|
|
12593
13195
|
"create": false,
|
|
@@ -12603,6 +13205,8 @@
|
|
|
12603
13205
|
"$ref": "#/components/schemas/bigip_virtual_serverListResponseItem"
|
|
12604
13206
|
},
|
|
12605
13207
|
"x-displayname": "Items",
|
|
13208
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
13209
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
12606
13210
|
"x-f5xc-required-for": {
|
|
12607
13211
|
"minimum_config": false,
|
|
12608
13212
|
"create": false,
|
|
@@ -12636,6 +13240,8 @@
|
|
|
12636
13240
|
"description": "The set of annotations present on this bigip_virtual_server.",
|
|
12637
13241
|
"title": "Annotations.",
|
|
12638
13242
|
"x-displayname": "Annotations.",
|
|
13243
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13244
|
+
"x-f5xc-description-short": "The set of annotations present on this bigip_virtual_server.",
|
|
12639
13245
|
"x-f5xc-required-for": {
|
|
12640
13246
|
"minimum_config": false,
|
|
12641
13247
|
"create": false,
|
|
@@ -12648,6 +13254,7 @@
|
|
|
12648
13254
|
"description": "The description set for this bigip_virtual_server.",
|
|
12649
13255
|
"title": "Description.",
|
|
12650
13256
|
"x-displayname": "Description.",
|
|
13257
|
+
"x-f5xc-description-short": "The description set for this bigip_virtual_server.",
|
|
12651
13258
|
"minLength": 0,
|
|
12652
13259
|
"maxLength": 0,
|
|
12653
13260
|
"x-f5xc-required-for": {
|
|
@@ -12658,7 +13265,7 @@
|
|
|
12658
13265
|
},
|
|
12659
13266
|
"x-original-maxLength": 1024,
|
|
12660
13267
|
"x-reconciled-from-discovery": true,
|
|
12661
|
-
"x-reconciled-at": "2026-01-
|
|
13268
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731824+00:00"
|
|
12662
13269
|
},
|
|
12663
13270
|
"disabled": {
|
|
12664
13271
|
"type": "boolean",
|
|
@@ -12666,6 +13273,8 @@
|
|
|
12666
13273
|
"title": "Disabled",
|
|
12667
13274
|
"format": "boolean",
|
|
12668
13275
|
"x-displayname": "Disabled",
|
|
13276
|
+
"x-f5xc-example": "True",
|
|
13277
|
+
"x-f5xc-description-short": "Value of true indicates bigip_virtual_server is administratively disabled.",
|
|
12669
13278
|
"x-f5xc-required-for": {
|
|
12670
13279
|
"minimum_config": false,
|
|
12671
13280
|
"create": false,
|
|
@@ -12681,6 +13290,8 @@
|
|
|
12681
13290
|
"description": "The set of labels present on this bigip_virtual_server.",
|
|
12682
13291
|
"title": "Labels",
|
|
12683
13292
|
"x-displayname": "Labels",
|
|
13293
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13294
|
+
"x-f5xc-description-short": "The set of labels present on this bigip_virtual_server.",
|
|
12684
13295
|
"x-f5xc-required-for": {
|
|
12685
13296
|
"minimum_config": false,
|
|
12686
13297
|
"create": false,
|
|
@@ -12708,7 +13319,7 @@
|
|
|
12708
13319
|
},
|
|
12709
13320
|
"x-original-maxLength": 1024,
|
|
12710
13321
|
"x-reconciled-from-discovery": true,
|
|
12711
|
-
"x-reconciled-at": "2026-01-
|
|
13322
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731834+00:00"
|
|
12712
13323
|
},
|
|
12713
13324
|
"namespace": {
|
|
12714
13325
|
"type": "string",
|
|
@@ -12727,7 +13338,7 @@
|
|
|
12727
13338
|
},
|
|
12728
13339
|
"x-original-maxLength": 1024,
|
|
12729
13340
|
"x-reconciled-from-discovery": true,
|
|
12730
|
-
"x-reconciled-at": "2026-01-
|
|
13341
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731838+00:00"
|
|
12731
13342
|
},
|
|
12732
13343
|
"owner_view": {
|
|
12733
13344
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -12740,6 +13351,7 @@
|
|
|
12740
13351
|
"$ref": "#/components/schemas/bigip_virtual_serverStatusObject"
|
|
12741
13352
|
},
|
|
12742
13353
|
"x-displayname": "Status",
|
|
13354
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
12743
13355
|
"x-f5xc-required-for": {
|
|
12744
13356
|
"minimum_config": false,
|
|
12745
13357
|
"create": false,
|
|
@@ -12768,7 +13380,7 @@
|
|
|
12768
13380
|
"x-field-mutability": "read-only",
|
|
12769
13381
|
"x-original-maxLength": 1024,
|
|
12770
13382
|
"x-reconciled-from-discovery": true,
|
|
12771
|
-
"x-reconciled-at": "2026-01-
|
|
13383
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731847+00:00"
|
|
12772
13384
|
},
|
|
12773
13385
|
"uid": {
|
|
12774
13386
|
"type": "string",
|
|
@@ -12777,6 +13389,7 @@
|
|
|
12777
13389
|
"x-displayname": "UID",
|
|
12778
13390
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
12779
13391
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
13392
|
+
"x-f5xc-description-short": "The unique uid of this bigip_virtual_server.",
|
|
12780
13393
|
"minLength": 0,
|
|
12781
13394
|
"maxLength": 36,
|
|
12782
13395
|
"x-f5xc-required-for": {
|
|
@@ -12789,9 +13402,11 @@
|
|
|
12789
13402
|
"x-original-maxLength": 1024,
|
|
12790
13403
|
"format": "uuid",
|
|
12791
13404
|
"x-reconciled-from-discovery": true,
|
|
12792
|
-
"x-reconciled-at": "2026-01-
|
|
13405
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731853+00:00"
|
|
12793
13406
|
}
|
|
12794
13407
|
},
|
|
13408
|
+
"x-f5xc-description-short": "By default a summary of bigip_virtual_server is returned in 'List'.",
|
|
13409
|
+
"x-f5xc-description-medium": "By default a summary of bigip_virtual_server is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
12795
13410
|
"x-f5xc-minimum-configuration": {
|
|
12796
13411
|
"description": "Minimum configuration for bigip_virtual_serverListResponseItem",
|
|
12797
13412
|
"required_fields": [
|
|
@@ -12871,6 +13486,7 @@
|
|
|
12871
13486
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
12872
13487
|
},
|
|
12873
13488
|
"x-displayname": "Conditions.",
|
|
13489
|
+
"x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
|
|
12874
13490
|
"x-f5xc-required-for": {
|
|
12875
13491
|
"minimum_config": false,
|
|
12876
13492
|
"create": false,
|
|
@@ -12889,6 +13505,7 @@
|
|
|
12889
13505
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12890
13506
|
},
|
|
12891
13507
|
"x-displayname": "Config Object.",
|
|
13508
|
+
"x-f5xc-description-short": "BIG-IP virtual_server view object direct reference.",
|
|
12892
13509
|
"x-f5xc-required-for": {
|
|
12893
13510
|
"minimum_config": false,
|
|
12894
13511
|
"create": false,
|
|
@@ -12897,6 +13514,7 @@
|
|
|
12897
13514
|
}
|
|
12898
13515
|
}
|
|
12899
13516
|
},
|
|
13517
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
12900
13518
|
"x-f5xc-minimum-configuration": {
|
|
12901
13519
|
"description": "Minimum configuration for bigip_virtual_serverStatusObject",
|
|
12902
13520
|
"required_fields": [
|
|
@@ -12924,6 +13542,7 @@
|
|
|
12924
13542
|
"type": "string"
|
|
12925
13543
|
},
|
|
12926
13544
|
"x-displayname": "API Protection Configured.",
|
|
13545
|
+
"description": "API version or group",
|
|
12927
13546
|
"x-f5xc-required-for": {
|
|
12928
13547
|
"minimum_config": false,
|
|
12929
13548
|
"create": false,
|
|
@@ -12938,6 +13557,8 @@
|
|
|
12938
13557
|
"type": "string"
|
|
12939
13558
|
},
|
|
12940
13559
|
"x-displayname": "App Firewall Configured.",
|
|
13560
|
+
"description": "Configuration parameter for app firewall",
|
|
13561
|
+
"x-f5xc-description-short": "Configuration parameter for app firewall.",
|
|
12941
13562
|
"x-f5xc-required-for": {
|
|
12942
13563
|
"minimum_config": false,
|
|
12943
13564
|
"create": false,
|
|
@@ -12952,6 +13573,8 @@
|
|
|
12952
13573
|
"type": "string"
|
|
12953
13574
|
},
|
|
12954
13575
|
"x-displayname": "List of Load Balancers Where App Firewall is Configured Per Route.",
|
|
13576
|
+
"description": "Configuration parameter for app firewall per route",
|
|
13577
|
+
"x-f5xc-description-short": "Configuration parameter for app firewall per route.",
|
|
12955
13578
|
"x-f5xc-required-for": {
|
|
12956
13579
|
"minimum_config": false,
|
|
12957
13580
|
"create": false,
|
|
@@ -12966,6 +13589,8 @@
|
|
|
12966
13589
|
"type": "string"
|
|
12967
13590
|
},
|
|
12968
13591
|
"x-displayname": "Bot Defense Configured.",
|
|
13592
|
+
"description": "Configuration parameter for bot defense",
|
|
13593
|
+
"x-f5xc-description-short": "Configuration parameter for bot defense.",
|
|
12969
13594
|
"x-f5xc-required-for": {
|
|
12970
13595
|
"minimum_config": false,
|
|
12971
13596
|
"create": false,
|
|
@@ -12980,6 +13605,8 @@
|
|
|
12980
13605
|
"type": "string"
|
|
12981
13606
|
},
|
|
12982
13607
|
"x-displayname": "DDoS Detection Configured.",
|
|
13608
|
+
"description": "Configuration parameter for ddos detection",
|
|
13609
|
+
"x-f5xc-description-short": "Configuration parameter for ddos detection.",
|
|
12983
13610
|
"x-f5xc-required-for": {
|
|
12984
13611
|
"minimum_config": false,
|
|
12985
13612
|
"create": false,
|
|
@@ -12994,6 +13621,8 @@
|
|
|
12994
13621
|
"type": "string"
|
|
12995
13622
|
},
|
|
12996
13623
|
"x-displayname": "List of Load Balancers Secured.",
|
|
13624
|
+
"description": "Protection or security configuration",
|
|
13625
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12997
13626
|
"x-f5xc-required-for": {
|
|
12998
13627
|
"minimum_config": false,
|
|
12999
13628
|
"create": false,
|
|
@@ -13063,6 +13692,7 @@
|
|
|
13063
13692
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13064
13693
|
}
|
|
13065
13694
|
},
|
|
13695
|
+
"x-f5xc-description-short": "Settings for API specification (API definition, OpenAPI validation, etc.).",
|
|
13066
13696
|
"x-f5xc-minimum-configuration": {
|
|
13067
13697
|
"description": "Minimum configuration for common_wafAPISpecificationSettings",
|
|
13068
13698
|
"required_fields": [
|
|
@@ -13103,6 +13733,7 @@
|
|
|
13103
13733
|
"ves.io.schema.rules.message.required": "true",
|
|
13104
13734
|
"ves.io.schema.rules.string.max_len": "256"
|
|
13105
13735
|
},
|
|
13736
|
+
"x-f5xc-description-short": "Code repository which contain API endpoints Required: YES.",
|
|
13106
13737
|
"x-f5xc-required-for": {
|
|
13107
13738
|
"minimum_config": false,
|
|
13108
13739
|
"create": false,
|
|
@@ -13111,6 +13742,7 @@
|
|
|
13111
13742
|
}
|
|
13112
13743
|
}
|
|
13113
13744
|
},
|
|
13745
|
+
"x-f5xc-description-short": "Select which API repositories represent the LB applications.",
|
|
13114
13746
|
"x-f5xc-minimum-configuration": {
|
|
13115
13747
|
"description": "Minimum configuration for common_wafApiCodeRepos",
|
|
13116
13748
|
"required_fields": [
|
|
@@ -13175,6 +13807,8 @@
|
|
|
13175
13807
|
"ves.io.schema.rules.message.required": "true",
|
|
13176
13808
|
"ves.io.schema.rules.repeated.max_items": "32"
|
|
13177
13809
|
},
|
|
13810
|
+
"x-f5xc-description-short": "Enter domains and their credentials to allow authenticated API crawling.",
|
|
13811
|
+
"x-f5xc-description-medium": "Enter domains and their credentials to allow authenticated API crawling. You can only include domains you own that are associated with this Load Balancer. Required: YES.",
|
|
13178
13812
|
"x-f5xc-required-for": {
|
|
13179
13813
|
"minimum_config": false,
|
|
13180
13814
|
"create": false,
|
|
@@ -13298,6 +13932,7 @@
|
|
|
13298
13932
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13299
13933
|
}
|
|
13300
13934
|
},
|
|
13935
|
+
"x-f5xc-description-short": "Specifies the settings used for API discovery.",
|
|
13301
13936
|
"x-f5xc-minimum-configuration": {
|
|
13302
13937
|
"description": "Minimum configuration for common_wafApiDiscoverySetting",
|
|
13303
13938
|
"required_fields": [
|
|
@@ -13450,6 +14085,7 @@
|
|
|
13450
14085
|
"ves.io.schema.rules.repeated.max_items": "15",
|
|
13451
14086
|
"ves.io.schema.rules.repeated.unique_metadata_name": "true"
|
|
13452
14087
|
},
|
|
14088
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13453
14089
|
"x-f5xc-required-for": {
|
|
13454
14090
|
"minimum_config": false,
|
|
13455
14091
|
"create": false,
|
|
@@ -13494,6 +14130,8 @@
|
|
|
13494
14130
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13495
14131
|
"ves.io.schema.rules.string.vh_domain": "true"
|
|
13496
14132
|
},
|
|
14133
|
+
"x-f5xc-example": "example.com",
|
|
14134
|
+
"x-f5xc-description-short": "Select the domain to execute API Crawling with given credentials. Required: YES.",
|
|
13497
14135
|
"minLength": 0,
|
|
13498
14136
|
"x-f5xc-required-for": {
|
|
13499
14137
|
"minimum_config": false,
|
|
@@ -13504,7 +14142,7 @@
|
|
|
13504
14142
|
"x-original-maxLength": 256,
|
|
13505
14143
|
"format": "hostname",
|
|
13506
14144
|
"x-reconciled-from-discovery": true,
|
|
13507
|
-
"x-reconciled-at": "2026-01-
|
|
14145
|
+
"x-reconciled-at": "2026-01-07T15:27:58.731911+00:00"
|
|
13508
14146
|
},
|
|
13509
14147
|
"simple_login": {
|
|
13510
14148
|
"$ref": "#/components/schemas/common_wafSimpleLogin"
|
|
@@ -13558,6 +14196,7 @@
|
|
|
13558
14196
|
"x-validation-rules": {
|
|
13559
14197
|
"ves.io.schema.rules.string.max_len": "128"
|
|
13560
14198
|
},
|
|
14199
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
|
|
13561
14200
|
"minLength": 0,
|
|
13562
14201
|
"x-f5xc-required-for": {
|
|
13563
14202
|
"minimum_config": false,
|
|
@@ -13582,6 +14221,7 @@
|
|
|
13582
14221
|
"ves.io.schema.rules.string.http_path": "true",
|
|
13583
14222
|
"ves.io.schema.rules.string.max_len": "128"
|
|
13584
14223
|
},
|
|
14224
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
|
|
13585
14225
|
"minLength": 0,
|
|
13586
14226
|
"x-f5xc-required-for": {
|
|
13587
14227
|
"minimum_config": false,
|
|
@@ -13594,6 +14234,7 @@
|
|
|
13594
14234
|
"$ref": "#/components/schemas/schemaMessageMetaType"
|
|
13595
14235
|
}
|
|
13596
14236
|
},
|
|
14237
|
+
"x-f5xc-description-short": "Fall Through Rule for a specific endpoint, base-path, or API group.",
|
|
13597
14238
|
"x-f5xc-minimum-configuration": {
|
|
13598
14239
|
"description": "Minimum configuration for common_wafFallThroughRule",
|
|
13599
14240
|
"required_fields": [
|
|
@@ -13628,6 +14269,8 @@
|
|
|
13628
14269
|
}
|
|
13629
14270
|
},
|
|
13630
14271
|
"x-required": true,
|
|
14272
|
+
"x-f5xc-description-short": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a.",
|
|
14273
|
+
"x-f5xc-description-medium": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn't have a specific rule in custom rules).",
|
|
13631
14274
|
"x-f5xc-minimum-configuration": {
|
|
13632
14275
|
"description": "Minimum configuration for common_wafOpenApiFallThroughMode",
|
|
13633
14276
|
"required_fields": [
|
|
@@ -13696,6 +14339,8 @@
|
|
|
13696
14339
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13697
14340
|
}
|
|
13698
14341
|
},
|
|
14342
|
+
"x-f5xc-description-short": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
|
|
14343
|
+
"x-f5xc-description-medium": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
|
|
13699
14344
|
"x-f5xc-minimum-configuration": {
|
|
13700
14345
|
"description": "Minimum configuration for common_wafOpenApiValidationCommonSettings",
|
|
13701
14346
|
"required_fields": [
|
|
@@ -13734,6 +14379,8 @@
|
|
|
13734
14379
|
}
|
|
13735
14380
|
},
|
|
13736
14381
|
"x-required": true,
|
|
14382
|
+
"x-f5xc-description-short": "Validation mode of OpenAPI specification.",
|
|
14383
|
+
"x-f5xc-description-medium": "Validation mode of OpenAPI specification. When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. Swagger).",
|
|
13737
14384
|
"x-f5xc-minimum-configuration": {
|
|
13738
14385
|
"description": "Minimum configuration for common_wafOpenApiValidationMode",
|
|
13739
14386
|
"required_fields": [
|
|
@@ -13787,6 +14434,8 @@
|
|
|
13787
14434
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
13788
14435
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
13789
14436
|
},
|
|
14437
|
+
"x-f5xc-description-short": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a.",
|
|
14438
|
+
"x-f5xc-description-medium": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
|
|
13790
14439
|
"x-f5xc-required-for": {
|
|
13791
14440
|
"minimum_config": false,
|
|
13792
14441
|
"create": false,
|
|
@@ -13847,6 +14496,8 @@
|
|
|
13847
14496
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
13848
14497
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
13849
14498
|
},
|
|
14499
|
+
"x-f5xc-description-short": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a.",
|
|
14500
|
+
"x-f5xc-description-medium": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
|
|
13850
14501
|
"x-f5xc-required-for": {
|
|
13851
14502
|
"minimum_config": false,
|
|
13852
14503
|
"create": false,
|
|
@@ -13898,6 +14549,7 @@
|
|
|
13898
14549
|
"x-validation-rules": {
|
|
13899
14550
|
"ves.io.schema.rules.string.max_len": "128"
|
|
13900
14551
|
},
|
|
14552
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
|
|
13901
14553
|
"minLength": 0,
|
|
13902
14554
|
"x-f5xc-required-for": {
|
|
13903
14555
|
"minimum_config": false,
|
|
@@ -13922,6 +14574,7 @@
|
|
|
13922
14574
|
"ves.io.schema.rules.string.http_path": "true",
|
|
13923
14575
|
"ves.io.schema.rules.string.max_len": "128"
|
|
13924
14576
|
},
|
|
14577
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
|
|
13925
14578
|
"minLength": 0,
|
|
13926
14579
|
"x-f5xc-required-for": {
|
|
13927
14580
|
"minimum_config": false,
|
|
@@ -13947,6 +14600,7 @@
|
|
|
13947
14600
|
"ves.io.schema.rules.string.max_len": "128",
|
|
13948
14601
|
"ves.io.schema.rules.string.vh_domain": "true"
|
|
13949
14602
|
},
|
|
14603
|
+
"x-f5xc-description-short": "Exclusive with [any_domain] The rule will apply for a specific domain.",
|
|
13950
14604
|
"minLength": 0,
|
|
13951
14605
|
"x-f5xc-required-for": {
|
|
13952
14606
|
"minimum_config": false,
|
|
@@ -13959,6 +14613,7 @@
|
|
|
13959
14613
|
"$ref": "#/components/schemas/common_wafOpenApiValidationMode"
|
|
13960
14614
|
}
|
|
13961
14615
|
},
|
|
14616
|
+
"x-f5xc-description-short": "OpenAPI Validation Rule for a specific endpoint, base-path, or API group.",
|
|
13962
14617
|
"x-f5xc-minimum-configuration": {
|
|
13963
14618
|
"description": "Minimum configuration for common_wafOpenApiValidationRule",
|
|
13964
14619
|
"required_fields": [
|
|
@@ -13998,6 +14653,7 @@
|
|
|
13998
14653
|
"x-validation-rules": {
|
|
13999
14654
|
"ves.io.schema.rules.string.max_len": "64"
|
|
14000
14655
|
},
|
|
14656
|
+
"x-f5xc-description-short": "Enter the username to assign credentials for the selected domain to crawl.",
|
|
14001
14657
|
"minLength": 0,
|
|
14002
14658
|
"x-f5xc-required-for": {
|
|
14003
14659
|
"minimum_config": false,
|
|
@@ -14051,6 +14707,7 @@
|
|
|
14051
14707
|
"ves.io.schema.rules.repeated.max_items": "15",
|
|
14052
14708
|
"ves.io.schema.rules.repeated.unique_metadata_name": "true"
|
|
14053
14709
|
},
|
|
14710
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
14054
14711
|
"x-f5xc-required-for": {
|
|
14055
14712
|
"minimum_config": false,
|
|
14056
14713
|
"create": false,
|
|
@@ -14062,6 +14719,8 @@
|
|
|
14062
14719
|
"$ref": "#/components/schemas/common_wafOpenApiValidationCommonSettings"
|
|
14063
14720
|
}
|
|
14064
14721
|
},
|
|
14722
|
+
"x-f5xc-description-short": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.",
|
|
14723
|
+
"x-f5xc-description-medium": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to \"Fall Through Mode\".",
|
|
14065
14724
|
"x-f5xc-minimum-configuration": {
|
|
14066
14725
|
"description": "Minimum configuration for common_wafValidateApiBySpecRule",
|
|
14067
14726
|
"required_fields": [
|
|
@@ -14111,6 +14770,7 @@
|
|
|
14111
14770
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
14112
14771
|
}
|
|
14113
14772
|
},
|
|
14773
|
+
"x-f5xc-description-short": "X-displayName: \"Validation Settings For Headers\" Custom settings for headers validation.",
|
|
14114
14774
|
"x-f5xc-minimum-configuration": {
|
|
14115
14775
|
"description": "Minimum configuration for common_wafValidationSettingForHeaders",
|
|
14116
14776
|
"required_fields": [
|
|
@@ -14139,6 +14799,7 @@
|
|
|
14139
14799
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
14140
14800
|
}
|
|
14141
14801
|
},
|
|
14802
|
+
"x-f5xc-description-short": "Custom settings for query parameters validation.",
|
|
14142
14803
|
"x-f5xc-minimum-configuration": {
|
|
14143
14804
|
"description": "Minimum configuration for common_wafValidationSettingForQueryParameters",
|
|
14144
14805
|
"required_fields": [
|
|
@@ -14172,6 +14833,7 @@
|
|
|
14172
14833
|
"default": "ANY",
|
|
14173
14834
|
"x-displayname": "HTTP Method.",
|
|
14174
14835
|
"x-ves-proto-enum": "ves.io.schema.HttpMethod",
|
|
14836
|
+
"x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
|
|
14175
14837
|
"x-f5xc-minimum-configuration": {
|
|
14176
14838
|
"description": "Minimum configuration for schemaHttpMethod",
|
|
14177
14839
|
"required_fields": [],
|
|
@@ -14195,6 +14857,8 @@
|
|
|
14195
14857
|
"HTTP_SECTION_RSP_BODY"
|
|
14196
14858
|
],
|
|
14197
14859
|
"default": "HTTP_SECTION_NONE",
|
|
14860
|
+
"x-f5xc-description-short": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" ...",
|
|
14861
|
+
"x-f5xc-description-medium": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" - HTTP_SECTION_QUERY_PARAMS: QUERY_PARAMS x-displayName: \"Request Query Params\" - HTTP_SECTION_REQ_HEADERS: REQ_HEADERS x-displayName: \"Request Headers\" ...",
|
|
14198
14862
|
"x-f5xc-minimum-configuration": {
|
|
14199
14863
|
"description": "Minimum configuration for schemaHttpSections",
|
|
14200
14864
|
"required_fields": [],
|
|
@@ -14235,7 +14899,7 @@
|
|
|
14235
14899
|
},
|
|
14236
14900
|
"x-original-maxLength": 256,
|
|
14237
14901
|
"x-reconciled-from-discovery": true,
|
|
14238
|
-
"x-reconciled-at": "2026-01-
|
|
14902
|
+
"x-reconciled-at": "2026-01-07T15:27:58.732045+00:00"
|
|
14239
14903
|
},
|
|
14240
14904
|
"name": {
|
|
14241
14905
|
"type": "string",
|
|
@@ -14256,6 +14920,7 @@
|
|
|
14256
14920
|
"ves.io.schema.rules.string.min_len": "1",
|
|
14257
14921
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
14258
14922
|
},
|
|
14923
|
+
"x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.",
|
|
14259
14924
|
"maxLength": 16,
|
|
14260
14925
|
"x-f5xc-required-for": {
|
|
14261
14926
|
"minimum_config": false,
|
|
@@ -14265,9 +14930,11 @@
|
|
|
14265
14930
|
},
|
|
14266
14931
|
"x-original-maxLength": 1024,
|
|
14267
14932
|
"x-reconciled-from-discovery": true,
|
|
14268
|
-
"x-reconciled-at": "2026-01-
|
|
14933
|
+
"x-reconciled-at": "2026-01-07T15:27:58.732049+00:00"
|
|
14269
14934
|
}
|
|
14270
14935
|
},
|
|
14936
|
+
"x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.",
|
|
14937
|
+
"x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...",
|
|
14271
14938
|
"x-f5xc-minimum-configuration": {
|
|
14272
14939
|
"description": "Minimum configuration for schemaMessageMetaType",
|
|
14273
14940
|
"required_fields": [
|
|
@@ -14298,6 +14965,8 @@
|
|
|
14298
14965
|
"default": "PROPERTY_QUERY_PARAMETERS",
|
|
14299
14966
|
"x-displayname": "OpenAPI Validation Properties.",
|
|
14300
14967
|
"x-ves-proto-enum": "ves.io.schema.OpenApiValidationProperties",
|
|
14968
|
+
"x-f5xc-description-short": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification...",
|
|
14969
|
+
"x-f5xc-description-medium": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification Validate that all path parameters are according to the OpenAPI specification Validate that the content type of the request is according to the OpenAPI...",
|
|
14301
14970
|
"x-f5xc-minimum-configuration": {
|
|
14302
14971
|
"description": "Minimum configuration for schemaOpenApiValidationProperties",
|
|
14303
14972
|
"required_fields": [],
|
|
@@ -14325,6 +14994,7 @@
|
|
|
14325
14994
|
"type": "string",
|
|
14326
14995
|
"description": "BIG-IP Hostname.",
|
|
14327
14996
|
"x-displayname": "Hostname",
|
|
14997
|
+
"x-f5xc-example": "example-resource",
|
|
14328
14998
|
"minLength": 0,
|
|
14329
14999
|
"maxLength": 1024,
|
|
14330
15000
|
"x-f5xc-required-for": {
|
|
@@ -14348,6 +15018,7 @@
|
|
|
14348
15018
|
"ves.io.schema.rules.message.required": "true",
|
|
14349
15019
|
"ves.io.schema.rules.string.max_len": "256"
|
|
14350
15020
|
},
|
|
15021
|
+
"x-f5xc-description-short": "Version of the BIG-IP which hosts the virtual server Required: YES.",
|
|
14351
15022
|
"minLength": 0,
|
|
14352
15023
|
"x-f5xc-required-for": {
|
|
14353
15024
|
"minimum_config": false,
|
|
@@ -14395,6 +15066,7 @@
|
|
|
14395
15066
|
"x-validation-rules": {
|
|
14396
15067
|
"ves.io.schema.rules.string.max_len": "1024"
|
|
14397
15068
|
},
|
|
15069
|
+
"x-f5xc-example": "example-resource",
|
|
14398
15070
|
"minLength": 0,
|
|
14399
15071
|
"x-f5xc-required-for": {
|
|
14400
15072
|
"minimum_config": false,
|
|
@@ -14410,6 +15082,7 @@
|
|
|
14410
15082
|
"$ref": "#/components/schemas/bigip_virtual_serverBigIpVirtualServerType"
|
|
14411
15083
|
}
|
|
14412
15084
|
},
|
|
15085
|
+
"x-f5xc-description-short": "Shape of the BIG-IP virtual server specification.",
|
|
14413
15086
|
"x-f5xc-minimum-configuration": {
|
|
14414
15087
|
"description": "Minimum configuration for viewsbigip_virtual_serverGetSpecType",
|
|
14415
15088
|
"required_fields": [
|
|
@@ -14462,6 +15135,7 @@
|
|
|
14462
15135
|
"$ref": "#/components/schemas/common_securitySensitiveDataPolicySettings"
|
|
14463
15136
|
}
|
|
14464
15137
|
},
|
|
15138
|
+
"x-f5xc-description-short": "Shape of the BIG-IP virtual server specification.",
|
|
14465
15139
|
"x-f5xc-minimum-configuration": {
|
|
14466
15140
|
"description": "Minimum configuration for viewsbigip_virtual_serverReplaceSpecType",
|
|
14467
15141
|
"required_fields": [
|
|
@@ -14555,6 +15229,7 @@
|
|
|
14555
15229
|
"ves.io.schema.rules.message.required": "true",
|
|
14556
15230
|
"ves.io.schema.rules.string.max_len": "256"
|
|
14557
15231
|
},
|
|
15232
|
+
"x-f5xc-description-short": "Specify Description for iRule Required: YES.",
|
|
14558
15233
|
"minLength": 0,
|
|
14559
15234
|
"x-f5xc-required-for": {
|
|
14560
15235
|
"minimum_config": false,
|
|
@@ -14564,7 +15239,7 @@
|
|
|
14564
15239
|
},
|
|
14565
15240
|
"x-original-maxLength": 256,
|
|
14566
15241
|
"x-reconciled-from-discovery": true,
|
|
14567
|
-
"x-reconciled-at": "2026-01-
|
|
15242
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935716+00:00"
|
|
14568
15243
|
},
|
|
14569
15244
|
"irule": {
|
|
14570
15245
|
"type": "string",
|
|
@@ -14582,6 +15257,7 @@
|
|
|
14582
15257
|
"ves.io.schema.rules.message.required": "true",
|
|
14583
15258
|
"ves.io.schema.rules.string.max_len": "24576"
|
|
14584
15259
|
},
|
|
15260
|
+
"x-f5xc-description-short": "Www.internal.example.f5.com\")} DNS::drop} irule content Required: YES.",
|
|
14585
15261
|
"minLength": 0,
|
|
14586
15262
|
"x-f5xc-required-for": {
|
|
14587
15263
|
"minimum_config": false,
|
|
@@ -14591,6 +15267,7 @@
|
|
|
14591
15267
|
}
|
|
14592
15268
|
}
|
|
14593
15269
|
},
|
|
15270
|
+
"x-f5xc-description-short": "Create iRule in a given namespace. If one already exists it will give an error.",
|
|
14594
15271
|
"x-f5xc-minimum-configuration": {
|
|
14595
15272
|
"description": "Minimum configuration for iruleCreateSpecType",
|
|
14596
15273
|
"required_fields": [
|
|
@@ -14617,6 +15294,7 @@
|
|
|
14617
15294
|
"title": "Fail_if_referred.",
|
|
14618
15295
|
"format": "boolean",
|
|
14619
15296
|
"x-displayname": "Fail-If-Referred.",
|
|
15297
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
14620
15298
|
"x-f5xc-required-for": {
|
|
14621
15299
|
"minimum_config": false,
|
|
14622
15300
|
"create": false,
|
|
@@ -14641,7 +15319,7 @@
|
|
|
14641
15319
|
},
|
|
14642
15320
|
"x-original-maxLength": 1024,
|
|
14643
15321
|
"x-reconciled-from-discovery": true,
|
|
14644
|
-
"x-reconciled-at": "2026-01-
|
|
15322
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935724+00:00"
|
|
14645
15323
|
},
|
|
14646
15324
|
"namespace": {
|
|
14647
15325
|
"type": "string",
|
|
@@ -14650,6 +15328,7 @@
|
|
|
14650
15328
|
"x-displayname": "Namespace",
|
|
14651
15329
|
"x-ves-example": "Ns1",
|
|
14652
15330
|
"x-f5xc-example": "ns1",
|
|
15331
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
14653
15332
|
"minLength": 0,
|
|
14654
15333
|
"maxLength": 6,
|
|
14655
15334
|
"x-f5xc-required-for": {
|
|
@@ -14660,7 +15339,7 @@
|
|
|
14660
15339
|
},
|
|
14661
15340
|
"x-original-maxLength": 1024,
|
|
14662
15341
|
"x-reconciled-from-discovery": true,
|
|
14663
|
-
"x-reconciled-at": "2026-01-
|
|
15342
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935729+00:00"
|
|
14664
15343
|
}
|
|
14665
15344
|
},
|
|
14666
15345
|
"x-f5xc-minimum-configuration": {
|
|
@@ -14695,6 +15374,7 @@
|
|
|
14695
15374
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14696
15375
|
},
|
|
14697
15376
|
"x-displayname": "Deleted Referred Objects.",
|
|
15377
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14698
15378
|
"x-f5xc-required-for": {
|
|
14699
15379
|
"minimum_config": false,
|
|
14700
15380
|
"create": false,
|
|
@@ -14710,6 +15390,7 @@
|
|
|
14710
15390
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14711
15391
|
},
|
|
14712
15392
|
"x-displayname": "Disabled Referred Objects.",
|
|
15393
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14713
15394
|
"x-f5xc-required-for": {
|
|
14714
15395
|
"minimum_config": false,
|
|
14715
15396
|
"create": false,
|
|
@@ -14728,6 +15409,7 @@
|
|
|
14728
15409
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14729
15410
|
},
|
|
14730
15411
|
"x-displayname": "Referring Objects.",
|
|
15412
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
14731
15413
|
"x-f5xc-required-for": {
|
|
14732
15414
|
"minimum_config": false,
|
|
14733
15415
|
"create": false,
|
|
@@ -14777,6 +15459,8 @@
|
|
|
14777
15459
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
14778
15460
|
],
|
|
14779
15461
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
15462
|
+
"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...",
|
|
15463
|
+
"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...",
|
|
14780
15464
|
"x-f5xc-minimum-configuration": {
|
|
14781
15465
|
"description": "Minimum configuration for iruleGetResponseFormatCode",
|
|
14782
15466
|
"required_fields": [],
|
|
@@ -14808,6 +15492,7 @@
|
|
|
14808
15492
|
"ves.io.schema.rules.message.required": "true",
|
|
14809
15493
|
"ves.io.schema.rules.string.max_len": "256"
|
|
14810
15494
|
},
|
|
15495
|
+
"x-f5xc-description-short": "Specify Description for iRule Required: YES.",
|
|
14811
15496
|
"minLength": 0,
|
|
14812
15497
|
"x-f5xc-required-for": {
|
|
14813
15498
|
"minimum_config": false,
|
|
@@ -14817,7 +15502,7 @@
|
|
|
14817
15502
|
},
|
|
14818
15503
|
"x-original-maxLength": 256,
|
|
14819
15504
|
"x-reconciled-from-discovery": true,
|
|
14820
|
-
"x-reconciled-at": "2026-01-
|
|
15505
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935745+00:00"
|
|
14821
15506
|
},
|
|
14822
15507
|
"irule": {
|
|
14823
15508
|
"type": "string",
|
|
@@ -14835,6 +15520,7 @@
|
|
|
14835
15520
|
"ves.io.schema.rules.message.required": "true",
|
|
14836
15521
|
"ves.io.schema.rules.string.max_len": "24576"
|
|
14837
15522
|
},
|
|
15523
|
+
"x-f5xc-description-short": "Www.internal.example.f5.com\")} DNS::drop} irule content Required: YES.",
|
|
14838
15524
|
"minLength": 0,
|
|
14839
15525
|
"x-f5xc-required-for": {
|
|
14840
15526
|
"minimum_config": false,
|
|
@@ -14872,6 +15558,7 @@
|
|
|
14872
15558
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
14873
15559
|
},
|
|
14874
15560
|
"x-displayname": "Errors",
|
|
15561
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
14875
15562
|
"x-f5xc-required-for": {
|
|
14876
15563
|
"minimum_config": false,
|
|
14877
15564
|
"create": false,
|
|
@@ -14887,6 +15574,8 @@
|
|
|
14887
15574
|
"$ref": "#/components/schemas/iruleListResponseItem"
|
|
14888
15575
|
},
|
|
14889
15576
|
"x-displayname": "Items",
|
|
15577
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
15578
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
14890
15579
|
"x-f5xc-required-for": {
|
|
14891
15580
|
"minimum_config": false,
|
|
14892
15581
|
"create": false,
|
|
@@ -14920,6 +15609,8 @@
|
|
|
14920
15609
|
"description": "The set of annotations present on this irule.",
|
|
14921
15610
|
"title": "Annotations.",
|
|
14922
15611
|
"x-displayname": "Annotations.",
|
|
15612
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15613
|
+
"x-f5xc-description-short": "The set of annotations present on this irule.",
|
|
14923
15614
|
"x-f5xc-required-for": {
|
|
14924
15615
|
"minimum_config": false,
|
|
14925
15616
|
"create": false,
|
|
@@ -14942,7 +15633,7 @@
|
|
|
14942
15633
|
},
|
|
14943
15634
|
"x-original-maxLength": 1024,
|
|
14944
15635
|
"x-reconciled-from-discovery": true,
|
|
14945
|
-
"x-reconciled-at": "2026-01-
|
|
15636
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935756+00:00"
|
|
14946
15637
|
},
|
|
14947
15638
|
"disabled": {
|
|
14948
15639
|
"type": "boolean",
|
|
@@ -14950,6 +15641,8 @@
|
|
|
14950
15641
|
"title": "Disabled",
|
|
14951
15642
|
"format": "boolean",
|
|
14952
15643
|
"x-displayname": "Disabled",
|
|
15644
|
+
"x-f5xc-example": "True",
|
|
15645
|
+
"x-f5xc-description-short": "Value of true indicates irule is administratively disabled.",
|
|
14953
15646
|
"x-f5xc-required-for": {
|
|
14954
15647
|
"minimum_config": false,
|
|
14955
15648
|
"create": false,
|
|
@@ -14965,6 +15658,8 @@
|
|
|
14965
15658
|
"description": "The set of labels present on this irule.",
|
|
14966
15659
|
"title": "Labels",
|
|
14967
15660
|
"x-displayname": "Labels",
|
|
15661
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15662
|
+
"x-f5xc-description-short": "The set of labels present on this irule.",
|
|
14968
15663
|
"x-f5xc-required-for": {
|
|
14969
15664
|
"minimum_config": false,
|
|
14970
15665
|
"create": false,
|
|
@@ -14992,7 +15687,7 @@
|
|
|
14992
15687
|
},
|
|
14993
15688
|
"x-original-maxLength": 1024,
|
|
14994
15689
|
"x-reconciled-from-discovery": true,
|
|
14995
|
-
"x-reconciled-at": "2026-01-
|
|
15690
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935767+00:00"
|
|
14996
15691
|
},
|
|
14997
15692
|
"namespace": {
|
|
14998
15693
|
"type": "string",
|
|
@@ -15011,7 +15706,7 @@
|
|
|
15011
15706
|
},
|
|
15012
15707
|
"x-original-maxLength": 1024,
|
|
15013
15708
|
"x-reconciled-from-discovery": true,
|
|
15014
|
-
"x-reconciled-at": "2026-01-
|
|
15709
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935771+00:00"
|
|
15015
15710
|
},
|
|
15016
15711
|
"owner_view": {
|
|
15017
15712
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -15037,7 +15732,7 @@
|
|
|
15037
15732
|
"x-field-mutability": "read-only",
|
|
15038
15733
|
"x-original-maxLength": 1024,
|
|
15039
15734
|
"x-reconciled-from-discovery": true,
|
|
15040
|
-
"x-reconciled-at": "2026-01-
|
|
15735
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935777+00:00"
|
|
15041
15736
|
},
|
|
15042
15737
|
"uid": {
|
|
15043
15738
|
"type": "string",
|
|
@@ -15058,9 +15753,11 @@
|
|
|
15058
15753
|
"x-original-maxLength": 1024,
|
|
15059
15754
|
"format": "uuid",
|
|
15060
15755
|
"x-reconciled-from-discovery": true,
|
|
15061
|
-
"x-reconciled-at": "2026-01-
|
|
15756
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935782+00:00"
|
|
15062
15757
|
}
|
|
15063
15758
|
},
|
|
15759
|
+
"x-f5xc-description-short": "By default a summary of irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15760
|
+
"x-f5xc-description-medium": "By default a summary of irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15064
15761
|
"x-f5xc-minimum-configuration": {
|
|
15065
15762
|
"description": "Minimum configuration for iruleListResponseItem",
|
|
15066
15763
|
"required_fields": [
|
|
@@ -15145,6 +15842,7 @@
|
|
|
15145
15842
|
"ves.io.schema.rules.message.required": "true",
|
|
15146
15843
|
"ves.io.schema.rules.string.max_len": "256"
|
|
15147
15844
|
},
|
|
15845
|
+
"x-f5xc-description-short": "Specify Description for iRule Required: YES.",
|
|
15148
15846
|
"minLength": 0,
|
|
15149
15847
|
"x-f5xc-required-for": {
|
|
15150
15848
|
"minimum_config": false,
|
|
@@ -15154,7 +15852,7 @@
|
|
|
15154
15852
|
},
|
|
15155
15853
|
"x-original-maxLength": 256,
|
|
15156
15854
|
"x-reconciled-from-discovery": true,
|
|
15157
|
-
"x-reconciled-at": "2026-01-
|
|
15855
|
+
"x-reconciled-at": "2026-01-07T15:28:24.935790+00:00"
|
|
15158
15856
|
},
|
|
15159
15857
|
"irule": {
|
|
15160
15858
|
"type": "string",
|
|
@@ -15172,6 +15870,7 @@
|
|
|
15172
15870
|
"ves.io.schema.rules.message.required": "true",
|
|
15173
15871
|
"ves.io.schema.rules.string.max_len": "24576"
|
|
15174
15872
|
},
|
|
15873
|
+
"x-f5xc-description-short": "Www.internal.example.f5.com\")} DNS::drop} irule content Required: YES.",
|
|
15175
15874
|
"minLength": 0,
|
|
15176
15875
|
"x-f5xc-required-for": {
|
|
15177
15876
|
"minimum_config": false,
|
|
@@ -15212,6 +15911,7 @@
|
|
|
15212
15911
|
"$ref": "#/components/schemas/data_groupStringRecords"
|
|
15213
15912
|
}
|
|
15214
15913
|
},
|
|
15914
|
+
"x-f5xc-description-short": "Create data group in a given namespace. If one already exists it will give an error.",
|
|
15215
15915
|
"x-f5xc-minimum-configuration": {
|
|
15216
15916
|
"description": "Minimum configuration for bigcnedata_groupCreateSpecType",
|
|
15217
15917
|
"required_fields": [
|
|
@@ -15276,6 +15976,7 @@
|
|
|
15276
15976
|
"$ref": "#/components/schemas/data_groupStringRecords"
|
|
15277
15977
|
}
|
|
15278
15978
|
},
|
|
15979
|
+
"x-f5xc-description-short": "Replace Data Group in a given namespace.",
|
|
15279
15980
|
"x-f5xc-minimum-configuration": {
|
|
15280
15981
|
"description": "Minimum configuration for bigcnedata_groupReplaceSpecType",
|
|
15281
15982
|
"required_fields": [
|
|
@@ -15299,7 +16000,7 @@
|
|
|
15299
16000
|
"properties": {
|
|
15300
16001
|
"records": {
|
|
15301
16002
|
"type": "object",
|
|
15302
|
-
"description": "",
|
|
16003
|
+
"description": "Configuration parameter for records",
|
|
15303
16004
|
"title": "Address records.",
|
|
15304
16005
|
"x-displayname": "Address records.",
|
|
15305
16006
|
"x-ves-validation-rules": {
|
|
@@ -15400,6 +16101,7 @@
|
|
|
15400
16101
|
"title": "Fail_if_referred.",
|
|
15401
16102
|
"format": "boolean",
|
|
15402
16103
|
"x-displayname": "Fail-If-Referred.",
|
|
16104
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
15403
16105
|
"x-f5xc-required-for": {
|
|
15404
16106
|
"minimum_config": false,
|
|
15405
16107
|
"create": false,
|
|
@@ -15424,7 +16126,7 @@
|
|
|
15424
16126
|
},
|
|
15425
16127
|
"x-original-maxLength": 1024,
|
|
15426
16128
|
"x-reconciled-from-discovery": true,
|
|
15427
|
-
"x-reconciled-at": "2026-01-
|
|
16129
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571829+00:00"
|
|
15428
16130
|
},
|
|
15429
16131
|
"namespace": {
|
|
15430
16132
|
"type": "string",
|
|
@@ -15433,6 +16135,7 @@
|
|
|
15433
16135
|
"x-displayname": "Namespace",
|
|
15434
16136
|
"x-ves-example": "Ns1",
|
|
15435
16137
|
"x-f5xc-example": "ns1",
|
|
16138
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
15436
16139
|
"minLength": 0,
|
|
15437
16140
|
"maxLength": 6,
|
|
15438
16141
|
"x-f5xc-required-for": {
|
|
@@ -15443,7 +16146,7 @@
|
|
|
15443
16146
|
},
|
|
15444
16147
|
"x-original-maxLength": 1024,
|
|
15445
16148
|
"x-reconciled-from-discovery": true,
|
|
15446
|
-
"x-reconciled-at": "2026-01-
|
|
16149
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571836+00:00"
|
|
15447
16150
|
}
|
|
15448
16151
|
},
|
|
15449
16152
|
"x-f5xc-minimum-configuration": {
|
|
@@ -15478,6 +16181,7 @@
|
|
|
15478
16181
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15479
16182
|
},
|
|
15480
16183
|
"x-displayname": "Deleted Referred Objects.",
|
|
16184
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
15481
16185
|
"x-f5xc-required-for": {
|
|
15482
16186
|
"minimum_config": false,
|
|
15483
16187
|
"create": false,
|
|
@@ -15493,6 +16197,7 @@
|
|
|
15493
16197
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15494
16198
|
},
|
|
15495
16199
|
"x-displayname": "Disabled Referred Objects.",
|
|
16200
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
15496
16201
|
"x-f5xc-required-for": {
|
|
15497
16202
|
"minimum_config": false,
|
|
15498
16203
|
"create": false,
|
|
@@ -15511,6 +16216,7 @@
|
|
|
15511
16216
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15512
16217
|
},
|
|
15513
16218
|
"x-displayname": "Referring Objects.",
|
|
16219
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
15514
16220
|
"x-f5xc-required-for": {
|
|
15515
16221
|
"minimum_config": false,
|
|
15516
16222
|
"create": false,
|
|
@@ -15560,6 +16266,8 @@
|
|
|
15560
16266
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
15561
16267
|
],
|
|
15562
16268
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
16269
|
+
"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...",
|
|
16270
|
+
"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...",
|
|
15563
16271
|
"x-f5xc-minimum-configuration": {
|
|
15564
16272
|
"description": "Minimum configuration for data_groupGetResponseFormatCode",
|
|
15565
16273
|
"required_fields": [],
|
|
@@ -15579,7 +16287,7 @@
|
|
|
15579
16287
|
"properties": {
|
|
15580
16288
|
"records": {
|
|
15581
16289
|
"type": "object",
|
|
15582
|
-
"description": "",
|
|
16290
|
+
"description": "Configuration parameter for records",
|
|
15583
16291
|
"title": "Integer records.",
|
|
15584
16292
|
"x-displayname": "Integer records.",
|
|
15585
16293
|
"x-ves-validation-rules": {
|
|
@@ -15625,6 +16333,7 @@
|
|
|
15625
16333
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
15626
16334
|
},
|
|
15627
16335
|
"x-displayname": "Errors",
|
|
16336
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
15628
16337
|
"x-f5xc-required-for": {
|
|
15629
16338
|
"minimum_config": false,
|
|
15630
16339
|
"create": false,
|
|
@@ -15640,6 +16349,8 @@
|
|
|
15640
16349
|
"$ref": "#/components/schemas/data_groupListResponseItem"
|
|
15641
16350
|
},
|
|
15642
16351
|
"x-displayname": "Items",
|
|
16352
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
16353
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
15643
16354
|
"x-f5xc-required-for": {
|
|
15644
16355
|
"minimum_config": false,
|
|
15645
16356
|
"create": false,
|
|
@@ -15673,6 +16384,8 @@
|
|
|
15673
16384
|
"description": "The set of annotations present on this data_group.",
|
|
15674
16385
|
"title": "Annotations.",
|
|
15675
16386
|
"x-displayname": "Annotations.",
|
|
16387
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16388
|
+
"x-f5xc-description-short": "The set of annotations present on this data_group.",
|
|
15676
16389
|
"x-f5xc-required-for": {
|
|
15677
16390
|
"minimum_config": false,
|
|
15678
16391
|
"create": false,
|
|
@@ -15685,6 +16398,7 @@
|
|
|
15685
16398
|
"description": "The description set for this data_group.",
|
|
15686
16399
|
"title": "Description.",
|
|
15687
16400
|
"x-displayname": "Description.",
|
|
16401
|
+
"x-f5xc-description-short": "The description set for this data_group.",
|
|
15688
16402
|
"minLength": 0,
|
|
15689
16403
|
"maxLength": 0,
|
|
15690
16404
|
"x-f5xc-required-for": {
|
|
@@ -15695,7 +16409,7 @@
|
|
|
15695
16409
|
},
|
|
15696
16410
|
"x-original-maxLength": 1024,
|
|
15697
16411
|
"x-reconciled-from-discovery": true,
|
|
15698
|
-
"x-reconciled-at": "2026-01-
|
|
16412
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571861+00:00"
|
|
15699
16413
|
},
|
|
15700
16414
|
"disabled": {
|
|
15701
16415
|
"type": "boolean",
|
|
@@ -15703,6 +16417,8 @@
|
|
|
15703
16417
|
"title": "Disabled",
|
|
15704
16418
|
"format": "boolean",
|
|
15705
16419
|
"x-displayname": "Disabled",
|
|
16420
|
+
"x-f5xc-example": "True",
|
|
16421
|
+
"x-f5xc-description-short": "Value of true indicates data_group is administratively disabled.",
|
|
15706
16422
|
"x-f5xc-required-for": {
|
|
15707
16423
|
"minimum_config": false,
|
|
15708
16424
|
"create": false,
|
|
@@ -15718,6 +16434,8 @@
|
|
|
15718
16434
|
"description": "The set of labels present on this data_group.",
|
|
15719
16435
|
"title": "Labels",
|
|
15720
16436
|
"x-displayname": "Labels",
|
|
16437
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16438
|
+
"x-f5xc-description-short": "The set of labels present on this data_group.",
|
|
15721
16439
|
"x-f5xc-required-for": {
|
|
15722
16440
|
"minimum_config": false,
|
|
15723
16441
|
"create": false,
|
|
@@ -15745,7 +16463,7 @@
|
|
|
15745
16463
|
},
|
|
15746
16464
|
"x-original-maxLength": 1024,
|
|
15747
16465
|
"x-reconciled-from-discovery": true,
|
|
15748
|
-
"x-reconciled-at": "2026-01-
|
|
16466
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571872+00:00"
|
|
15749
16467
|
},
|
|
15750
16468
|
"namespace": {
|
|
15751
16469
|
"type": "string",
|
|
@@ -15764,7 +16482,7 @@
|
|
|
15764
16482
|
},
|
|
15765
16483
|
"x-original-maxLength": 1024,
|
|
15766
16484
|
"x-reconciled-from-discovery": true,
|
|
15767
|
-
"x-reconciled-at": "2026-01-
|
|
16485
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571876+00:00"
|
|
15768
16486
|
},
|
|
15769
16487
|
"owner_view": {
|
|
15770
16488
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -15790,7 +16508,7 @@
|
|
|
15790
16508
|
"x-field-mutability": "read-only",
|
|
15791
16509
|
"x-original-maxLength": 1024,
|
|
15792
16510
|
"x-reconciled-from-discovery": true,
|
|
15793
|
-
"x-reconciled-at": "2026-01-
|
|
16511
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571882+00:00"
|
|
15794
16512
|
},
|
|
15795
16513
|
"uid": {
|
|
15796
16514
|
"type": "string",
|
|
@@ -15811,9 +16529,11 @@
|
|
|
15811
16529
|
"x-original-maxLength": 1024,
|
|
15812
16530
|
"format": "uuid",
|
|
15813
16531
|
"x-reconciled-from-discovery": true,
|
|
15814
|
-
"x-reconciled-at": "2026-01-
|
|
16532
|
+
"x-reconciled-at": "2026-01-07T15:28:31.571889+00:00"
|
|
15815
16533
|
}
|
|
15816
16534
|
},
|
|
16535
|
+
"x-f5xc-description-short": "By default a summary of data_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
16536
|
+
"x-f5xc-description-medium": "By default a summary of data_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15817
16537
|
"x-f5xc-minimum-configuration": {
|
|
15818
16538
|
"description": "Minimum configuration for data_groupListResponseItem",
|
|
15819
16539
|
"required_fields": [
|
|
@@ -15886,7 +16606,7 @@
|
|
|
15886
16606
|
"properties": {
|
|
15887
16607
|
"records": {
|
|
15888
16608
|
"type": "object",
|
|
15889
|
-
"description": "",
|
|
16609
|
+
"description": "Configuration parameter for records",
|
|
15890
16610
|
"title": "String records.",
|
|
15891
16611
|
"x-displayname": "String records.",
|
|
15892
16612
|
"x-ves-validation-rules": {
|