@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.5.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 +355 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +202 -2
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -2
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +144 -28
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/index.d.ts +2 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +28 -33
- package/dist/index.js.map +1 -1
- package/dist/prompts/workflows.d.ts.map +1 -1
- package/dist/prompts/workflows.js +30 -174
- package/dist/prompts/workflows.js.map +1 -1
- package/dist/resources/handlers.d.ts +0 -2
- package/dist/resources/handlers.d.ts.map +1 -1
- package/dist/resources/handlers.js +0 -51
- package/dist/resources/handlers.js.map +1 -1
- package/dist/server.d.ts +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +1 -2
- package/dist/server.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/discovery/execute.d.ts +1 -3
- package/dist/tools/discovery/execute.d.ts.map +1 -1
- package/dist/tools/discovery/execute.js +1 -34
- package/dist/tools/discovery/execute.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 +259 -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 +5812 -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 +858 -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 +1660 -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 +2283 -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 +3462 -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 +2264 -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 +1498 -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 +3437 -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 +2279 -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 +3585 -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 +1806 -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 +1519 -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 +1495 -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 +7427 -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 +5604 -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 +972 -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 +2858 -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 +4022 -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 +11132 -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 +7827 -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 +1598 -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 +964 -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 +3521 -4641
- 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 +1712 -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 +578 -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 +3810 -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 +18464 -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 +11494 -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 +7557 -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 +5334 -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 +2304 -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 +17560 -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 +99 -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 +1376 -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 +10103 -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 +85 -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 +3802 -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/cli/index.d.ts +0 -16
- package/dist/cli/index.d.ts.map +0 -1
- package/dist/cli/index.js +0 -116
- package/dist/cli/index.js.map +0 -1
- package/dist/cli/setup.d.ts +0 -54
- package/dist/cli/setup.d.ts.map +0 -1
- package/dist/cli/setup.js +0 -347
- package/dist/cli/setup.js.map +0 -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 bigipTools = [
|
|
|
21
21
|
schema: {
|
|
22
22
|
type: "string",
|
|
23
23
|
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "Staging",
|
|
24
26
|
},
|
|
25
27
|
],
|
|
26
28
|
queryParameters: [],
|
|
@@ -34,6 +36,69 @@ export const bigipTools = [
|
|
|
34
36
|
operationId: "ves.io.schema.bigip.apm.API.Create",
|
|
35
37
|
tags: ["Other"],
|
|
36
38
|
sourceFile: "domains/bigip.json",
|
|
39
|
+
displayName: null,
|
|
40
|
+
dangerLevel: "medium",
|
|
41
|
+
sideEffects: {
|
|
42
|
+
creates: ["apm"],
|
|
43
|
+
},
|
|
44
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
45
|
+
confirmationRequired: false,
|
|
46
|
+
parameterExamples: {
|
|
47
|
+
"metadata.namespace": "Staging",
|
|
48
|
+
},
|
|
49
|
+
validationRules: {},
|
|
50
|
+
operationMetadata: {
|
|
51
|
+
common_errors: [
|
|
52
|
+
{
|
|
53
|
+
code: 401,
|
|
54
|
+
message: "Authentication required",
|
|
55
|
+
solution: "Provide valid API credentials",
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
code: 403,
|
|
59
|
+
message: "Permission denied",
|
|
60
|
+
solution: "Check access permissions for this operation",
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
code: 404,
|
|
64
|
+
message: "Resource not found",
|
|
65
|
+
solution: "Verify resource name, namespace, and path",
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
code: 409,
|
|
69
|
+
message: "Resource already exists",
|
|
70
|
+
solution: "Use different name or update existing resource",
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
code: 429,
|
|
74
|
+
message: "Rate limit exceeded",
|
|
75
|
+
solution: "Wait before retrying the operation",
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
code: 500,
|
|
79
|
+
message: "Server error",
|
|
80
|
+
solution: "Retry operation or contact support",
|
|
81
|
+
},
|
|
82
|
+
],
|
|
83
|
+
conditions: {
|
|
84
|
+
postconditions: ["Apm resource created", "Resource assigned unique identifier"],
|
|
85
|
+
prerequisites: ["Active namespace"],
|
|
86
|
+
},
|
|
87
|
+
confirmation_required: false,
|
|
88
|
+
danger_level: "medium",
|
|
89
|
+
field_docs: {},
|
|
90
|
+
optional_fields: [],
|
|
91
|
+
performance_impact: {
|
|
92
|
+
latency: "low",
|
|
93
|
+
resource_usage: "low",
|
|
94
|
+
},
|
|
95
|
+
purpose: "Create new apm",
|
|
96
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
97
|
+
side_effects: {
|
|
98
|
+
creates: ["apm"],
|
|
99
|
+
},
|
|
100
|
+
},
|
|
101
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/apms" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
37
102
|
},
|
|
38
103
|
{
|
|
39
104
|
toolName: "f5xc-api-bigip-apm-delete",
|
|
@@ -53,6 +118,8 @@ export const bigipTools = [
|
|
|
53
118
|
schema: {
|
|
54
119
|
type: "string",
|
|
55
120
|
},
|
|
121
|
+
"x-displayname": "Name",
|
|
122
|
+
"x-ves-example": "Name",
|
|
56
123
|
},
|
|
57
124
|
{
|
|
58
125
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -62,6 +129,8 @@ export const bigipTools = [
|
|
|
62
129
|
schema: {
|
|
63
130
|
type: "string",
|
|
64
131
|
},
|
|
132
|
+
"x-displayname": "Namespace",
|
|
133
|
+
"x-ves-example": "Ns1",
|
|
65
134
|
},
|
|
66
135
|
],
|
|
67
136
|
queryParameters: [],
|
|
@@ -73,6 +142,70 @@ export const bigipTools = [
|
|
|
73
142
|
operationId: "ves.io.schema.bigip.apm.API.Delete",
|
|
74
143
|
tags: ["Other"],
|
|
75
144
|
sourceFile: "domains/bigip.json",
|
|
145
|
+
displayName: null,
|
|
146
|
+
dangerLevel: "high",
|
|
147
|
+
sideEffects: {
|
|
148
|
+
deletes: ["apm", "contained_resources"],
|
|
149
|
+
},
|
|
150
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
151
|
+
confirmationRequired: true,
|
|
152
|
+
parameterExamples: {
|
|
153
|
+
name: "Name",
|
|
154
|
+
namespace: "Ns1",
|
|
155
|
+
},
|
|
156
|
+
validationRules: {},
|
|
157
|
+
operationMetadata: {
|
|
158
|
+
common_errors: [
|
|
159
|
+
{
|
|
160
|
+
code: 401,
|
|
161
|
+
message: "Authentication required",
|
|
162
|
+
solution: "Provide valid API credentials",
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
code: 403,
|
|
166
|
+
message: "Permission denied",
|
|
167
|
+
solution: "Check access permissions for this operation",
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
code: 404,
|
|
171
|
+
message: "Resource not found",
|
|
172
|
+
solution: "Verify resource name, namespace, and path",
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
code: 409,
|
|
176
|
+
message: "Resource already exists",
|
|
177
|
+
solution: "Use different name or update existing resource",
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
code: 429,
|
|
181
|
+
message: "Rate limit exceeded",
|
|
182
|
+
solution: "Wait before retrying the operation",
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
code: 500,
|
|
186
|
+
message: "Server error",
|
|
187
|
+
solution: "Retry operation or contact support",
|
|
188
|
+
},
|
|
189
|
+
],
|
|
190
|
+
conditions: {
|
|
191
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
192
|
+
prerequisites: ["Active namespace"],
|
|
193
|
+
},
|
|
194
|
+
confirmation_required: true,
|
|
195
|
+
danger_level: "high",
|
|
196
|
+
field_docs: {},
|
|
197
|
+
optional_fields: [],
|
|
198
|
+
performance_impact: {
|
|
199
|
+
latency: "high",
|
|
200
|
+
resource_usage: "moderate",
|
|
201
|
+
},
|
|
202
|
+
purpose: "Delete apm",
|
|
203
|
+
required_fields: ["path.name", "path.namespace"],
|
|
204
|
+
side_effects: {
|
|
205
|
+
deletes: ["apm", "contained_resources"],
|
|
206
|
+
},
|
|
207
|
+
},
|
|
208
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/apms" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
76
209
|
},
|
|
77
210
|
{
|
|
78
211
|
toolName: "f5xc-api-bigip-apm-get",
|
|
@@ -92,6 +225,8 @@ export const bigipTools = [
|
|
|
92
225
|
schema: {
|
|
93
226
|
type: "string",
|
|
94
227
|
},
|
|
228
|
+
"x-displayname": "Name",
|
|
229
|
+
"x-ves-example": "Name",
|
|
95
230
|
},
|
|
96
231
|
{
|
|
97
232
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -101,6 +236,8 @@ export const bigipTools = [
|
|
|
101
236
|
schema: {
|
|
102
237
|
type: "string",
|
|
103
238
|
},
|
|
239
|
+
"x-displayname": "Namespace",
|
|
240
|
+
"x-ves-example": "Ns1",
|
|
104
241
|
},
|
|
105
242
|
],
|
|
106
243
|
queryParameters: [
|
|
@@ -122,6 +259,7 @@ export const bigipTools = [
|
|
|
122
259
|
],
|
|
123
260
|
type: "string",
|
|
124
261
|
},
|
|
262
|
+
"x-displayname": "Broken Referred Objects.",
|
|
125
263
|
},
|
|
126
264
|
],
|
|
127
265
|
requestBodySchema: null,
|
|
@@ -132,6 +270,66 @@ export const bigipTools = [
|
|
|
132
270
|
operationId: "ves.io.schema.bigip.apm.API.Get",
|
|
133
271
|
tags: ["Other"],
|
|
134
272
|
sourceFile: "domains/bigip.json",
|
|
273
|
+
displayName: null,
|
|
274
|
+
dangerLevel: "low",
|
|
275
|
+
sideEffects: null,
|
|
276
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
277
|
+
confirmationRequired: false,
|
|
278
|
+
parameterExamples: {
|
|
279
|
+
name: "Name",
|
|
280
|
+
namespace: "Ns1",
|
|
281
|
+
},
|
|
282
|
+
validationRules: {},
|
|
283
|
+
operationMetadata: {
|
|
284
|
+
common_errors: [
|
|
285
|
+
{
|
|
286
|
+
code: 401,
|
|
287
|
+
message: "Authentication required",
|
|
288
|
+
solution: "Provide valid API credentials",
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
code: 403,
|
|
292
|
+
message: "Permission denied",
|
|
293
|
+
solution: "Check access permissions for this operation",
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
code: 404,
|
|
297
|
+
message: "Resource not found",
|
|
298
|
+
solution: "Verify resource name, namespace, and path",
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
code: 409,
|
|
302
|
+
message: "Resource already exists",
|
|
303
|
+
solution: "Use different name or update existing resource",
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
code: 429,
|
|
307
|
+
message: "Rate limit exceeded",
|
|
308
|
+
solution: "Wait before retrying the operation",
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
code: 500,
|
|
312
|
+
message: "Server error",
|
|
313
|
+
solution: "Retry operation or contact support",
|
|
314
|
+
},
|
|
315
|
+
],
|
|
316
|
+
conditions: {
|
|
317
|
+
postconditions: [],
|
|
318
|
+
prerequisites: ["Active namespace"],
|
|
319
|
+
},
|
|
320
|
+
confirmation_required: false,
|
|
321
|
+
danger_level: "low",
|
|
322
|
+
field_docs: {},
|
|
323
|
+
optional_fields: [],
|
|
324
|
+
performance_impact: {
|
|
325
|
+
latency: "low",
|
|
326
|
+
resource_usage: "low",
|
|
327
|
+
},
|
|
328
|
+
purpose: "Retrieve specific apm",
|
|
329
|
+
required_fields: ["path.name", "path.namespace"],
|
|
330
|
+
side_effects: {},
|
|
331
|
+
},
|
|
332
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/apms" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
135
333
|
},
|
|
136
334
|
{
|
|
137
335
|
toolName: "f5xc-api-bigip-apm-list",
|
|
@@ -151,6 +349,8 @@ export const bigipTools = [
|
|
|
151
349
|
schema: {
|
|
152
350
|
type: "string",
|
|
153
351
|
},
|
|
352
|
+
"x-displayname": "Namespace",
|
|
353
|
+
"x-ves-example": "Ns1",
|
|
154
354
|
},
|
|
155
355
|
],
|
|
156
356
|
queryParameters: [
|
|
@@ -162,6 +362,8 @@ export const bigipTools = [
|
|
|
162
362
|
schema: {
|
|
163
363
|
type: "string",
|
|
164
364
|
},
|
|
365
|
+
"x-displayname": "Label Filter.",
|
|
366
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
165
367
|
},
|
|
166
368
|
{
|
|
167
369
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -174,6 +376,7 @@ export const bigipTools = [
|
|
|
174
376
|
},
|
|
175
377
|
type: "array",
|
|
176
378
|
},
|
|
379
|
+
"x-displayname": "Report Fields.",
|
|
177
380
|
},
|
|
178
381
|
{
|
|
179
382
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -186,6 +389,7 @@ export const bigipTools = [
|
|
|
186
389
|
},
|
|
187
390
|
type: "array",
|
|
188
391
|
},
|
|
392
|
+
"x-displayname": "Report Status Fields.",
|
|
189
393
|
},
|
|
190
394
|
],
|
|
191
395
|
requestBodySchema: null,
|
|
@@ -196,6 +400,66 @@ export const bigipTools = [
|
|
|
196
400
|
operationId: "ves.io.schema.bigip.apm.API.List",
|
|
197
401
|
tags: ["Other"],
|
|
198
402
|
sourceFile: "domains/bigip.json",
|
|
403
|
+
displayName: null,
|
|
404
|
+
dangerLevel: "low",
|
|
405
|
+
sideEffects: null,
|
|
406
|
+
requiredFields: ["path.namespace"],
|
|
407
|
+
confirmationRequired: false,
|
|
408
|
+
parameterExamples: {
|
|
409
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
410
|
+
namespace: "Ns1",
|
|
411
|
+
},
|
|
412
|
+
validationRules: {},
|
|
413
|
+
operationMetadata: {
|
|
414
|
+
common_errors: [
|
|
415
|
+
{
|
|
416
|
+
code: 401,
|
|
417
|
+
message: "Authentication required",
|
|
418
|
+
solution: "Provide valid API credentials",
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
code: 403,
|
|
422
|
+
message: "Permission denied",
|
|
423
|
+
solution: "Check access permissions for this operation",
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
code: 404,
|
|
427
|
+
message: "Resource not found",
|
|
428
|
+
solution: "Verify resource name, namespace, and path",
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
code: 409,
|
|
432
|
+
message: "Resource already exists",
|
|
433
|
+
solution: "Use different name or update existing resource",
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
code: 429,
|
|
437
|
+
message: "Rate limit exceeded",
|
|
438
|
+
solution: "Wait before retrying the operation",
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
code: 500,
|
|
442
|
+
message: "Server error",
|
|
443
|
+
solution: "Retry operation or contact support",
|
|
444
|
+
},
|
|
445
|
+
],
|
|
446
|
+
conditions: {
|
|
447
|
+
postconditions: [],
|
|
448
|
+
prerequisites: ["Active namespace"],
|
|
449
|
+
},
|
|
450
|
+
confirmation_required: false,
|
|
451
|
+
danger_level: "low",
|
|
452
|
+
field_docs: {},
|
|
453
|
+
optional_fields: [],
|
|
454
|
+
performance_impact: {
|
|
455
|
+
latency: "moderate",
|
|
456
|
+
resource_usage: "moderate",
|
|
457
|
+
},
|
|
458
|
+
purpose: "List all apms",
|
|
459
|
+
required_fields: ["path.namespace"],
|
|
460
|
+
side_effects: {},
|
|
461
|
+
},
|
|
462
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/apms" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
199
463
|
},
|
|
200
464
|
{
|
|
201
465
|
toolName: "f5xc-api-bigip-apm-update",
|
|
@@ -215,6 +479,8 @@ export const bigipTools = [
|
|
|
215
479
|
schema: {
|
|
216
480
|
type: "string",
|
|
217
481
|
},
|
|
482
|
+
"x-displayname": "Name",
|
|
483
|
+
"x-ves-example": "Example-corp-web.",
|
|
218
484
|
},
|
|
219
485
|
{
|
|
220
486
|
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 ""',
|
|
@@ -224,6 +490,8 @@ export const bigipTools = [
|
|
|
224
490
|
schema: {
|
|
225
491
|
type: "string",
|
|
226
492
|
},
|
|
493
|
+
"x-displayname": "Namespace",
|
|
494
|
+
"x-ves-example": "Staging",
|
|
227
495
|
},
|
|
228
496
|
],
|
|
229
497
|
queryParameters: [],
|
|
@@ -237,6 +505,70 @@ export const bigipTools = [
|
|
|
237
505
|
operationId: "ves.io.schema.bigip.apm.API.Replace",
|
|
238
506
|
tags: ["Other"],
|
|
239
507
|
sourceFile: "domains/bigip.json",
|
|
508
|
+
displayName: null,
|
|
509
|
+
dangerLevel: "medium",
|
|
510
|
+
sideEffects: {
|
|
511
|
+
modifies: ["apm"],
|
|
512
|
+
},
|
|
513
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
514
|
+
confirmationRequired: false,
|
|
515
|
+
parameterExamples: {
|
|
516
|
+
"metadata.name": "Example-corp-web.",
|
|
517
|
+
"metadata.namespace": "Staging",
|
|
518
|
+
},
|
|
519
|
+
validationRules: {},
|
|
520
|
+
operationMetadata: {
|
|
521
|
+
common_errors: [
|
|
522
|
+
{
|
|
523
|
+
code: 401,
|
|
524
|
+
message: "Authentication required",
|
|
525
|
+
solution: "Provide valid API credentials",
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
code: 403,
|
|
529
|
+
message: "Permission denied",
|
|
530
|
+
solution: "Check access permissions for this operation",
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
code: 404,
|
|
534
|
+
message: "Resource not found",
|
|
535
|
+
solution: "Verify resource name, namespace, and path",
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
code: 409,
|
|
539
|
+
message: "Resource already exists",
|
|
540
|
+
solution: "Use different name or update existing resource",
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
code: 429,
|
|
544
|
+
message: "Rate limit exceeded",
|
|
545
|
+
solution: "Wait before retrying the operation",
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
code: 500,
|
|
549
|
+
message: "Server error",
|
|
550
|
+
solution: "Retry operation or contact support",
|
|
551
|
+
},
|
|
552
|
+
],
|
|
553
|
+
conditions: {
|
|
554
|
+
postconditions: ["Resource updated with new values"],
|
|
555
|
+
prerequisites: ["Active namespace"],
|
|
556
|
+
},
|
|
557
|
+
confirmation_required: false,
|
|
558
|
+
danger_level: "medium",
|
|
559
|
+
field_docs: {},
|
|
560
|
+
optional_fields: [],
|
|
561
|
+
performance_impact: {
|
|
562
|
+
latency: "low",
|
|
563
|
+
resource_usage: "low",
|
|
564
|
+
},
|
|
565
|
+
purpose: "Replace existing apm",
|
|
566
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
567
|
+
side_effects: {
|
|
568
|
+
modifies: ["apm"],
|
|
569
|
+
},
|
|
570
|
+
},
|
|
571
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/apms" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
240
572
|
},
|
|
241
573
|
{
|
|
242
574
|
toolName: "f5xc-api-bigip-bigip-irule-create",
|
|
@@ -256,6 +588,8 @@ export const bigipTools = [
|
|
|
256
588
|
schema: {
|
|
257
589
|
type: "string",
|
|
258
590
|
},
|
|
591
|
+
"x-displayname": "Namespace",
|
|
592
|
+
"x-ves-example": "Staging",
|
|
259
593
|
},
|
|
260
594
|
],
|
|
261
595
|
queryParameters: [],
|
|
@@ -269,6 +603,69 @@ export const bigipTools = [
|
|
|
269
603
|
operationId: "ves.io.schema.bigip_irule.API.Create",
|
|
270
604
|
tags: ["Other"],
|
|
271
605
|
sourceFile: "domains/bigip.json",
|
|
606
|
+
displayName: null,
|
|
607
|
+
dangerLevel: "medium",
|
|
608
|
+
sideEffects: {
|
|
609
|
+
creates: ["bigip-irule"],
|
|
610
|
+
},
|
|
611
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
612
|
+
confirmationRequired: false,
|
|
613
|
+
parameterExamples: {
|
|
614
|
+
"metadata.namespace": "Staging",
|
|
615
|
+
},
|
|
616
|
+
validationRules: {},
|
|
617
|
+
operationMetadata: {
|
|
618
|
+
common_errors: [
|
|
619
|
+
{
|
|
620
|
+
code: 401,
|
|
621
|
+
message: "Authentication required",
|
|
622
|
+
solution: "Provide valid API credentials",
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
code: 403,
|
|
626
|
+
message: "Permission denied",
|
|
627
|
+
solution: "Check access permissions for this operation",
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
code: 404,
|
|
631
|
+
message: "Resource not found",
|
|
632
|
+
solution: "Verify resource name, namespace, and path",
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
code: 409,
|
|
636
|
+
message: "Resource already exists",
|
|
637
|
+
solution: "Use different name or update existing resource",
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
code: 429,
|
|
641
|
+
message: "Rate limit exceeded",
|
|
642
|
+
solution: "Wait before retrying the operation",
|
|
643
|
+
},
|
|
644
|
+
{
|
|
645
|
+
code: 500,
|
|
646
|
+
message: "Server error",
|
|
647
|
+
solution: "Retry operation or contact support",
|
|
648
|
+
},
|
|
649
|
+
],
|
|
650
|
+
conditions: {
|
|
651
|
+
postconditions: ["Bigip-irule resource created", "Resource assigned unique identifier"],
|
|
652
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
653
|
+
},
|
|
654
|
+
confirmation_required: false,
|
|
655
|
+
danger_level: "medium",
|
|
656
|
+
field_docs: {},
|
|
657
|
+
optional_fields: [],
|
|
658
|
+
performance_impact: {
|
|
659
|
+
latency: "low",
|
|
660
|
+
resource_usage: "low",
|
|
661
|
+
},
|
|
662
|
+
purpose: "Create new bigip-irule",
|
|
663
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
664
|
+
side_effects: {
|
|
665
|
+
creates: ["bigip-irule"],
|
|
666
|
+
},
|
|
667
|
+
},
|
|
668
|
+
curlExample: null,
|
|
272
669
|
},
|
|
273
670
|
{
|
|
274
671
|
toolName: "f5xc-api-bigip-bigip-irule-delete",
|
|
@@ -288,6 +685,8 @@ export const bigipTools = [
|
|
|
288
685
|
schema: {
|
|
289
686
|
type: "string",
|
|
290
687
|
},
|
|
688
|
+
"x-displayname": "Name",
|
|
689
|
+
"x-ves-example": "Name",
|
|
291
690
|
},
|
|
292
691
|
{
|
|
293
692
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -297,6 +696,8 @@ export const bigipTools = [
|
|
|
297
696
|
schema: {
|
|
298
697
|
type: "string",
|
|
299
698
|
},
|
|
699
|
+
"x-displayname": "Namespace",
|
|
700
|
+
"x-ves-example": "Ns1",
|
|
300
701
|
},
|
|
301
702
|
],
|
|
302
703
|
queryParameters: [],
|
|
@@ -308,6 +709,70 @@ export const bigipTools = [
|
|
|
308
709
|
operationId: "ves.io.schema.bigip_irule.API.Delete",
|
|
309
710
|
tags: ["Other"],
|
|
310
711
|
sourceFile: "domains/bigip.json",
|
|
712
|
+
displayName: null,
|
|
713
|
+
dangerLevel: "high",
|
|
714
|
+
sideEffects: {
|
|
715
|
+
deletes: ["bigip-irule", "contained_resources"],
|
|
716
|
+
},
|
|
717
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
718
|
+
confirmationRequired: true,
|
|
719
|
+
parameterExamples: {
|
|
720
|
+
name: "Name",
|
|
721
|
+
namespace: "Ns1",
|
|
722
|
+
},
|
|
723
|
+
validationRules: {},
|
|
724
|
+
operationMetadata: {
|
|
725
|
+
common_errors: [
|
|
726
|
+
{
|
|
727
|
+
code: 401,
|
|
728
|
+
message: "Authentication required",
|
|
729
|
+
solution: "Provide valid API credentials",
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
code: 403,
|
|
733
|
+
message: "Permission denied",
|
|
734
|
+
solution: "Check access permissions for this operation",
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
code: 404,
|
|
738
|
+
message: "Resource not found",
|
|
739
|
+
solution: "Verify resource name, namespace, and path",
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
code: 409,
|
|
743
|
+
message: "Resource already exists",
|
|
744
|
+
solution: "Use different name or update existing resource",
|
|
745
|
+
},
|
|
746
|
+
{
|
|
747
|
+
code: 429,
|
|
748
|
+
message: "Rate limit exceeded",
|
|
749
|
+
solution: "Wait before retrying the operation",
|
|
750
|
+
},
|
|
751
|
+
{
|
|
752
|
+
code: 500,
|
|
753
|
+
message: "Server error",
|
|
754
|
+
solution: "Retry operation or contact support",
|
|
755
|
+
},
|
|
756
|
+
],
|
|
757
|
+
conditions: {
|
|
758
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
759
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
760
|
+
},
|
|
761
|
+
confirmation_required: true,
|
|
762
|
+
danger_level: "high",
|
|
763
|
+
field_docs: {},
|
|
764
|
+
optional_fields: [],
|
|
765
|
+
performance_impact: {
|
|
766
|
+
latency: "high",
|
|
767
|
+
resource_usage: "moderate",
|
|
768
|
+
},
|
|
769
|
+
purpose: "Delete bigip-irule",
|
|
770
|
+
required_fields: ["path.name", "path.namespace"],
|
|
771
|
+
side_effects: {
|
|
772
|
+
deletes: ["bigip-irule", "contained_resources"],
|
|
773
|
+
},
|
|
774
|
+
},
|
|
775
|
+
curlExample: null,
|
|
311
776
|
},
|
|
312
777
|
{
|
|
313
778
|
toolName: "f5xc-api-bigip-bigip-irule-get",
|
|
@@ -327,6 +792,8 @@ export const bigipTools = [
|
|
|
327
792
|
schema: {
|
|
328
793
|
type: "string",
|
|
329
794
|
},
|
|
795
|
+
"x-displayname": "Name",
|
|
796
|
+
"x-ves-example": "Name",
|
|
330
797
|
},
|
|
331
798
|
{
|
|
332
799
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -336,6 +803,8 @@ export const bigipTools = [
|
|
|
336
803
|
schema: {
|
|
337
804
|
type: "string",
|
|
338
805
|
},
|
|
806
|
+
"x-displayname": "Namespace",
|
|
807
|
+
"x-ves-example": "Ns1",
|
|
339
808
|
},
|
|
340
809
|
],
|
|
341
810
|
queryParameters: [
|
|
@@ -357,6 +826,7 @@ export const bigipTools = [
|
|
|
357
826
|
],
|
|
358
827
|
type: "string",
|
|
359
828
|
},
|
|
829
|
+
"x-displayname": "Broken Referred Objects.",
|
|
360
830
|
},
|
|
361
831
|
],
|
|
362
832
|
requestBodySchema: null,
|
|
@@ -367,6 +837,66 @@ export const bigipTools = [
|
|
|
367
837
|
operationId: "ves.io.schema.bigip_irule.API.Get",
|
|
368
838
|
tags: ["Other"],
|
|
369
839
|
sourceFile: "domains/bigip.json",
|
|
840
|
+
displayName: null,
|
|
841
|
+
dangerLevel: "low",
|
|
842
|
+
sideEffects: null,
|
|
843
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
844
|
+
confirmationRequired: false,
|
|
845
|
+
parameterExamples: {
|
|
846
|
+
name: "Name",
|
|
847
|
+
namespace: "Ns1",
|
|
848
|
+
},
|
|
849
|
+
validationRules: {},
|
|
850
|
+
operationMetadata: {
|
|
851
|
+
common_errors: [
|
|
852
|
+
{
|
|
853
|
+
code: 401,
|
|
854
|
+
message: "Authentication required",
|
|
855
|
+
solution: "Provide valid API credentials",
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
code: 403,
|
|
859
|
+
message: "Permission denied",
|
|
860
|
+
solution: "Check access permissions for this operation",
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
code: 404,
|
|
864
|
+
message: "Resource not found",
|
|
865
|
+
solution: "Verify resource name, namespace, and path",
|
|
866
|
+
},
|
|
867
|
+
{
|
|
868
|
+
code: 409,
|
|
869
|
+
message: "Resource already exists",
|
|
870
|
+
solution: "Use different name or update existing resource",
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
code: 429,
|
|
874
|
+
message: "Rate limit exceeded",
|
|
875
|
+
solution: "Wait before retrying the operation",
|
|
876
|
+
},
|
|
877
|
+
{
|
|
878
|
+
code: 500,
|
|
879
|
+
message: "Server error",
|
|
880
|
+
solution: "Retry operation or contact support",
|
|
881
|
+
},
|
|
882
|
+
],
|
|
883
|
+
conditions: {
|
|
884
|
+
postconditions: [],
|
|
885
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
886
|
+
},
|
|
887
|
+
confirmation_required: false,
|
|
888
|
+
danger_level: "low",
|
|
889
|
+
field_docs: {},
|
|
890
|
+
optional_fields: [],
|
|
891
|
+
performance_impact: {
|
|
892
|
+
latency: "low",
|
|
893
|
+
resource_usage: "low",
|
|
894
|
+
},
|
|
895
|
+
purpose: "Retrieve specific bigip-irule",
|
|
896
|
+
required_fields: ["path.name", "path.namespace"],
|
|
897
|
+
side_effects: {},
|
|
898
|
+
},
|
|
899
|
+
curlExample: null,
|
|
370
900
|
},
|
|
371
901
|
{
|
|
372
902
|
toolName: "f5xc-api-bigip-bigip-irule-list",
|
|
@@ -386,6 +916,8 @@ export const bigipTools = [
|
|
|
386
916
|
schema: {
|
|
387
917
|
type: "string",
|
|
388
918
|
},
|
|
919
|
+
"x-displayname": "Namespace",
|
|
920
|
+
"x-ves-example": "Ns1",
|
|
389
921
|
},
|
|
390
922
|
],
|
|
391
923
|
queryParameters: [
|
|
@@ -397,6 +929,8 @@ export const bigipTools = [
|
|
|
397
929
|
schema: {
|
|
398
930
|
type: "string",
|
|
399
931
|
},
|
|
932
|
+
"x-displayname": "Label Filter.",
|
|
933
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
400
934
|
},
|
|
401
935
|
{
|
|
402
936
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -409,6 +943,7 @@ export const bigipTools = [
|
|
|
409
943
|
},
|
|
410
944
|
type: "array",
|
|
411
945
|
},
|
|
946
|
+
"x-displayname": "Report Fields.",
|
|
412
947
|
},
|
|
413
948
|
{
|
|
414
949
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -421,6 +956,7 @@ export const bigipTools = [
|
|
|
421
956
|
},
|
|
422
957
|
type: "array",
|
|
423
958
|
},
|
|
959
|
+
"x-displayname": "Report Status Fields.",
|
|
424
960
|
},
|
|
425
961
|
],
|
|
426
962
|
requestBodySchema: null,
|
|
@@ -431,6 +967,66 @@ export const bigipTools = [
|
|
|
431
967
|
operationId: "ves.io.schema.bigip_irule.API.List",
|
|
432
968
|
tags: ["Other"],
|
|
433
969
|
sourceFile: "domains/bigip.json",
|
|
970
|
+
displayName: null,
|
|
971
|
+
dangerLevel: "low",
|
|
972
|
+
sideEffects: null,
|
|
973
|
+
requiredFields: ["path.namespace"],
|
|
974
|
+
confirmationRequired: false,
|
|
975
|
+
parameterExamples: {
|
|
976
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
977
|
+
namespace: "Ns1",
|
|
978
|
+
},
|
|
979
|
+
validationRules: {},
|
|
980
|
+
operationMetadata: {
|
|
981
|
+
common_errors: [
|
|
982
|
+
{
|
|
983
|
+
code: 401,
|
|
984
|
+
message: "Authentication required",
|
|
985
|
+
solution: "Provide valid API credentials",
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
code: 403,
|
|
989
|
+
message: "Permission denied",
|
|
990
|
+
solution: "Check access permissions for this operation",
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
code: 404,
|
|
994
|
+
message: "Resource not found",
|
|
995
|
+
solution: "Verify resource name, namespace, and path",
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
code: 409,
|
|
999
|
+
message: "Resource already exists",
|
|
1000
|
+
solution: "Use different name or update existing resource",
|
|
1001
|
+
},
|
|
1002
|
+
{
|
|
1003
|
+
code: 429,
|
|
1004
|
+
message: "Rate limit exceeded",
|
|
1005
|
+
solution: "Wait before retrying the operation",
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
code: 500,
|
|
1009
|
+
message: "Server error",
|
|
1010
|
+
solution: "Retry operation or contact support",
|
|
1011
|
+
},
|
|
1012
|
+
],
|
|
1013
|
+
conditions: {
|
|
1014
|
+
postconditions: [],
|
|
1015
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1016
|
+
},
|
|
1017
|
+
confirmation_required: false,
|
|
1018
|
+
danger_level: "low",
|
|
1019
|
+
field_docs: {},
|
|
1020
|
+
optional_fields: [],
|
|
1021
|
+
performance_impact: {
|
|
1022
|
+
latency: "moderate",
|
|
1023
|
+
resource_usage: "moderate",
|
|
1024
|
+
},
|
|
1025
|
+
purpose: "List all bigip-irules",
|
|
1026
|
+
required_fields: ["path.namespace"],
|
|
1027
|
+
side_effects: {},
|
|
1028
|
+
},
|
|
1029
|
+
curlExample: null,
|
|
434
1030
|
},
|
|
435
1031
|
{
|
|
436
1032
|
toolName: "f5xc-api-bigip-bigip-irule-update",
|
|
@@ -450,6 +1046,8 @@ export const bigipTools = [
|
|
|
450
1046
|
schema: {
|
|
451
1047
|
type: "string",
|
|
452
1048
|
},
|
|
1049
|
+
"x-displayname": "Name",
|
|
1050
|
+
"x-ves-example": "Example-corp-web.",
|
|
453
1051
|
},
|
|
454
1052
|
{
|
|
455
1053
|
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 ""',
|
|
@@ -459,6 +1057,8 @@ export const bigipTools = [
|
|
|
459
1057
|
schema: {
|
|
460
1058
|
type: "string",
|
|
461
1059
|
},
|
|
1060
|
+
"x-displayname": "Namespace",
|
|
1061
|
+
"x-ves-example": "Staging",
|
|
462
1062
|
},
|
|
463
1063
|
],
|
|
464
1064
|
queryParameters: [],
|
|
@@ -472,6 +1072,70 @@ export const bigipTools = [
|
|
|
472
1072
|
operationId: "ves.io.schema.bigip_irule.API.Replace",
|
|
473
1073
|
tags: ["Other"],
|
|
474
1074
|
sourceFile: "domains/bigip.json",
|
|
1075
|
+
displayName: null,
|
|
1076
|
+
dangerLevel: "medium",
|
|
1077
|
+
sideEffects: {
|
|
1078
|
+
modifies: ["bigip-irule"],
|
|
1079
|
+
},
|
|
1080
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1081
|
+
confirmationRequired: false,
|
|
1082
|
+
parameterExamples: {
|
|
1083
|
+
"metadata.name": "Example-corp-web.",
|
|
1084
|
+
"metadata.namespace": "Staging",
|
|
1085
|
+
},
|
|
1086
|
+
validationRules: {},
|
|
1087
|
+
operationMetadata: {
|
|
1088
|
+
common_errors: [
|
|
1089
|
+
{
|
|
1090
|
+
code: 401,
|
|
1091
|
+
message: "Authentication required",
|
|
1092
|
+
solution: "Provide valid API credentials",
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
code: 403,
|
|
1096
|
+
message: "Permission denied",
|
|
1097
|
+
solution: "Check access permissions for this operation",
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
code: 404,
|
|
1101
|
+
message: "Resource not found",
|
|
1102
|
+
solution: "Verify resource name, namespace, and path",
|
|
1103
|
+
},
|
|
1104
|
+
{
|
|
1105
|
+
code: 409,
|
|
1106
|
+
message: "Resource already exists",
|
|
1107
|
+
solution: "Use different name or update existing resource",
|
|
1108
|
+
},
|
|
1109
|
+
{
|
|
1110
|
+
code: 429,
|
|
1111
|
+
message: "Rate limit exceeded",
|
|
1112
|
+
solution: "Wait before retrying the operation",
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
code: 500,
|
|
1116
|
+
message: "Server error",
|
|
1117
|
+
solution: "Retry operation or contact support",
|
|
1118
|
+
},
|
|
1119
|
+
],
|
|
1120
|
+
conditions: {
|
|
1121
|
+
postconditions: ["Resource updated with new values"],
|
|
1122
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1123
|
+
},
|
|
1124
|
+
confirmation_required: false,
|
|
1125
|
+
danger_level: "medium",
|
|
1126
|
+
field_docs: {},
|
|
1127
|
+
optional_fields: [],
|
|
1128
|
+
performance_impact: {
|
|
1129
|
+
latency: "low",
|
|
1130
|
+
resource_usage: "low",
|
|
1131
|
+
},
|
|
1132
|
+
purpose: "Replace existing bigip-irule",
|
|
1133
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1134
|
+
side_effects: {
|
|
1135
|
+
modifies: ["bigip-irule"],
|
|
1136
|
+
},
|
|
1137
|
+
},
|
|
1138
|
+
curlExample: null,
|
|
475
1139
|
},
|
|
476
1140
|
{
|
|
477
1141
|
toolName: "f5xc-api-bigip-bigip-virtual-server-get",
|
|
@@ -491,6 +1155,8 @@ export const bigipTools = [
|
|
|
491
1155
|
schema: {
|
|
492
1156
|
type: "string",
|
|
493
1157
|
},
|
|
1158
|
+
"x-displayname": "Name",
|
|
1159
|
+
"x-ves-example": "Name",
|
|
494
1160
|
},
|
|
495
1161
|
{
|
|
496
1162
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -500,6 +1166,8 @@ export const bigipTools = [
|
|
|
500
1166
|
schema: {
|
|
501
1167
|
type: "string",
|
|
502
1168
|
},
|
|
1169
|
+
"x-displayname": "Namespace",
|
|
1170
|
+
"x-ves-example": "Ns1",
|
|
503
1171
|
},
|
|
504
1172
|
],
|
|
505
1173
|
queryParameters: [
|
|
@@ -520,6 +1188,7 @@ export const bigipTools = [
|
|
|
520
1188
|
],
|
|
521
1189
|
type: "string",
|
|
522
1190
|
},
|
|
1191
|
+
"x-displayname": "Broken Referred Objects.",
|
|
523
1192
|
},
|
|
524
1193
|
],
|
|
525
1194
|
requestBodySchema: null,
|
|
@@ -530,6 +1199,66 @@ export const bigipTools = [
|
|
|
530
1199
|
operationId: "ves.io.schema.views.bigip_virtual_server.API.Get",
|
|
531
1200
|
tags: ["Other"],
|
|
532
1201
|
sourceFile: "domains/bigip.json",
|
|
1202
|
+
displayName: null,
|
|
1203
|
+
dangerLevel: "low",
|
|
1204
|
+
sideEffects: null,
|
|
1205
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1206
|
+
confirmationRequired: false,
|
|
1207
|
+
parameterExamples: {
|
|
1208
|
+
name: "Name",
|
|
1209
|
+
namespace: "Ns1",
|
|
1210
|
+
},
|
|
1211
|
+
validationRules: {},
|
|
1212
|
+
operationMetadata: {
|
|
1213
|
+
common_errors: [
|
|
1214
|
+
{
|
|
1215
|
+
code: 401,
|
|
1216
|
+
message: "Authentication required",
|
|
1217
|
+
solution: "Provide valid API credentials",
|
|
1218
|
+
},
|
|
1219
|
+
{
|
|
1220
|
+
code: 403,
|
|
1221
|
+
message: "Permission denied",
|
|
1222
|
+
solution: "Check access permissions for this operation",
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
code: 404,
|
|
1226
|
+
message: "Resource not found",
|
|
1227
|
+
solution: "Verify resource name, namespace, and path",
|
|
1228
|
+
},
|
|
1229
|
+
{
|
|
1230
|
+
code: 409,
|
|
1231
|
+
message: "Resource already exists",
|
|
1232
|
+
solution: "Use different name or update existing resource",
|
|
1233
|
+
},
|
|
1234
|
+
{
|
|
1235
|
+
code: 429,
|
|
1236
|
+
message: "Rate limit exceeded",
|
|
1237
|
+
solution: "Wait before retrying the operation",
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
code: 500,
|
|
1241
|
+
message: "Server error",
|
|
1242
|
+
solution: "Retry operation or contact support",
|
|
1243
|
+
},
|
|
1244
|
+
],
|
|
1245
|
+
conditions: {
|
|
1246
|
+
postconditions: [],
|
|
1247
|
+
prerequisites: ["Active namespace"],
|
|
1248
|
+
},
|
|
1249
|
+
confirmation_required: false,
|
|
1250
|
+
danger_level: "low",
|
|
1251
|
+
field_docs: {},
|
|
1252
|
+
optional_fields: [],
|
|
1253
|
+
performance_impact: {
|
|
1254
|
+
latency: "low",
|
|
1255
|
+
resource_usage: "low",
|
|
1256
|
+
},
|
|
1257
|
+
purpose: "Retrieve specific bigip-virtual-server",
|
|
1258
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1259
|
+
side_effects: {},
|
|
1260
|
+
},
|
|
1261
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bigip_virtual_servers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
533
1262
|
},
|
|
534
1263
|
{
|
|
535
1264
|
toolName: "f5xc-api-bigip-bigip-virtual-server-list",
|
|
@@ -549,6 +1278,8 @@ export const bigipTools = [
|
|
|
549
1278
|
schema: {
|
|
550
1279
|
type: "string",
|
|
551
1280
|
},
|
|
1281
|
+
"x-displayname": "Namespace",
|
|
1282
|
+
"x-ves-example": "Ns1",
|
|
552
1283
|
},
|
|
553
1284
|
],
|
|
554
1285
|
queryParameters: [
|
|
@@ -560,6 +1291,8 @@ export const bigipTools = [
|
|
|
560
1291
|
schema: {
|
|
561
1292
|
type: "string",
|
|
562
1293
|
},
|
|
1294
|
+
"x-displayname": "Label Filter.",
|
|
1295
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
563
1296
|
},
|
|
564
1297
|
{
|
|
565
1298
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -572,6 +1305,7 @@ export const bigipTools = [
|
|
|
572
1305
|
},
|
|
573
1306
|
type: "array",
|
|
574
1307
|
},
|
|
1308
|
+
"x-displayname": "Report Fields.",
|
|
575
1309
|
},
|
|
576
1310
|
{
|
|
577
1311
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -584,6 +1318,7 @@ export const bigipTools = [
|
|
|
584
1318
|
},
|
|
585
1319
|
type: "array",
|
|
586
1320
|
},
|
|
1321
|
+
"x-displayname": "Report Status Fields.",
|
|
587
1322
|
},
|
|
588
1323
|
],
|
|
589
1324
|
requestBodySchema: null,
|
|
@@ -594,6 +1329,66 @@ export const bigipTools = [
|
|
|
594
1329
|
operationId: "ves.io.schema.views.bigip_virtual_server.API.List",
|
|
595
1330
|
tags: ["Other"],
|
|
596
1331
|
sourceFile: "domains/bigip.json",
|
|
1332
|
+
displayName: null,
|
|
1333
|
+
dangerLevel: "low",
|
|
1334
|
+
sideEffects: null,
|
|
1335
|
+
requiredFields: ["path.namespace"],
|
|
1336
|
+
confirmationRequired: false,
|
|
1337
|
+
parameterExamples: {
|
|
1338
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
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
|
+
field_docs: {},
|
|
1382
|
+
optional_fields: [],
|
|
1383
|
+
performance_impact: {
|
|
1384
|
+
latency: "moderate",
|
|
1385
|
+
resource_usage: "moderate",
|
|
1386
|
+
},
|
|
1387
|
+
purpose: "List all bigip-virtual-servers",
|
|
1388
|
+
required_fields: ["path.namespace"],
|
|
1389
|
+
side_effects: {},
|
|
1390
|
+
},
|
|
1391
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bigip_virtual_servers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
597
1392
|
},
|
|
598
1393
|
{
|
|
599
1394
|
toolName: "f5xc-api-bigip-bigip-virtual-server-update",
|
|
@@ -613,6 +1408,8 @@ export const bigipTools = [
|
|
|
613
1408
|
schema: {
|
|
614
1409
|
type: "string",
|
|
615
1410
|
},
|
|
1411
|
+
"x-displayname": "Name",
|
|
1412
|
+
"x-ves-example": "Example-corp-web.",
|
|
616
1413
|
},
|
|
617
1414
|
{
|
|
618
1415
|
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 ""',
|
|
@@ -622,6 +1419,8 @@ export const bigipTools = [
|
|
|
622
1419
|
schema: {
|
|
623
1420
|
type: "string",
|
|
624
1421
|
},
|
|
1422
|
+
"x-displayname": "Namespace",
|
|
1423
|
+
"x-ves-example": "Staging",
|
|
625
1424
|
},
|
|
626
1425
|
],
|
|
627
1426
|
queryParameters: [],
|
|
@@ -635,6 +1434,70 @@ export const bigipTools = [
|
|
|
635
1434
|
operationId: "ves.io.schema.views.bigip_virtual_server.API.Replace",
|
|
636
1435
|
tags: ["Other"],
|
|
637
1436
|
sourceFile: "domains/bigip.json",
|
|
1437
|
+
displayName: null,
|
|
1438
|
+
dangerLevel: "medium",
|
|
1439
|
+
sideEffects: {
|
|
1440
|
+
modifies: ["bigip-virtual-server"],
|
|
1441
|
+
},
|
|
1442
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1443
|
+
confirmationRequired: false,
|
|
1444
|
+
parameterExamples: {
|
|
1445
|
+
"metadata.name": "Example-corp-web.",
|
|
1446
|
+
"metadata.namespace": "Staging",
|
|
1447
|
+
},
|
|
1448
|
+
validationRules: {},
|
|
1449
|
+
operationMetadata: {
|
|
1450
|
+
common_errors: [
|
|
1451
|
+
{
|
|
1452
|
+
code: 401,
|
|
1453
|
+
message: "Authentication required",
|
|
1454
|
+
solution: "Provide valid API credentials",
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
code: 403,
|
|
1458
|
+
message: "Permission denied",
|
|
1459
|
+
solution: "Check access permissions for this operation",
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
code: 404,
|
|
1463
|
+
message: "Resource not found",
|
|
1464
|
+
solution: "Verify resource name, namespace, and path",
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
code: 409,
|
|
1468
|
+
message: "Resource already exists",
|
|
1469
|
+
solution: "Use different name or update existing resource",
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
code: 429,
|
|
1473
|
+
message: "Rate limit exceeded",
|
|
1474
|
+
solution: "Wait before retrying the operation",
|
|
1475
|
+
},
|
|
1476
|
+
{
|
|
1477
|
+
code: 500,
|
|
1478
|
+
message: "Server error",
|
|
1479
|
+
solution: "Retry operation or contact support",
|
|
1480
|
+
},
|
|
1481
|
+
],
|
|
1482
|
+
conditions: {
|
|
1483
|
+
postconditions: ["Resource updated with new values"],
|
|
1484
|
+
prerequisites: ["Active namespace"],
|
|
1485
|
+
},
|
|
1486
|
+
confirmation_required: false,
|
|
1487
|
+
danger_level: "medium",
|
|
1488
|
+
field_docs: {},
|
|
1489
|
+
optional_fields: [],
|
|
1490
|
+
performance_impact: {
|
|
1491
|
+
latency: "low",
|
|
1492
|
+
resource_usage: "low",
|
|
1493
|
+
},
|
|
1494
|
+
purpose: "Replace existing bigip-virtual-server",
|
|
1495
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1496
|
+
side_effects: {
|
|
1497
|
+
modifies: ["bigip-virtual-server"],
|
|
1498
|
+
},
|
|
1499
|
+
},
|
|
1500
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bigip_virtual_servers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
638
1501
|
},
|
|
639
1502
|
{
|
|
640
1503
|
toolName: "f5xc-api-bigip-data-group-create",
|
|
@@ -654,6 +1517,8 @@ export const bigipTools = [
|
|
|
654
1517
|
schema: {
|
|
655
1518
|
type: "string",
|
|
656
1519
|
},
|
|
1520
|
+
"x-displayname": "Namespace",
|
|
1521
|
+
"x-ves-example": "Staging",
|
|
657
1522
|
},
|
|
658
1523
|
],
|
|
659
1524
|
queryParameters: [],
|
|
@@ -667,6 +1532,69 @@ export const bigipTools = [
|
|
|
667
1532
|
operationId: "ves.io.schema.bigcne.data_group.API.Create",
|
|
668
1533
|
tags: ["Other"],
|
|
669
1534
|
sourceFile: "domains/bigip.json",
|
|
1535
|
+
displayName: null,
|
|
1536
|
+
dangerLevel: "medium",
|
|
1537
|
+
sideEffects: {
|
|
1538
|
+
creates: ["data-group"],
|
|
1539
|
+
},
|
|
1540
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1541
|
+
confirmationRequired: false,
|
|
1542
|
+
parameterExamples: {
|
|
1543
|
+
"metadata.namespace": "Staging",
|
|
1544
|
+
},
|
|
1545
|
+
validationRules: {},
|
|
1546
|
+
operationMetadata: {
|
|
1547
|
+
common_errors: [
|
|
1548
|
+
{
|
|
1549
|
+
code: 401,
|
|
1550
|
+
message: "Authentication required",
|
|
1551
|
+
solution: "Provide valid API credentials",
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
code: 403,
|
|
1555
|
+
message: "Permission denied",
|
|
1556
|
+
solution: "Check access permissions for this operation",
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
code: 404,
|
|
1560
|
+
message: "Resource not found",
|
|
1561
|
+
solution: "Verify resource name, namespace, and path",
|
|
1562
|
+
},
|
|
1563
|
+
{
|
|
1564
|
+
code: 409,
|
|
1565
|
+
message: "Resource already exists",
|
|
1566
|
+
solution: "Use different name or update existing resource",
|
|
1567
|
+
},
|
|
1568
|
+
{
|
|
1569
|
+
code: 429,
|
|
1570
|
+
message: "Rate limit exceeded",
|
|
1571
|
+
solution: "Wait before retrying the operation",
|
|
1572
|
+
},
|
|
1573
|
+
{
|
|
1574
|
+
code: 500,
|
|
1575
|
+
message: "Server error",
|
|
1576
|
+
solution: "Retry operation or contact support",
|
|
1577
|
+
},
|
|
1578
|
+
],
|
|
1579
|
+
conditions: {
|
|
1580
|
+
postconditions: ["Data-group resource created", "Resource assigned unique identifier"],
|
|
1581
|
+
prerequisites: ["Active namespace"],
|
|
1582
|
+
},
|
|
1583
|
+
confirmation_required: false,
|
|
1584
|
+
danger_level: "medium",
|
|
1585
|
+
field_docs: {},
|
|
1586
|
+
optional_fields: [],
|
|
1587
|
+
performance_impact: {
|
|
1588
|
+
latency: "low",
|
|
1589
|
+
resource_usage: "low",
|
|
1590
|
+
},
|
|
1591
|
+
purpose: "Create new data-group",
|
|
1592
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1593
|
+
side_effects: {
|
|
1594
|
+
creates: ["data-group"],
|
|
1595
|
+
},
|
|
1596
|
+
},
|
|
1597
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/data_groups" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
670
1598
|
},
|
|
671
1599
|
{
|
|
672
1600
|
toolName: "f5xc-api-bigip-data-group-delete",
|
|
@@ -686,6 +1614,8 @@ export const bigipTools = [
|
|
|
686
1614
|
schema: {
|
|
687
1615
|
type: "string",
|
|
688
1616
|
},
|
|
1617
|
+
"x-displayname": "Name",
|
|
1618
|
+
"x-ves-example": "Name",
|
|
689
1619
|
},
|
|
690
1620
|
{
|
|
691
1621
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -695,6 +1625,8 @@ export const bigipTools = [
|
|
|
695
1625
|
schema: {
|
|
696
1626
|
type: "string",
|
|
697
1627
|
},
|
|
1628
|
+
"x-displayname": "Namespace",
|
|
1629
|
+
"x-ves-example": "Ns1",
|
|
698
1630
|
},
|
|
699
1631
|
],
|
|
700
1632
|
queryParameters: [],
|
|
@@ -706,6 +1638,70 @@ export const bigipTools = [
|
|
|
706
1638
|
operationId: "ves.io.schema.bigcne.data_group.API.Delete",
|
|
707
1639
|
tags: ["Other"],
|
|
708
1640
|
sourceFile: "domains/bigip.json",
|
|
1641
|
+
displayName: null,
|
|
1642
|
+
dangerLevel: "high",
|
|
1643
|
+
sideEffects: {
|
|
1644
|
+
deletes: ["data-group", "contained_resources"],
|
|
1645
|
+
},
|
|
1646
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1647
|
+
confirmationRequired: true,
|
|
1648
|
+
parameterExamples: {
|
|
1649
|
+
name: "Name",
|
|
1650
|
+
namespace: "Ns1",
|
|
1651
|
+
},
|
|
1652
|
+
validationRules: {},
|
|
1653
|
+
operationMetadata: {
|
|
1654
|
+
common_errors: [
|
|
1655
|
+
{
|
|
1656
|
+
code: 401,
|
|
1657
|
+
message: "Authentication required",
|
|
1658
|
+
solution: "Provide valid API credentials",
|
|
1659
|
+
},
|
|
1660
|
+
{
|
|
1661
|
+
code: 403,
|
|
1662
|
+
message: "Permission denied",
|
|
1663
|
+
solution: "Check access permissions for this operation",
|
|
1664
|
+
},
|
|
1665
|
+
{
|
|
1666
|
+
code: 404,
|
|
1667
|
+
message: "Resource not found",
|
|
1668
|
+
solution: "Verify resource name, namespace, and path",
|
|
1669
|
+
},
|
|
1670
|
+
{
|
|
1671
|
+
code: 409,
|
|
1672
|
+
message: "Resource already exists",
|
|
1673
|
+
solution: "Use different name or update existing resource",
|
|
1674
|
+
},
|
|
1675
|
+
{
|
|
1676
|
+
code: 429,
|
|
1677
|
+
message: "Rate limit exceeded",
|
|
1678
|
+
solution: "Wait before retrying the operation",
|
|
1679
|
+
},
|
|
1680
|
+
{
|
|
1681
|
+
code: 500,
|
|
1682
|
+
message: "Server error",
|
|
1683
|
+
solution: "Retry operation or contact support",
|
|
1684
|
+
},
|
|
1685
|
+
],
|
|
1686
|
+
conditions: {
|
|
1687
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1688
|
+
prerequisites: ["Active namespace"],
|
|
1689
|
+
},
|
|
1690
|
+
confirmation_required: true,
|
|
1691
|
+
danger_level: "high",
|
|
1692
|
+
field_docs: {},
|
|
1693
|
+
optional_fields: [],
|
|
1694
|
+
performance_impact: {
|
|
1695
|
+
latency: "high",
|
|
1696
|
+
resource_usage: "moderate",
|
|
1697
|
+
},
|
|
1698
|
+
purpose: "Delete data-group",
|
|
1699
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1700
|
+
side_effects: {
|
|
1701
|
+
deletes: ["data-group", "contained_resources"],
|
|
1702
|
+
},
|
|
1703
|
+
},
|
|
1704
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/data_groups" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
709
1705
|
},
|
|
710
1706
|
{
|
|
711
1707
|
toolName: "f5xc-api-bigip-data-group-get",
|
|
@@ -725,6 +1721,8 @@ export const bigipTools = [
|
|
|
725
1721
|
schema: {
|
|
726
1722
|
type: "string",
|
|
727
1723
|
},
|
|
1724
|
+
"x-displayname": "Name",
|
|
1725
|
+
"x-ves-example": "Name",
|
|
728
1726
|
},
|
|
729
1727
|
{
|
|
730
1728
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -734,6 +1732,8 @@ export const bigipTools = [
|
|
|
734
1732
|
schema: {
|
|
735
1733
|
type: "string",
|
|
736
1734
|
},
|
|
1735
|
+
"x-displayname": "Namespace",
|
|
1736
|
+
"x-ves-example": "Ns1",
|
|
737
1737
|
},
|
|
738
1738
|
],
|
|
739
1739
|
queryParameters: [
|
|
@@ -754,6 +1754,7 @@ export const bigipTools = [
|
|
|
754
1754
|
],
|
|
755
1755
|
type: "string",
|
|
756
1756
|
},
|
|
1757
|
+
"x-displayname": "Broken Referred Objects.",
|
|
757
1758
|
},
|
|
758
1759
|
],
|
|
759
1760
|
requestBodySchema: null,
|
|
@@ -764,6 +1765,66 @@ export const bigipTools = [
|
|
|
764
1765
|
operationId: "ves.io.schema.bigcne.data_group.API.Get",
|
|
765
1766
|
tags: ["Other"],
|
|
766
1767
|
sourceFile: "domains/bigip.json",
|
|
1768
|
+
displayName: null,
|
|
1769
|
+
dangerLevel: "low",
|
|
1770
|
+
sideEffects: null,
|
|
1771
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1772
|
+
confirmationRequired: false,
|
|
1773
|
+
parameterExamples: {
|
|
1774
|
+
name: "Name",
|
|
1775
|
+
namespace: "Ns1",
|
|
1776
|
+
},
|
|
1777
|
+
validationRules: {},
|
|
1778
|
+
operationMetadata: {
|
|
1779
|
+
common_errors: [
|
|
1780
|
+
{
|
|
1781
|
+
code: 401,
|
|
1782
|
+
message: "Authentication required",
|
|
1783
|
+
solution: "Provide valid API credentials",
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
code: 403,
|
|
1787
|
+
message: "Permission denied",
|
|
1788
|
+
solution: "Check access permissions for this operation",
|
|
1789
|
+
},
|
|
1790
|
+
{
|
|
1791
|
+
code: 404,
|
|
1792
|
+
message: "Resource not found",
|
|
1793
|
+
solution: "Verify resource name, namespace, and path",
|
|
1794
|
+
},
|
|
1795
|
+
{
|
|
1796
|
+
code: 409,
|
|
1797
|
+
message: "Resource already exists",
|
|
1798
|
+
solution: "Use different name or update existing resource",
|
|
1799
|
+
},
|
|
1800
|
+
{
|
|
1801
|
+
code: 429,
|
|
1802
|
+
message: "Rate limit exceeded",
|
|
1803
|
+
solution: "Wait before retrying the operation",
|
|
1804
|
+
},
|
|
1805
|
+
{
|
|
1806
|
+
code: 500,
|
|
1807
|
+
message: "Server error",
|
|
1808
|
+
solution: "Retry operation or contact support",
|
|
1809
|
+
},
|
|
1810
|
+
],
|
|
1811
|
+
conditions: {
|
|
1812
|
+
postconditions: [],
|
|
1813
|
+
prerequisites: ["Active namespace"],
|
|
1814
|
+
},
|
|
1815
|
+
confirmation_required: false,
|
|
1816
|
+
danger_level: "low",
|
|
1817
|
+
field_docs: {},
|
|
1818
|
+
optional_fields: [],
|
|
1819
|
+
performance_impact: {
|
|
1820
|
+
latency: "low",
|
|
1821
|
+
resource_usage: "low",
|
|
1822
|
+
},
|
|
1823
|
+
purpose: "Retrieve specific data-group",
|
|
1824
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1825
|
+
side_effects: {},
|
|
1826
|
+
},
|
|
1827
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/data_groups" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
767
1828
|
},
|
|
768
1829
|
{
|
|
769
1830
|
toolName: "f5xc-api-bigip-data-group-list",
|
|
@@ -783,6 +1844,8 @@ export const bigipTools = [
|
|
|
783
1844
|
schema: {
|
|
784
1845
|
type: "string",
|
|
785
1846
|
},
|
|
1847
|
+
"x-displayname": "Namespace",
|
|
1848
|
+
"x-ves-example": "Ns1",
|
|
786
1849
|
},
|
|
787
1850
|
],
|
|
788
1851
|
queryParameters: [
|
|
@@ -794,6 +1857,8 @@ export const bigipTools = [
|
|
|
794
1857
|
schema: {
|
|
795
1858
|
type: "string",
|
|
796
1859
|
},
|
|
1860
|
+
"x-displayname": "Label Filter.",
|
|
1861
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
797
1862
|
},
|
|
798
1863
|
{
|
|
799
1864
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -806,6 +1871,7 @@ export const bigipTools = [
|
|
|
806
1871
|
},
|
|
807
1872
|
type: "array",
|
|
808
1873
|
},
|
|
1874
|
+
"x-displayname": "Report Fields.",
|
|
809
1875
|
},
|
|
810
1876
|
{
|
|
811
1877
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -818,6 +1884,7 @@ export const bigipTools = [
|
|
|
818
1884
|
},
|
|
819
1885
|
type: "array",
|
|
820
1886
|
},
|
|
1887
|
+
"x-displayname": "Report Status Fields.",
|
|
821
1888
|
},
|
|
822
1889
|
],
|
|
823
1890
|
requestBodySchema: null,
|
|
@@ -828,6 +1895,66 @@ export const bigipTools = [
|
|
|
828
1895
|
operationId: "ves.io.schema.bigcne.data_group.API.List",
|
|
829
1896
|
tags: ["Other"],
|
|
830
1897
|
sourceFile: "domains/bigip.json",
|
|
1898
|
+
displayName: null,
|
|
1899
|
+
dangerLevel: "low",
|
|
1900
|
+
sideEffects: null,
|
|
1901
|
+
requiredFields: ["path.namespace"],
|
|
1902
|
+
confirmationRequired: false,
|
|
1903
|
+
parameterExamples: {
|
|
1904
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1905
|
+
namespace: "Ns1",
|
|
1906
|
+
},
|
|
1907
|
+
validationRules: {},
|
|
1908
|
+
operationMetadata: {
|
|
1909
|
+
common_errors: [
|
|
1910
|
+
{
|
|
1911
|
+
code: 401,
|
|
1912
|
+
message: "Authentication required",
|
|
1913
|
+
solution: "Provide valid API credentials",
|
|
1914
|
+
},
|
|
1915
|
+
{
|
|
1916
|
+
code: 403,
|
|
1917
|
+
message: "Permission denied",
|
|
1918
|
+
solution: "Check access permissions for this operation",
|
|
1919
|
+
},
|
|
1920
|
+
{
|
|
1921
|
+
code: 404,
|
|
1922
|
+
message: "Resource not found",
|
|
1923
|
+
solution: "Verify resource name, namespace, and path",
|
|
1924
|
+
},
|
|
1925
|
+
{
|
|
1926
|
+
code: 409,
|
|
1927
|
+
message: "Resource already exists",
|
|
1928
|
+
solution: "Use different name or update existing resource",
|
|
1929
|
+
},
|
|
1930
|
+
{
|
|
1931
|
+
code: 429,
|
|
1932
|
+
message: "Rate limit exceeded",
|
|
1933
|
+
solution: "Wait before retrying the operation",
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
code: 500,
|
|
1937
|
+
message: "Server error",
|
|
1938
|
+
solution: "Retry operation or contact support",
|
|
1939
|
+
},
|
|
1940
|
+
],
|
|
1941
|
+
conditions: {
|
|
1942
|
+
postconditions: [],
|
|
1943
|
+
prerequisites: ["Active namespace"],
|
|
1944
|
+
},
|
|
1945
|
+
confirmation_required: false,
|
|
1946
|
+
danger_level: "low",
|
|
1947
|
+
field_docs: {},
|
|
1948
|
+
optional_fields: [],
|
|
1949
|
+
performance_impact: {
|
|
1950
|
+
latency: "moderate",
|
|
1951
|
+
resource_usage: "moderate",
|
|
1952
|
+
},
|
|
1953
|
+
purpose: "List all data-groups",
|
|
1954
|
+
required_fields: ["path.namespace"],
|
|
1955
|
+
side_effects: {},
|
|
1956
|
+
},
|
|
1957
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/data_groups" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
831
1958
|
},
|
|
832
1959
|
{
|
|
833
1960
|
toolName: "f5xc-api-bigip-data-group-update",
|
|
@@ -847,6 +1974,8 @@ export const bigipTools = [
|
|
|
847
1974
|
schema: {
|
|
848
1975
|
type: "string",
|
|
849
1976
|
},
|
|
1977
|
+
"x-displayname": "Name",
|
|
1978
|
+
"x-ves-example": "Example-corp-web.",
|
|
850
1979
|
},
|
|
851
1980
|
{
|
|
852
1981
|
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 ""',
|
|
@@ -856,6 +1985,8 @@ export const bigipTools = [
|
|
|
856
1985
|
schema: {
|
|
857
1986
|
type: "string",
|
|
858
1987
|
},
|
|
1988
|
+
"x-displayname": "Namespace",
|
|
1989
|
+
"x-ves-example": "Staging",
|
|
859
1990
|
},
|
|
860
1991
|
],
|
|
861
1992
|
queryParameters: [],
|
|
@@ -869,6 +2000,70 @@ export const bigipTools = [
|
|
|
869
2000
|
operationId: "ves.io.schema.bigcne.data_group.API.Replace",
|
|
870
2001
|
tags: ["Other"],
|
|
871
2002
|
sourceFile: "domains/bigip.json",
|
|
2003
|
+
displayName: null,
|
|
2004
|
+
dangerLevel: "medium",
|
|
2005
|
+
sideEffects: {
|
|
2006
|
+
modifies: ["data-group"],
|
|
2007
|
+
},
|
|
2008
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2009
|
+
confirmationRequired: false,
|
|
2010
|
+
parameterExamples: {
|
|
2011
|
+
"metadata.name": "Example-corp-web.",
|
|
2012
|
+
"metadata.namespace": "Staging",
|
|
2013
|
+
},
|
|
2014
|
+
validationRules: {},
|
|
2015
|
+
operationMetadata: {
|
|
2016
|
+
common_errors: [
|
|
2017
|
+
{
|
|
2018
|
+
code: 401,
|
|
2019
|
+
message: "Authentication required",
|
|
2020
|
+
solution: "Provide valid API credentials",
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
code: 403,
|
|
2024
|
+
message: "Permission denied",
|
|
2025
|
+
solution: "Check access permissions for this operation",
|
|
2026
|
+
},
|
|
2027
|
+
{
|
|
2028
|
+
code: 404,
|
|
2029
|
+
message: "Resource not found",
|
|
2030
|
+
solution: "Verify resource name, namespace, and path",
|
|
2031
|
+
},
|
|
2032
|
+
{
|
|
2033
|
+
code: 409,
|
|
2034
|
+
message: "Resource already exists",
|
|
2035
|
+
solution: "Use different name or update existing resource",
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
code: 429,
|
|
2039
|
+
message: "Rate limit exceeded",
|
|
2040
|
+
solution: "Wait before retrying the operation",
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
code: 500,
|
|
2044
|
+
message: "Server error",
|
|
2045
|
+
solution: "Retry operation or contact support",
|
|
2046
|
+
},
|
|
2047
|
+
],
|
|
2048
|
+
conditions: {
|
|
2049
|
+
postconditions: ["Resource updated with new values"],
|
|
2050
|
+
prerequisites: ["Active namespace"],
|
|
2051
|
+
},
|
|
2052
|
+
confirmation_required: false,
|
|
2053
|
+
danger_level: "medium",
|
|
2054
|
+
field_docs: {},
|
|
2055
|
+
optional_fields: [],
|
|
2056
|
+
performance_impact: {
|
|
2057
|
+
latency: "low",
|
|
2058
|
+
resource_usage: "low",
|
|
2059
|
+
},
|
|
2060
|
+
purpose: "Replace existing data-group",
|
|
2061
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2062
|
+
side_effects: {
|
|
2063
|
+
modifies: ["data-group"],
|
|
2064
|
+
},
|
|
2065
|
+
},
|
|
2066
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/data_groups" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
872
2067
|
},
|
|
873
2068
|
{
|
|
874
2069
|
toolName: "f5xc-api-bigip-get-security-config-create",
|
|
@@ -888,6 +2083,8 @@ export const bigipTools = [
|
|
|
888
2083
|
schema: {
|
|
889
2084
|
type: "string",
|
|
890
2085
|
},
|
|
2086
|
+
"x-displayname": "Namespace",
|
|
2087
|
+
"x-ves-example": "Shared",
|
|
891
2088
|
},
|
|
892
2089
|
],
|
|
893
2090
|
queryParameters: [],
|
|
@@ -901,6 +2098,72 @@ export const bigipTools = [
|
|
|
901
2098
|
operationId: "ves.io.schema.views.bigip_virtual_server.CustomAPI.GetSecurityConfig",
|
|
902
2099
|
tags: ["Other"],
|
|
903
2100
|
sourceFile: "domains/bigip.json",
|
|
2101
|
+
displayName: null,
|
|
2102
|
+
dangerLevel: "medium",
|
|
2103
|
+
sideEffects: {
|
|
2104
|
+
creates: ["get-security-config"],
|
|
2105
|
+
},
|
|
2106
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2107
|
+
confirmationRequired: false,
|
|
2108
|
+
parameterExamples: {
|
|
2109
|
+
namespace: "Shared",
|
|
2110
|
+
},
|
|
2111
|
+
validationRules: {},
|
|
2112
|
+
operationMetadata: {
|
|
2113
|
+
common_errors: [
|
|
2114
|
+
{
|
|
2115
|
+
code: 401,
|
|
2116
|
+
message: "Authentication required",
|
|
2117
|
+
solution: "Provide valid API credentials",
|
|
2118
|
+
},
|
|
2119
|
+
{
|
|
2120
|
+
code: 403,
|
|
2121
|
+
message: "Permission denied",
|
|
2122
|
+
solution: "Check access permissions for this operation",
|
|
2123
|
+
},
|
|
2124
|
+
{
|
|
2125
|
+
code: 404,
|
|
2126
|
+
message: "Resource not found",
|
|
2127
|
+
solution: "Verify resource name, namespace, and path",
|
|
2128
|
+
},
|
|
2129
|
+
{
|
|
2130
|
+
code: 409,
|
|
2131
|
+
message: "Resource already exists",
|
|
2132
|
+
solution: "Use different name or update existing resource",
|
|
2133
|
+
},
|
|
2134
|
+
{
|
|
2135
|
+
code: 429,
|
|
2136
|
+
message: "Rate limit exceeded",
|
|
2137
|
+
solution: "Wait before retrying the operation",
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
code: 500,
|
|
2141
|
+
message: "Server error",
|
|
2142
|
+
solution: "Retry operation or contact support",
|
|
2143
|
+
},
|
|
2144
|
+
],
|
|
2145
|
+
conditions: {
|
|
2146
|
+
postconditions: [
|
|
2147
|
+
"Get-security-config resource created",
|
|
2148
|
+
"Resource assigned unique identifier",
|
|
2149
|
+
],
|
|
2150
|
+
prerequisites: ["Active namespace"],
|
|
2151
|
+
},
|
|
2152
|
+
confirmation_required: false,
|
|
2153
|
+
danger_level: "medium",
|
|
2154
|
+
field_docs: {},
|
|
2155
|
+
optional_fields: [],
|
|
2156
|
+
performance_impact: {
|
|
2157
|
+
latency: "low",
|
|
2158
|
+
resource_usage: "low",
|
|
2159
|
+
},
|
|
2160
|
+
purpose: "Create new get-security-config",
|
|
2161
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2162
|
+
side_effects: {
|
|
2163
|
+
creates: ["get-security-config"],
|
|
2164
|
+
},
|
|
2165
|
+
},
|
|
2166
|
+
curlExample: null,
|
|
904
2167
|
},
|
|
905
2168
|
{
|
|
906
2169
|
toolName: "f5xc-api-bigip-irule-create",
|
|
@@ -920,6 +2183,8 @@ export const bigipTools = [
|
|
|
920
2183
|
schema: {
|
|
921
2184
|
type: "string",
|
|
922
2185
|
},
|
|
2186
|
+
"x-displayname": "Namespace",
|
|
2187
|
+
"x-ves-example": "Staging",
|
|
923
2188
|
},
|
|
924
2189
|
],
|
|
925
2190
|
queryParameters: [],
|
|
@@ -933,6 +2198,69 @@ export const bigipTools = [
|
|
|
933
2198
|
operationId: "ves.io.schema.bigcne.irule.API.Create",
|
|
934
2199
|
tags: ["Other"],
|
|
935
2200
|
sourceFile: "domains/bigip.json",
|
|
2201
|
+
displayName: null,
|
|
2202
|
+
dangerLevel: "medium",
|
|
2203
|
+
sideEffects: {
|
|
2204
|
+
creates: ["irule"],
|
|
2205
|
+
},
|
|
2206
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2207
|
+
confirmationRequired: false,
|
|
2208
|
+
parameterExamples: {
|
|
2209
|
+
"metadata.namespace": "Staging",
|
|
2210
|
+
},
|
|
2211
|
+
validationRules: {},
|
|
2212
|
+
operationMetadata: {
|
|
2213
|
+
common_errors: [
|
|
2214
|
+
{
|
|
2215
|
+
code: 401,
|
|
2216
|
+
message: "Authentication required",
|
|
2217
|
+
solution: "Provide valid API credentials",
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
code: 403,
|
|
2221
|
+
message: "Permission denied",
|
|
2222
|
+
solution: "Check access permissions for this operation",
|
|
2223
|
+
},
|
|
2224
|
+
{
|
|
2225
|
+
code: 404,
|
|
2226
|
+
message: "Resource not found",
|
|
2227
|
+
solution: "Verify resource name, namespace, and path",
|
|
2228
|
+
},
|
|
2229
|
+
{
|
|
2230
|
+
code: 409,
|
|
2231
|
+
message: "Resource already exists",
|
|
2232
|
+
solution: "Use different name or update existing resource",
|
|
2233
|
+
},
|
|
2234
|
+
{
|
|
2235
|
+
code: 429,
|
|
2236
|
+
message: "Rate limit exceeded",
|
|
2237
|
+
solution: "Wait before retrying the operation",
|
|
2238
|
+
},
|
|
2239
|
+
{
|
|
2240
|
+
code: 500,
|
|
2241
|
+
message: "Server error",
|
|
2242
|
+
solution: "Retry operation or contact support",
|
|
2243
|
+
},
|
|
2244
|
+
],
|
|
2245
|
+
conditions: {
|
|
2246
|
+
postconditions: ["Irule resource created", "Resource assigned unique identifier"],
|
|
2247
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2248
|
+
},
|
|
2249
|
+
confirmation_required: false,
|
|
2250
|
+
danger_level: "medium",
|
|
2251
|
+
field_docs: {},
|
|
2252
|
+
optional_fields: [],
|
|
2253
|
+
performance_impact: {
|
|
2254
|
+
latency: "low",
|
|
2255
|
+
resource_usage: "low",
|
|
2256
|
+
},
|
|
2257
|
+
purpose: "Create new irule",
|
|
2258
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2259
|
+
side_effects: {
|
|
2260
|
+
creates: ["irule"],
|
|
2261
|
+
},
|
|
2262
|
+
},
|
|
2263
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/irules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
936
2264
|
},
|
|
937
2265
|
{
|
|
938
2266
|
toolName: "f5xc-api-bigip-irule-delete",
|
|
@@ -952,6 +2280,8 @@ export const bigipTools = [
|
|
|
952
2280
|
schema: {
|
|
953
2281
|
type: "string",
|
|
954
2282
|
},
|
|
2283
|
+
"x-displayname": "Name",
|
|
2284
|
+
"x-ves-example": "Name",
|
|
955
2285
|
},
|
|
956
2286
|
{
|
|
957
2287
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -961,6 +2291,8 @@ export const bigipTools = [
|
|
|
961
2291
|
schema: {
|
|
962
2292
|
type: "string",
|
|
963
2293
|
},
|
|
2294
|
+
"x-displayname": "Namespace",
|
|
2295
|
+
"x-ves-example": "Ns1",
|
|
964
2296
|
},
|
|
965
2297
|
],
|
|
966
2298
|
queryParameters: [],
|
|
@@ -972,6 +2304,70 @@ export const bigipTools = [
|
|
|
972
2304
|
operationId: "ves.io.schema.bigcne.irule.API.Delete",
|
|
973
2305
|
tags: ["Other"],
|
|
974
2306
|
sourceFile: "domains/bigip.json",
|
|
2307
|
+
displayName: null,
|
|
2308
|
+
dangerLevel: "high",
|
|
2309
|
+
sideEffects: {
|
|
2310
|
+
deletes: ["irule", "contained_resources"],
|
|
2311
|
+
},
|
|
2312
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2313
|
+
confirmationRequired: true,
|
|
2314
|
+
parameterExamples: {
|
|
2315
|
+
name: "Name",
|
|
2316
|
+
namespace: "Ns1",
|
|
2317
|
+
},
|
|
2318
|
+
validationRules: {},
|
|
2319
|
+
operationMetadata: {
|
|
2320
|
+
common_errors: [
|
|
2321
|
+
{
|
|
2322
|
+
code: 401,
|
|
2323
|
+
message: "Authentication required",
|
|
2324
|
+
solution: "Provide valid API credentials",
|
|
2325
|
+
},
|
|
2326
|
+
{
|
|
2327
|
+
code: 403,
|
|
2328
|
+
message: "Permission denied",
|
|
2329
|
+
solution: "Check access permissions for this operation",
|
|
2330
|
+
},
|
|
2331
|
+
{
|
|
2332
|
+
code: 404,
|
|
2333
|
+
message: "Resource not found",
|
|
2334
|
+
solution: "Verify resource name, namespace, and path",
|
|
2335
|
+
},
|
|
2336
|
+
{
|
|
2337
|
+
code: 409,
|
|
2338
|
+
message: "Resource already exists",
|
|
2339
|
+
solution: "Use different name or update existing resource",
|
|
2340
|
+
},
|
|
2341
|
+
{
|
|
2342
|
+
code: 429,
|
|
2343
|
+
message: "Rate limit exceeded",
|
|
2344
|
+
solution: "Wait before retrying the operation",
|
|
2345
|
+
},
|
|
2346
|
+
{
|
|
2347
|
+
code: 500,
|
|
2348
|
+
message: "Server error",
|
|
2349
|
+
solution: "Retry operation or contact support",
|
|
2350
|
+
},
|
|
2351
|
+
],
|
|
2352
|
+
conditions: {
|
|
2353
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2354
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2355
|
+
},
|
|
2356
|
+
confirmation_required: true,
|
|
2357
|
+
danger_level: "high",
|
|
2358
|
+
field_docs: {},
|
|
2359
|
+
optional_fields: [],
|
|
2360
|
+
performance_impact: {
|
|
2361
|
+
latency: "high",
|
|
2362
|
+
resource_usage: "moderate",
|
|
2363
|
+
},
|
|
2364
|
+
purpose: "Delete irule",
|
|
2365
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2366
|
+
side_effects: {
|
|
2367
|
+
deletes: ["irule", "contained_resources"],
|
|
2368
|
+
},
|
|
2369
|
+
},
|
|
2370
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/irules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
975
2371
|
},
|
|
976
2372
|
{
|
|
977
2373
|
toolName: "f5xc-api-bigip-irule-get",
|
|
@@ -991,6 +2387,8 @@ export const bigipTools = [
|
|
|
991
2387
|
schema: {
|
|
992
2388
|
type: "string",
|
|
993
2389
|
},
|
|
2390
|
+
"x-displayname": "Name",
|
|
2391
|
+
"x-ves-example": "Name",
|
|
994
2392
|
},
|
|
995
2393
|
{
|
|
996
2394
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -1000,6 +2398,8 @@ export const bigipTools = [
|
|
|
1000
2398
|
schema: {
|
|
1001
2399
|
type: "string",
|
|
1002
2400
|
},
|
|
2401
|
+
"x-displayname": "Namespace",
|
|
2402
|
+
"x-ves-example": "Ns1",
|
|
1003
2403
|
},
|
|
1004
2404
|
],
|
|
1005
2405
|
queryParameters: [
|
|
@@ -1020,6 +2420,7 @@ export const bigipTools = [
|
|
|
1020
2420
|
],
|
|
1021
2421
|
type: "string",
|
|
1022
2422
|
},
|
|
2423
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1023
2424
|
},
|
|
1024
2425
|
],
|
|
1025
2426
|
requestBodySchema: null,
|
|
@@ -1030,6 +2431,66 @@ export const bigipTools = [
|
|
|
1030
2431
|
operationId: "ves.io.schema.bigcne.irule.API.Get",
|
|
1031
2432
|
tags: ["Other"],
|
|
1032
2433
|
sourceFile: "domains/bigip.json",
|
|
2434
|
+
displayName: null,
|
|
2435
|
+
dangerLevel: "low",
|
|
2436
|
+
sideEffects: null,
|
|
2437
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2438
|
+
confirmationRequired: false,
|
|
2439
|
+
parameterExamples: {
|
|
2440
|
+
name: "Name",
|
|
2441
|
+
namespace: "Ns1",
|
|
2442
|
+
},
|
|
2443
|
+
validationRules: {},
|
|
2444
|
+
operationMetadata: {
|
|
2445
|
+
common_errors: [
|
|
2446
|
+
{
|
|
2447
|
+
code: 401,
|
|
2448
|
+
message: "Authentication required",
|
|
2449
|
+
solution: "Provide valid API credentials",
|
|
2450
|
+
},
|
|
2451
|
+
{
|
|
2452
|
+
code: 403,
|
|
2453
|
+
message: "Permission denied",
|
|
2454
|
+
solution: "Check access permissions for this operation",
|
|
2455
|
+
},
|
|
2456
|
+
{
|
|
2457
|
+
code: 404,
|
|
2458
|
+
message: "Resource not found",
|
|
2459
|
+
solution: "Verify resource name, namespace, and path",
|
|
2460
|
+
},
|
|
2461
|
+
{
|
|
2462
|
+
code: 409,
|
|
2463
|
+
message: "Resource already exists",
|
|
2464
|
+
solution: "Use different name or update existing resource",
|
|
2465
|
+
},
|
|
2466
|
+
{
|
|
2467
|
+
code: 429,
|
|
2468
|
+
message: "Rate limit exceeded",
|
|
2469
|
+
solution: "Wait before retrying the operation",
|
|
2470
|
+
},
|
|
2471
|
+
{
|
|
2472
|
+
code: 500,
|
|
2473
|
+
message: "Server error",
|
|
2474
|
+
solution: "Retry operation or contact support",
|
|
2475
|
+
},
|
|
2476
|
+
],
|
|
2477
|
+
conditions: {
|
|
2478
|
+
postconditions: [],
|
|
2479
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2480
|
+
},
|
|
2481
|
+
confirmation_required: false,
|
|
2482
|
+
danger_level: "low",
|
|
2483
|
+
field_docs: {},
|
|
2484
|
+
optional_fields: [],
|
|
2485
|
+
performance_impact: {
|
|
2486
|
+
latency: "low",
|
|
2487
|
+
resource_usage: "low",
|
|
2488
|
+
},
|
|
2489
|
+
purpose: "Retrieve specific irule",
|
|
2490
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2491
|
+
side_effects: {},
|
|
2492
|
+
},
|
|
2493
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/irules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
1033
2494
|
},
|
|
1034
2495
|
{
|
|
1035
2496
|
toolName: "f5xc-api-bigip-irule-list",
|
|
@@ -1049,6 +2510,8 @@ export const bigipTools = [
|
|
|
1049
2510
|
schema: {
|
|
1050
2511
|
type: "string",
|
|
1051
2512
|
},
|
|
2513
|
+
"x-displayname": "Namespace",
|
|
2514
|
+
"x-ves-example": "Ns1",
|
|
1052
2515
|
},
|
|
1053
2516
|
],
|
|
1054
2517
|
queryParameters: [
|
|
@@ -1060,6 +2523,8 @@ export const bigipTools = [
|
|
|
1060
2523
|
schema: {
|
|
1061
2524
|
type: "string",
|
|
1062
2525
|
},
|
|
2526
|
+
"x-displayname": "Label Filter.",
|
|
2527
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1063
2528
|
},
|
|
1064
2529
|
{
|
|
1065
2530
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -1072,6 +2537,7 @@ export const bigipTools = [
|
|
|
1072
2537
|
},
|
|
1073
2538
|
type: "array",
|
|
1074
2539
|
},
|
|
2540
|
+
"x-displayname": "Report Fields.",
|
|
1075
2541
|
},
|
|
1076
2542
|
{
|
|
1077
2543
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -1084,6 +2550,7 @@ export const bigipTools = [
|
|
|
1084
2550
|
},
|
|
1085
2551
|
type: "array",
|
|
1086
2552
|
},
|
|
2553
|
+
"x-displayname": "Report Status Fields.",
|
|
1087
2554
|
},
|
|
1088
2555
|
],
|
|
1089
2556
|
requestBodySchema: null,
|
|
@@ -1094,6 +2561,66 @@ export const bigipTools = [
|
|
|
1094
2561
|
operationId: "ves.io.schema.bigcne.irule.API.List",
|
|
1095
2562
|
tags: ["Other"],
|
|
1096
2563
|
sourceFile: "domains/bigip.json",
|
|
2564
|
+
displayName: null,
|
|
2565
|
+
dangerLevel: "low",
|
|
2566
|
+
sideEffects: null,
|
|
2567
|
+
requiredFields: ["path.namespace"],
|
|
2568
|
+
confirmationRequired: false,
|
|
2569
|
+
parameterExamples: {
|
|
2570
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2571
|
+
namespace: "Ns1",
|
|
2572
|
+
},
|
|
2573
|
+
validationRules: {},
|
|
2574
|
+
operationMetadata: {
|
|
2575
|
+
common_errors: [
|
|
2576
|
+
{
|
|
2577
|
+
code: 401,
|
|
2578
|
+
message: "Authentication required",
|
|
2579
|
+
solution: "Provide valid API credentials",
|
|
2580
|
+
},
|
|
2581
|
+
{
|
|
2582
|
+
code: 403,
|
|
2583
|
+
message: "Permission denied",
|
|
2584
|
+
solution: "Check access permissions for this operation",
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
code: 404,
|
|
2588
|
+
message: "Resource not found",
|
|
2589
|
+
solution: "Verify resource name, namespace, and path",
|
|
2590
|
+
},
|
|
2591
|
+
{
|
|
2592
|
+
code: 409,
|
|
2593
|
+
message: "Resource already exists",
|
|
2594
|
+
solution: "Use different name or update existing resource",
|
|
2595
|
+
},
|
|
2596
|
+
{
|
|
2597
|
+
code: 429,
|
|
2598
|
+
message: "Rate limit exceeded",
|
|
2599
|
+
solution: "Wait before retrying the operation",
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
code: 500,
|
|
2603
|
+
message: "Server error",
|
|
2604
|
+
solution: "Retry operation or contact support",
|
|
2605
|
+
},
|
|
2606
|
+
],
|
|
2607
|
+
conditions: {
|
|
2608
|
+
postconditions: [],
|
|
2609
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2610
|
+
},
|
|
2611
|
+
confirmation_required: false,
|
|
2612
|
+
danger_level: "low",
|
|
2613
|
+
field_docs: {},
|
|
2614
|
+
optional_fields: [],
|
|
2615
|
+
performance_impact: {
|
|
2616
|
+
latency: "moderate",
|
|
2617
|
+
resource_usage: "moderate",
|
|
2618
|
+
},
|
|
2619
|
+
purpose: "List all irules",
|
|
2620
|
+
required_fields: ["path.namespace"],
|
|
2621
|
+
side_effects: {},
|
|
2622
|
+
},
|
|
2623
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/irules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
1097
2624
|
},
|
|
1098
2625
|
{
|
|
1099
2626
|
toolName: "f5xc-api-bigip-irule-update",
|
|
@@ -1113,6 +2640,8 @@ export const bigipTools = [
|
|
|
1113
2640
|
schema: {
|
|
1114
2641
|
type: "string",
|
|
1115
2642
|
},
|
|
2643
|
+
"x-displayname": "Name",
|
|
2644
|
+
"x-ves-example": "Example-corp-web.",
|
|
1116
2645
|
},
|
|
1117
2646
|
{
|
|
1118
2647
|
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 ""',
|
|
@@ -1122,6 +2651,8 @@ export const bigipTools = [
|
|
|
1122
2651
|
schema: {
|
|
1123
2652
|
type: "string",
|
|
1124
2653
|
},
|
|
2654
|
+
"x-displayname": "Namespace",
|
|
2655
|
+
"x-ves-example": "Staging",
|
|
1125
2656
|
},
|
|
1126
2657
|
],
|
|
1127
2658
|
queryParameters: [],
|
|
@@ -1135,6 +2666,70 @@ export const bigipTools = [
|
|
|
1135
2666
|
operationId: "ves.io.schema.bigcne.irule.API.Replace",
|
|
1136
2667
|
tags: ["Other"],
|
|
1137
2668
|
sourceFile: "domains/bigip.json",
|
|
2669
|
+
displayName: null,
|
|
2670
|
+
dangerLevel: "medium",
|
|
2671
|
+
sideEffects: {
|
|
2672
|
+
modifies: ["irule"],
|
|
2673
|
+
},
|
|
2674
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2675
|
+
confirmationRequired: false,
|
|
2676
|
+
parameterExamples: {
|
|
2677
|
+
"metadata.name": "Example-corp-web.",
|
|
2678
|
+
"metadata.namespace": "Staging",
|
|
2679
|
+
},
|
|
2680
|
+
validationRules: {},
|
|
2681
|
+
operationMetadata: {
|
|
2682
|
+
common_errors: [
|
|
2683
|
+
{
|
|
2684
|
+
code: 401,
|
|
2685
|
+
message: "Authentication required",
|
|
2686
|
+
solution: "Provide valid API credentials",
|
|
2687
|
+
},
|
|
2688
|
+
{
|
|
2689
|
+
code: 403,
|
|
2690
|
+
message: "Permission denied",
|
|
2691
|
+
solution: "Check access permissions for this operation",
|
|
2692
|
+
},
|
|
2693
|
+
{
|
|
2694
|
+
code: 404,
|
|
2695
|
+
message: "Resource not found",
|
|
2696
|
+
solution: "Verify resource name, namespace, and path",
|
|
2697
|
+
},
|
|
2698
|
+
{
|
|
2699
|
+
code: 409,
|
|
2700
|
+
message: "Resource already exists",
|
|
2701
|
+
solution: "Use different name or update existing resource",
|
|
2702
|
+
},
|
|
2703
|
+
{
|
|
2704
|
+
code: 429,
|
|
2705
|
+
message: "Rate limit exceeded",
|
|
2706
|
+
solution: "Wait before retrying the operation",
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
code: 500,
|
|
2710
|
+
message: "Server error",
|
|
2711
|
+
solution: "Retry operation or contact support",
|
|
2712
|
+
},
|
|
2713
|
+
],
|
|
2714
|
+
conditions: {
|
|
2715
|
+
postconditions: ["Resource updated with new values"],
|
|
2716
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2717
|
+
},
|
|
2718
|
+
confirmation_required: false,
|
|
2719
|
+
danger_level: "medium",
|
|
2720
|
+
field_docs: {},
|
|
2721
|
+
optional_fields: [],
|
|
2722
|
+
performance_impact: {
|
|
2723
|
+
latency: "low",
|
|
2724
|
+
resource_usage: "low",
|
|
2725
|
+
},
|
|
2726
|
+
purpose: "Replace existing irule",
|
|
2727
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2728
|
+
side_effects: {
|
|
2729
|
+
modifies: ["irule"],
|
|
2730
|
+
},
|
|
2731
|
+
},
|
|
2732
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/irules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
1138
2733
|
},
|
|
1139
2734
|
{
|
|
1140
2735
|
toolName: "f5xc-api-bigip-metric-create",
|
|
@@ -1154,6 +2749,8 @@ export const bigipTools = [
|
|
|
1154
2749
|
schema: {
|
|
1155
2750
|
type: "string",
|
|
1156
2751
|
},
|
|
2752
|
+
"x-displayname": "Namespace",
|
|
2753
|
+
"x-ves-example": "System",
|
|
1157
2754
|
},
|
|
1158
2755
|
],
|
|
1159
2756
|
queryParameters: [],
|
|
@@ -1167,6 +2764,69 @@ export const bigipTools = [
|
|
|
1167
2764
|
operationId: "ves.io.schema.bigip.apm.CustomDataAPI.Metrics",
|
|
1168
2765
|
tags: ["BIG-IP"],
|
|
1169
2766
|
sourceFile: "domains/bigip.json",
|
|
2767
|
+
displayName: null,
|
|
2768
|
+
dangerLevel: "medium",
|
|
2769
|
+
sideEffects: {
|
|
2770
|
+
creates: ["metric"],
|
|
2771
|
+
},
|
|
2772
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2773
|
+
confirmationRequired: false,
|
|
2774
|
+
parameterExamples: {
|
|
2775
|
+
namespace: "System",
|
|
2776
|
+
},
|
|
2777
|
+
validationRules: {},
|
|
2778
|
+
operationMetadata: {
|
|
2779
|
+
common_errors: [
|
|
2780
|
+
{
|
|
2781
|
+
code: 401,
|
|
2782
|
+
message: "Authentication required",
|
|
2783
|
+
solution: "Provide valid API credentials",
|
|
2784
|
+
},
|
|
2785
|
+
{
|
|
2786
|
+
code: 403,
|
|
2787
|
+
message: "Permission denied",
|
|
2788
|
+
solution: "Check access permissions for this operation",
|
|
2789
|
+
},
|
|
2790
|
+
{
|
|
2791
|
+
code: 404,
|
|
2792
|
+
message: "Resource not found",
|
|
2793
|
+
solution: "Verify resource name, namespace, and path",
|
|
2794
|
+
},
|
|
2795
|
+
{
|
|
2796
|
+
code: 409,
|
|
2797
|
+
message: "Resource already exists",
|
|
2798
|
+
solution: "Use different name or update existing resource",
|
|
2799
|
+
},
|
|
2800
|
+
{
|
|
2801
|
+
code: 429,
|
|
2802
|
+
message: "Rate limit exceeded",
|
|
2803
|
+
solution: "Wait before retrying the operation",
|
|
2804
|
+
},
|
|
2805
|
+
{
|
|
2806
|
+
code: 500,
|
|
2807
|
+
message: "Server error",
|
|
2808
|
+
solution: "Retry operation or contact support",
|
|
2809
|
+
},
|
|
2810
|
+
],
|
|
2811
|
+
conditions: {
|
|
2812
|
+
postconditions: ["Metric resource created", "Resource assigned unique identifier"],
|
|
2813
|
+
prerequisites: ["Active namespace"],
|
|
2814
|
+
},
|
|
2815
|
+
confirmation_required: false,
|
|
2816
|
+
danger_level: "medium",
|
|
2817
|
+
field_docs: {},
|
|
2818
|
+
optional_fields: [],
|
|
2819
|
+
performance_impact: {
|
|
2820
|
+
latency: "low",
|
|
2821
|
+
resource_usage: "low",
|
|
2822
|
+
},
|
|
2823
|
+
purpose: "Create new metric",
|
|
2824
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2825
|
+
side_effects: {
|
|
2826
|
+
creates: ["metric"],
|
|
2827
|
+
},
|
|
2828
|
+
},
|
|
2829
|
+
curlExample: null,
|
|
1170
2830
|
},
|
|
1171
2831
|
];
|
|
1172
2832
|
export default bigipTools;
|