@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.0
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/dist/generator/openapi-parser.d.ts +418 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +132 -0
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -1
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +150 -7
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/tools/discovery/describe.d.ts +1 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -1
- package/dist/tools/discovery/describe.js +10 -8
- package/dist/tools/discovery/describe.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
- package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
- package/dist/tools/generated/api/index.d.ts +8 -0
- package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +6668 -0
- package/dist/tools/generated/api/index.js.map +1 -0
- package/dist/tools/generated/authentication/index.d.ts +8 -0
- package/dist/tools/generated/authentication/index.d.ts.map +1 -0
- package/dist/tools/generated/authentication/index.js +1005 -0
- package/dist/tools/generated/authentication/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +2045 -0
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
- package/dist/tools/generated/billing_and_usage/index.js +2702 -0
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
- package/dist/tools/generated/blindfold/index.d.ts +8 -0
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
- package/dist/tools/generated/blindfold/index.js +3998 -0
- package/dist/tools/generated/blindfold/index.js.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +1904 -0
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts +8 -0
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
- package/dist/tools/generated/ce_management/index.js +3963 -0
- package/dist/tools/generated/ce_management/index.js.map +1 -0
- package/dist/tools/generated/certificates/index.d.ts +8 -0
- package/dist/tools/generated/certificates/index.d.ts.map +1 -0
- package/dist/tools/generated/certificates/index.js +2579 -0
- package/dist/tools/generated/certificates/index.js.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
- package/dist/tools/generated/container_services/index.d.ts +8 -0
- package/dist/tools/generated/container_services/index.d.ts.map +1 -0
- package/dist/tools/generated/container_services/index.js +2054 -0
- package/dist/tools/generated/container_services/index.js.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
- package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/data_intelligence/index.js +1770 -0
- package/dist/tools/generated/data_intelligence/index.js.map +1 -0
- package/dist/tools/generated/ddos/index.d.ts +8 -0
- package/dist/tools/generated/ddos/index.d.ts.map +1 -0
- package/dist/tools/generated/ddos/index.js +8511 -0
- package/dist/tools/generated/ddos/index.js.map +1 -0
- package/dist/tools/generated/dns/index.d.ts +8 -0
- package/dist/tools/generated/dns/index.d.ts.map +1 -0
- package/dist/tools/generated/dns/index.js +6460 -0
- package/dist/tools/generated/dns/index.js.map +1 -0
- package/dist/tools/generated/generative_ai/index.d.ts +8 -0
- package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
- package/dist/tools/generated/generative_ai/index.js +1215 -0
- package/dist/tools/generated/generative_ai/index.js.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
- package/dist/tools/generated/marketplace/index.d.ts +8 -0
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
- package/dist/tools/generated/marketplace/index.js +4580 -0
- package/dist/tools/generated/marketplace/index.js.map +1 -0
- package/dist/tools/generated/network/index.d.ts +8 -0
- package/dist/tools/generated/network/index.d.ts.map +1 -0
- package/dist/tools/generated/network/index.js +12616 -0
- package/dist/tools/generated/network/index.js.map +1 -0
- package/dist/tools/generated/network_security/index.d.ts +8 -0
- package/dist/tools/generated/network_security/index.d.ts.map +1 -0
- package/dist/tools/generated/network_security/index.js +8884 -0
- package/dist/tools/generated/network_security/index.js.map +1 -0
- package/dist/tools/generated/nginx_one/index.d.ts +8 -0
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx_one/index.js +1820 -0
- package/dist/tools/generated/nginx_one/index.js.map +1 -0
- package/dist/tools/generated/object_storage/index.d.ts +8 -0
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
- package/dist/tools/generated/object_storage/index.js +1055 -0
- package/dist/tools/generated/object_storage/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +4243 -4618
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
- package/dist/tools/generated/rate_limiting/index.js +1937 -0
- package/dist/tools/generated/rate_limiting/index.js.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +4532 -438
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts +8 -0
- package/dist/tools/generated/shape/index.d.ts.map +1 -0
- package/dist/tools/generated/shape/index.js +21784 -0
- package/dist/tools/generated/shape/index.js.map +1 -0
- package/dist/tools/generated/sites/index.d.ts +8 -0
- package/dist/tools/generated/sites/index.d.ts.map +1 -0
- package/dist/tools/generated/sites/index.js +13252 -0
- package/dist/tools/generated/sites/index.js.map +1 -0
- package/dist/tools/generated/statistics/index.d.ts +8 -0
- package/dist/tools/generated/statistics/index.d.ts.map +1 -0
- package/dist/tools/generated/statistics/index.js +8837 -0
- package/dist/tools/generated/statistics/index.js.map +1 -0
- package/dist/tools/generated/support/index.d.ts +8 -0
- package/dist/tools/generated/support/index.d.ts.map +1 -0
- package/dist/tools/generated/support/index.js +6215 -0
- package/dist/tools/generated/support/index.js.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
- package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
- package/dist/tools/generated/threat_campaign/index.js +112 -0
- package/dist/tools/generated/threat_campaign/index.js.map +1 -0
- package/dist/tools/generated/users/index.d.ts +8 -0
- package/dist/tools/generated/users/index.d.ts.map +1 -0
- package/dist/tools/generated/users/index.js +1572 -0
- package/dist/tools/generated/users/index.js.map +1 -0
- package/dist/tools/generated/virtual/index.d.ts +8 -0
- package/dist/tools/generated/virtual/index.d.ts.map +1 -0
- package/dist/tools/generated/virtual/index.js +11540 -0
- package/dist/tools/generated/virtual/index.js.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
- package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
- package/dist/tools/generated/waf/index.d.ts +8 -0
- package/dist/tools/generated/waf/index.d.ts.map +1 -0
- package/dist/tools/generated/waf/index.js +4440 -0
- package/dist/tools/generated/waf/index.js.map +1 -0
- package/dist/tools/registry.d.ts.map +1 -1
- package/dist/tools/registry.js +68 -36
- package/dist/tools/registry.js.map +1 -1
- package/package.json +3 -1
- package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.js +0 -282
- package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
- package/dist/tools/generated/api_security/index.d.ts +0 -8
- package/dist/tools/generated/api_security/index.d.ts.map +0 -1
- package/dist/tools/generated/api_security/index.js +0 -1852
- package/dist/tools/generated/api_security/index.js.map +0 -1
- package/dist/tools/generated/applications/index.d.ts +0 -8
- package/dist/tools/generated/applications/index.d.ts.map +0 -1
- package/dist/tools/generated/applications/index.js +0 -1589
- package/dist/tools/generated/applications/index.js.map +0 -1
- package/dist/tools/generated/billing/index.d.ts +0 -8
- package/dist/tools/generated/billing/index.d.ts.map +0 -1
- package/dist/tools/generated/billing/index.js +0 -759
- package/dist/tools/generated/billing/index.js.map +0 -1
- package/dist/tools/generated/config/index.d.ts +0 -8
- package/dist/tools/generated/config/index.d.ts.map +0 -1
- package/dist/tools/generated/config/index.js +0 -316
- package/dist/tools/generated/config/index.js.map +0 -1
- package/dist/tools/generated/identity/index.d.ts +0 -8
- package/dist/tools/generated/identity/index.d.ts.map +0 -1
- package/dist/tools/generated/identity/index.js +0 -5371
- package/dist/tools/generated/identity/index.js.map +0 -1
- package/dist/tools/generated/infrastructure/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure/index.js +0 -5342
- package/dist/tools/generated/infrastructure/index.js.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
- package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
- package/dist/tools/generated/integrations/index.d.ts +0 -8
- package/dist/tools/generated/integrations/index.d.ts.map +0 -1
- package/dist/tools/generated/integrations/index.js +0 -1995
- package/dist/tools/generated/integrations/index.js.map +0 -1
- package/dist/tools/generated/load_balancer/index.d.ts +0 -8
- package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
- package/dist/tools/generated/load_balancer/index.js +0 -2269
- package/dist/tools/generated/load_balancer/index.js.map +0 -1
- package/dist/tools/generated/networking/index.d.ts +0 -8
- package/dist/tools/generated/networking/index.d.ts.map +0 -1
- package/dist/tools/generated/networking/index.js +0 -11289
- package/dist/tools/generated/networking/index.js.map +0 -1
- package/dist/tools/generated/nginx/index.d.ts +0 -8
- package/dist/tools/generated/nginx/index.d.ts.map +0 -1
- package/dist/tools/generated/nginx/index.js +0 -680
- package/dist/tools/generated/nginx/index.js.map +0 -1
- package/dist/tools/generated/operations/index.d.ts +0 -8
- package/dist/tools/generated/operations/index.d.ts.map +0 -1
- package/dist/tools/generated/operations/index.js +0 -1759
- package/dist/tools/generated/operations/index.js.map +0 -1
- package/dist/tools/generated/security/index.d.ts +0 -8
- package/dist/tools/generated/security/index.d.ts.map +0 -1
- package/dist/tools/generated/security/index.js +0 -9111
- package/dist/tools/generated/security/index.js.map +0 -1
- package/dist/tools/generated/shape_security/index.d.ts +0 -8
- package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
- package/dist/tools/generated/shape_security/index.js +0 -4121
- package/dist/tools/generated/shape_security/index.js.map +0 -1
- package/dist/tools/generated/subscriptions/index.d.ts +0 -8
- package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
- package/dist/tools/generated/subscriptions/index.js +0 -778
- package/dist/tools/generated/subscriptions/index.js.map +0 -1
- package/dist/tools/generated/tenant_management/index.d.ts +0 -8
- package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
- package/dist/tools/generated/tenant_management/index.js +0 -2292
- package/dist/tools/generated/tenant_management/index.js.map +0 -1
- package/dist/tools/generated/vpn/index.d.ts +0 -8
- package/dist/tools/generated/vpn/index.js +0 -1183
- package/dist/tools/generated/vpn/index.js.map +0 -1
|
@@ -21,6 +21,8 @@ export const cdnTools = [
|
|
|
21
21
|
schema: {
|
|
22
22
|
type: "string",
|
|
23
23
|
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "Value",
|
|
24
26
|
},
|
|
25
27
|
],
|
|
26
28
|
queryParameters: [],
|
|
@@ -34,6 +36,92 @@ export const cdnTools = [
|
|
|
34
36
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNAccessLogs",
|
|
35
37
|
tags: ["CDN"],
|
|
36
38
|
sourceFile: "domains/cdn.json",
|
|
39
|
+
displayName: null,
|
|
40
|
+
dangerLevel: "medium",
|
|
41
|
+
sideEffects: {
|
|
42
|
+
creates: ["access-log"],
|
|
43
|
+
},
|
|
44
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
45
|
+
cliExamples: [
|
|
46
|
+
{
|
|
47
|
+
command: "f5xcctl cdn access-log create {name} --namespace {namespace}",
|
|
48
|
+
description: "Create access-log",
|
|
49
|
+
use_case: "basic_create",
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
command: "f5xcctl cdn access-log create -f {file}.yaml",
|
|
53
|
+
description: "Create from YAML file",
|
|
54
|
+
use_case: "file_based",
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
confirmationRequired: false,
|
|
58
|
+
parameterExamples: {
|
|
59
|
+
namespace: "Value",
|
|
60
|
+
},
|
|
61
|
+
validationRules: {},
|
|
62
|
+
operationMetadata: {
|
|
63
|
+
common_errors: [
|
|
64
|
+
{
|
|
65
|
+
code: 401,
|
|
66
|
+
message: "Authentication required",
|
|
67
|
+
solution: "Provide valid API credentials",
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
code: 403,
|
|
71
|
+
message: "Permission denied",
|
|
72
|
+
solution: "Check access permissions for this operation",
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
code: 404,
|
|
76
|
+
message: "Resource not found",
|
|
77
|
+
solution: "Verify resource name, namespace, and path",
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
code: 409,
|
|
81
|
+
message: "Resource already exists",
|
|
82
|
+
solution: "Use different name or update existing resource",
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
code: 429,
|
|
86
|
+
message: "Rate limit exceeded",
|
|
87
|
+
solution: "Wait before retrying the operation",
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
code: 500,
|
|
91
|
+
message: "Server error",
|
|
92
|
+
solution: "Retry operation or contact support",
|
|
93
|
+
},
|
|
94
|
+
],
|
|
95
|
+
conditions: {
|
|
96
|
+
postconditions: ["Access-log resource created", "Resource assigned unique identifier"],
|
|
97
|
+
prerequisites: ["Active namespace"],
|
|
98
|
+
},
|
|
99
|
+
confirmation_required: false,
|
|
100
|
+
danger_level: "medium",
|
|
101
|
+
examples: [
|
|
102
|
+
{
|
|
103
|
+
command: "f5xcctl cdn access-log create {name} --namespace {namespace}",
|
|
104
|
+
description: "Create access-log",
|
|
105
|
+
use_case: "basic_create",
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
command: "f5xcctl cdn access-log create -f {file}.yaml",
|
|
109
|
+
description: "Create from YAML file",
|
|
110
|
+
use_case: "file_based",
|
|
111
|
+
},
|
|
112
|
+
],
|
|
113
|
+
field_docs: {},
|
|
114
|
+
optional_fields: [],
|
|
115
|
+
performance_impact: {
|
|
116
|
+
latency: "low",
|
|
117
|
+
resource_usage: "low",
|
|
118
|
+
},
|
|
119
|
+
purpose: "Create new access-log",
|
|
120
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
121
|
+
side_effects: {
|
|
122
|
+
creates: ["access-log"],
|
|
123
|
+
},
|
|
124
|
+
},
|
|
37
125
|
},
|
|
38
126
|
{
|
|
39
127
|
toolName: "f5xc-api-cdn-aggregation-create",
|
|
@@ -53,6 +141,8 @@ export const cdnTools = [
|
|
|
53
141
|
schema: {
|
|
54
142
|
type: "string",
|
|
55
143
|
},
|
|
144
|
+
"x-displayname": "Namespace",
|
|
145
|
+
"x-ves-example": "Value",
|
|
56
146
|
},
|
|
57
147
|
],
|
|
58
148
|
queryParameters: [],
|
|
@@ -66,6 +156,92 @@ export const cdnTools = [
|
|
|
66
156
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNAccessLogAggregationQuery",
|
|
67
157
|
tags: ["CDN"],
|
|
68
158
|
sourceFile: "domains/cdn.json",
|
|
159
|
+
displayName: null,
|
|
160
|
+
dangerLevel: "medium",
|
|
161
|
+
sideEffects: {
|
|
162
|
+
creates: ["aggregation"],
|
|
163
|
+
},
|
|
164
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
165
|
+
cliExamples: [
|
|
166
|
+
{
|
|
167
|
+
command: "f5xcctl cdn aggregation create {name} --namespace {namespace}",
|
|
168
|
+
description: "Create aggregation",
|
|
169
|
+
use_case: "basic_create",
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
command: "f5xcctl cdn aggregation create -f {file}.yaml",
|
|
173
|
+
description: "Create from YAML file",
|
|
174
|
+
use_case: "file_based",
|
|
175
|
+
},
|
|
176
|
+
],
|
|
177
|
+
confirmationRequired: false,
|
|
178
|
+
parameterExamples: {
|
|
179
|
+
namespace: "Value",
|
|
180
|
+
},
|
|
181
|
+
validationRules: {},
|
|
182
|
+
operationMetadata: {
|
|
183
|
+
common_errors: [
|
|
184
|
+
{
|
|
185
|
+
code: 401,
|
|
186
|
+
message: "Authentication required",
|
|
187
|
+
solution: "Provide valid API credentials",
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
code: 403,
|
|
191
|
+
message: "Permission denied",
|
|
192
|
+
solution: "Check access permissions for this operation",
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
code: 404,
|
|
196
|
+
message: "Resource not found",
|
|
197
|
+
solution: "Verify resource name, namespace, and path",
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
code: 409,
|
|
201
|
+
message: "Resource already exists",
|
|
202
|
+
solution: "Use different name or update existing resource",
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
code: 429,
|
|
206
|
+
message: "Rate limit exceeded",
|
|
207
|
+
solution: "Wait before retrying the operation",
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
code: 500,
|
|
211
|
+
message: "Server error",
|
|
212
|
+
solution: "Retry operation or contact support",
|
|
213
|
+
},
|
|
214
|
+
],
|
|
215
|
+
conditions: {
|
|
216
|
+
postconditions: ["Aggregation resource created", "Resource assigned unique identifier"],
|
|
217
|
+
prerequisites: ["Active namespace"],
|
|
218
|
+
},
|
|
219
|
+
confirmation_required: false,
|
|
220
|
+
danger_level: "medium",
|
|
221
|
+
examples: [
|
|
222
|
+
{
|
|
223
|
+
command: "f5xcctl cdn aggregation create {name} --namespace {namespace}",
|
|
224
|
+
description: "Create aggregation",
|
|
225
|
+
use_case: "basic_create",
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
command: "f5xcctl cdn aggregation create -f {file}.yaml",
|
|
229
|
+
description: "Create from YAML file",
|
|
230
|
+
use_case: "file_based",
|
|
231
|
+
},
|
|
232
|
+
],
|
|
233
|
+
field_docs: {},
|
|
234
|
+
optional_fields: [],
|
|
235
|
+
performance_impact: {
|
|
236
|
+
latency: "low",
|
|
237
|
+
resource_usage: "low",
|
|
238
|
+
},
|
|
239
|
+
purpose: "Create new aggregation",
|
|
240
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
241
|
+
side_effects: {
|
|
242
|
+
creates: ["aggregation"],
|
|
243
|
+
},
|
|
244
|
+
},
|
|
69
245
|
},
|
|
70
246
|
{
|
|
71
247
|
toolName: "f5xc-api-cdn-cache-purge-create",
|
|
@@ -85,6 +261,8 @@ export const cdnTools = [
|
|
|
85
261
|
schema: {
|
|
86
262
|
type: "string",
|
|
87
263
|
},
|
|
264
|
+
"x-displayname": "Name of the CDN distrubition.",
|
|
265
|
+
"x-ves-example": "CDN-1",
|
|
88
266
|
},
|
|
89
267
|
{
|
|
90
268
|
description: "Namespace\nx-required\nNamespace scope of the metric request.",
|
|
@@ -94,6 +272,8 @@ export const cdnTools = [
|
|
|
94
272
|
schema: {
|
|
95
273
|
type: "string",
|
|
96
274
|
},
|
|
275
|
+
"x-displayname": "Namespace",
|
|
276
|
+
"x-ves-example": "Default",
|
|
97
277
|
},
|
|
98
278
|
],
|
|
99
279
|
queryParameters: [],
|
|
@@ -107,6 +287,93 @@ export const cdnTools = [
|
|
|
107
287
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNCachePurge",
|
|
108
288
|
tags: ["CDN"],
|
|
109
289
|
sourceFile: "domains/cdn.json",
|
|
290
|
+
displayName: null,
|
|
291
|
+
dangerLevel: "medium",
|
|
292
|
+
sideEffects: {
|
|
293
|
+
creates: ["cache-purge"],
|
|
294
|
+
},
|
|
295
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
296
|
+
cliExamples: [
|
|
297
|
+
{
|
|
298
|
+
command: "f5xcctl cdn cache-purge create {name} --namespace {namespace}",
|
|
299
|
+
description: "Create cache-purge",
|
|
300
|
+
use_case: "basic_create",
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
command: "f5xcctl cdn cache-purge create -f {file}.yaml",
|
|
304
|
+
description: "Create from YAML file",
|
|
305
|
+
use_case: "file_based",
|
|
306
|
+
},
|
|
307
|
+
],
|
|
308
|
+
confirmationRequired: false,
|
|
309
|
+
parameterExamples: {
|
|
310
|
+
name: "CDN-1",
|
|
311
|
+
namespace: "Default",
|
|
312
|
+
},
|
|
313
|
+
validationRules: {},
|
|
314
|
+
operationMetadata: {
|
|
315
|
+
common_errors: [
|
|
316
|
+
{
|
|
317
|
+
code: 401,
|
|
318
|
+
message: "Authentication required",
|
|
319
|
+
solution: "Provide valid API credentials",
|
|
320
|
+
},
|
|
321
|
+
{
|
|
322
|
+
code: 403,
|
|
323
|
+
message: "Permission denied",
|
|
324
|
+
solution: "Check access permissions for this operation",
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
code: 404,
|
|
328
|
+
message: "Resource not found",
|
|
329
|
+
solution: "Verify resource name, namespace, and path",
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
code: 409,
|
|
333
|
+
message: "Resource already exists",
|
|
334
|
+
solution: "Use different name or update existing resource",
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
code: 429,
|
|
338
|
+
message: "Rate limit exceeded",
|
|
339
|
+
solution: "Wait before retrying the operation",
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
code: 500,
|
|
343
|
+
message: "Server error",
|
|
344
|
+
solution: "Retry operation or contact support",
|
|
345
|
+
},
|
|
346
|
+
],
|
|
347
|
+
conditions: {
|
|
348
|
+
postconditions: ["Cache-purge resource created", "Resource assigned unique identifier"],
|
|
349
|
+
prerequisites: ["Active namespace"],
|
|
350
|
+
},
|
|
351
|
+
confirmation_required: false,
|
|
352
|
+
danger_level: "medium",
|
|
353
|
+
examples: [
|
|
354
|
+
{
|
|
355
|
+
command: "f5xcctl cdn cache-purge create {name} --namespace {namespace}",
|
|
356
|
+
description: "Create cache-purge",
|
|
357
|
+
use_case: "basic_create",
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
command: "f5xcctl cdn cache-purge create -f {file}.yaml",
|
|
361
|
+
description: "Create from YAML file",
|
|
362
|
+
use_case: "file_based",
|
|
363
|
+
},
|
|
364
|
+
],
|
|
365
|
+
field_docs: {},
|
|
366
|
+
optional_fields: [],
|
|
367
|
+
performance_impact: {
|
|
368
|
+
latency: "low",
|
|
369
|
+
resource_usage: "low",
|
|
370
|
+
},
|
|
371
|
+
purpose: "Create new cache-purge",
|
|
372
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
373
|
+
side_effects: {
|
|
374
|
+
creates: ["cache-purge"],
|
|
375
|
+
},
|
|
376
|
+
},
|
|
110
377
|
},
|
|
111
378
|
{
|
|
112
379
|
toolName: "f5xc-api-cdn-cdn-cache-rule-create",
|
|
@@ -126,6 +393,8 @@ export const cdnTools = [
|
|
|
126
393
|
schema: {
|
|
127
394
|
type: "string",
|
|
128
395
|
},
|
|
396
|
+
"x-displayname": "Namespace",
|
|
397
|
+
"x-ves-example": "Staging",
|
|
129
398
|
},
|
|
130
399
|
],
|
|
131
400
|
queryParameters: [],
|
|
@@ -139,6 +408,92 @@ export const cdnTools = [
|
|
|
139
408
|
operationId: "ves.io.schema.cdn_cache_rule.API.Create",
|
|
140
409
|
tags: ["Other"],
|
|
141
410
|
sourceFile: "domains/cdn.json",
|
|
411
|
+
displayName: null,
|
|
412
|
+
dangerLevel: "medium",
|
|
413
|
+
sideEffects: {
|
|
414
|
+
creates: ["cdn-cache-rule"],
|
|
415
|
+
},
|
|
416
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
417
|
+
cliExamples: [
|
|
418
|
+
{
|
|
419
|
+
command: "f5xcctl config cdn-cache-rule create {name} --namespace {namespace}",
|
|
420
|
+
description: "Create cdn-cache-rule",
|
|
421
|
+
use_case: "basic_create",
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
command: "f5xcctl config cdn-cache-rule create -f {file}.yaml",
|
|
425
|
+
description: "Create from YAML file",
|
|
426
|
+
use_case: "file_based",
|
|
427
|
+
},
|
|
428
|
+
],
|
|
429
|
+
confirmationRequired: false,
|
|
430
|
+
parameterExamples: {
|
|
431
|
+
"metadata.namespace": "Staging",
|
|
432
|
+
},
|
|
433
|
+
validationRules: {},
|
|
434
|
+
operationMetadata: {
|
|
435
|
+
common_errors: [
|
|
436
|
+
{
|
|
437
|
+
code: 401,
|
|
438
|
+
message: "Authentication required",
|
|
439
|
+
solution: "Provide valid API credentials",
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
code: 403,
|
|
443
|
+
message: "Permission denied",
|
|
444
|
+
solution: "Check access permissions for this operation",
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
code: 404,
|
|
448
|
+
message: "Resource not found",
|
|
449
|
+
solution: "Verify resource name, namespace, and path",
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
code: 409,
|
|
453
|
+
message: "Resource already exists",
|
|
454
|
+
solution: "Use different name or update existing resource",
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
code: 429,
|
|
458
|
+
message: "Rate limit exceeded",
|
|
459
|
+
solution: "Wait before retrying the operation",
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
code: 500,
|
|
463
|
+
message: "Server error",
|
|
464
|
+
solution: "Retry operation or contact support",
|
|
465
|
+
},
|
|
466
|
+
],
|
|
467
|
+
conditions: {
|
|
468
|
+
postconditions: ["Cdn-cache-rule resource created", "Resource assigned unique identifier"],
|
|
469
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
470
|
+
},
|
|
471
|
+
confirmation_required: false,
|
|
472
|
+
danger_level: "medium",
|
|
473
|
+
examples: [
|
|
474
|
+
{
|
|
475
|
+
command: "f5xcctl config cdn-cache-rule create {name} --namespace {namespace}",
|
|
476
|
+
description: "Create cdn-cache-rule",
|
|
477
|
+
use_case: "basic_create",
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
command: "f5xcctl config cdn-cache-rule create -f {file}.yaml",
|
|
481
|
+
description: "Create from YAML file",
|
|
482
|
+
use_case: "file_based",
|
|
483
|
+
},
|
|
484
|
+
],
|
|
485
|
+
field_docs: {},
|
|
486
|
+
optional_fields: [],
|
|
487
|
+
performance_impact: {
|
|
488
|
+
latency: "low",
|
|
489
|
+
resource_usage: "low",
|
|
490
|
+
},
|
|
491
|
+
purpose: "Create new cdn-cache-rule",
|
|
492
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
493
|
+
side_effects: {
|
|
494
|
+
creates: ["cdn-cache-rule"],
|
|
495
|
+
},
|
|
496
|
+
},
|
|
142
497
|
},
|
|
143
498
|
{
|
|
144
499
|
toolName: "f5xc-api-cdn-cdn-cache-rule-delete",
|
|
@@ -158,6 +513,8 @@ export const cdnTools = [
|
|
|
158
513
|
schema: {
|
|
159
514
|
type: "string",
|
|
160
515
|
},
|
|
516
|
+
"x-displayname": "Name",
|
|
517
|
+
"x-ves-example": "Name",
|
|
161
518
|
},
|
|
162
519
|
{
|
|
163
520
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -167,6 +524,8 @@ export const cdnTools = [
|
|
|
167
524
|
schema: {
|
|
168
525
|
type: "string",
|
|
169
526
|
},
|
|
527
|
+
"x-displayname": "Namespace",
|
|
528
|
+
"x-ves-example": "Ns1",
|
|
170
529
|
},
|
|
171
530
|
],
|
|
172
531
|
queryParameters: [],
|
|
@@ -178,6 +537,83 @@ export const cdnTools = [
|
|
|
178
537
|
operationId: "ves.io.schema.cdn_cache_rule.API.Delete",
|
|
179
538
|
tags: ["Other"],
|
|
180
539
|
sourceFile: "domains/cdn.json",
|
|
540
|
+
displayName: null,
|
|
541
|
+
dangerLevel: "high",
|
|
542
|
+
sideEffects: {
|
|
543
|
+
deletes: ["cdn-cache-rule", "contained_resources"],
|
|
544
|
+
},
|
|
545
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
546
|
+
cliExamples: [
|
|
547
|
+
{
|
|
548
|
+
command: "f5xcctl config cdn-cache-rule delete {name} --namespace {namespace}",
|
|
549
|
+
description: "Delete cdn-cache-rule",
|
|
550
|
+
use_case: "delete",
|
|
551
|
+
},
|
|
552
|
+
],
|
|
553
|
+
confirmationRequired: true,
|
|
554
|
+
parameterExamples: {
|
|
555
|
+
name: "Name",
|
|
556
|
+
namespace: "Ns1",
|
|
557
|
+
},
|
|
558
|
+
validationRules: {},
|
|
559
|
+
operationMetadata: {
|
|
560
|
+
common_errors: [
|
|
561
|
+
{
|
|
562
|
+
code: 401,
|
|
563
|
+
message: "Authentication required",
|
|
564
|
+
solution: "Provide valid API credentials",
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
code: 403,
|
|
568
|
+
message: "Permission denied",
|
|
569
|
+
solution: "Check access permissions for this operation",
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
code: 404,
|
|
573
|
+
message: "Resource not found",
|
|
574
|
+
solution: "Verify resource name, namespace, and path",
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
code: 409,
|
|
578
|
+
message: "Resource already exists",
|
|
579
|
+
solution: "Use different name or update existing resource",
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
code: 429,
|
|
583
|
+
message: "Rate limit exceeded",
|
|
584
|
+
solution: "Wait before retrying the operation",
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
code: 500,
|
|
588
|
+
message: "Server error",
|
|
589
|
+
solution: "Retry operation or contact support",
|
|
590
|
+
},
|
|
591
|
+
],
|
|
592
|
+
conditions: {
|
|
593
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
594
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
595
|
+
},
|
|
596
|
+
confirmation_required: true,
|
|
597
|
+
danger_level: "high",
|
|
598
|
+
examples: [
|
|
599
|
+
{
|
|
600
|
+
command: "f5xcctl config cdn-cache-rule delete {name} --namespace {namespace}",
|
|
601
|
+
description: "Delete cdn-cache-rule",
|
|
602
|
+
use_case: "delete",
|
|
603
|
+
},
|
|
604
|
+
],
|
|
605
|
+
field_docs: {},
|
|
606
|
+
optional_fields: [],
|
|
607
|
+
performance_impact: {
|
|
608
|
+
latency: "high",
|
|
609
|
+
resource_usage: "moderate",
|
|
610
|
+
},
|
|
611
|
+
purpose: "Delete cdn-cache-rule",
|
|
612
|
+
required_fields: ["path.name", "path.namespace"],
|
|
613
|
+
side_effects: {
|
|
614
|
+
deletes: ["cdn-cache-rule", "contained_resources"],
|
|
615
|
+
},
|
|
616
|
+
},
|
|
181
617
|
},
|
|
182
618
|
{
|
|
183
619
|
toolName: "f5xc-api-cdn-cdn-cache-rule-get",
|
|
@@ -197,6 +633,8 @@ export const cdnTools = [
|
|
|
197
633
|
schema: {
|
|
198
634
|
type: "string",
|
|
199
635
|
},
|
|
636
|
+
"x-displayname": "Name",
|
|
637
|
+
"x-ves-example": "Name",
|
|
200
638
|
},
|
|
201
639
|
{
|
|
202
640
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -206,6 +644,8 @@ export const cdnTools = [
|
|
|
206
644
|
schema: {
|
|
207
645
|
type: "string",
|
|
208
646
|
},
|
|
647
|
+
"x-displayname": "Namespace",
|
|
648
|
+
"x-ves-example": "Ns1",
|
|
209
649
|
},
|
|
210
650
|
],
|
|
211
651
|
queryParameters: [
|
|
@@ -226,6 +666,7 @@ export const cdnTools = [
|
|
|
226
666
|
],
|
|
227
667
|
type: "string",
|
|
228
668
|
},
|
|
669
|
+
"x-displayname": "Broken Referred Objects.",
|
|
229
670
|
},
|
|
230
671
|
],
|
|
231
672
|
requestBodySchema: null,
|
|
@@ -236,6 +677,79 @@ export const cdnTools = [
|
|
|
236
677
|
operationId: "ves.io.schema.cdn_cache_rule.API.Get",
|
|
237
678
|
tags: ["Other"],
|
|
238
679
|
sourceFile: "domains/cdn.json",
|
|
680
|
+
displayName: null,
|
|
681
|
+
dangerLevel: "low",
|
|
682
|
+
sideEffects: null,
|
|
683
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
684
|
+
cliExamples: [
|
|
685
|
+
{
|
|
686
|
+
command: "f5xcctl config cdn-cache-rule get {name} --namespace {namespace}",
|
|
687
|
+
description: "Get specific cdn-cache-rule",
|
|
688
|
+
use_case: "get_specific",
|
|
689
|
+
},
|
|
690
|
+
],
|
|
691
|
+
confirmationRequired: false,
|
|
692
|
+
parameterExamples: {
|
|
693
|
+
name: "Name",
|
|
694
|
+
namespace: "Ns1",
|
|
695
|
+
},
|
|
696
|
+
validationRules: {},
|
|
697
|
+
operationMetadata: {
|
|
698
|
+
common_errors: [
|
|
699
|
+
{
|
|
700
|
+
code: 401,
|
|
701
|
+
message: "Authentication required",
|
|
702
|
+
solution: "Provide valid API credentials",
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
code: 403,
|
|
706
|
+
message: "Permission denied",
|
|
707
|
+
solution: "Check access permissions for this operation",
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
code: 404,
|
|
711
|
+
message: "Resource not found",
|
|
712
|
+
solution: "Verify resource name, namespace, and path",
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
code: 409,
|
|
716
|
+
message: "Resource already exists",
|
|
717
|
+
solution: "Use different name or update existing resource",
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
code: 429,
|
|
721
|
+
message: "Rate limit exceeded",
|
|
722
|
+
solution: "Wait before retrying the operation",
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
code: 500,
|
|
726
|
+
message: "Server error",
|
|
727
|
+
solution: "Retry operation or contact support",
|
|
728
|
+
},
|
|
729
|
+
],
|
|
730
|
+
conditions: {
|
|
731
|
+
postconditions: [],
|
|
732
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
733
|
+
},
|
|
734
|
+
confirmation_required: false,
|
|
735
|
+
danger_level: "low",
|
|
736
|
+
examples: [
|
|
737
|
+
{
|
|
738
|
+
command: "f5xcctl config cdn-cache-rule get {name} --namespace {namespace}",
|
|
739
|
+
description: "Get specific cdn-cache-rule",
|
|
740
|
+
use_case: "get_specific",
|
|
741
|
+
},
|
|
742
|
+
],
|
|
743
|
+
field_docs: {},
|
|
744
|
+
optional_fields: [],
|
|
745
|
+
performance_impact: {
|
|
746
|
+
latency: "low",
|
|
747
|
+
resource_usage: "low",
|
|
748
|
+
},
|
|
749
|
+
purpose: "Retrieve specific cdn-cache-rule",
|
|
750
|
+
required_fields: ["path.name", "path.namespace"],
|
|
751
|
+
side_effects: {},
|
|
752
|
+
},
|
|
239
753
|
},
|
|
240
754
|
{
|
|
241
755
|
toolName: "f5xc-api-cdn-cdn-cache-rule-list",
|
|
@@ -255,6 +769,8 @@ export const cdnTools = [
|
|
|
255
769
|
schema: {
|
|
256
770
|
type: "string",
|
|
257
771
|
},
|
|
772
|
+
"x-displayname": "Namespace",
|
|
773
|
+
"x-ves-example": "Ns1",
|
|
258
774
|
},
|
|
259
775
|
],
|
|
260
776
|
queryParameters: [
|
|
@@ -266,6 +782,8 @@ export const cdnTools = [
|
|
|
266
782
|
schema: {
|
|
267
783
|
type: "string",
|
|
268
784
|
},
|
|
785
|
+
"x-displayname": "Label Filter.",
|
|
786
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
269
787
|
},
|
|
270
788
|
{
|
|
271
789
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -278,6 +796,7 @@ export const cdnTools = [
|
|
|
278
796
|
},
|
|
279
797
|
type: "array",
|
|
280
798
|
},
|
|
799
|
+
"x-displayname": "Report Fields.",
|
|
281
800
|
},
|
|
282
801
|
{
|
|
283
802
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -290,6 +809,7 @@ export const cdnTools = [
|
|
|
290
809
|
},
|
|
291
810
|
type: "array",
|
|
292
811
|
},
|
|
812
|
+
"x-displayname": "Report Status Fields.",
|
|
293
813
|
},
|
|
294
814
|
],
|
|
295
815
|
requestBodySchema: null,
|
|
@@ -300,6 +820,79 @@ export const cdnTools = [
|
|
|
300
820
|
operationId: "ves.io.schema.cdn_cache_rule.API.List",
|
|
301
821
|
tags: ["Other"],
|
|
302
822
|
sourceFile: "domains/cdn.json",
|
|
823
|
+
displayName: null,
|
|
824
|
+
dangerLevel: "low",
|
|
825
|
+
sideEffects: null,
|
|
826
|
+
requiredFields: ["path.namespace"],
|
|
827
|
+
cliExamples: [
|
|
828
|
+
{
|
|
829
|
+
command: "f5xcctl config cdn-cache-rule list --namespace {namespace}",
|
|
830
|
+
description: "List all cdn-cache-rules",
|
|
831
|
+
use_case: "list_all",
|
|
832
|
+
},
|
|
833
|
+
],
|
|
834
|
+
confirmationRequired: false,
|
|
835
|
+
parameterExamples: {
|
|
836
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
837
|
+
namespace: "Ns1",
|
|
838
|
+
},
|
|
839
|
+
validationRules: {},
|
|
840
|
+
operationMetadata: {
|
|
841
|
+
common_errors: [
|
|
842
|
+
{
|
|
843
|
+
code: 401,
|
|
844
|
+
message: "Authentication required",
|
|
845
|
+
solution: "Provide valid API credentials",
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
code: 403,
|
|
849
|
+
message: "Permission denied",
|
|
850
|
+
solution: "Check access permissions for this operation",
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
code: 404,
|
|
854
|
+
message: "Resource not found",
|
|
855
|
+
solution: "Verify resource name, namespace, and path",
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
code: 409,
|
|
859
|
+
message: "Resource already exists",
|
|
860
|
+
solution: "Use different name or update existing resource",
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
code: 429,
|
|
864
|
+
message: "Rate limit exceeded",
|
|
865
|
+
solution: "Wait before retrying the operation",
|
|
866
|
+
},
|
|
867
|
+
{
|
|
868
|
+
code: 500,
|
|
869
|
+
message: "Server error",
|
|
870
|
+
solution: "Retry operation or contact support",
|
|
871
|
+
},
|
|
872
|
+
],
|
|
873
|
+
conditions: {
|
|
874
|
+
postconditions: [],
|
|
875
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
876
|
+
},
|
|
877
|
+
confirmation_required: false,
|
|
878
|
+
danger_level: "low",
|
|
879
|
+
examples: [
|
|
880
|
+
{
|
|
881
|
+
command: "f5xcctl config cdn-cache-rule list --namespace {namespace}",
|
|
882
|
+
description: "List all cdn-cache-rules",
|
|
883
|
+
use_case: "list_all",
|
|
884
|
+
},
|
|
885
|
+
],
|
|
886
|
+
field_docs: {},
|
|
887
|
+
optional_fields: [],
|
|
888
|
+
performance_impact: {
|
|
889
|
+
latency: "moderate",
|
|
890
|
+
resource_usage: "moderate",
|
|
891
|
+
},
|
|
892
|
+
purpose: "List all cdn-cache-rules",
|
|
893
|
+
required_fields: ["path.namespace"],
|
|
894
|
+
side_effects: {},
|
|
895
|
+
},
|
|
303
896
|
},
|
|
304
897
|
{
|
|
305
898
|
toolName: "f5xc-api-cdn-cdn-cache-rule-update",
|
|
@@ -319,6 +912,8 @@ export const cdnTools = [
|
|
|
319
912
|
schema: {
|
|
320
913
|
type: "string",
|
|
321
914
|
},
|
|
915
|
+
"x-displayname": "Name",
|
|
916
|
+
"x-ves-example": "Example-corp-web.",
|
|
322
917
|
},
|
|
323
918
|
{
|
|
324
919
|
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
@@ -328,6 +923,8 @@ export const cdnTools = [
|
|
|
328
923
|
schema: {
|
|
329
924
|
type: "string",
|
|
330
925
|
},
|
|
926
|
+
"x-displayname": "Namespace",
|
|
927
|
+
"x-ves-example": "Staging",
|
|
331
928
|
},
|
|
332
929
|
],
|
|
333
930
|
queryParameters: [],
|
|
@@ -341,6 +938,83 @@ export const cdnTools = [
|
|
|
341
938
|
operationId: "ves.io.schema.cdn_cache_rule.API.Replace",
|
|
342
939
|
tags: ["Other"],
|
|
343
940
|
sourceFile: "domains/cdn.json",
|
|
941
|
+
displayName: null,
|
|
942
|
+
dangerLevel: "medium",
|
|
943
|
+
sideEffects: {
|
|
944
|
+
modifies: ["cdn-cache-rule"],
|
|
945
|
+
},
|
|
946
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
947
|
+
cliExamples: [
|
|
948
|
+
{
|
|
949
|
+
command: "f5xcctl config cdn-cache-rule update {name} --namespace {namespace} -f {file}.yaml",
|
|
950
|
+
description: "Update cdn-cache-rule",
|
|
951
|
+
use_case: "update",
|
|
952
|
+
},
|
|
953
|
+
],
|
|
954
|
+
confirmationRequired: false,
|
|
955
|
+
parameterExamples: {
|
|
956
|
+
"metadata.name": "Example-corp-web.",
|
|
957
|
+
"metadata.namespace": "Staging",
|
|
958
|
+
},
|
|
959
|
+
validationRules: {},
|
|
960
|
+
operationMetadata: {
|
|
961
|
+
common_errors: [
|
|
962
|
+
{
|
|
963
|
+
code: 401,
|
|
964
|
+
message: "Authentication required",
|
|
965
|
+
solution: "Provide valid API credentials",
|
|
966
|
+
},
|
|
967
|
+
{
|
|
968
|
+
code: 403,
|
|
969
|
+
message: "Permission denied",
|
|
970
|
+
solution: "Check access permissions for this operation",
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
code: 404,
|
|
974
|
+
message: "Resource not found",
|
|
975
|
+
solution: "Verify resource name, namespace, and path",
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
code: 409,
|
|
979
|
+
message: "Resource already exists",
|
|
980
|
+
solution: "Use different name or update existing resource",
|
|
981
|
+
},
|
|
982
|
+
{
|
|
983
|
+
code: 429,
|
|
984
|
+
message: "Rate limit exceeded",
|
|
985
|
+
solution: "Wait before retrying the operation",
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
code: 500,
|
|
989
|
+
message: "Server error",
|
|
990
|
+
solution: "Retry operation or contact support",
|
|
991
|
+
},
|
|
992
|
+
],
|
|
993
|
+
conditions: {
|
|
994
|
+
postconditions: ["Resource updated with new values"],
|
|
995
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
996
|
+
},
|
|
997
|
+
confirmation_required: false,
|
|
998
|
+
danger_level: "medium",
|
|
999
|
+
examples: [
|
|
1000
|
+
{
|
|
1001
|
+
command: "f5xcctl config cdn-cache-rule update {name} --namespace {namespace} -f {file}.yaml",
|
|
1002
|
+
description: "Update cdn-cache-rule",
|
|
1003
|
+
use_case: "update",
|
|
1004
|
+
},
|
|
1005
|
+
],
|
|
1006
|
+
field_docs: {},
|
|
1007
|
+
optional_fields: [],
|
|
1008
|
+
performance_impact: {
|
|
1009
|
+
latency: "low",
|
|
1010
|
+
resource_usage: "low",
|
|
1011
|
+
},
|
|
1012
|
+
purpose: "Replace existing cdn-cache-rule",
|
|
1013
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1014
|
+
side_effects: {
|
|
1015
|
+
modifies: ["cdn-cache-rule"],
|
|
1016
|
+
},
|
|
1017
|
+
},
|
|
344
1018
|
},
|
|
345
1019
|
{
|
|
346
1020
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-create",
|
|
@@ -360,6 +1034,8 @@ export const cdnTools = [
|
|
|
360
1034
|
schema: {
|
|
361
1035
|
type: "string",
|
|
362
1036
|
},
|
|
1037
|
+
"x-displayname": "Namespace",
|
|
1038
|
+
"x-ves-example": "Staging",
|
|
363
1039
|
},
|
|
364
1040
|
],
|
|
365
1041
|
queryParameters: [],
|
|
@@ -373,6 +1049,95 @@ export const cdnTools = [
|
|
|
373
1049
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Create",
|
|
374
1050
|
tags: ["Other"],
|
|
375
1051
|
sourceFile: "domains/cdn.json",
|
|
1052
|
+
displayName: null,
|
|
1053
|
+
dangerLevel: "medium",
|
|
1054
|
+
sideEffects: {
|
|
1055
|
+
creates: ["cdn-loadbalancer"],
|
|
1056
|
+
},
|
|
1057
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1058
|
+
cliExamples: [
|
|
1059
|
+
{
|
|
1060
|
+
command: "f5xcctl config cdn-loadbalancer create {name} --namespace {namespace}",
|
|
1061
|
+
description: "Create cdn-loadbalancer",
|
|
1062
|
+
use_case: "basic_create",
|
|
1063
|
+
},
|
|
1064
|
+
{
|
|
1065
|
+
command: "f5xcctl config cdn-loadbalancer create -f {file}.yaml",
|
|
1066
|
+
description: "Create from YAML file",
|
|
1067
|
+
use_case: "file_based",
|
|
1068
|
+
},
|
|
1069
|
+
],
|
|
1070
|
+
confirmationRequired: false,
|
|
1071
|
+
parameterExamples: {
|
|
1072
|
+
"metadata.namespace": "Staging",
|
|
1073
|
+
},
|
|
1074
|
+
validationRules: {},
|
|
1075
|
+
operationMetadata: {
|
|
1076
|
+
common_errors: [
|
|
1077
|
+
{
|
|
1078
|
+
code: 401,
|
|
1079
|
+
message: "Authentication required",
|
|
1080
|
+
solution: "Provide valid API credentials",
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
code: 403,
|
|
1084
|
+
message: "Permission denied",
|
|
1085
|
+
solution: "Check access permissions for this operation",
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
code: 404,
|
|
1089
|
+
message: "Resource not found",
|
|
1090
|
+
solution: "Verify resource name, namespace, and path",
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
code: 409,
|
|
1094
|
+
message: "Resource already exists",
|
|
1095
|
+
solution: "Use different name or update existing resource",
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
code: 429,
|
|
1099
|
+
message: "Rate limit exceeded",
|
|
1100
|
+
solution: "Wait before retrying the operation",
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
code: 500,
|
|
1104
|
+
message: "Server error",
|
|
1105
|
+
solution: "Retry operation or contact support",
|
|
1106
|
+
},
|
|
1107
|
+
],
|
|
1108
|
+
conditions: {
|
|
1109
|
+
postconditions: [
|
|
1110
|
+
"Cdn-loadbalancer resource created",
|
|
1111
|
+
"Resource assigned unique identifier",
|
|
1112
|
+
],
|
|
1113
|
+
prerequisites: ["Active namespace"],
|
|
1114
|
+
},
|
|
1115
|
+
confirmation_required: false,
|
|
1116
|
+
danger_level: "medium",
|
|
1117
|
+
examples: [
|
|
1118
|
+
{
|
|
1119
|
+
command: "f5xcctl config cdn-loadbalancer create {name} --namespace {namespace}",
|
|
1120
|
+
description: "Create cdn-loadbalancer",
|
|
1121
|
+
use_case: "basic_create",
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
command: "f5xcctl config cdn-loadbalancer create -f {file}.yaml",
|
|
1125
|
+
description: "Create from YAML file",
|
|
1126
|
+
use_case: "file_based",
|
|
1127
|
+
},
|
|
1128
|
+
],
|
|
1129
|
+
field_docs: {},
|
|
1130
|
+
optional_fields: [],
|
|
1131
|
+
performance_impact: {
|
|
1132
|
+
latency: "low",
|
|
1133
|
+
resource_usage: "low",
|
|
1134
|
+
},
|
|
1135
|
+
purpose: "Create new cdn-loadbalancer",
|
|
1136
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1137
|
+
side_effects: {
|
|
1138
|
+
creates: ["cdn-loadbalancer"],
|
|
1139
|
+
},
|
|
1140
|
+
},
|
|
376
1141
|
},
|
|
377
1142
|
{
|
|
378
1143
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-delete",
|
|
@@ -392,6 +1157,8 @@ export const cdnTools = [
|
|
|
392
1157
|
schema: {
|
|
393
1158
|
type: "string",
|
|
394
1159
|
},
|
|
1160
|
+
"x-displayname": "Name",
|
|
1161
|
+
"x-ves-example": "Name",
|
|
395
1162
|
},
|
|
396
1163
|
{
|
|
397
1164
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -401,6 +1168,8 @@ export const cdnTools = [
|
|
|
401
1168
|
schema: {
|
|
402
1169
|
type: "string",
|
|
403
1170
|
},
|
|
1171
|
+
"x-displayname": "Namespace",
|
|
1172
|
+
"x-ves-example": "Ns1",
|
|
404
1173
|
},
|
|
405
1174
|
],
|
|
406
1175
|
queryParameters: [],
|
|
@@ -412,6 +1181,83 @@ export const cdnTools = [
|
|
|
412
1181
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Delete",
|
|
413
1182
|
tags: ["Other"],
|
|
414
1183
|
sourceFile: "domains/cdn.json",
|
|
1184
|
+
displayName: null,
|
|
1185
|
+
dangerLevel: "high",
|
|
1186
|
+
sideEffects: {
|
|
1187
|
+
deletes: ["cdn-loadbalancer", "contained_resources"],
|
|
1188
|
+
},
|
|
1189
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1190
|
+
cliExamples: [
|
|
1191
|
+
{
|
|
1192
|
+
command: "f5xcctl config cdn-loadbalancer delete {name} --namespace {namespace}",
|
|
1193
|
+
description: "Delete cdn-loadbalancer",
|
|
1194
|
+
use_case: "delete",
|
|
1195
|
+
},
|
|
1196
|
+
],
|
|
1197
|
+
confirmationRequired: true,
|
|
1198
|
+
parameterExamples: {
|
|
1199
|
+
name: "Name",
|
|
1200
|
+
namespace: "Ns1",
|
|
1201
|
+
},
|
|
1202
|
+
validationRules: {},
|
|
1203
|
+
operationMetadata: {
|
|
1204
|
+
common_errors: [
|
|
1205
|
+
{
|
|
1206
|
+
code: 401,
|
|
1207
|
+
message: "Authentication required",
|
|
1208
|
+
solution: "Provide valid API credentials",
|
|
1209
|
+
},
|
|
1210
|
+
{
|
|
1211
|
+
code: 403,
|
|
1212
|
+
message: "Permission denied",
|
|
1213
|
+
solution: "Check access permissions for this operation",
|
|
1214
|
+
},
|
|
1215
|
+
{
|
|
1216
|
+
code: 404,
|
|
1217
|
+
message: "Resource not found",
|
|
1218
|
+
solution: "Verify resource name, namespace, and path",
|
|
1219
|
+
},
|
|
1220
|
+
{
|
|
1221
|
+
code: 409,
|
|
1222
|
+
message: "Resource already exists",
|
|
1223
|
+
solution: "Use different name or update existing resource",
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
code: 429,
|
|
1227
|
+
message: "Rate limit exceeded",
|
|
1228
|
+
solution: "Wait before retrying the operation",
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
code: 500,
|
|
1232
|
+
message: "Server error",
|
|
1233
|
+
solution: "Retry operation or contact support",
|
|
1234
|
+
},
|
|
1235
|
+
],
|
|
1236
|
+
conditions: {
|
|
1237
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1238
|
+
prerequisites: ["Active namespace"],
|
|
1239
|
+
},
|
|
1240
|
+
confirmation_required: true,
|
|
1241
|
+
danger_level: "high",
|
|
1242
|
+
examples: [
|
|
1243
|
+
{
|
|
1244
|
+
command: "f5xcctl config cdn-loadbalancer delete {name} --namespace {namespace}",
|
|
1245
|
+
description: "Delete cdn-loadbalancer",
|
|
1246
|
+
use_case: "delete",
|
|
1247
|
+
},
|
|
1248
|
+
],
|
|
1249
|
+
field_docs: {},
|
|
1250
|
+
optional_fields: [],
|
|
1251
|
+
performance_impact: {
|
|
1252
|
+
latency: "high",
|
|
1253
|
+
resource_usage: "moderate",
|
|
1254
|
+
},
|
|
1255
|
+
purpose: "Delete cdn-loadbalancer",
|
|
1256
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1257
|
+
side_effects: {
|
|
1258
|
+
deletes: ["cdn-loadbalancer", "contained_resources"],
|
|
1259
|
+
},
|
|
1260
|
+
},
|
|
415
1261
|
},
|
|
416
1262
|
{
|
|
417
1263
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-get",
|
|
@@ -431,6 +1277,8 @@ export const cdnTools = [
|
|
|
431
1277
|
schema: {
|
|
432
1278
|
type: "string",
|
|
433
1279
|
},
|
|
1280
|
+
"x-displayname": "Name",
|
|
1281
|
+
"x-ves-example": "Name",
|
|
434
1282
|
},
|
|
435
1283
|
{
|
|
436
1284
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -440,6 +1288,8 @@ export const cdnTools = [
|
|
|
440
1288
|
schema: {
|
|
441
1289
|
type: "string",
|
|
442
1290
|
},
|
|
1291
|
+
"x-displayname": "Namespace",
|
|
1292
|
+
"x-ves-example": "Ns1",
|
|
443
1293
|
},
|
|
444
1294
|
],
|
|
445
1295
|
queryParameters: [
|
|
@@ -461,6 +1311,7 @@ export const cdnTools = [
|
|
|
461
1311
|
],
|
|
462
1312
|
type: "string",
|
|
463
1313
|
},
|
|
1314
|
+
"x-displayname": "Broken Referred Objects.",
|
|
464
1315
|
},
|
|
465
1316
|
],
|
|
466
1317
|
requestBodySchema: null,
|
|
@@ -471,6 +1322,79 @@ export const cdnTools = [
|
|
|
471
1322
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Get",
|
|
472
1323
|
tags: ["Other"],
|
|
473
1324
|
sourceFile: "domains/cdn.json",
|
|
1325
|
+
displayName: null,
|
|
1326
|
+
dangerLevel: "low",
|
|
1327
|
+
sideEffects: null,
|
|
1328
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1329
|
+
cliExamples: [
|
|
1330
|
+
{
|
|
1331
|
+
command: "f5xcctl config cdn-loadbalancer get {name} --namespace {namespace}",
|
|
1332
|
+
description: "Get specific cdn-loadbalancer",
|
|
1333
|
+
use_case: "get_specific",
|
|
1334
|
+
},
|
|
1335
|
+
],
|
|
1336
|
+
confirmationRequired: false,
|
|
1337
|
+
parameterExamples: {
|
|
1338
|
+
name: "Name",
|
|
1339
|
+
namespace: "Ns1",
|
|
1340
|
+
},
|
|
1341
|
+
validationRules: {},
|
|
1342
|
+
operationMetadata: {
|
|
1343
|
+
common_errors: [
|
|
1344
|
+
{
|
|
1345
|
+
code: 401,
|
|
1346
|
+
message: "Authentication required",
|
|
1347
|
+
solution: "Provide valid API credentials",
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
code: 403,
|
|
1351
|
+
message: "Permission denied",
|
|
1352
|
+
solution: "Check access permissions for this operation",
|
|
1353
|
+
},
|
|
1354
|
+
{
|
|
1355
|
+
code: 404,
|
|
1356
|
+
message: "Resource not found",
|
|
1357
|
+
solution: "Verify resource name, namespace, and path",
|
|
1358
|
+
},
|
|
1359
|
+
{
|
|
1360
|
+
code: 409,
|
|
1361
|
+
message: "Resource already exists",
|
|
1362
|
+
solution: "Use different name or update existing resource",
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
code: 429,
|
|
1366
|
+
message: "Rate limit exceeded",
|
|
1367
|
+
solution: "Wait before retrying the operation",
|
|
1368
|
+
},
|
|
1369
|
+
{
|
|
1370
|
+
code: 500,
|
|
1371
|
+
message: "Server error",
|
|
1372
|
+
solution: "Retry operation or contact support",
|
|
1373
|
+
},
|
|
1374
|
+
],
|
|
1375
|
+
conditions: {
|
|
1376
|
+
postconditions: [],
|
|
1377
|
+
prerequisites: ["Active namespace"],
|
|
1378
|
+
},
|
|
1379
|
+
confirmation_required: false,
|
|
1380
|
+
danger_level: "low",
|
|
1381
|
+
examples: [
|
|
1382
|
+
{
|
|
1383
|
+
command: "f5xcctl config cdn-loadbalancer get {name} --namespace {namespace}",
|
|
1384
|
+
description: "Get specific cdn-loadbalancer",
|
|
1385
|
+
use_case: "get_specific",
|
|
1386
|
+
},
|
|
1387
|
+
],
|
|
1388
|
+
field_docs: {},
|
|
1389
|
+
optional_fields: [],
|
|
1390
|
+
performance_impact: {
|
|
1391
|
+
latency: "low",
|
|
1392
|
+
resource_usage: "low",
|
|
1393
|
+
},
|
|
1394
|
+
purpose: "Retrieve specific cdn-loadbalancer",
|
|
1395
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1396
|
+
side_effects: {},
|
|
1397
|
+
},
|
|
474
1398
|
},
|
|
475
1399
|
{
|
|
476
1400
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-list",
|
|
@@ -490,6 +1414,8 @@ export const cdnTools = [
|
|
|
490
1414
|
schema: {
|
|
491
1415
|
type: "string",
|
|
492
1416
|
},
|
|
1417
|
+
"x-displayname": "Namespace",
|
|
1418
|
+
"x-ves-example": "Ns1",
|
|
493
1419
|
},
|
|
494
1420
|
],
|
|
495
1421
|
queryParameters: [
|
|
@@ -501,6 +1427,8 @@ export const cdnTools = [
|
|
|
501
1427
|
schema: {
|
|
502
1428
|
type: "string",
|
|
503
1429
|
},
|
|
1430
|
+
"x-displayname": "Label Filter.",
|
|
1431
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
504
1432
|
},
|
|
505
1433
|
{
|
|
506
1434
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -513,6 +1441,7 @@ export const cdnTools = [
|
|
|
513
1441
|
},
|
|
514
1442
|
type: "array",
|
|
515
1443
|
},
|
|
1444
|
+
"x-displayname": "Report Fields.",
|
|
516
1445
|
},
|
|
517
1446
|
{
|
|
518
1447
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -525,6 +1454,7 @@ export const cdnTools = [
|
|
|
525
1454
|
},
|
|
526
1455
|
type: "array",
|
|
527
1456
|
},
|
|
1457
|
+
"x-displayname": "Report Status Fields.",
|
|
528
1458
|
},
|
|
529
1459
|
],
|
|
530
1460
|
requestBodySchema: null,
|
|
@@ -535,6 +1465,79 @@ export const cdnTools = [
|
|
|
535
1465
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.List",
|
|
536
1466
|
tags: ["Other"],
|
|
537
1467
|
sourceFile: "domains/cdn.json",
|
|
1468
|
+
displayName: null,
|
|
1469
|
+
dangerLevel: "low",
|
|
1470
|
+
sideEffects: null,
|
|
1471
|
+
requiredFields: ["path.namespace"],
|
|
1472
|
+
cliExamples: [
|
|
1473
|
+
{
|
|
1474
|
+
command: "f5xcctl config cdn-loadbalancer list --namespace {namespace}",
|
|
1475
|
+
description: "List all cdn-loadbalancers",
|
|
1476
|
+
use_case: "list_all",
|
|
1477
|
+
},
|
|
1478
|
+
],
|
|
1479
|
+
confirmationRequired: false,
|
|
1480
|
+
parameterExamples: {
|
|
1481
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1482
|
+
namespace: "Ns1",
|
|
1483
|
+
},
|
|
1484
|
+
validationRules: {},
|
|
1485
|
+
operationMetadata: {
|
|
1486
|
+
common_errors: [
|
|
1487
|
+
{
|
|
1488
|
+
code: 401,
|
|
1489
|
+
message: "Authentication required",
|
|
1490
|
+
solution: "Provide valid API credentials",
|
|
1491
|
+
},
|
|
1492
|
+
{
|
|
1493
|
+
code: 403,
|
|
1494
|
+
message: "Permission denied",
|
|
1495
|
+
solution: "Check access permissions for this operation",
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
code: 404,
|
|
1499
|
+
message: "Resource not found",
|
|
1500
|
+
solution: "Verify resource name, namespace, and path",
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
code: 409,
|
|
1504
|
+
message: "Resource already exists",
|
|
1505
|
+
solution: "Use different name or update existing resource",
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
code: 429,
|
|
1509
|
+
message: "Rate limit exceeded",
|
|
1510
|
+
solution: "Wait before retrying the operation",
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
code: 500,
|
|
1514
|
+
message: "Server error",
|
|
1515
|
+
solution: "Retry operation or contact support",
|
|
1516
|
+
},
|
|
1517
|
+
],
|
|
1518
|
+
conditions: {
|
|
1519
|
+
postconditions: [],
|
|
1520
|
+
prerequisites: ["Active namespace"],
|
|
1521
|
+
},
|
|
1522
|
+
confirmation_required: false,
|
|
1523
|
+
danger_level: "low",
|
|
1524
|
+
examples: [
|
|
1525
|
+
{
|
|
1526
|
+
command: "f5xcctl config cdn-loadbalancer list --namespace {namespace}",
|
|
1527
|
+
description: "List all cdn-loadbalancers",
|
|
1528
|
+
use_case: "list_all",
|
|
1529
|
+
},
|
|
1530
|
+
],
|
|
1531
|
+
field_docs: {},
|
|
1532
|
+
optional_fields: [],
|
|
1533
|
+
performance_impact: {
|
|
1534
|
+
latency: "moderate",
|
|
1535
|
+
resource_usage: "moderate",
|
|
1536
|
+
},
|
|
1537
|
+
purpose: "List all cdn-loadbalancers",
|
|
1538
|
+
required_fields: ["path.namespace"],
|
|
1539
|
+
side_effects: {},
|
|
1540
|
+
},
|
|
538
1541
|
},
|
|
539
1542
|
{
|
|
540
1543
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-update",
|
|
@@ -554,6 +1557,8 @@ export const cdnTools = [
|
|
|
554
1557
|
schema: {
|
|
555
1558
|
type: "string",
|
|
556
1559
|
},
|
|
1560
|
+
"x-displayname": "Name",
|
|
1561
|
+
"x-ves-example": "Example-corp-web.",
|
|
557
1562
|
},
|
|
558
1563
|
{
|
|
559
1564
|
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
@@ -563,6 +1568,8 @@ export const cdnTools = [
|
|
|
563
1568
|
schema: {
|
|
564
1569
|
type: "string",
|
|
565
1570
|
},
|
|
1571
|
+
"x-displayname": "Namespace",
|
|
1572
|
+
"x-ves-example": "Staging",
|
|
566
1573
|
},
|
|
567
1574
|
],
|
|
568
1575
|
queryParameters: [],
|
|
@@ -576,6 +1583,83 @@ export const cdnTools = [
|
|
|
576
1583
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Replace",
|
|
577
1584
|
tags: ["Other"],
|
|
578
1585
|
sourceFile: "domains/cdn.json",
|
|
1586
|
+
displayName: null,
|
|
1587
|
+
dangerLevel: "medium",
|
|
1588
|
+
sideEffects: {
|
|
1589
|
+
modifies: ["cdn-loadbalancer"],
|
|
1590
|
+
},
|
|
1591
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1592
|
+
cliExamples: [
|
|
1593
|
+
{
|
|
1594
|
+
command: "f5xcctl config cdn-loadbalancer update {name} --namespace {namespace} -f {file}.yaml",
|
|
1595
|
+
description: "Update cdn-loadbalancer",
|
|
1596
|
+
use_case: "update",
|
|
1597
|
+
},
|
|
1598
|
+
],
|
|
1599
|
+
confirmationRequired: false,
|
|
1600
|
+
parameterExamples: {
|
|
1601
|
+
"metadata.name": "Example-corp-web.",
|
|
1602
|
+
"metadata.namespace": "Staging",
|
|
1603
|
+
},
|
|
1604
|
+
validationRules: {},
|
|
1605
|
+
operationMetadata: {
|
|
1606
|
+
common_errors: [
|
|
1607
|
+
{
|
|
1608
|
+
code: 401,
|
|
1609
|
+
message: "Authentication required",
|
|
1610
|
+
solution: "Provide valid API credentials",
|
|
1611
|
+
},
|
|
1612
|
+
{
|
|
1613
|
+
code: 403,
|
|
1614
|
+
message: "Permission denied",
|
|
1615
|
+
solution: "Check access permissions for this operation",
|
|
1616
|
+
},
|
|
1617
|
+
{
|
|
1618
|
+
code: 404,
|
|
1619
|
+
message: "Resource not found",
|
|
1620
|
+
solution: "Verify resource name, namespace, and path",
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
code: 409,
|
|
1624
|
+
message: "Resource already exists",
|
|
1625
|
+
solution: "Use different name or update existing resource",
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
code: 429,
|
|
1629
|
+
message: "Rate limit exceeded",
|
|
1630
|
+
solution: "Wait before retrying the operation",
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
code: 500,
|
|
1634
|
+
message: "Server error",
|
|
1635
|
+
solution: "Retry operation or contact support",
|
|
1636
|
+
},
|
|
1637
|
+
],
|
|
1638
|
+
conditions: {
|
|
1639
|
+
postconditions: ["Resource updated with new values"],
|
|
1640
|
+
prerequisites: ["Active namespace"],
|
|
1641
|
+
},
|
|
1642
|
+
confirmation_required: false,
|
|
1643
|
+
danger_level: "medium",
|
|
1644
|
+
examples: [
|
|
1645
|
+
{
|
|
1646
|
+
command: "f5xcctl config cdn-loadbalancer update {name} --namespace {namespace} -f {file}.yaml",
|
|
1647
|
+
description: "Update cdn-loadbalancer",
|
|
1648
|
+
use_case: "update",
|
|
1649
|
+
},
|
|
1650
|
+
],
|
|
1651
|
+
field_docs: {},
|
|
1652
|
+
optional_fields: [],
|
|
1653
|
+
performance_impact: {
|
|
1654
|
+
latency: "low",
|
|
1655
|
+
resource_usage: "low",
|
|
1656
|
+
},
|
|
1657
|
+
purpose: "Replace existing cdn-loadbalancer",
|
|
1658
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1659
|
+
side_effects: {
|
|
1660
|
+
modifies: ["cdn-loadbalancer"],
|
|
1661
|
+
},
|
|
1662
|
+
},
|
|
579
1663
|
},
|
|
580
1664
|
{
|
|
581
1665
|
toolName: "f5xc-api-cdn-dos-automitigation-rule-delete",
|
|
@@ -595,6 +1679,8 @@ export const cdnTools = [
|
|
|
595
1679
|
schema: {
|
|
596
1680
|
type: "string",
|
|
597
1681
|
},
|
|
1682
|
+
"x-displayname": "DoS Mitigation Rule Name.",
|
|
1683
|
+
"x-ves-example": "Dos-auto-mitigation-VES-I/O-HTTP-loadbalancer-ce22.",
|
|
598
1684
|
},
|
|
599
1685
|
{
|
|
600
1686
|
description: "Name\nName of the Load Balancer.",
|
|
@@ -604,6 +1690,8 @@ export const cdnTools = [
|
|
|
604
1690
|
schema: {
|
|
605
1691
|
type: "string",
|
|
606
1692
|
},
|
|
1693
|
+
"x-displayname": "Name",
|
|
1694
|
+
"x-ves-example": "Blogging-app.",
|
|
607
1695
|
},
|
|
608
1696
|
{
|
|
609
1697
|
description: "Namespace\nNamespace of the Load Balancer.",
|
|
@@ -613,6 +1701,8 @@ export const cdnTools = [
|
|
|
613
1701
|
schema: {
|
|
614
1702
|
type: "string",
|
|
615
1703
|
},
|
|
1704
|
+
"x-displayname": "Namespace",
|
|
1705
|
+
"x-ves-example": "Shared",
|
|
616
1706
|
},
|
|
617
1707
|
],
|
|
618
1708
|
queryParameters: [],
|
|
@@ -624,6 +1714,84 @@ export const cdnTools = [
|
|
|
624
1714
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomCDNWAAPAPI.DeleteCDNDoSAutoMitigationRule",
|
|
625
1715
|
tags: ["Other"],
|
|
626
1716
|
sourceFile: "domains/cdn.json",
|
|
1717
|
+
displayName: null,
|
|
1718
|
+
dangerLevel: "high",
|
|
1719
|
+
sideEffects: {
|
|
1720
|
+
deletes: ["dos-automitigation-rule", "contained_resources"],
|
|
1721
|
+
},
|
|
1722
|
+
requiredFields: ["path.dos_automitigation_rule_name", "path.name", "path.namespace"],
|
|
1723
|
+
cliExamples: [
|
|
1724
|
+
{
|
|
1725
|
+
command: "f5xcctl config dos-automitigation-rule delete {name} --namespace {namespace}",
|
|
1726
|
+
description: "Delete dos-automitigation-rule",
|
|
1727
|
+
use_case: "delete",
|
|
1728
|
+
},
|
|
1729
|
+
],
|
|
1730
|
+
confirmationRequired: true,
|
|
1731
|
+
parameterExamples: {
|
|
1732
|
+
dos_automitigation_rule_name: "Dos-auto-mitigation-VES-I/O-HTTP-loadbalancer-ce22.",
|
|
1733
|
+
name: "Blogging-app.",
|
|
1734
|
+
namespace: "Shared",
|
|
1735
|
+
},
|
|
1736
|
+
validationRules: {},
|
|
1737
|
+
operationMetadata: {
|
|
1738
|
+
common_errors: [
|
|
1739
|
+
{
|
|
1740
|
+
code: 401,
|
|
1741
|
+
message: "Authentication required",
|
|
1742
|
+
solution: "Provide valid API credentials",
|
|
1743
|
+
},
|
|
1744
|
+
{
|
|
1745
|
+
code: 403,
|
|
1746
|
+
message: "Permission denied",
|
|
1747
|
+
solution: "Check access permissions for this operation",
|
|
1748
|
+
},
|
|
1749
|
+
{
|
|
1750
|
+
code: 404,
|
|
1751
|
+
message: "Resource not found",
|
|
1752
|
+
solution: "Verify resource name, namespace, and path",
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
code: 409,
|
|
1756
|
+
message: "Resource already exists",
|
|
1757
|
+
solution: "Use different name or update existing resource",
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
code: 429,
|
|
1761
|
+
message: "Rate limit exceeded",
|
|
1762
|
+
solution: "Wait before retrying the operation",
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
code: 500,
|
|
1766
|
+
message: "Server error",
|
|
1767
|
+
solution: "Retry operation or contact support",
|
|
1768
|
+
},
|
|
1769
|
+
],
|
|
1770
|
+
conditions: {
|
|
1771
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1772
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1773
|
+
},
|
|
1774
|
+
confirmation_required: true,
|
|
1775
|
+
danger_level: "high",
|
|
1776
|
+
examples: [
|
|
1777
|
+
{
|
|
1778
|
+
command: "f5xcctl config dos-automitigation-rule delete {name} --namespace {namespace}",
|
|
1779
|
+
description: "Delete dos-automitigation-rule",
|
|
1780
|
+
use_case: "delete",
|
|
1781
|
+
},
|
|
1782
|
+
],
|
|
1783
|
+
field_docs: {},
|
|
1784
|
+
optional_fields: [],
|
|
1785
|
+
performance_impact: {
|
|
1786
|
+
latency: "high",
|
|
1787
|
+
resource_usage: "moderate",
|
|
1788
|
+
},
|
|
1789
|
+
purpose: "Delete dos-automitigation-rule",
|
|
1790
|
+
required_fields: ["path.dos_automitigation_rule_name", "path.name", "path.namespace"],
|
|
1791
|
+
side_effects: {
|
|
1792
|
+
deletes: ["dos-automitigation-rule", "contained_resources"],
|
|
1793
|
+
},
|
|
1794
|
+
},
|
|
627
1795
|
},
|
|
628
1796
|
{
|
|
629
1797
|
toolName: "f5xc-api-cdn-dos-automitigation-rule-get",
|
|
@@ -643,6 +1811,8 @@ export const cdnTools = [
|
|
|
643
1811
|
schema: {
|
|
644
1812
|
type: "string",
|
|
645
1813
|
},
|
|
1814
|
+
"x-displayname": "Name",
|
|
1815
|
+
"x-ves-example": "Blogging-app.",
|
|
646
1816
|
},
|
|
647
1817
|
{
|
|
648
1818
|
description: "Namespace\nNamespace of the Load Balancer.",
|
|
@@ -652,6 +1822,8 @@ export const cdnTools = [
|
|
|
652
1822
|
schema: {
|
|
653
1823
|
type: "string",
|
|
654
1824
|
},
|
|
1825
|
+
"x-displayname": "Namespace",
|
|
1826
|
+
"x-ves-example": "Shared",
|
|
655
1827
|
},
|
|
656
1828
|
],
|
|
657
1829
|
queryParameters: [],
|
|
@@ -663,6 +1835,79 @@ export const cdnTools = [
|
|
|
663
1835
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomCDNWAAPAPI.GetCDNDoSAutoMitigationRules",
|
|
664
1836
|
tags: ["Other"],
|
|
665
1837
|
sourceFile: "domains/cdn.json",
|
|
1838
|
+
displayName: null,
|
|
1839
|
+
dangerLevel: "low",
|
|
1840
|
+
sideEffects: null,
|
|
1841
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1842
|
+
cliExamples: [
|
|
1843
|
+
{
|
|
1844
|
+
command: "f5xcctl config dos-automitigation-rule get {name} --namespace {namespace}",
|
|
1845
|
+
description: "Get specific dos-automitigation-rule",
|
|
1846
|
+
use_case: "get_specific",
|
|
1847
|
+
},
|
|
1848
|
+
],
|
|
1849
|
+
confirmationRequired: false,
|
|
1850
|
+
parameterExamples: {
|
|
1851
|
+
name: "Blogging-app.",
|
|
1852
|
+
namespace: "Shared",
|
|
1853
|
+
},
|
|
1854
|
+
validationRules: {},
|
|
1855
|
+
operationMetadata: {
|
|
1856
|
+
common_errors: [
|
|
1857
|
+
{
|
|
1858
|
+
code: 401,
|
|
1859
|
+
message: "Authentication required",
|
|
1860
|
+
solution: "Provide valid API credentials",
|
|
1861
|
+
},
|
|
1862
|
+
{
|
|
1863
|
+
code: 403,
|
|
1864
|
+
message: "Permission denied",
|
|
1865
|
+
solution: "Check access permissions for this operation",
|
|
1866
|
+
},
|
|
1867
|
+
{
|
|
1868
|
+
code: 404,
|
|
1869
|
+
message: "Resource not found",
|
|
1870
|
+
solution: "Verify resource name, namespace, and path",
|
|
1871
|
+
},
|
|
1872
|
+
{
|
|
1873
|
+
code: 409,
|
|
1874
|
+
message: "Resource already exists",
|
|
1875
|
+
solution: "Use different name or update existing resource",
|
|
1876
|
+
},
|
|
1877
|
+
{
|
|
1878
|
+
code: 429,
|
|
1879
|
+
message: "Rate limit exceeded",
|
|
1880
|
+
solution: "Wait before retrying the operation",
|
|
1881
|
+
},
|
|
1882
|
+
{
|
|
1883
|
+
code: 500,
|
|
1884
|
+
message: "Server error",
|
|
1885
|
+
solution: "Retry operation or contact support",
|
|
1886
|
+
},
|
|
1887
|
+
],
|
|
1888
|
+
conditions: {
|
|
1889
|
+
postconditions: [],
|
|
1890
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1891
|
+
},
|
|
1892
|
+
confirmation_required: false,
|
|
1893
|
+
danger_level: "low",
|
|
1894
|
+
examples: [
|
|
1895
|
+
{
|
|
1896
|
+
command: "f5xcctl config dos-automitigation-rule get {name} --namespace {namespace}",
|
|
1897
|
+
description: "Get specific dos-automitigation-rule",
|
|
1898
|
+
use_case: "get_specific",
|
|
1899
|
+
},
|
|
1900
|
+
],
|
|
1901
|
+
field_docs: {},
|
|
1902
|
+
optional_fields: [],
|
|
1903
|
+
performance_impact: {
|
|
1904
|
+
latency: "moderate",
|
|
1905
|
+
resource_usage: "moderate",
|
|
1906
|
+
},
|
|
1907
|
+
purpose: "Retrieve specific dos-automitigation-rule",
|
|
1908
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1909
|
+
side_effects: {},
|
|
1910
|
+
},
|
|
666
1911
|
},
|
|
667
1912
|
{
|
|
668
1913
|
toolName: "f5xc-api-cdn-get-security-config-create",
|
|
@@ -682,6 +1927,8 @@ export const cdnTools = [
|
|
|
682
1927
|
schema: {
|
|
683
1928
|
type: "string",
|
|
684
1929
|
},
|
|
1930
|
+
"x-displayname": "Namespace",
|
|
1931
|
+
"x-ves-example": "Shared",
|
|
685
1932
|
},
|
|
686
1933
|
],
|
|
687
1934
|
queryParameters: [],
|
|
@@ -695,6 +1942,95 @@ export const cdnTools = [
|
|
|
695
1942
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomCDNWAAPAPI.GetCDNSecurityConfig",
|
|
696
1943
|
tags: ["Other"],
|
|
697
1944
|
sourceFile: "domains/cdn.json",
|
|
1945
|
+
displayName: null,
|
|
1946
|
+
dangerLevel: "medium",
|
|
1947
|
+
sideEffects: {
|
|
1948
|
+
creates: ["get-security-config"],
|
|
1949
|
+
},
|
|
1950
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1951
|
+
cliExamples: [
|
|
1952
|
+
{
|
|
1953
|
+
command: "f5xcctl config get-security-config create -f {file}.yaml",
|
|
1954
|
+
description: "Create from YAML file",
|
|
1955
|
+
use_case: "file_based",
|
|
1956
|
+
},
|
|
1957
|
+
{
|
|
1958
|
+
command: "f5xcctl config get-security-config create {name} --namespace {namespace}",
|
|
1959
|
+
description: "Create get-security-config",
|
|
1960
|
+
use_case: "basic_create",
|
|
1961
|
+
},
|
|
1962
|
+
],
|
|
1963
|
+
confirmationRequired: false,
|
|
1964
|
+
parameterExamples: {
|
|
1965
|
+
namespace: "Shared",
|
|
1966
|
+
},
|
|
1967
|
+
validationRules: {},
|
|
1968
|
+
operationMetadata: {
|
|
1969
|
+
common_errors: [
|
|
1970
|
+
{
|
|
1971
|
+
code: 401,
|
|
1972
|
+
message: "Authentication required",
|
|
1973
|
+
solution: "Provide valid API credentials",
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
code: 403,
|
|
1977
|
+
message: "Permission denied",
|
|
1978
|
+
solution: "Check access permissions for this operation",
|
|
1979
|
+
},
|
|
1980
|
+
{
|
|
1981
|
+
code: 404,
|
|
1982
|
+
message: "Resource not found",
|
|
1983
|
+
solution: "Verify resource name, namespace, and path",
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
code: 409,
|
|
1987
|
+
message: "Resource already exists",
|
|
1988
|
+
solution: "Use different name or update existing resource",
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
code: 429,
|
|
1992
|
+
message: "Rate limit exceeded",
|
|
1993
|
+
solution: "Wait before retrying the operation",
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
code: 500,
|
|
1997
|
+
message: "Server error",
|
|
1998
|
+
solution: "Retry operation or contact support",
|
|
1999
|
+
},
|
|
2000
|
+
],
|
|
2001
|
+
conditions: {
|
|
2002
|
+
postconditions: [
|
|
2003
|
+
"Get-security-config resource created",
|
|
2004
|
+
"Resource assigned unique identifier",
|
|
2005
|
+
],
|
|
2006
|
+
prerequisites: ["Active namespace"],
|
|
2007
|
+
},
|
|
2008
|
+
confirmation_required: false,
|
|
2009
|
+
danger_level: "medium",
|
|
2010
|
+
examples: [
|
|
2011
|
+
{
|
|
2012
|
+
command: "f5xcctl config get-security-config create {name} --namespace {namespace}",
|
|
2013
|
+
description: "Create get-security-config",
|
|
2014
|
+
use_case: "basic_create",
|
|
2015
|
+
},
|
|
2016
|
+
{
|
|
2017
|
+
command: "f5xcctl config get-security-config create -f {file}.yaml",
|
|
2018
|
+
description: "Create from YAML file",
|
|
2019
|
+
use_case: "file_based",
|
|
2020
|
+
},
|
|
2021
|
+
],
|
|
2022
|
+
field_docs: {},
|
|
2023
|
+
optional_fields: [],
|
|
2024
|
+
performance_impact: {
|
|
2025
|
+
latency: "low",
|
|
2026
|
+
resource_usage: "low",
|
|
2027
|
+
},
|
|
2028
|
+
purpose: "Create new get-security-config",
|
|
2029
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2030
|
+
side_effects: {
|
|
2031
|
+
creates: ["get-security-config"],
|
|
2032
|
+
},
|
|
2033
|
+
},
|
|
698
2034
|
},
|
|
699
2035
|
{
|
|
700
2036
|
toolName: "f5xc-api-cdn-get-service-operation-statu-create",
|
|
@@ -714,6 +2050,8 @@ export const cdnTools = [
|
|
|
714
2050
|
schema: {
|
|
715
2051
|
type: "string",
|
|
716
2052
|
},
|
|
2053
|
+
"x-displayname": "Namespace",
|
|
2054
|
+
"x-ves-example": "Default",
|
|
717
2055
|
},
|
|
718
2056
|
],
|
|
719
2057
|
queryParameters: [],
|
|
@@ -727,6 +2065,95 @@ export const cdnTools = [
|
|
|
727
2065
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.GetServiceOperation",
|
|
728
2066
|
tags: ["CDN"],
|
|
729
2067
|
sourceFile: "domains/cdn.json",
|
|
2068
|
+
displayName: null,
|
|
2069
|
+
dangerLevel: "medium",
|
|
2070
|
+
sideEffects: {
|
|
2071
|
+
creates: ["get-service-operation-statu"],
|
|
2072
|
+
},
|
|
2073
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2074
|
+
cliExamples: [
|
|
2075
|
+
{
|
|
2076
|
+
command: "f5xcctl cdn get-service-operation-statu create -f {file}.yaml",
|
|
2077
|
+
description: "Create from YAML file",
|
|
2078
|
+
use_case: "file_based",
|
|
2079
|
+
},
|
|
2080
|
+
{
|
|
2081
|
+
command: "f5xcctl cdn get-service-operation-statu create {name} --namespace {namespace}",
|
|
2082
|
+
description: "Create get-service-operation-statu",
|
|
2083
|
+
use_case: "basic_create",
|
|
2084
|
+
},
|
|
2085
|
+
],
|
|
2086
|
+
confirmationRequired: false,
|
|
2087
|
+
parameterExamples: {
|
|
2088
|
+
namespace: "Default",
|
|
2089
|
+
},
|
|
2090
|
+
validationRules: {},
|
|
2091
|
+
operationMetadata: {
|
|
2092
|
+
common_errors: [
|
|
2093
|
+
{
|
|
2094
|
+
code: 401,
|
|
2095
|
+
message: "Authentication required",
|
|
2096
|
+
solution: "Provide valid API credentials",
|
|
2097
|
+
},
|
|
2098
|
+
{
|
|
2099
|
+
code: 403,
|
|
2100
|
+
message: "Permission denied",
|
|
2101
|
+
solution: "Check access permissions for this operation",
|
|
2102
|
+
},
|
|
2103
|
+
{
|
|
2104
|
+
code: 404,
|
|
2105
|
+
message: "Resource not found",
|
|
2106
|
+
solution: "Verify resource name, namespace, and path",
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
code: 409,
|
|
2110
|
+
message: "Resource already exists",
|
|
2111
|
+
solution: "Use different name or update existing resource",
|
|
2112
|
+
},
|
|
2113
|
+
{
|
|
2114
|
+
code: 429,
|
|
2115
|
+
message: "Rate limit exceeded",
|
|
2116
|
+
solution: "Wait before retrying the operation",
|
|
2117
|
+
},
|
|
2118
|
+
{
|
|
2119
|
+
code: 500,
|
|
2120
|
+
message: "Server error",
|
|
2121
|
+
solution: "Retry operation or contact support",
|
|
2122
|
+
},
|
|
2123
|
+
],
|
|
2124
|
+
conditions: {
|
|
2125
|
+
postconditions: [
|
|
2126
|
+
"Get-service-operation-statu resource created",
|
|
2127
|
+
"Resource assigned unique identifier",
|
|
2128
|
+
],
|
|
2129
|
+
prerequisites: ["Active namespace"],
|
|
2130
|
+
},
|
|
2131
|
+
confirmation_required: false,
|
|
2132
|
+
danger_level: "medium",
|
|
2133
|
+
examples: [
|
|
2134
|
+
{
|
|
2135
|
+
command: "f5xcctl cdn get-service-operation-statu create {name} --namespace {namespace}",
|
|
2136
|
+
description: "Create get-service-operation-statu",
|
|
2137
|
+
use_case: "basic_create",
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
command: "f5xcctl cdn get-service-operation-statu create -f {file}.yaml",
|
|
2141
|
+
description: "Create from YAML file",
|
|
2142
|
+
use_case: "file_based",
|
|
2143
|
+
},
|
|
2144
|
+
],
|
|
2145
|
+
field_docs: {},
|
|
2146
|
+
optional_fields: [],
|
|
2147
|
+
performance_impact: {
|
|
2148
|
+
latency: "low",
|
|
2149
|
+
resource_usage: "low",
|
|
2150
|
+
},
|
|
2151
|
+
purpose: "Create new get-service-operation-statu",
|
|
2152
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2153
|
+
side_effects: {
|
|
2154
|
+
creates: ["get-service-operation-statu"],
|
|
2155
|
+
},
|
|
2156
|
+
},
|
|
730
2157
|
},
|
|
731
2158
|
{
|
|
732
2159
|
toolName: "f5xc-api-cdn-list-service-operations-statu-create",
|
|
@@ -746,6 +2173,8 @@ export const cdnTools = [
|
|
|
746
2173
|
schema: {
|
|
747
2174
|
type: "string",
|
|
748
2175
|
},
|
|
2176
|
+
"x-displayname": "Namespace",
|
|
2177
|
+
"x-ves-example": "Ns1",
|
|
749
2178
|
},
|
|
750
2179
|
],
|
|
751
2180
|
queryParameters: [],
|
|
@@ -759,6 +2188,95 @@ export const cdnTools = [
|
|
|
759
2188
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.ListServiceOperations",
|
|
760
2189
|
tags: ["CDN"],
|
|
761
2190
|
sourceFile: "domains/cdn.json",
|
|
2191
|
+
displayName: null,
|
|
2192
|
+
dangerLevel: "medium",
|
|
2193
|
+
sideEffects: {
|
|
2194
|
+
creates: ["list-service-operations-statu"],
|
|
2195
|
+
},
|
|
2196
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2197
|
+
cliExamples: [
|
|
2198
|
+
{
|
|
2199
|
+
command: "f5xcctl cdn list-service-operations-statu create -f {file}.yaml",
|
|
2200
|
+
description: "Create from YAML file",
|
|
2201
|
+
use_case: "file_based",
|
|
2202
|
+
},
|
|
2203
|
+
{
|
|
2204
|
+
command: "f5xcctl cdn list-service-operations-statu create {name} --namespace {namespace}",
|
|
2205
|
+
description: "Create list-service-operations-statu",
|
|
2206
|
+
use_case: "basic_create",
|
|
2207
|
+
},
|
|
2208
|
+
],
|
|
2209
|
+
confirmationRequired: false,
|
|
2210
|
+
parameterExamples: {
|
|
2211
|
+
namespace: "Ns1",
|
|
2212
|
+
},
|
|
2213
|
+
validationRules: {},
|
|
2214
|
+
operationMetadata: {
|
|
2215
|
+
common_errors: [
|
|
2216
|
+
{
|
|
2217
|
+
code: 401,
|
|
2218
|
+
message: "Authentication required",
|
|
2219
|
+
solution: "Provide valid API credentials",
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
code: 403,
|
|
2223
|
+
message: "Permission denied",
|
|
2224
|
+
solution: "Check access permissions for this operation",
|
|
2225
|
+
},
|
|
2226
|
+
{
|
|
2227
|
+
code: 404,
|
|
2228
|
+
message: "Resource not found",
|
|
2229
|
+
solution: "Verify resource name, namespace, and path",
|
|
2230
|
+
},
|
|
2231
|
+
{
|
|
2232
|
+
code: 409,
|
|
2233
|
+
message: "Resource already exists",
|
|
2234
|
+
solution: "Use different name or update existing resource",
|
|
2235
|
+
},
|
|
2236
|
+
{
|
|
2237
|
+
code: 429,
|
|
2238
|
+
message: "Rate limit exceeded",
|
|
2239
|
+
solution: "Wait before retrying the operation",
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
code: 500,
|
|
2243
|
+
message: "Server error",
|
|
2244
|
+
solution: "Retry operation or contact support",
|
|
2245
|
+
},
|
|
2246
|
+
],
|
|
2247
|
+
conditions: {
|
|
2248
|
+
postconditions: [
|
|
2249
|
+
"List-service-operations-statu resource created",
|
|
2250
|
+
"Resource assigned unique identifier",
|
|
2251
|
+
],
|
|
2252
|
+
prerequisites: ["Active namespace"],
|
|
2253
|
+
},
|
|
2254
|
+
confirmation_required: false,
|
|
2255
|
+
danger_level: "medium",
|
|
2256
|
+
examples: [
|
|
2257
|
+
{
|
|
2258
|
+
command: "f5xcctl cdn list-service-operations-statu create {name} --namespace {namespace}",
|
|
2259
|
+
description: "Create list-service-operations-statu",
|
|
2260
|
+
use_case: "basic_create",
|
|
2261
|
+
},
|
|
2262
|
+
{
|
|
2263
|
+
command: "f5xcctl cdn list-service-operations-statu create -f {file}.yaml",
|
|
2264
|
+
description: "Create from YAML file",
|
|
2265
|
+
use_case: "file_based",
|
|
2266
|
+
},
|
|
2267
|
+
],
|
|
2268
|
+
field_docs: {},
|
|
2269
|
+
optional_fields: [],
|
|
2270
|
+
performance_impact: {
|
|
2271
|
+
latency: "low",
|
|
2272
|
+
resource_usage: "low",
|
|
2273
|
+
},
|
|
2274
|
+
purpose: "Create new list-service-operations-statu",
|
|
2275
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2276
|
+
side_effects: {
|
|
2277
|
+
creates: ["list-service-operations-statu"],
|
|
2278
|
+
},
|
|
2279
|
+
},
|
|
762
2280
|
},
|
|
763
2281
|
{
|
|
764
2282
|
toolName: "f5xc-api-cdn-metric-create",
|
|
@@ -778,6 +2296,8 @@ export const cdnTools = [
|
|
|
778
2296
|
schema: {
|
|
779
2297
|
type: "string",
|
|
780
2298
|
},
|
|
2299
|
+
"x-displayname": "Namespace",
|
|
2300
|
+
"x-ves-example": "Default",
|
|
781
2301
|
},
|
|
782
2302
|
],
|
|
783
2303
|
queryParameters: [],
|
|
@@ -791,6 +2311,92 @@ export const cdnTools = [
|
|
|
791
2311
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNMetrics",
|
|
792
2312
|
tags: ["CDN"],
|
|
793
2313
|
sourceFile: "domains/cdn.json",
|
|
2314
|
+
displayName: null,
|
|
2315
|
+
dangerLevel: "medium",
|
|
2316
|
+
sideEffects: {
|
|
2317
|
+
creates: ["metric"],
|
|
2318
|
+
},
|
|
2319
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2320
|
+
cliExamples: [
|
|
2321
|
+
{
|
|
2322
|
+
command: "f5xcctl cdn metric create -f {file}.yaml",
|
|
2323
|
+
description: "Create from YAML file",
|
|
2324
|
+
use_case: "file_based",
|
|
2325
|
+
},
|
|
2326
|
+
{
|
|
2327
|
+
command: "f5xcctl cdn metric create {name} --namespace {namespace}",
|
|
2328
|
+
description: "Create metric",
|
|
2329
|
+
use_case: "basic_create",
|
|
2330
|
+
},
|
|
2331
|
+
],
|
|
2332
|
+
confirmationRequired: false,
|
|
2333
|
+
parameterExamples: {
|
|
2334
|
+
namespace: "Default",
|
|
2335
|
+
},
|
|
2336
|
+
validationRules: {},
|
|
2337
|
+
operationMetadata: {
|
|
2338
|
+
common_errors: [
|
|
2339
|
+
{
|
|
2340
|
+
code: 401,
|
|
2341
|
+
message: "Authentication required",
|
|
2342
|
+
solution: "Provide valid API credentials",
|
|
2343
|
+
},
|
|
2344
|
+
{
|
|
2345
|
+
code: 403,
|
|
2346
|
+
message: "Permission denied",
|
|
2347
|
+
solution: "Check access permissions for this operation",
|
|
2348
|
+
},
|
|
2349
|
+
{
|
|
2350
|
+
code: 404,
|
|
2351
|
+
message: "Resource not found",
|
|
2352
|
+
solution: "Verify resource name, namespace, and path",
|
|
2353
|
+
},
|
|
2354
|
+
{
|
|
2355
|
+
code: 409,
|
|
2356
|
+
message: "Resource already exists",
|
|
2357
|
+
solution: "Use different name or update existing resource",
|
|
2358
|
+
},
|
|
2359
|
+
{
|
|
2360
|
+
code: 429,
|
|
2361
|
+
message: "Rate limit exceeded",
|
|
2362
|
+
solution: "Wait before retrying the operation",
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
code: 500,
|
|
2366
|
+
message: "Server error",
|
|
2367
|
+
solution: "Retry operation or contact support",
|
|
2368
|
+
},
|
|
2369
|
+
],
|
|
2370
|
+
conditions: {
|
|
2371
|
+
postconditions: ["Metric resource created", "Resource assigned unique identifier"],
|
|
2372
|
+
prerequisites: ["Active namespace"],
|
|
2373
|
+
},
|
|
2374
|
+
confirmation_required: false,
|
|
2375
|
+
danger_level: "medium",
|
|
2376
|
+
examples: [
|
|
2377
|
+
{
|
|
2378
|
+
command: "f5xcctl cdn metric create {name} --namespace {namespace}",
|
|
2379
|
+
description: "Create metric",
|
|
2380
|
+
use_case: "basic_create",
|
|
2381
|
+
},
|
|
2382
|
+
{
|
|
2383
|
+
command: "f5xcctl cdn metric create -f {file}.yaml",
|
|
2384
|
+
description: "Create from YAML file",
|
|
2385
|
+
use_case: "file_based",
|
|
2386
|
+
},
|
|
2387
|
+
],
|
|
2388
|
+
field_docs: {},
|
|
2389
|
+
optional_fields: [],
|
|
2390
|
+
performance_impact: {
|
|
2391
|
+
latency: "low",
|
|
2392
|
+
resource_usage: "low",
|
|
2393
|
+
},
|
|
2394
|
+
purpose: "Create new metric",
|
|
2395
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2396
|
+
side_effects: {
|
|
2397
|
+
creates: ["metric"],
|
|
2398
|
+
},
|
|
2399
|
+
},
|
|
794
2400
|
},
|
|
795
2401
|
{
|
|
796
2402
|
toolName: "f5xc-api-cdn-subscribe-create",
|
|
@@ -813,6 +2419,220 @@ export const cdnTools = [
|
|
|
813
2419
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.Subscribe",
|
|
814
2420
|
tags: ["Other"],
|
|
815
2421
|
sourceFile: "domains/cdn.json",
|
|
2422
|
+
displayName: null,
|
|
2423
|
+
dangerLevel: "medium",
|
|
2424
|
+
sideEffects: {
|
|
2425
|
+
creates: ["subscribe"],
|
|
2426
|
+
},
|
|
2427
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2428
|
+
cliExamples: [
|
|
2429
|
+
{
|
|
2430
|
+
command: "f5xcctl cdn subscribe create -f {file}.yaml",
|
|
2431
|
+
description: "Create from YAML file",
|
|
2432
|
+
use_case: "file_based",
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
command: "f5xcctl cdn subscribe create {name} --namespace {namespace}",
|
|
2436
|
+
description: "Create subscribe",
|
|
2437
|
+
use_case: "basic_create",
|
|
2438
|
+
},
|
|
2439
|
+
],
|
|
2440
|
+
confirmationRequired: false,
|
|
2441
|
+
parameterExamples: {},
|
|
2442
|
+
validationRules: {},
|
|
2443
|
+
operationMetadata: {
|
|
2444
|
+
common_errors: [
|
|
2445
|
+
{
|
|
2446
|
+
code: 401,
|
|
2447
|
+
message: "Authentication required",
|
|
2448
|
+
solution: "Provide valid API credentials",
|
|
2449
|
+
},
|
|
2450
|
+
{
|
|
2451
|
+
code: 403,
|
|
2452
|
+
message: "Permission denied",
|
|
2453
|
+
solution: "Check access permissions for this operation",
|
|
2454
|
+
},
|
|
2455
|
+
{
|
|
2456
|
+
code: 404,
|
|
2457
|
+
message: "Resource not found",
|
|
2458
|
+
solution: "Verify resource name, namespace, and path",
|
|
2459
|
+
},
|
|
2460
|
+
{
|
|
2461
|
+
code: 409,
|
|
2462
|
+
message: "Resource already exists",
|
|
2463
|
+
solution: "Use different name or update existing resource",
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
code: 429,
|
|
2467
|
+
message: "Rate limit exceeded",
|
|
2468
|
+
solution: "Wait before retrying the operation",
|
|
2469
|
+
},
|
|
2470
|
+
{
|
|
2471
|
+
code: 500,
|
|
2472
|
+
message: "Server error",
|
|
2473
|
+
solution: "Retry operation or contact support",
|
|
2474
|
+
},
|
|
2475
|
+
],
|
|
2476
|
+
conditions: {
|
|
2477
|
+
postconditions: ["Subscribe resource created", "Resource assigned unique identifier"],
|
|
2478
|
+
prerequisites: ["Active namespace"],
|
|
2479
|
+
},
|
|
2480
|
+
confirmation_required: false,
|
|
2481
|
+
danger_level: "medium",
|
|
2482
|
+
examples: [
|
|
2483
|
+
{
|
|
2484
|
+
command: "f5xcctl cdn subscribe create {name} --namespace {namespace}",
|
|
2485
|
+
description: "Create subscribe",
|
|
2486
|
+
use_case: "basic_create",
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
command: "f5xcctl cdn subscribe create -f {file}.yaml",
|
|
2490
|
+
description: "Create from YAML file",
|
|
2491
|
+
use_case: "file_based",
|
|
2492
|
+
},
|
|
2493
|
+
],
|
|
2494
|
+
field_docs: {},
|
|
2495
|
+
optional_fields: [],
|
|
2496
|
+
performance_impact: {
|
|
2497
|
+
latency: "low",
|
|
2498
|
+
resource_usage: "low",
|
|
2499
|
+
},
|
|
2500
|
+
purpose: "Create new subscribe",
|
|
2501
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2502
|
+
side_effects: {
|
|
2503
|
+
creates: ["subscribe"],
|
|
2504
|
+
},
|
|
2505
|
+
},
|
|
2506
|
+
},
|
|
2507
|
+
{
|
|
2508
|
+
toolName: "f5xc-api-cdn-suggestion-create",
|
|
2509
|
+
method: "POST",
|
|
2510
|
+
path: "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/block_client/suggestion",
|
|
2511
|
+
operation: "create",
|
|
2512
|
+
domain: "cdn",
|
|
2513
|
+
resource: "suggestion",
|
|
2514
|
+
summary: "Suggest block client rule.",
|
|
2515
|
+
description: "Suggest blocking SimpleClientSrcRule for a given IP/ASN.",
|
|
2516
|
+
pathParameters: [
|
|
2517
|
+
{
|
|
2518
|
+
description: "Name\nHTTP load balancer for which this WAF exclusion will be applied.",
|
|
2519
|
+
in: "path",
|
|
2520
|
+
name: "name",
|
|
2521
|
+
required: true,
|
|
2522
|
+
schema: {
|
|
2523
|
+
type: "string",
|
|
2524
|
+
},
|
|
2525
|
+
"x-displayname": "HTTP Load Balancer Name.",
|
|
2526
|
+
"x-ves-example": "VES-I/O-frontend.",
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
2530
|
+
in: "path",
|
|
2531
|
+
name: "namespace",
|
|
2532
|
+
required: true,
|
|
2533
|
+
schema: {
|
|
2534
|
+
type: "string",
|
|
2535
|
+
},
|
|
2536
|
+
"x-displayname": "Namespace",
|
|
2537
|
+
"x-ves-example": "Shared",
|
|
2538
|
+
},
|
|
2539
|
+
],
|
|
2540
|
+
queryParameters: [],
|
|
2541
|
+
requestBodySchema: null,
|
|
2542
|
+
responseSchema: {
|
|
2543
|
+
$ref: "#/components/schemas/app_securityGetSuggestedBlockClientRuleRsp",
|
|
2544
|
+
},
|
|
2545
|
+
requiredParams: ["name", "namespace"],
|
|
2546
|
+
operationId: "ves.io.schema.app_security.AppSecurityClientRuleAPI.GetSuggestedBlockClientRuleForCDN",
|
|
2547
|
+
tags: ["Other"],
|
|
2548
|
+
sourceFile: "domains/cdn.json",
|
|
2549
|
+
displayName: null,
|
|
2550
|
+
dangerLevel: "medium",
|
|
2551
|
+
sideEffects: {
|
|
2552
|
+
creates: ["suggestion"],
|
|
2553
|
+
},
|
|
2554
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
2555
|
+
cliExamples: [
|
|
2556
|
+
{
|
|
2557
|
+
command: "f5xcctl config suggestion create -f {file}.yaml",
|
|
2558
|
+
description: "Create from YAML file",
|
|
2559
|
+
use_case: "file_based",
|
|
2560
|
+
},
|
|
2561
|
+
{
|
|
2562
|
+
command: "f5xcctl config suggestion create {name} --namespace {namespace}",
|
|
2563
|
+
description: "Create suggestion",
|
|
2564
|
+
use_case: "basic_create",
|
|
2565
|
+
},
|
|
2566
|
+
],
|
|
2567
|
+
confirmationRequired: false,
|
|
2568
|
+
parameterExamples: {
|
|
2569
|
+
name: "VES-I/O-frontend.",
|
|
2570
|
+
namespace: "Shared",
|
|
2571
|
+
},
|
|
2572
|
+
validationRules: {},
|
|
2573
|
+
operationMetadata: {
|
|
2574
|
+
common_errors: [
|
|
2575
|
+
{
|
|
2576
|
+
code: 401,
|
|
2577
|
+
message: "Authentication required",
|
|
2578
|
+
solution: "Provide valid API credentials",
|
|
2579
|
+
},
|
|
2580
|
+
{
|
|
2581
|
+
code: 403,
|
|
2582
|
+
message: "Permission denied",
|
|
2583
|
+
solution: "Check access permissions for this operation",
|
|
2584
|
+
},
|
|
2585
|
+
{
|
|
2586
|
+
code: 404,
|
|
2587
|
+
message: "Resource not found",
|
|
2588
|
+
solution: "Verify resource name, namespace, and path",
|
|
2589
|
+
},
|
|
2590
|
+
{
|
|
2591
|
+
code: 409,
|
|
2592
|
+
message: "Resource already exists",
|
|
2593
|
+
solution: "Use different name or update existing resource",
|
|
2594
|
+
},
|
|
2595
|
+
{
|
|
2596
|
+
code: 429,
|
|
2597
|
+
message: "Rate limit exceeded",
|
|
2598
|
+
solution: "Wait before retrying the operation",
|
|
2599
|
+
},
|
|
2600
|
+
{
|
|
2601
|
+
code: 500,
|
|
2602
|
+
message: "Server error",
|
|
2603
|
+
solution: "Retry operation or contact support",
|
|
2604
|
+
},
|
|
2605
|
+
],
|
|
2606
|
+
conditions: {
|
|
2607
|
+
postconditions: ["Suggestion resource created", "Resource assigned unique identifier"],
|
|
2608
|
+
prerequisites: ["Active namespace"],
|
|
2609
|
+
},
|
|
2610
|
+
confirmation_required: false,
|
|
2611
|
+
danger_level: "medium",
|
|
2612
|
+
examples: [
|
|
2613
|
+
{
|
|
2614
|
+
command: "f5xcctl config suggestion create {name} --namespace {namespace}",
|
|
2615
|
+
description: "Create suggestion",
|
|
2616
|
+
use_case: "basic_create",
|
|
2617
|
+
},
|
|
2618
|
+
{
|
|
2619
|
+
command: "f5xcctl config suggestion create -f {file}.yaml",
|
|
2620
|
+
description: "Create from YAML file",
|
|
2621
|
+
use_case: "file_based",
|
|
2622
|
+
},
|
|
2623
|
+
],
|
|
2624
|
+
field_docs: {},
|
|
2625
|
+
optional_fields: [],
|
|
2626
|
+
performance_impact: {
|
|
2627
|
+
latency: "low",
|
|
2628
|
+
resource_usage: "low",
|
|
2629
|
+
},
|
|
2630
|
+
purpose: "Create new suggestion",
|
|
2631
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
2632
|
+
side_effects: {
|
|
2633
|
+
creates: ["suggestion"],
|
|
2634
|
+
},
|
|
2635
|
+
},
|
|
816
2636
|
},
|
|
817
2637
|
{
|
|
818
2638
|
toolName: "f5xc-api-cdn-unsubscribe-create",
|
|
@@ -835,6 +2655,90 @@ export const cdnTools = [
|
|
|
835
2655
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.Unsubscribe",
|
|
836
2656
|
tags: ["Other"],
|
|
837
2657
|
sourceFile: "domains/cdn.json",
|
|
2658
|
+
displayName: null,
|
|
2659
|
+
dangerLevel: "medium",
|
|
2660
|
+
sideEffects: {
|
|
2661
|
+
creates: ["unsubscribe"],
|
|
2662
|
+
},
|
|
2663
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2664
|
+
cliExamples: [
|
|
2665
|
+
{
|
|
2666
|
+
command: "f5xcctl cdn unsubscribe create -f {file}.yaml",
|
|
2667
|
+
description: "Create from YAML file",
|
|
2668
|
+
use_case: "file_based",
|
|
2669
|
+
},
|
|
2670
|
+
{
|
|
2671
|
+
command: "f5xcctl cdn unsubscribe create {name} --namespace {namespace}",
|
|
2672
|
+
description: "Create unsubscribe",
|
|
2673
|
+
use_case: "basic_create",
|
|
2674
|
+
},
|
|
2675
|
+
],
|
|
2676
|
+
confirmationRequired: false,
|
|
2677
|
+
parameterExamples: {},
|
|
2678
|
+
validationRules: {},
|
|
2679
|
+
operationMetadata: {
|
|
2680
|
+
common_errors: [
|
|
2681
|
+
{
|
|
2682
|
+
code: 401,
|
|
2683
|
+
message: "Authentication required",
|
|
2684
|
+
solution: "Provide valid API credentials",
|
|
2685
|
+
},
|
|
2686
|
+
{
|
|
2687
|
+
code: 403,
|
|
2688
|
+
message: "Permission denied",
|
|
2689
|
+
solution: "Check access permissions for this operation",
|
|
2690
|
+
},
|
|
2691
|
+
{
|
|
2692
|
+
code: 404,
|
|
2693
|
+
message: "Resource not found",
|
|
2694
|
+
solution: "Verify resource name, namespace, and path",
|
|
2695
|
+
},
|
|
2696
|
+
{
|
|
2697
|
+
code: 409,
|
|
2698
|
+
message: "Resource already exists",
|
|
2699
|
+
solution: "Use different name or update existing resource",
|
|
2700
|
+
},
|
|
2701
|
+
{
|
|
2702
|
+
code: 429,
|
|
2703
|
+
message: "Rate limit exceeded",
|
|
2704
|
+
solution: "Wait before retrying the operation",
|
|
2705
|
+
},
|
|
2706
|
+
{
|
|
2707
|
+
code: 500,
|
|
2708
|
+
message: "Server error",
|
|
2709
|
+
solution: "Retry operation or contact support",
|
|
2710
|
+
},
|
|
2711
|
+
],
|
|
2712
|
+
conditions: {
|
|
2713
|
+
postconditions: ["Unsubscribe resource created", "Resource assigned unique identifier"],
|
|
2714
|
+
prerequisites: ["Active namespace"],
|
|
2715
|
+
},
|
|
2716
|
+
confirmation_required: false,
|
|
2717
|
+
danger_level: "medium",
|
|
2718
|
+
examples: [
|
|
2719
|
+
{
|
|
2720
|
+
command: "f5xcctl cdn unsubscribe create {name} --namespace {namespace}",
|
|
2721
|
+
description: "Create unsubscribe",
|
|
2722
|
+
use_case: "basic_create",
|
|
2723
|
+
},
|
|
2724
|
+
{
|
|
2725
|
+
command: "f5xcctl cdn unsubscribe create -f {file}.yaml",
|
|
2726
|
+
description: "Create from YAML file",
|
|
2727
|
+
use_case: "file_based",
|
|
2728
|
+
},
|
|
2729
|
+
],
|
|
2730
|
+
field_docs: {},
|
|
2731
|
+
optional_fields: [],
|
|
2732
|
+
performance_impact: {
|
|
2733
|
+
latency: "low",
|
|
2734
|
+
resource_usage: "low",
|
|
2735
|
+
},
|
|
2736
|
+
purpose: "Create new unsubscribe",
|
|
2737
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2738
|
+
side_effects: {
|
|
2739
|
+
creates: ["unsubscribe"],
|
|
2740
|
+
},
|
|
2741
|
+
},
|
|
838
2742
|
},
|
|
839
2743
|
];
|
|
840
2744
|
export default cdnTools;
|