@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generator/openapi-parser.d.ts +418 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +132 -0
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -1
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +150 -7
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/tools/discovery/describe.d.ts +1 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -1
- package/dist/tools/discovery/describe.js +10 -8
- package/dist/tools/discovery/describe.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
- package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
- package/dist/tools/generated/api/index.d.ts +8 -0
- package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +6668 -0
- package/dist/tools/generated/api/index.js.map +1 -0
- package/dist/tools/generated/authentication/index.d.ts +8 -0
- package/dist/tools/generated/authentication/index.d.ts.map +1 -0
- package/dist/tools/generated/authentication/index.js +1005 -0
- package/dist/tools/generated/authentication/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +2045 -0
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
- package/dist/tools/generated/billing_and_usage/index.js +2702 -0
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
- package/dist/tools/generated/blindfold/index.d.ts +8 -0
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
- package/dist/tools/generated/blindfold/index.js +3998 -0
- package/dist/tools/generated/blindfold/index.js.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +1904 -0
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts +8 -0
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
- package/dist/tools/generated/ce_management/index.js +3963 -0
- package/dist/tools/generated/ce_management/index.js.map +1 -0
- package/dist/tools/generated/certificates/index.d.ts +8 -0
- package/dist/tools/generated/certificates/index.d.ts.map +1 -0
- package/dist/tools/generated/certificates/index.js +2579 -0
- package/dist/tools/generated/certificates/index.js.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
- package/dist/tools/generated/container_services/index.d.ts +8 -0
- package/dist/tools/generated/container_services/index.d.ts.map +1 -0
- package/dist/tools/generated/container_services/index.js +2054 -0
- package/dist/tools/generated/container_services/index.js.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
- package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/data_intelligence/index.js +1770 -0
- package/dist/tools/generated/data_intelligence/index.js.map +1 -0
- package/dist/tools/generated/ddos/index.d.ts +8 -0
- package/dist/tools/generated/ddos/index.d.ts.map +1 -0
- package/dist/tools/generated/ddos/index.js +8511 -0
- package/dist/tools/generated/ddos/index.js.map +1 -0
- package/dist/tools/generated/dns/index.d.ts +8 -0
- package/dist/tools/generated/dns/index.d.ts.map +1 -0
- package/dist/tools/generated/dns/index.js +6460 -0
- package/dist/tools/generated/dns/index.js.map +1 -0
- package/dist/tools/generated/generative_ai/index.d.ts +8 -0
- package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
- package/dist/tools/generated/generative_ai/index.js +1215 -0
- package/dist/tools/generated/generative_ai/index.js.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
- package/dist/tools/generated/marketplace/index.d.ts +8 -0
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
- package/dist/tools/generated/marketplace/index.js +4580 -0
- package/dist/tools/generated/marketplace/index.js.map +1 -0
- package/dist/tools/generated/network/index.d.ts +8 -0
- package/dist/tools/generated/network/index.d.ts.map +1 -0
- package/dist/tools/generated/network/index.js +12616 -0
- package/dist/tools/generated/network/index.js.map +1 -0
- package/dist/tools/generated/network_security/index.d.ts +8 -0
- package/dist/tools/generated/network_security/index.d.ts.map +1 -0
- package/dist/tools/generated/network_security/index.js +8884 -0
- package/dist/tools/generated/network_security/index.js.map +1 -0
- package/dist/tools/generated/nginx_one/index.d.ts +8 -0
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx_one/index.js +1820 -0
- package/dist/tools/generated/nginx_one/index.js.map +1 -0
- package/dist/tools/generated/object_storage/index.d.ts +8 -0
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
- package/dist/tools/generated/object_storage/index.js +1055 -0
- package/dist/tools/generated/object_storage/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +4243 -4618
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
- package/dist/tools/generated/rate_limiting/index.js +1937 -0
- package/dist/tools/generated/rate_limiting/index.js.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +4532 -438
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts +8 -0
- package/dist/tools/generated/shape/index.d.ts.map +1 -0
- package/dist/tools/generated/shape/index.js +21784 -0
- package/dist/tools/generated/shape/index.js.map +1 -0
- package/dist/tools/generated/sites/index.d.ts +8 -0
- package/dist/tools/generated/sites/index.d.ts.map +1 -0
- package/dist/tools/generated/sites/index.js +13252 -0
- package/dist/tools/generated/sites/index.js.map +1 -0
- package/dist/tools/generated/statistics/index.d.ts +8 -0
- package/dist/tools/generated/statistics/index.d.ts.map +1 -0
- package/dist/tools/generated/statistics/index.js +8837 -0
- package/dist/tools/generated/statistics/index.js.map +1 -0
- package/dist/tools/generated/support/index.d.ts +8 -0
- package/dist/tools/generated/support/index.d.ts.map +1 -0
- package/dist/tools/generated/support/index.js +6215 -0
- package/dist/tools/generated/support/index.js.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
- package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
- package/dist/tools/generated/threat_campaign/index.js +112 -0
- package/dist/tools/generated/threat_campaign/index.js.map +1 -0
- package/dist/tools/generated/users/index.d.ts +8 -0
- package/dist/tools/generated/users/index.d.ts.map +1 -0
- package/dist/tools/generated/users/index.js +1572 -0
- package/dist/tools/generated/users/index.js.map +1 -0
- package/dist/tools/generated/virtual/index.d.ts +8 -0
- package/dist/tools/generated/virtual/index.d.ts.map +1 -0
- package/dist/tools/generated/virtual/index.js +11540 -0
- package/dist/tools/generated/virtual/index.js.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
- package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
- package/dist/tools/generated/waf/index.d.ts +8 -0
- package/dist/tools/generated/waf/index.d.ts.map +1 -0
- package/dist/tools/generated/waf/index.js +4440 -0
- package/dist/tools/generated/waf/index.js.map +1 -0
- package/dist/tools/registry.d.ts.map +1 -1
- package/dist/tools/registry.js +68 -36
- package/dist/tools/registry.js.map +1 -1
- package/package.json +3 -1
- package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.js +0 -282
- package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
- package/dist/tools/generated/api_security/index.d.ts +0 -8
- package/dist/tools/generated/api_security/index.d.ts.map +0 -1
- package/dist/tools/generated/api_security/index.js +0 -1852
- package/dist/tools/generated/api_security/index.js.map +0 -1
- package/dist/tools/generated/applications/index.d.ts +0 -8
- package/dist/tools/generated/applications/index.d.ts.map +0 -1
- package/dist/tools/generated/applications/index.js +0 -1589
- package/dist/tools/generated/applications/index.js.map +0 -1
- package/dist/tools/generated/billing/index.d.ts +0 -8
- package/dist/tools/generated/billing/index.d.ts.map +0 -1
- package/dist/tools/generated/billing/index.js +0 -759
- package/dist/tools/generated/billing/index.js.map +0 -1
- package/dist/tools/generated/config/index.d.ts +0 -8
- package/dist/tools/generated/config/index.d.ts.map +0 -1
- package/dist/tools/generated/config/index.js +0 -316
- package/dist/tools/generated/config/index.js.map +0 -1
- package/dist/tools/generated/identity/index.d.ts +0 -8
- package/dist/tools/generated/identity/index.d.ts.map +0 -1
- package/dist/tools/generated/identity/index.js +0 -5371
- package/dist/tools/generated/identity/index.js.map +0 -1
- package/dist/tools/generated/infrastructure/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure/index.js +0 -5342
- package/dist/tools/generated/infrastructure/index.js.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
- package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
- package/dist/tools/generated/integrations/index.d.ts +0 -8
- package/dist/tools/generated/integrations/index.d.ts.map +0 -1
- package/dist/tools/generated/integrations/index.js +0 -1995
- package/dist/tools/generated/integrations/index.js.map +0 -1
- package/dist/tools/generated/load_balancer/index.d.ts +0 -8
- package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
- package/dist/tools/generated/load_balancer/index.js +0 -2269
- package/dist/tools/generated/load_balancer/index.js.map +0 -1
- package/dist/tools/generated/networking/index.d.ts +0 -8
- package/dist/tools/generated/networking/index.d.ts.map +0 -1
- package/dist/tools/generated/networking/index.js +0 -11289
- package/dist/tools/generated/networking/index.js.map +0 -1
- package/dist/tools/generated/nginx/index.d.ts +0 -8
- package/dist/tools/generated/nginx/index.d.ts.map +0 -1
- package/dist/tools/generated/nginx/index.js +0 -680
- package/dist/tools/generated/nginx/index.js.map +0 -1
- package/dist/tools/generated/operations/index.d.ts +0 -8
- package/dist/tools/generated/operations/index.d.ts.map +0 -1
- package/dist/tools/generated/operations/index.js +0 -1759
- package/dist/tools/generated/operations/index.js.map +0 -1
- package/dist/tools/generated/security/index.d.ts +0 -8
- package/dist/tools/generated/security/index.d.ts.map +0 -1
- package/dist/tools/generated/security/index.js +0 -9111
- package/dist/tools/generated/security/index.js.map +0 -1
- package/dist/tools/generated/shape_security/index.d.ts +0 -8
- package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
- package/dist/tools/generated/shape_security/index.js +0 -4121
- package/dist/tools/generated/shape_security/index.js.map +0 -1
- package/dist/tools/generated/subscriptions/index.d.ts +0 -8
- package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
- package/dist/tools/generated/subscriptions/index.js +0 -778
- package/dist/tools/generated/subscriptions/index.js.map +0 -1
- package/dist/tools/generated/tenant_management/index.d.ts +0 -8
- package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
- package/dist/tools/generated/tenant_management/index.js +0 -2292
- package/dist/tools/generated/tenant_management/index.js.map +0 -1
- package/dist/tools/generated/vpn/index.d.ts +0 -8
- package/dist/tools/generated/vpn/index.js +0 -1183
- package/dist/tools/generated/vpn/index.js.map +0 -1
|
@@ -21,6 +21,8 @@ export const 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,92 @@ 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
|
+
cliExamples: [
|
|
46
|
+
{
|
|
47
|
+
command: "f5xcctl config apm create {name} --namespace {namespace}",
|
|
48
|
+
description: "Create apm",
|
|
49
|
+
use_case: "basic_create",
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
command: "f5xcctl config apm create -f {file}.yaml",
|
|
53
|
+
description: "Create from YAML file",
|
|
54
|
+
use_case: "file_based",
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
confirmationRequired: false,
|
|
58
|
+
parameterExamples: {
|
|
59
|
+
"metadata.namespace": "Staging",
|
|
60
|
+
},
|
|
61
|
+
validationRules: {},
|
|
62
|
+
operationMetadata: {
|
|
63
|
+
common_errors: [
|
|
64
|
+
{
|
|
65
|
+
code: 401,
|
|
66
|
+
message: "Authentication required",
|
|
67
|
+
solution: "Provide valid API credentials",
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
code: 403,
|
|
71
|
+
message: "Permission denied",
|
|
72
|
+
solution: "Check access permissions for this operation",
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
code: 404,
|
|
76
|
+
message: "Resource not found",
|
|
77
|
+
solution: "Verify resource name, namespace, and path",
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
code: 409,
|
|
81
|
+
message: "Resource already exists",
|
|
82
|
+
solution: "Use different name or update existing resource",
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
code: 429,
|
|
86
|
+
message: "Rate limit exceeded",
|
|
87
|
+
solution: "Wait before retrying the operation",
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
code: 500,
|
|
91
|
+
message: "Server error",
|
|
92
|
+
solution: "Retry operation or contact support",
|
|
93
|
+
},
|
|
94
|
+
],
|
|
95
|
+
conditions: {
|
|
96
|
+
postconditions: ["Apm resource created", "Resource assigned unique identifier"],
|
|
97
|
+
prerequisites: ["Active namespace"],
|
|
98
|
+
},
|
|
99
|
+
confirmation_required: false,
|
|
100
|
+
danger_level: "medium",
|
|
101
|
+
examples: [
|
|
102
|
+
{
|
|
103
|
+
command: "f5xcctl config apm create {name} --namespace {namespace}",
|
|
104
|
+
description: "Create apm",
|
|
105
|
+
use_case: "basic_create",
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
command: "f5xcctl config apm create -f {file}.yaml",
|
|
109
|
+
description: "Create from YAML file",
|
|
110
|
+
use_case: "file_based",
|
|
111
|
+
},
|
|
112
|
+
],
|
|
113
|
+
field_docs: {},
|
|
114
|
+
optional_fields: [],
|
|
115
|
+
performance_impact: {
|
|
116
|
+
latency: "low",
|
|
117
|
+
resource_usage: "low",
|
|
118
|
+
},
|
|
119
|
+
purpose: "Create new apm",
|
|
120
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
121
|
+
side_effects: {
|
|
122
|
+
creates: ["apm"],
|
|
123
|
+
},
|
|
124
|
+
},
|
|
37
125
|
},
|
|
38
126
|
{
|
|
39
127
|
toolName: "f5xc-api-bigip-apm-delete",
|
|
@@ -53,6 +141,8 @@ export const bigipTools = [
|
|
|
53
141
|
schema: {
|
|
54
142
|
type: "string",
|
|
55
143
|
},
|
|
144
|
+
"x-displayname": "Name",
|
|
145
|
+
"x-ves-example": "Name",
|
|
56
146
|
},
|
|
57
147
|
{
|
|
58
148
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -62,6 +152,8 @@ export const bigipTools = [
|
|
|
62
152
|
schema: {
|
|
63
153
|
type: "string",
|
|
64
154
|
},
|
|
155
|
+
"x-displayname": "Namespace",
|
|
156
|
+
"x-ves-example": "Ns1",
|
|
65
157
|
},
|
|
66
158
|
],
|
|
67
159
|
queryParameters: [],
|
|
@@ -73,6 +165,83 @@ export const bigipTools = [
|
|
|
73
165
|
operationId: "ves.io.schema.bigip.apm.API.Delete",
|
|
74
166
|
tags: ["Other"],
|
|
75
167
|
sourceFile: "domains/bigip.json",
|
|
168
|
+
displayName: null,
|
|
169
|
+
dangerLevel: "high",
|
|
170
|
+
sideEffects: {
|
|
171
|
+
deletes: ["apm", "contained_resources"],
|
|
172
|
+
},
|
|
173
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
174
|
+
cliExamples: [
|
|
175
|
+
{
|
|
176
|
+
command: "f5xcctl config apm delete {name} --namespace {namespace}",
|
|
177
|
+
description: "Delete apm",
|
|
178
|
+
use_case: "delete",
|
|
179
|
+
},
|
|
180
|
+
],
|
|
181
|
+
confirmationRequired: true,
|
|
182
|
+
parameterExamples: {
|
|
183
|
+
name: "Name",
|
|
184
|
+
namespace: "Ns1",
|
|
185
|
+
},
|
|
186
|
+
validationRules: {},
|
|
187
|
+
operationMetadata: {
|
|
188
|
+
common_errors: [
|
|
189
|
+
{
|
|
190
|
+
code: 401,
|
|
191
|
+
message: "Authentication required",
|
|
192
|
+
solution: "Provide valid API credentials",
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
code: 403,
|
|
196
|
+
message: "Permission denied",
|
|
197
|
+
solution: "Check access permissions for this operation",
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
code: 404,
|
|
201
|
+
message: "Resource not found",
|
|
202
|
+
solution: "Verify resource name, namespace, and path",
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
code: 409,
|
|
206
|
+
message: "Resource already exists",
|
|
207
|
+
solution: "Use different name or update existing resource",
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
code: 429,
|
|
211
|
+
message: "Rate limit exceeded",
|
|
212
|
+
solution: "Wait before retrying the operation",
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
code: 500,
|
|
216
|
+
message: "Server error",
|
|
217
|
+
solution: "Retry operation or contact support",
|
|
218
|
+
},
|
|
219
|
+
],
|
|
220
|
+
conditions: {
|
|
221
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
222
|
+
prerequisites: ["Active namespace"],
|
|
223
|
+
},
|
|
224
|
+
confirmation_required: true,
|
|
225
|
+
danger_level: "high",
|
|
226
|
+
examples: [
|
|
227
|
+
{
|
|
228
|
+
command: "f5xcctl config apm delete {name} --namespace {namespace}",
|
|
229
|
+
description: "Delete apm",
|
|
230
|
+
use_case: "delete",
|
|
231
|
+
},
|
|
232
|
+
],
|
|
233
|
+
field_docs: {},
|
|
234
|
+
optional_fields: [],
|
|
235
|
+
performance_impact: {
|
|
236
|
+
latency: "high",
|
|
237
|
+
resource_usage: "moderate",
|
|
238
|
+
},
|
|
239
|
+
purpose: "Delete apm",
|
|
240
|
+
required_fields: ["path.name", "path.namespace"],
|
|
241
|
+
side_effects: {
|
|
242
|
+
deletes: ["apm", "contained_resources"],
|
|
243
|
+
},
|
|
244
|
+
},
|
|
76
245
|
},
|
|
77
246
|
{
|
|
78
247
|
toolName: "f5xc-api-bigip-apm-get",
|
|
@@ -92,6 +261,8 @@ export const bigipTools = [
|
|
|
92
261
|
schema: {
|
|
93
262
|
type: "string",
|
|
94
263
|
},
|
|
264
|
+
"x-displayname": "Name",
|
|
265
|
+
"x-ves-example": "Name",
|
|
95
266
|
},
|
|
96
267
|
{
|
|
97
268
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -101,6 +272,8 @@ export const bigipTools = [
|
|
|
101
272
|
schema: {
|
|
102
273
|
type: "string",
|
|
103
274
|
},
|
|
275
|
+
"x-displayname": "Namespace",
|
|
276
|
+
"x-ves-example": "Ns1",
|
|
104
277
|
},
|
|
105
278
|
],
|
|
106
279
|
queryParameters: [
|
|
@@ -122,6 +295,7 @@ export const bigipTools = [
|
|
|
122
295
|
],
|
|
123
296
|
type: "string",
|
|
124
297
|
},
|
|
298
|
+
"x-displayname": "Broken Referred Objects.",
|
|
125
299
|
},
|
|
126
300
|
],
|
|
127
301
|
requestBodySchema: null,
|
|
@@ -132,6 +306,79 @@ export const bigipTools = [
|
|
|
132
306
|
operationId: "ves.io.schema.bigip.apm.API.Get",
|
|
133
307
|
tags: ["Other"],
|
|
134
308
|
sourceFile: "domains/bigip.json",
|
|
309
|
+
displayName: null,
|
|
310
|
+
dangerLevel: "low",
|
|
311
|
+
sideEffects: null,
|
|
312
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
313
|
+
cliExamples: [
|
|
314
|
+
{
|
|
315
|
+
command: "f5xcctl config apm get {name} --namespace {namespace}",
|
|
316
|
+
description: "Get specific apm",
|
|
317
|
+
use_case: "get_specific",
|
|
318
|
+
},
|
|
319
|
+
],
|
|
320
|
+
confirmationRequired: false,
|
|
321
|
+
parameterExamples: {
|
|
322
|
+
name: "Name",
|
|
323
|
+
namespace: "Ns1",
|
|
324
|
+
},
|
|
325
|
+
validationRules: {},
|
|
326
|
+
operationMetadata: {
|
|
327
|
+
common_errors: [
|
|
328
|
+
{
|
|
329
|
+
code: 401,
|
|
330
|
+
message: "Authentication required",
|
|
331
|
+
solution: "Provide valid API credentials",
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
code: 403,
|
|
335
|
+
message: "Permission denied",
|
|
336
|
+
solution: "Check access permissions for this operation",
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
code: 404,
|
|
340
|
+
message: "Resource not found",
|
|
341
|
+
solution: "Verify resource name, namespace, and path",
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
code: 409,
|
|
345
|
+
message: "Resource already exists",
|
|
346
|
+
solution: "Use different name or update existing resource",
|
|
347
|
+
},
|
|
348
|
+
{
|
|
349
|
+
code: 429,
|
|
350
|
+
message: "Rate limit exceeded",
|
|
351
|
+
solution: "Wait before retrying the operation",
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
code: 500,
|
|
355
|
+
message: "Server error",
|
|
356
|
+
solution: "Retry operation or contact support",
|
|
357
|
+
},
|
|
358
|
+
],
|
|
359
|
+
conditions: {
|
|
360
|
+
postconditions: [],
|
|
361
|
+
prerequisites: ["Active namespace"],
|
|
362
|
+
},
|
|
363
|
+
confirmation_required: false,
|
|
364
|
+
danger_level: "low",
|
|
365
|
+
examples: [
|
|
366
|
+
{
|
|
367
|
+
command: "f5xcctl config apm get {name} --namespace {namespace}",
|
|
368
|
+
description: "Get specific apm",
|
|
369
|
+
use_case: "get_specific",
|
|
370
|
+
},
|
|
371
|
+
],
|
|
372
|
+
field_docs: {},
|
|
373
|
+
optional_fields: [],
|
|
374
|
+
performance_impact: {
|
|
375
|
+
latency: "low",
|
|
376
|
+
resource_usage: "low",
|
|
377
|
+
},
|
|
378
|
+
purpose: "Retrieve specific apm",
|
|
379
|
+
required_fields: ["path.name", "path.namespace"],
|
|
380
|
+
side_effects: {},
|
|
381
|
+
},
|
|
135
382
|
},
|
|
136
383
|
{
|
|
137
384
|
toolName: "f5xc-api-bigip-apm-list",
|
|
@@ -151,6 +398,8 @@ export const bigipTools = [
|
|
|
151
398
|
schema: {
|
|
152
399
|
type: "string",
|
|
153
400
|
},
|
|
401
|
+
"x-displayname": "Namespace",
|
|
402
|
+
"x-ves-example": "Ns1",
|
|
154
403
|
},
|
|
155
404
|
],
|
|
156
405
|
queryParameters: [
|
|
@@ -162,6 +411,8 @@ export const bigipTools = [
|
|
|
162
411
|
schema: {
|
|
163
412
|
type: "string",
|
|
164
413
|
},
|
|
414
|
+
"x-displayname": "Label Filter.",
|
|
415
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
165
416
|
},
|
|
166
417
|
{
|
|
167
418
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -174,6 +425,7 @@ export const bigipTools = [
|
|
|
174
425
|
},
|
|
175
426
|
type: "array",
|
|
176
427
|
},
|
|
428
|
+
"x-displayname": "Report Fields.",
|
|
177
429
|
},
|
|
178
430
|
{
|
|
179
431
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -186,6 +438,7 @@ export const bigipTools = [
|
|
|
186
438
|
},
|
|
187
439
|
type: "array",
|
|
188
440
|
},
|
|
441
|
+
"x-displayname": "Report Status Fields.",
|
|
189
442
|
},
|
|
190
443
|
],
|
|
191
444
|
requestBodySchema: null,
|
|
@@ -196,6 +449,79 @@ export const bigipTools = [
|
|
|
196
449
|
operationId: "ves.io.schema.bigip.apm.API.List",
|
|
197
450
|
tags: ["Other"],
|
|
198
451
|
sourceFile: "domains/bigip.json",
|
|
452
|
+
displayName: null,
|
|
453
|
+
dangerLevel: "low",
|
|
454
|
+
sideEffects: null,
|
|
455
|
+
requiredFields: ["path.namespace"],
|
|
456
|
+
cliExamples: [
|
|
457
|
+
{
|
|
458
|
+
command: "f5xcctl config apm list --namespace {namespace}",
|
|
459
|
+
description: "List all apms",
|
|
460
|
+
use_case: "list_all",
|
|
461
|
+
},
|
|
462
|
+
],
|
|
463
|
+
confirmationRequired: false,
|
|
464
|
+
parameterExamples: {
|
|
465
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
466
|
+
namespace: "Ns1",
|
|
467
|
+
},
|
|
468
|
+
validationRules: {},
|
|
469
|
+
operationMetadata: {
|
|
470
|
+
common_errors: [
|
|
471
|
+
{
|
|
472
|
+
code: 401,
|
|
473
|
+
message: "Authentication required",
|
|
474
|
+
solution: "Provide valid API credentials",
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
code: 403,
|
|
478
|
+
message: "Permission denied",
|
|
479
|
+
solution: "Check access permissions for this operation",
|
|
480
|
+
},
|
|
481
|
+
{
|
|
482
|
+
code: 404,
|
|
483
|
+
message: "Resource not found",
|
|
484
|
+
solution: "Verify resource name, namespace, and path",
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
code: 409,
|
|
488
|
+
message: "Resource already exists",
|
|
489
|
+
solution: "Use different name or update existing resource",
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
code: 429,
|
|
493
|
+
message: "Rate limit exceeded",
|
|
494
|
+
solution: "Wait before retrying the operation",
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
code: 500,
|
|
498
|
+
message: "Server error",
|
|
499
|
+
solution: "Retry operation or contact support",
|
|
500
|
+
},
|
|
501
|
+
],
|
|
502
|
+
conditions: {
|
|
503
|
+
postconditions: [],
|
|
504
|
+
prerequisites: ["Active namespace"],
|
|
505
|
+
},
|
|
506
|
+
confirmation_required: false,
|
|
507
|
+
danger_level: "low",
|
|
508
|
+
examples: [
|
|
509
|
+
{
|
|
510
|
+
command: "f5xcctl config apm list --namespace {namespace}",
|
|
511
|
+
description: "List all apms",
|
|
512
|
+
use_case: "list_all",
|
|
513
|
+
},
|
|
514
|
+
],
|
|
515
|
+
field_docs: {},
|
|
516
|
+
optional_fields: [],
|
|
517
|
+
performance_impact: {
|
|
518
|
+
latency: "moderate",
|
|
519
|
+
resource_usage: "moderate",
|
|
520
|
+
},
|
|
521
|
+
purpose: "List all apms",
|
|
522
|
+
required_fields: ["path.namespace"],
|
|
523
|
+
side_effects: {},
|
|
524
|
+
},
|
|
199
525
|
},
|
|
200
526
|
{
|
|
201
527
|
toolName: "f5xc-api-bigip-apm-update",
|
|
@@ -215,6 +541,8 @@ export const bigipTools = [
|
|
|
215
541
|
schema: {
|
|
216
542
|
type: "string",
|
|
217
543
|
},
|
|
544
|
+
"x-displayname": "Name",
|
|
545
|
+
"x-ves-example": "Example-corp-web.",
|
|
218
546
|
},
|
|
219
547
|
{
|
|
220
548
|
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 +552,8 @@ export const bigipTools = [
|
|
|
224
552
|
schema: {
|
|
225
553
|
type: "string",
|
|
226
554
|
},
|
|
555
|
+
"x-displayname": "Namespace",
|
|
556
|
+
"x-ves-example": "Staging",
|
|
227
557
|
},
|
|
228
558
|
],
|
|
229
559
|
queryParameters: [],
|
|
@@ -237,6 +567,83 @@ export const bigipTools = [
|
|
|
237
567
|
operationId: "ves.io.schema.bigip.apm.API.Replace",
|
|
238
568
|
tags: ["Other"],
|
|
239
569
|
sourceFile: "domains/bigip.json",
|
|
570
|
+
displayName: null,
|
|
571
|
+
dangerLevel: "medium",
|
|
572
|
+
sideEffects: {
|
|
573
|
+
modifies: ["apm"],
|
|
574
|
+
},
|
|
575
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
576
|
+
cliExamples: [
|
|
577
|
+
{
|
|
578
|
+
command: "f5xcctl config apm update {name} --namespace {namespace} -f {file}.yaml",
|
|
579
|
+
description: "Update apm",
|
|
580
|
+
use_case: "update",
|
|
581
|
+
},
|
|
582
|
+
],
|
|
583
|
+
confirmationRequired: false,
|
|
584
|
+
parameterExamples: {
|
|
585
|
+
"metadata.name": "Example-corp-web.",
|
|
586
|
+
"metadata.namespace": "Staging",
|
|
587
|
+
},
|
|
588
|
+
validationRules: {},
|
|
589
|
+
operationMetadata: {
|
|
590
|
+
common_errors: [
|
|
591
|
+
{
|
|
592
|
+
code: 401,
|
|
593
|
+
message: "Authentication required",
|
|
594
|
+
solution: "Provide valid API credentials",
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
code: 403,
|
|
598
|
+
message: "Permission denied",
|
|
599
|
+
solution: "Check access permissions for this operation",
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
code: 404,
|
|
603
|
+
message: "Resource not found",
|
|
604
|
+
solution: "Verify resource name, namespace, and path",
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
code: 409,
|
|
608
|
+
message: "Resource already exists",
|
|
609
|
+
solution: "Use different name or update existing resource",
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
code: 429,
|
|
613
|
+
message: "Rate limit exceeded",
|
|
614
|
+
solution: "Wait before retrying the operation",
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
code: 500,
|
|
618
|
+
message: "Server error",
|
|
619
|
+
solution: "Retry operation or contact support",
|
|
620
|
+
},
|
|
621
|
+
],
|
|
622
|
+
conditions: {
|
|
623
|
+
postconditions: ["Resource updated with new values"],
|
|
624
|
+
prerequisites: ["Active namespace"],
|
|
625
|
+
},
|
|
626
|
+
confirmation_required: false,
|
|
627
|
+
danger_level: "medium",
|
|
628
|
+
examples: [
|
|
629
|
+
{
|
|
630
|
+
command: "f5xcctl config apm update {name} --namespace {namespace} -f {file}.yaml",
|
|
631
|
+
description: "Update apm",
|
|
632
|
+
use_case: "update",
|
|
633
|
+
},
|
|
634
|
+
],
|
|
635
|
+
field_docs: {},
|
|
636
|
+
optional_fields: [],
|
|
637
|
+
performance_impact: {
|
|
638
|
+
latency: "low",
|
|
639
|
+
resource_usage: "low",
|
|
640
|
+
},
|
|
641
|
+
purpose: "Replace existing apm",
|
|
642
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
643
|
+
side_effects: {
|
|
644
|
+
modifies: ["apm"],
|
|
645
|
+
},
|
|
646
|
+
},
|
|
240
647
|
},
|
|
241
648
|
{
|
|
242
649
|
toolName: "f5xc-api-bigip-bigip-irule-create",
|
|
@@ -256,6 +663,8 @@ export const bigipTools = [
|
|
|
256
663
|
schema: {
|
|
257
664
|
type: "string",
|
|
258
665
|
},
|
|
666
|
+
"x-displayname": "Namespace",
|
|
667
|
+
"x-ves-example": "Staging",
|
|
259
668
|
},
|
|
260
669
|
],
|
|
261
670
|
queryParameters: [],
|
|
@@ -269,6 +678,92 @@ export const bigipTools = [
|
|
|
269
678
|
operationId: "ves.io.schema.bigip_irule.API.Create",
|
|
270
679
|
tags: ["Other"],
|
|
271
680
|
sourceFile: "domains/bigip.json",
|
|
681
|
+
displayName: null,
|
|
682
|
+
dangerLevel: "medium",
|
|
683
|
+
sideEffects: {
|
|
684
|
+
creates: ["bigip-irule"],
|
|
685
|
+
},
|
|
686
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
687
|
+
cliExamples: [
|
|
688
|
+
{
|
|
689
|
+
command: "f5xcctl bigipconnector bigip-irule create {name} --namespace {namespace}",
|
|
690
|
+
description: "Create bigip-irule",
|
|
691
|
+
use_case: "basic_create",
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
command: "f5xcctl bigipconnector bigip-irule create -f {file}.yaml",
|
|
695
|
+
description: "Create from YAML file",
|
|
696
|
+
use_case: "file_based",
|
|
697
|
+
},
|
|
698
|
+
],
|
|
699
|
+
confirmationRequired: false,
|
|
700
|
+
parameterExamples: {
|
|
701
|
+
"metadata.namespace": "Staging",
|
|
702
|
+
},
|
|
703
|
+
validationRules: {},
|
|
704
|
+
operationMetadata: {
|
|
705
|
+
common_errors: [
|
|
706
|
+
{
|
|
707
|
+
code: 401,
|
|
708
|
+
message: "Authentication required",
|
|
709
|
+
solution: "Provide valid API credentials",
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
code: 403,
|
|
713
|
+
message: "Permission denied",
|
|
714
|
+
solution: "Check access permissions for this operation",
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
code: 404,
|
|
718
|
+
message: "Resource not found",
|
|
719
|
+
solution: "Verify resource name, namespace, and path",
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
code: 409,
|
|
723
|
+
message: "Resource already exists",
|
|
724
|
+
solution: "Use different name or update existing resource",
|
|
725
|
+
},
|
|
726
|
+
{
|
|
727
|
+
code: 429,
|
|
728
|
+
message: "Rate limit exceeded",
|
|
729
|
+
solution: "Wait before retrying the operation",
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
code: 500,
|
|
733
|
+
message: "Server error",
|
|
734
|
+
solution: "Retry operation or contact support",
|
|
735
|
+
},
|
|
736
|
+
],
|
|
737
|
+
conditions: {
|
|
738
|
+
postconditions: ["Bigip-irule resource created", "Resource assigned unique identifier"],
|
|
739
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
740
|
+
},
|
|
741
|
+
confirmation_required: false,
|
|
742
|
+
danger_level: "medium",
|
|
743
|
+
examples: [
|
|
744
|
+
{
|
|
745
|
+
command: "f5xcctl bigipconnector bigip-irule create {name} --namespace {namespace}",
|
|
746
|
+
description: "Create bigip-irule",
|
|
747
|
+
use_case: "basic_create",
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
command: "f5xcctl bigipconnector bigip-irule create -f {file}.yaml",
|
|
751
|
+
description: "Create from YAML file",
|
|
752
|
+
use_case: "file_based",
|
|
753
|
+
},
|
|
754
|
+
],
|
|
755
|
+
field_docs: {},
|
|
756
|
+
optional_fields: [],
|
|
757
|
+
performance_impact: {
|
|
758
|
+
latency: "low",
|
|
759
|
+
resource_usage: "low",
|
|
760
|
+
},
|
|
761
|
+
purpose: "Create new bigip-irule",
|
|
762
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
763
|
+
side_effects: {
|
|
764
|
+
creates: ["bigip-irule"],
|
|
765
|
+
},
|
|
766
|
+
},
|
|
272
767
|
},
|
|
273
768
|
{
|
|
274
769
|
toolName: "f5xc-api-bigip-bigip-irule-delete",
|
|
@@ -288,6 +783,8 @@ export const bigipTools = [
|
|
|
288
783
|
schema: {
|
|
289
784
|
type: "string",
|
|
290
785
|
},
|
|
786
|
+
"x-displayname": "Name",
|
|
787
|
+
"x-ves-example": "Name",
|
|
291
788
|
},
|
|
292
789
|
{
|
|
293
790
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -297,6 +794,8 @@ export const bigipTools = [
|
|
|
297
794
|
schema: {
|
|
298
795
|
type: "string",
|
|
299
796
|
},
|
|
797
|
+
"x-displayname": "Namespace",
|
|
798
|
+
"x-ves-example": "Ns1",
|
|
300
799
|
},
|
|
301
800
|
],
|
|
302
801
|
queryParameters: [],
|
|
@@ -308,6 +807,83 @@ export const bigipTools = [
|
|
|
308
807
|
operationId: "ves.io.schema.bigip_irule.API.Delete",
|
|
309
808
|
tags: ["Other"],
|
|
310
809
|
sourceFile: "domains/bigip.json",
|
|
810
|
+
displayName: null,
|
|
811
|
+
dangerLevel: "high",
|
|
812
|
+
sideEffects: {
|
|
813
|
+
deletes: ["bigip-irule", "contained_resources"],
|
|
814
|
+
},
|
|
815
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
816
|
+
cliExamples: [
|
|
817
|
+
{
|
|
818
|
+
command: "f5xcctl bigipconnector bigip-irule delete {name} --namespace {namespace}",
|
|
819
|
+
description: "Delete bigip-irule",
|
|
820
|
+
use_case: "delete",
|
|
821
|
+
},
|
|
822
|
+
],
|
|
823
|
+
confirmationRequired: true,
|
|
824
|
+
parameterExamples: {
|
|
825
|
+
name: "Name",
|
|
826
|
+
namespace: "Ns1",
|
|
827
|
+
},
|
|
828
|
+
validationRules: {},
|
|
829
|
+
operationMetadata: {
|
|
830
|
+
common_errors: [
|
|
831
|
+
{
|
|
832
|
+
code: 401,
|
|
833
|
+
message: "Authentication required",
|
|
834
|
+
solution: "Provide valid API credentials",
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
code: 403,
|
|
838
|
+
message: "Permission denied",
|
|
839
|
+
solution: "Check access permissions for this operation",
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
code: 404,
|
|
843
|
+
message: "Resource not found",
|
|
844
|
+
solution: "Verify resource name, namespace, and path",
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
code: 409,
|
|
848
|
+
message: "Resource already exists",
|
|
849
|
+
solution: "Use different name or update existing resource",
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
code: 429,
|
|
853
|
+
message: "Rate limit exceeded",
|
|
854
|
+
solution: "Wait before retrying the operation",
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
code: 500,
|
|
858
|
+
message: "Server error",
|
|
859
|
+
solution: "Retry operation or contact support",
|
|
860
|
+
},
|
|
861
|
+
],
|
|
862
|
+
conditions: {
|
|
863
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
864
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
865
|
+
},
|
|
866
|
+
confirmation_required: true,
|
|
867
|
+
danger_level: "high",
|
|
868
|
+
examples: [
|
|
869
|
+
{
|
|
870
|
+
command: "f5xcctl bigipconnector bigip-irule delete {name} --namespace {namespace}",
|
|
871
|
+
description: "Delete bigip-irule",
|
|
872
|
+
use_case: "delete",
|
|
873
|
+
},
|
|
874
|
+
],
|
|
875
|
+
field_docs: {},
|
|
876
|
+
optional_fields: [],
|
|
877
|
+
performance_impact: {
|
|
878
|
+
latency: "high",
|
|
879
|
+
resource_usage: "moderate",
|
|
880
|
+
},
|
|
881
|
+
purpose: "Delete bigip-irule",
|
|
882
|
+
required_fields: ["path.name", "path.namespace"],
|
|
883
|
+
side_effects: {
|
|
884
|
+
deletes: ["bigip-irule", "contained_resources"],
|
|
885
|
+
},
|
|
886
|
+
},
|
|
311
887
|
},
|
|
312
888
|
{
|
|
313
889
|
toolName: "f5xc-api-bigip-bigip-irule-get",
|
|
@@ -327,6 +903,8 @@ export const bigipTools = [
|
|
|
327
903
|
schema: {
|
|
328
904
|
type: "string",
|
|
329
905
|
},
|
|
906
|
+
"x-displayname": "Name",
|
|
907
|
+
"x-ves-example": "Name",
|
|
330
908
|
},
|
|
331
909
|
{
|
|
332
910
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -336,6 +914,8 @@ export const bigipTools = [
|
|
|
336
914
|
schema: {
|
|
337
915
|
type: "string",
|
|
338
916
|
},
|
|
917
|
+
"x-displayname": "Namespace",
|
|
918
|
+
"x-ves-example": "Ns1",
|
|
339
919
|
},
|
|
340
920
|
],
|
|
341
921
|
queryParameters: [
|
|
@@ -357,6 +937,7 @@ export const bigipTools = [
|
|
|
357
937
|
],
|
|
358
938
|
type: "string",
|
|
359
939
|
},
|
|
940
|
+
"x-displayname": "Broken Referred Objects.",
|
|
360
941
|
},
|
|
361
942
|
],
|
|
362
943
|
requestBodySchema: null,
|
|
@@ -367,6 +948,79 @@ export const bigipTools = [
|
|
|
367
948
|
operationId: "ves.io.schema.bigip_irule.API.Get",
|
|
368
949
|
tags: ["Other"],
|
|
369
950
|
sourceFile: "domains/bigip.json",
|
|
951
|
+
displayName: null,
|
|
952
|
+
dangerLevel: "low",
|
|
953
|
+
sideEffects: null,
|
|
954
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
955
|
+
cliExamples: [
|
|
956
|
+
{
|
|
957
|
+
command: "f5xcctl bigipconnector bigip-irule get {name} --namespace {namespace}",
|
|
958
|
+
description: "Get specific bigip-irule",
|
|
959
|
+
use_case: "get_specific",
|
|
960
|
+
},
|
|
961
|
+
],
|
|
962
|
+
confirmationRequired: false,
|
|
963
|
+
parameterExamples: {
|
|
964
|
+
name: "Name",
|
|
965
|
+
namespace: "Ns1",
|
|
966
|
+
},
|
|
967
|
+
validationRules: {},
|
|
968
|
+
operationMetadata: {
|
|
969
|
+
common_errors: [
|
|
970
|
+
{
|
|
971
|
+
code: 401,
|
|
972
|
+
message: "Authentication required",
|
|
973
|
+
solution: "Provide valid API credentials",
|
|
974
|
+
},
|
|
975
|
+
{
|
|
976
|
+
code: 403,
|
|
977
|
+
message: "Permission denied",
|
|
978
|
+
solution: "Check access permissions for this operation",
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
code: 404,
|
|
982
|
+
message: "Resource not found",
|
|
983
|
+
solution: "Verify resource name, namespace, and path",
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
code: 409,
|
|
987
|
+
message: "Resource already exists",
|
|
988
|
+
solution: "Use different name or update existing resource",
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
code: 429,
|
|
992
|
+
message: "Rate limit exceeded",
|
|
993
|
+
solution: "Wait before retrying the operation",
|
|
994
|
+
},
|
|
995
|
+
{
|
|
996
|
+
code: 500,
|
|
997
|
+
message: "Server error",
|
|
998
|
+
solution: "Retry operation or contact support",
|
|
999
|
+
},
|
|
1000
|
+
],
|
|
1001
|
+
conditions: {
|
|
1002
|
+
postconditions: [],
|
|
1003
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1004
|
+
},
|
|
1005
|
+
confirmation_required: false,
|
|
1006
|
+
danger_level: "low",
|
|
1007
|
+
examples: [
|
|
1008
|
+
{
|
|
1009
|
+
command: "f5xcctl bigipconnector bigip-irule get {name} --namespace {namespace}",
|
|
1010
|
+
description: "Get specific bigip-irule",
|
|
1011
|
+
use_case: "get_specific",
|
|
1012
|
+
},
|
|
1013
|
+
],
|
|
1014
|
+
field_docs: {},
|
|
1015
|
+
optional_fields: [],
|
|
1016
|
+
performance_impact: {
|
|
1017
|
+
latency: "low",
|
|
1018
|
+
resource_usage: "low",
|
|
1019
|
+
},
|
|
1020
|
+
purpose: "Retrieve specific bigip-irule",
|
|
1021
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1022
|
+
side_effects: {},
|
|
1023
|
+
},
|
|
370
1024
|
},
|
|
371
1025
|
{
|
|
372
1026
|
toolName: "f5xc-api-bigip-bigip-irule-list",
|
|
@@ -386,6 +1040,8 @@ export const bigipTools = [
|
|
|
386
1040
|
schema: {
|
|
387
1041
|
type: "string",
|
|
388
1042
|
},
|
|
1043
|
+
"x-displayname": "Namespace",
|
|
1044
|
+
"x-ves-example": "Ns1",
|
|
389
1045
|
},
|
|
390
1046
|
],
|
|
391
1047
|
queryParameters: [
|
|
@@ -397,6 +1053,8 @@ export const bigipTools = [
|
|
|
397
1053
|
schema: {
|
|
398
1054
|
type: "string",
|
|
399
1055
|
},
|
|
1056
|
+
"x-displayname": "Label Filter.",
|
|
1057
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
400
1058
|
},
|
|
401
1059
|
{
|
|
402
1060
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -409,6 +1067,7 @@ export const bigipTools = [
|
|
|
409
1067
|
},
|
|
410
1068
|
type: "array",
|
|
411
1069
|
},
|
|
1070
|
+
"x-displayname": "Report Fields.",
|
|
412
1071
|
},
|
|
413
1072
|
{
|
|
414
1073
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -421,6 +1080,7 @@ export const bigipTools = [
|
|
|
421
1080
|
},
|
|
422
1081
|
type: "array",
|
|
423
1082
|
},
|
|
1083
|
+
"x-displayname": "Report Status Fields.",
|
|
424
1084
|
},
|
|
425
1085
|
],
|
|
426
1086
|
requestBodySchema: null,
|
|
@@ -431,6 +1091,79 @@ export const bigipTools = [
|
|
|
431
1091
|
operationId: "ves.io.schema.bigip_irule.API.List",
|
|
432
1092
|
tags: ["Other"],
|
|
433
1093
|
sourceFile: "domains/bigip.json",
|
|
1094
|
+
displayName: null,
|
|
1095
|
+
dangerLevel: "low",
|
|
1096
|
+
sideEffects: null,
|
|
1097
|
+
requiredFields: ["path.namespace"],
|
|
1098
|
+
cliExamples: [
|
|
1099
|
+
{
|
|
1100
|
+
command: "f5xcctl bigipconnector bigip-irule list --namespace {namespace}",
|
|
1101
|
+
description: "List all bigip-irules",
|
|
1102
|
+
use_case: "list_all",
|
|
1103
|
+
},
|
|
1104
|
+
],
|
|
1105
|
+
confirmationRequired: false,
|
|
1106
|
+
parameterExamples: {
|
|
1107
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1108
|
+
namespace: "Ns1",
|
|
1109
|
+
},
|
|
1110
|
+
validationRules: {},
|
|
1111
|
+
operationMetadata: {
|
|
1112
|
+
common_errors: [
|
|
1113
|
+
{
|
|
1114
|
+
code: 401,
|
|
1115
|
+
message: "Authentication required",
|
|
1116
|
+
solution: "Provide valid API credentials",
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
code: 403,
|
|
1120
|
+
message: "Permission denied",
|
|
1121
|
+
solution: "Check access permissions for this operation",
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
code: 404,
|
|
1125
|
+
message: "Resource not found",
|
|
1126
|
+
solution: "Verify resource name, namespace, and path",
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
code: 409,
|
|
1130
|
+
message: "Resource already exists",
|
|
1131
|
+
solution: "Use different name or update existing resource",
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
code: 429,
|
|
1135
|
+
message: "Rate limit exceeded",
|
|
1136
|
+
solution: "Wait before retrying the operation",
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
code: 500,
|
|
1140
|
+
message: "Server error",
|
|
1141
|
+
solution: "Retry operation or contact support",
|
|
1142
|
+
},
|
|
1143
|
+
],
|
|
1144
|
+
conditions: {
|
|
1145
|
+
postconditions: [],
|
|
1146
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1147
|
+
},
|
|
1148
|
+
confirmation_required: false,
|
|
1149
|
+
danger_level: "low",
|
|
1150
|
+
examples: [
|
|
1151
|
+
{
|
|
1152
|
+
command: "f5xcctl bigipconnector bigip-irule list --namespace {namespace}",
|
|
1153
|
+
description: "List all bigip-irules",
|
|
1154
|
+
use_case: "list_all",
|
|
1155
|
+
},
|
|
1156
|
+
],
|
|
1157
|
+
field_docs: {},
|
|
1158
|
+
optional_fields: [],
|
|
1159
|
+
performance_impact: {
|
|
1160
|
+
latency: "moderate",
|
|
1161
|
+
resource_usage: "moderate",
|
|
1162
|
+
},
|
|
1163
|
+
purpose: "List all bigip-irules",
|
|
1164
|
+
required_fields: ["path.namespace"],
|
|
1165
|
+
side_effects: {},
|
|
1166
|
+
},
|
|
434
1167
|
},
|
|
435
1168
|
{
|
|
436
1169
|
toolName: "f5xc-api-bigip-bigip-irule-update",
|
|
@@ -450,6 +1183,8 @@ export const bigipTools = [
|
|
|
450
1183
|
schema: {
|
|
451
1184
|
type: "string",
|
|
452
1185
|
},
|
|
1186
|
+
"x-displayname": "Name",
|
|
1187
|
+
"x-ves-example": "Example-corp-web.",
|
|
453
1188
|
},
|
|
454
1189
|
{
|
|
455
1190
|
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 +1194,8 @@ export const bigipTools = [
|
|
|
459
1194
|
schema: {
|
|
460
1195
|
type: "string",
|
|
461
1196
|
},
|
|
1197
|
+
"x-displayname": "Namespace",
|
|
1198
|
+
"x-ves-example": "Staging",
|
|
462
1199
|
},
|
|
463
1200
|
],
|
|
464
1201
|
queryParameters: [],
|
|
@@ -472,6 +1209,83 @@ export const bigipTools = [
|
|
|
472
1209
|
operationId: "ves.io.schema.bigip_irule.API.Replace",
|
|
473
1210
|
tags: ["Other"],
|
|
474
1211
|
sourceFile: "domains/bigip.json",
|
|
1212
|
+
displayName: null,
|
|
1213
|
+
dangerLevel: "medium",
|
|
1214
|
+
sideEffects: {
|
|
1215
|
+
modifies: ["bigip-irule"],
|
|
1216
|
+
},
|
|
1217
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1218
|
+
cliExamples: [
|
|
1219
|
+
{
|
|
1220
|
+
command: "f5xcctl bigipconnector bigip-irule update {name} --namespace {namespace} -f {file}.yaml",
|
|
1221
|
+
description: "Update bigip-irule",
|
|
1222
|
+
use_case: "update",
|
|
1223
|
+
},
|
|
1224
|
+
],
|
|
1225
|
+
confirmationRequired: false,
|
|
1226
|
+
parameterExamples: {
|
|
1227
|
+
"metadata.name": "Example-corp-web.",
|
|
1228
|
+
"metadata.namespace": "Staging",
|
|
1229
|
+
},
|
|
1230
|
+
validationRules: {},
|
|
1231
|
+
operationMetadata: {
|
|
1232
|
+
common_errors: [
|
|
1233
|
+
{
|
|
1234
|
+
code: 401,
|
|
1235
|
+
message: "Authentication required",
|
|
1236
|
+
solution: "Provide valid API credentials",
|
|
1237
|
+
},
|
|
1238
|
+
{
|
|
1239
|
+
code: 403,
|
|
1240
|
+
message: "Permission denied",
|
|
1241
|
+
solution: "Check access permissions for this operation",
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
code: 404,
|
|
1245
|
+
message: "Resource not found",
|
|
1246
|
+
solution: "Verify resource name, namespace, and path",
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
code: 409,
|
|
1250
|
+
message: "Resource already exists",
|
|
1251
|
+
solution: "Use different name or update existing resource",
|
|
1252
|
+
},
|
|
1253
|
+
{
|
|
1254
|
+
code: 429,
|
|
1255
|
+
message: "Rate limit exceeded",
|
|
1256
|
+
solution: "Wait before retrying the operation",
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
code: 500,
|
|
1260
|
+
message: "Server error",
|
|
1261
|
+
solution: "Retry operation or contact support",
|
|
1262
|
+
},
|
|
1263
|
+
],
|
|
1264
|
+
conditions: {
|
|
1265
|
+
postconditions: ["Resource updated with new values"],
|
|
1266
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1267
|
+
},
|
|
1268
|
+
confirmation_required: false,
|
|
1269
|
+
danger_level: "medium",
|
|
1270
|
+
examples: [
|
|
1271
|
+
{
|
|
1272
|
+
command: "f5xcctl bigipconnector bigip-irule update {name} --namespace {namespace} -f {file}.yaml",
|
|
1273
|
+
description: "Update bigip-irule",
|
|
1274
|
+
use_case: "update",
|
|
1275
|
+
},
|
|
1276
|
+
],
|
|
1277
|
+
field_docs: {},
|
|
1278
|
+
optional_fields: [],
|
|
1279
|
+
performance_impact: {
|
|
1280
|
+
latency: "low",
|
|
1281
|
+
resource_usage: "low",
|
|
1282
|
+
},
|
|
1283
|
+
purpose: "Replace existing bigip-irule",
|
|
1284
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1285
|
+
side_effects: {
|
|
1286
|
+
modifies: ["bigip-irule"],
|
|
1287
|
+
},
|
|
1288
|
+
},
|
|
475
1289
|
},
|
|
476
1290
|
{
|
|
477
1291
|
toolName: "f5xc-api-bigip-bigip-virtual-server-get",
|
|
@@ -491,6 +1305,8 @@ export const bigipTools = [
|
|
|
491
1305
|
schema: {
|
|
492
1306
|
type: "string",
|
|
493
1307
|
},
|
|
1308
|
+
"x-displayname": "Name",
|
|
1309
|
+
"x-ves-example": "Name",
|
|
494
1310
|
},
|
|
495
1311
|
{
|
|
496
1312
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -500,6 +1316,8 @@ export const bigipTools = [
|
|
|
500
1316
|
schema: {
|
|
501
1317
|
type: "string",
|
|
502
1318
|
},
|
|
1319
|
+
"x-displayname": "Namespace",
|
|
1320
|
+
"x-ves-example": "Ns1",
|
|
503
1321
|
},
|
|
504
1322
|
],
|
|
505
1323
|
queryParameters: [
|
|
@@ -520,6 +1338,7 @@ export const bigipTools = [
|
|
|
520
1338
|
],
|
|
521
1339
|
type: "string",
|
|
522
1340
|
},
|
|
1341
|
+
"x-displayname": "Broken Referred Objects.",
|
|
523
1342
|
},
|
|
524
1343
|
],
|
|
525
1344
|
requestBodySchema: null,
|
|
@@ -530,6 +1349,79 @@ export const bigipTools = [
|
|
|
530
1349
|
operationId: "ves.io.schema.views.bigip_virtual_server.API.Get",
|
|
531
1350
|
tags: ["Other"],
|
|
532
1351
|
sourceFile: "domains/bigip.json",
|
|
1352
|
+
displayName: null,
|
|
1353
|
+
dangerLevel: "low",
|
|
1354
|
+
sideEffects: null,
|
|
1355
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1356
|
+
cliExamples: [
|
|
1357
|
+
{
|
|
1358
|
+
command: "f5xcctl config bigip-virtual-server get {name} --namespace {namespace}",
|
|
1359
|
+
description: "Get specific bigip-virtual-server",
|
|
1360
|
+
use_case: "get_specific",
|
|
1361
|
+
},
|
|
1362
|
+
],
|
|
1363
|
+
confirmationRequired: false,
|
|
1364
|
+
parameterExamples: {
|
|
1365
|
+
name: "Name",
|
|
1366
|
+
namespace: "Ns1",
|
|
1367
|
+
},
|
|
1368
|
+
validationRules: {},
|
|
1369
|
+
operationMetadata: {
|
|
1370
|
+
common_errors: [
|
|
1371
|
+
{
|
|
1372
|
+
code: 401,
|
|
1373
|
+
message: "Authentication required",
|
|
1374
|
+
solution: "Provide valid API credentials",
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
code: 403,
|
|
1378
|
+
message: "Permission denied",
|
|
1379
|
+
solution: "Check access permissions for this operation",
|
|
1380
|
+
},
|
|
1381
|
+
{
|
|
1382
|
+
code: 404,
|
|
1383
|
+
message: "Resource not found",
|
|
1384
|
+
solution: "Verify resource name, namespace, and path",
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
code: 409,
|
|
1388
|
+
message: "Resource already exists",
|
|
1389
|
+
solution: "Use different name or update existing resource",
|
|
1390
|
+
},
|
|
1391
|
+
{
|
|
1392
|
+
code: 429,
|
|
1393
|
+
message: "Rate limit exceeded",
|
|
1394
|
+
solution: "Wait before retrying the operation",
|
|
1395
|
+
},
|
|
1396
|
+
{
|
|
1397
|
+
code: 500,
|
|
1398
|
+
message: "Server error",
|
|
1399
|
+
solution: "Retry operation or contact support",
|
|
1400
|
+
},
|
|
1401
|
+
],
|
|
1402
|
+
conditions: {
|
|
1403
|
+
postconditions: [],
|
|
1404
|
+
prerequisites: ["Active namespace"],
|
|
1405
|
+
},
|
|
1406
|
+
confirmation_required: false,
|
|
1407
|
+
danger_level: "low",
|
|
1408
|
+
examples: [
|
|
1409
|
+
{
|
|
1410
|
+
command: "f5xcctl config bigip-virtual-server get {name} --namespace {namespace}",
|
|
1411
|
+
description: "Get specific bigip-virtual-server",
|
|
1412
|
+
use_case: "get_specific",
|
|
1413
|
+
},
|
|
1414
|
+
],
|
|
1415
|
+
field_docs: {},
|
|
1416
|
+
optional_fields: [],
|
|
1417
|
+
performance_impact: {
|
|
1418
|
+
latency: "low",
|
|
1419
|
+
resource_usage: "low",
|
|
1420
|
+
},
|
|
1421
|
+
purpose: "Retrieve specific bigip-virtual-server",
|
|
1422
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1423
|
+
side_effects: {},
|
|
1424
|
+
},
|
|
533
1425
|
},
|
|
534
1426
|
{
|
|
535
1427
|
toolName: "f5xc-api-bigip-bigip-virtual-server-list",
|
|
@@ -549,6 +1441,8 @@ export const bigipTools = [
|
|
|
549
1441
|
schema: {
|
|
550
1442
|
type: "string",
|
|
551
1443
|
},
|
|
1444
|
+
"x-displayname": "Namespace",
|
|
1445
|
+
"x-ves-example": "Ns1",
|
|
552
1446
|
},
|
|
553
1447
|
],
|
|
554
1448
|
queryParameters: [
|
|
@@ -560,6 +1454,8 @@ export const bigipTools = [
|
|
|
560
1454
|
schema: {
|
|
561
1455
|
type: "string",
|
|
562
1456
|
},
|
|
1457
|
+
"x-displayname": "Label Filter.",
|
|
1458
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
563
1459
|
},
|
|
564
1460
|
{
|
|
565
1461
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -572,6 +1468,7 @@ export const bigipTools = [
|
|
|
572
1468
|
},
|
|
573
1469
|
type: "array",
|
|
574
1470
|
},
|
|
1471
|
+
"x-displayname": "Report Fields.",
|
|
575
1472
|
},
|
|
576
1473
|
{
|
|
577
1474
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -584,6 +1481,7 @@ export const bigipTools = [
|
|
|
584
1481
|
},
|
|
585
1482
|
type: "array",
|
|
586
1483
|
},
|
|
1484
|
+
"x-displayname": "Report Status Fields.",
|
|
587
1485
|
},
|
|
588
1486
|
],
|
|
589
1487
|
requestBodySchema: null,
|
|
@@ -594,6 +1492,79 @@ export const bigipTools = [
|
|
|
594
1492
|
operationId: "ves.io.schema.views.bigip_virtual_server.API.List",
|
|
595
1493
|
tags: ["Other"],
|
|
596
1494
|
sourceFile: "domains/bigip.json",
|
|
1495
|
+
displayName: null,
|
|
1496
|
+
dangerLevel: "low",
|
|
1497
|
+
sideEffects: null,
|
|
1498
|
+
requiredFields: ["path.namespace"],
|
|
1499
|
+
cliExamples: [
|
|
1500
|
+
{
|
|
1501
|
+
command: "f5xcctl config bigip-virtual-server list --namespace {namespace}",
|
|
1502
|
+
description: "List all bigip-virtual-servers",
|
|
1503
|
+
use_case: "list_all",
|
|
1504
|
+
},
|
|
1505
|
+
],
|
|
1506
|
+
confirmationRequired: false,
|
|
1507
|
+
parameterExamples: {
|
|
1508
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1509
|
+
namespace: "Ns1",
|
|
1510
|
+
},
|
|
1511
|
+
validationRules: {},
|
|
1512
|
+
operationMetadata: {
|
|
1513
|
+
common_errors: [
|
|
1514
|
+
{
|
|
1515
|
+
code: 401,
|
|
1516
|
+
message: "Authentication required",
|
|
1517
|
+
solution: "Provide valid API credentials",
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
code: 403,
|
|
1521
|
+
message: "Permission denied",
|
|
1522
|
+
solution: "Check access permissions for this operation",
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
code: 404,
|
|
1526
|
+
message: "Resource not found",
|
|
1527
|
+
solution: "Verify resource name, namespace, and path",
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
code: 409,
|
|
1531
|
+
message: "Resource already exists",
|
|
1532
|
+
solution: "Use different name or update existing resource",
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
code: 429,
|
|
1536
|
+
message: "Rate limit exceeded",
|
|
1537
|
+
solution: "Wait before retrying the operation",
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
code: 500,
|
|
1541
|
+
message: "Server error",
|
|
1542
|
+
solution: "Retry operation or contact support",
|
|
1543
|
+
},
|
|
1544
|
+
],
|
|
1545
|
+
conditions: {
|
|
1546
|
+
postconditions: [],
|
|
1547
|
+
prerequisites: ["Active namespace"],
|
|
1548
|
+
},
|
|
1549
|
+
confirmation_required: false,
|
|
1550
|
+
danger_level: "low",
|
|
1551
|
+
examples: [
|
|
1552
|
+
{
|
|
1553
|
+
command: "f5xcctl config bigip-virtual-server list --namespace {namespace}",
|
|
1554
|
+
description: "List all bigip-virtual-servers",
|
|
1555
|
+
use_case: "list_all",
|
|
1556
|
+
},
|
|
1557
|
+
],
|
|
1558
|
+
field_docs: {},
|
|
1559
|
+
optional_fields: [],
|
|
1560
|
+
performance_impact: {
|
|
1561
|
+
latency: "moderate",
|
|
1562
|
+
resource_usage: "moderate",
|
|
1563
|
+
},
|
|
1564
|
+
purpose: "List all bigip-virtual-servers",
|
|
1565
|
+
required_fields: ["path.namespace"],
|
|
1566
|
+
side_effects: {},
|
|
1567
|
+
},
|
|
597
1568
|
},
|
|
598
1569
|
{
|
|
599
1570
|
toolName: "f5xc-api-bigip-bigip-virtual-server-update",
|
|
@@ -613,6 +1584,8 @@ export const bigipTools = [
|
|
|
613
1584
|
schema: {
|
|
614
1585
|
type: "string",
|
|
615
1586
|
},
|
|
1587
|
+
"x-displayname": "Name",
|
|
1588
|
+
"x-ves-example": "Example-corp-web.",
|
|
616
1589
|
},
|
|
617
1590
|
{
|
|
618
1591
|
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 +1595,8 @@ export const bigipTools = [
|
|
|
622
1595
|
schema: {
|
|
623
1596
|
type: "string",
|
|
624
1597
|
},
|
|
1598
|
+
"x-displayname": "Namespace",
|
|
1599
|
+
"x-ves-example": "Staging",
|
|
625
1600
|
},
|
|
626
1601
|
],
|
|
627
1602
|
queryParameters: [],
|
|
@@ -635,6 +1610,83 @@ export const bigipTools = [
|
|
|
635
1610
|
operationId: "ves.io.schema.views.bigip_virtual_server.API.Replace",
|
|
636
1611
|
tags: ["Other"],
|
|
637
1612
|
sourceFile: "domains/bigip.json",
|
|
1613
|
+
displayName: null,
|
|
1614
|
+
dangerLevel: "medium",
|
|
1615
|
+
sideEffects: {
|
|
1616
|
+
modifies: ["bigip-virtual-server"],
|
|
1617
|
+
},
|
|
1618
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1619
|
+
cliExamples: [
|
|
1620
|
+
{
|
|
1621
|
+
command: "f5xcctl config bigip-virtual-server update {name} --namespace {namespace} -f {file}.yaml",
|
|
1622
|
+
description: "Update bigip-virtual-server",
|
|
1623
|
+
use_case: "update",
|
|
1624
|
+
},
|
|
1625
|
+
],
|
|
1626
|
+
confirmationRequired: false,
|
|
1627
|
+
parameterExamples: {
|
|
1628
|
+
"metadata.name": "Example-corp-web.",
|
|
1629
|
+
"metadata.namespace": "Staging",
|
|
1630
|
+
},
|
|
1631
|
+
validationRules: {},
|
|
1632
|
+
operationMetadata: {
|
|
1633
|
+
common_errors: [
|
|
1634
|
+
{
|
|
1635
|
+
code: 401,
|
|
1636
|
+
message: "Authentication required",
|
|
1637
|
+
solution: "Provide valid API credentials",
|
|
1638
|
+
},
|
|
1639
|
+
{
|
|
1640
|
+
code: 403,
|
|
1641
|
+
message: "Permission denied",
|
|
1642
|
+
solution: "Check access permissions for this operation",
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
code: 404,
|
|
1646
|
+
message: "Resource not found",
|
|
1647
|
+
solution: "Verify resource name, namespace, and path",
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
code: 409,
|
|
1651
|
+
message: "Resource already exists",
|
|
1652
|
+
solution: "Use different name or update existing resource",
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
code: 429,
|
|
1656
|
+
message: "Rate limit exceeded",
|
|
1657
|
+
solution: "Wait before retrying the operation",
|
|
1658
|
+
},
|
|
1659
|
+
{
|
|
1660
|
+
code: 500,
|
|
1661
|
+
message: "Server error",
|
|
1662
|
+
solution: "Retry operation or contact support",
|
|
1663
|
+
},
|
|
1664
|
+
],
|
|
1665
|
+
conditions: {
|
|
1666
|
+
postconditions: ["Resource updated with new values"],
|
|
1667
|
+
prerequisites: ["Active namespace"],
|
|
1668
|
+
},
|
|
1669
|
+
confirmation_required: false,
|
|
1670
|
+
danger_level: "medium",
|
|
1671
|
+
examples: [
|
|
1672
|
+
{
|
|
1673
|
+
command: "f5xcctl config bigip-virtual-server update {name} --namespace {namespace} -f {file}.yaml",
|
|
1674
|
+
description: "Update bigip-virtual-server",
|
|
1675
|
+
use_case: "update",
|
|
1676
|
+
},
|
|
1677
|
+
],
|
|
1678
|
+
field_docs: {},
|
|
1679
|
+
optional_fields: [],
|
|
1680
|
+
performance_impact: {
|
|
1681
|
+
latency: "low",
|
|
1682
|
+
resource_usage: "low",
|
|
1683
|
+
},
|
|
1684
|
+
purpose: "Replace existing bigip-virtual-server",
|
|
1685
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1686
|
+
side_effects: {
|
|
1687
|
+
modifies: ["bigip-virtual-server"],
|
|
1688
|
+
},
|
|
1689
|
+
},
|
|
638
1690
|
},
|
|
639
1691
|
{
|
|
640
1692
|
toolName: "f5xc-api-bigip-data-group-create",
|
|
@@ -654,6 +1706,8 @@ export const bigipTools = [
|
|
|
654
1706
|
schema: {
|
|
655
1707
|
type: "string",
|
|
656
1708
|
},
|
|
1709
|
+
"x-displayname": "Namespace",
|
|
1710
|
+
"x-ves-example": "Staging",
|
|
657
1711
|
},
|
|
658
1712
|
],
|
|
659
1713
|
queryParameters: [],
|
|
@@ -667,6 +1721,92 @@ export const bigipTools = [
|
|
|
667
1721
|
operationId: "ves.io.schema.bigcne.data_group.API.Create",
|
|
668
1722
|
tags: ["Other"],
|
|
669
1723
|
sourceFile: "domains/bigip.json",
|
|
1724
|
+
displayName: null,
|
|
1725
|
+
dangerLevel: "medium",
|
|
1726
|
+
sideEffects: {
|
|
1727
|
+
creates: ["data-group"],
|
|
1728
|
+
},
|
|
1729
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1730
|
+
cliExamples: [
|
|
1731
|
+
{
|
|
1732
|
+
command: "f5xcctl config data-group create {name} --namespace {namespace}",
|
|
1733
|
+
description: "Create data-group",
|
|
1734
|
+
use_case: "basic_create",
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
command: "f5xcctl config data-group create -f {file}.yaml",
|
|
1738
|
+
description: "Create from YAML file",
|
|
1739
|
+
use_case: "file_based",
|
|
1740
|
+
},
|
|
1741
|
+
],
|
|
1742
|
+
confirmationRequired: false,
|
|
1743
|
+
parameterExamples: {
|
|
1744
|
+
"metadata.namespace": "Staging",
|
|
1745
|
+
},
|
|
1746
|
+
validationRules: {},
|
|
1747
|
+
operationMetadata: {
|
|
1748
|
+
common_errors: [
|
|
1749
|
+
{
|
|
1750
|
+
code: 401,
|
|
1751
|
+
message: "Authentication required",
|
|
1752
|
+
solution: "Provide valid API credentials",
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
code: 403,
|
|
1756
|
+
message: "Permission denied",
|
|
1757
|
+
solution: "Check access permissions for this operation",
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
code: 404,
|
|
1761
|
+
message: "Resource not found",
|
|
1762
|
+
solution: "Verify resource name, namespace, and path",
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
code: 409,
|
|
1766
|
+
message: "Resource already exists",
|
|
1767
|
+
solution: "Use different name or update existing resource",
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
code: 429,
|
|
1771
|
+
message: "Rate limit exceeded",
|
|
1772
|
+
solution: "Wait before retrying the operation",
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
code: 500,
|
|
1776
|
+
message: "Server error",
|
|
1777
|
+
solution: "Retry operation or contact support",
|
|
1778
|
+
},
|
|
1779
|
+
],
|
|
1780
|
+
conditions: {
|
|
1781
|
+
postconditions: ["Data-group resource created", "Resource assigned unique identifier"],
|
|
1782
|
+
prerequisites: ["Active namespace"],
|
|
1783
|
+
},
|
|
1784
|
+
confirmation_required: false,
|
|
1785
|
+
danger_level: "medium",
|
|
1786
|
+
examples: [
|
|
1787
|
+
{
|
|
1788
|
+
command: "f5xcctl config data-group create {name} --namespace {namespace}",
|
|
1789
|
+
description: "Create data-group",
|
|
1790
|
+
use_case: "basic_create",
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
command: "f5xcctl config data-group create -f {file}.yaml",
|
|
1794
|
+
description: "Create from YAML file",
|
|
1795
|
+
use_case: "file_based",
|
|
1796
|
+
},
|
|
1797
|
+
],
|
|
1798
|
+
field_docs: {},
|
|
1799
|
+
optional_fields: [],
|
|
1800
|
+
performance_impact: {
|
|
1801
|
+
latency: "low",
|
|
1802
|
+
resource_usage: "low",
|
|
1803
|
+
},
|
|
1804
|
+
purpose: "Create new data-group",
|
|
1805
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1806
|
+
side_effects: {
|
|
1807
|
+
creates: ["data-group"],
|
|
1808
|
+
},
|
|
1809
|
+
},
|
|
670
1810
|
},
|
|
671
1811
|
{
|
|
672
1812
|
toolName: "f5xc-api-bigip-data-group-delete",
|
|
@@ -686,6 +1826,8 @@ export const bigipTools = [
|
|
|
686
1826
|
schema: {
|
|
687
1827
|
type: "string",
|
|
688
1828
|
},
|
|
1829
|
+
"x-displayname": "Name",
|
|
1830
|
+
"x-ves-example": "Name",
|
|
689
1831
|
},
|
|
690
1832
|
{
|
|
691
1833
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -695,6 +1837,8 @@ export const bigipTools = [
|
|
|
695
1837
|
schema: {
|
|
696
1838
|
type: "string",
|
|
697
1839
|
},
|
|
1840
|
+
"x-displayname": "Namespace",
|
|
1841
|
+
"x-ves-example": "Ns1",
|
|
698
1842
|
},
|
|
699
1843
|
],
|
|
700
1844
|
queryParameters: [],
|
|
@@ -706,6 +1850,83 @@ export const bigipTools = [
|
|
|
706
1850
|
operationId: "ves.io.schema.bigcne.data_group.API.Delete",
|
|
707
1851
|
tags: ["Other"],
|
|
708
1852
|
sourceFile: "domains/bigip.json",
|
|
1853
|
+
displayName: null,
|
|
1854
|
+
dangerLevel: "high",
|
|
1855
|
+
sideEffects: {
|
|
1856
|
+
deletes: ["data-group", "contained_resources"],
|
|
1857
|
+
},
|
|
1858
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1859
|
+
cliExamples: [
|
|
1860
|
+
{
|
|
1861
|
+
command: "f5xcctl config data-group delete {name} --namespace {namespace}",
|
|
1862
|
+
description: "Delete data-group",
|
|
1863
|
+
use_case: "delete",
|
|
1864
|
+
},
|
|
1865
|
+
],
|
|
1866
|
+
confirmationRequired: true,
|
|
1867
|
+
parameterExamples: {
|
|
1868
|
+
name: "Name",
|
|
1869
|
+
namespace: "Ns1",
|
|
1870
|
+
},
|
|
1871
|
+
validationRules: {},
|
|
1872
|
+
operationMetadata: {
|
|
1873
|
+
common_errors: [
|
|
1874
|
+
{
|
|
1875
|
+
code: 401,
|
|
1876
|
+
message: "Authentication required",
|
|
1877
|
+
solution: "Provide valid API credentials",
|
|
1878
|
+
},
|
|
1879
|
+
{
|
|
1880
|
+
code: 403,
|
|
1881
|
+
message: "Permission denied",
|
|
1882
|
+
solution: "Check access permissions for this operation",
|
|
1883
|
+
},
|
|
1884
|
+
{
|
|
1885
|
+
code: 404,
|
|
1886
|
+
message: "Resource not found",
|
|
1887
|
+
solution: "Verify resource name, namespace, and path",
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
code: 409,
|
|
1891
|
+
message: "Resource already exists",
|
|
1892
|
+
solution: "Use different name or update existing resource",
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
code: 429,
|
|
1896
|
+
message: "Rate limit exceeded",
|
|
1897
|
+
solution: "Wait before retrying the operation",
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
code: 500,
|
|
1901
|
+
message: "Server error",
|
|
1902
|
+
solution: "Retry operation or contact support",
|
|
1903
|
+
},
|
|
1904
|
+
],
|
|
1905
|
+
conditions: {
|
|
1906
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1907
|
+
prerequisites: ["Active namespace"],
|
|
1908
|
+
},
|
|
1909
|
+
confirmation_required: true,
|
|
1910
|
+
danger_level: "high",
|
|
1911
|
+
examples: [
|
|
1912
|
+
{
|
|
1913
|
+
command: "f5xcctl config data-group delete {name} --namespace {namespace}",
|
|
1914
|
+
description: "Delete data-group",
|
|
1915
|
+
use_case: "delete",
|
|
1916
|
+
},
|
|
1917
|
+
],
|
|
1918
|
+
field_docs: {},
|
|
1919
|
+
optional_fields: [],
|
|
1920
|
+
performance_impact: {
|
|
1921
|
+
latency: "high",
|
|
1922
|
+
resource_usage: "moderate",
|
|
1923
|
+
},
|
|
1924
|
+
purpose: "Delete data-group",
|
|
1925
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1926
|
+
side_effects: {
|
|
1927
|
+
deletes: ["data-group", "contained_resources"],
|
|
1928
|
+
},
|
|
1929
|
+
},
|
|
709
1930
|
},
|
|
710
1931
|
{
|
|
711
1932
|
toolName: "f5xc-api-bigip-data-group-get",
|
|
@@ -725,6 +1946,8 @@ export const bigipTools = [
|
|
|
725
1946
|
schema: {
|
|
726
1947
|
type: "string",
|
|
727
1948
|
},
|
|
1949
|
+
"x-displayname": "Name",
|
|
1950
|
+
"x-ves-example": "Name",
|
|
728
1951
|
},
|
|
729
1952
|
{
|
|
730
1953
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -734,6 +1957,8 @@ export const bigipTools = [
|
|
|
734
1957
|
schema: {
|
|
735
1958
|
type: "string",
|
|
736
1959
|
},
|
|
1960
|
+
"x-displayname": "Namespace",
|
|
1961
|
+
"x-ves-example": "Ns1",
|
|
737
1962
|
},
|
|
738
1963
|
],
|
|
739
1964
|
queryParameters: [
|
|
@@ -754,6 +1979,7 @@ export const bigipTools = [
|
|
|
754
1979
|
],
|
|
755
1980
|
type: "string",
|
|
756
1981
|
},
|
|
1982
|
+
"x-displayname": "Broken Referred Objects.",
|
|
757
1983
|
},
|
|
758
1984
|
],
|
|
759
1985
|
requestBodySchema: null,
|
|
@@ -764,6 +1990,79 @@ export const bigipTools = [
|
|
|
764
1990
|
operationId: "ves.io.schema.bigcne.data_group.API.Get",
|
|
765
1991
|
tags: ["Other"],
|
|
766
1992
|
sourceFile: "domains/bigip.json",
|
|
1993
|
+
displayName: null,
|
|
1994
|
+
dangerLevel: "low",
|
|
1995
|
+
sideEffects: null,
|
|
1996
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1997
|
+
cliExamples: [
|
|
1998
|
+
{
|
|
1999
|
+
command: "f5xcctl config data-group get {name} --namespace {namespace}",
|
|
2000
|
+
description: "Get specific data-group",
|
|
2001
|
+
use_case: "get_specific",
|
|
2002
|
+
},
|
|
2003
|
+
],
|
|
2004
|
+
confirmationRequired: false,
|
|
2005
|
+
parameterExamples: {
|
|
2006
|
+
name: "Name",
|
|
2007
|
+
namespace: "Ns1",
|
|
2008
|
+
},
|
|
2009
|
+
validationRules: {},
|
|
2010
|
+
operationMetadata: {
|
|
2011
|
+
common_errors: [
|
|
2012
|
+
{
|
|
2013
|
+
code: 401,
|
|
2014
|
+
message: "Authentication required",
|
|
2015
|
+
solution: "Provide valid API credentials",
|
|
2016
|
+
},
|
|
2017
|
+
{
|
|
2018
|
+
code: 403,
|
|
2019
|
+
message: "Permission denied",
|
|
2020
|
+
solution: "Check access permissions for this operation",
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
code: 404,
|
|
2024
|
+
message: "Resource not found",
|
|
2025
|
+
solution: "Verify resource name, namespace, and path",
|
|
2026
|
+
},
|
|
2027
|
+
{
|
|
2028
|
+
code: 409,
|
|
2029
|
+
message: "Resource already exists",
|
|
2030
|
+
solution: "Use different name or update existing resource",
|
|
2031
|
+
},
|
|
2032
|
+
{
|
|
2033
|
+
code: 429,
|
|
2034
|
+
message: "Rate limit exceeded",
|
|
2035
|
+
solution: "Wait before retrying the operation",
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
code: 500,
|
|
2039
|
+
message: "Server error",
|
|
2040
|
+
solution: "Retry operation or contact support",
|
|
2041
|
+
},
|
|
2042
|
+
],
|
|
2043
|
+
conditions: {
|
|
2044
|
+
postconditions: [],
|
|
2045
|
+
prerequisites: ["Active namespace"],
|
|
2046
|
+
},
|
|
2047
|
+
confirmation_required: false,
|
|
2048
|
+
danger_level: "low",
|
|
2049
|
+
examples: [
|
|
2050
|
+
{
|
|
2051
|
+
command: "f5xcctl config data-group get {name} --namespace {namespace}",
|
|
2052
|
+
description: "Get specific data-group",
|
|
2053
|
+
use_case: "get_specific",
|
|
2054
|
+
},
|
|
2055
|
+
],
|
|
2056
|
+
field_docs: {},
|
|
2057
|
+
optional_fields: [],
|
|
2058
|
+
performance_impact: {
|
|
2059
|
+
latency: "low",
|
|
2060
|
+
resource_usage: "low",
|
|
2061
|
+
},
|
|
2062
|
+
purpose: "Retrieve specific data-group",
|
|
2063
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2064
|
+
side_effects: {},
|
|
2065
|
+
},
|
|
767
2066
|
},
|
|
768
2067
|
{
|
|
769
2068
|
toolName: "f5xc-api-bigip-data-group-list",
|
|
@@ -783,6 +2082,8 @@ export const bigipTools = [
|
|
|
783
2082
|
schema: {
|
|
784
2083
|
type: "string",
|
|
785
2084
|
},
|
|
2085
|
+
"x-displayname": "Namespace",
|
|
2086
|
+
"x-ves-example": "Ns1",
|
|
786
2087
|
},
|
|
787
2088
|
],
|
|
788
2089
|
queryParameters: [
|
|
@@ -794,6 +2095,8 @@ export const bigipTools = [
|
|
|
794
2095
|
schema: {
|
|
795
2096
|
type: "string",
|
|
796
2097
|
},
|
|
2098
|
+
"x-displayname": "Label Filter.",
|
|
2099
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
797
2100
|
},
|
|
798
2101
|
{
|
|
799
2102
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -806,6 +2109,7 @@ export const bigipTools = [
|
|
|
806
2109
|
},
|
|
807
2110
|
type: "array",
|
|
808
2111
|
},
|
|
2112
|
+
"x-displayname": "Report Fields.",
|
|
809
2113
|
},
|
|
810
2114
|
{
|
|
811
2115
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -818,6 +2122,7 @@ export const bigipTools = [
|
|
|
818
2122
|
},
|
|
819
2123
|
type: "array",
|
|
820
2124
|
},
|
|
2125
|
+
"x-displayname": "Report Status Fields.",
|
|
821
2126
|
},
|
|
822
2127
|
],
|
|
823
2128
|
requestBodySchema: null,
|
|
@@ -828,6 +2133,79 @@ export const bigipTools = [
|
|
|
828
2133
|
operationId: "ves.io.schema.bigcne.data_group.API.List",
|
|
829
2134
|
tags: ["Other"],
|
|
830
2135
|
sourceFile: "domains/bigip.json",
|
|
2136
|
+
displayName: null,
|
|
2137
|
+
dangerLevel: "low",
|
|
2138
|
+
sideEffects: null,
|
|
2139
|
+
requiredFields: ["path.namespace"],
|
|
2140
|
+
cliExamples: [
|
|
2141
|
+
{
|
|
2142
|
+
command: "f5xcctl config data-group list --namespace {namespace}",
|
|
2143
|
+
description: "List all data-groups",
|
|
2144
|
+
use_case: "list_all",
|
|
2145
|
+
},
|
|
2146
|
+
],
|
|
2147
|
+
confirmationRequired: false,
|
|
2148
|
+
parameterExamples: {
|
|
2149
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2150
|
+
namespace: "Ns1",
|
|
2151
|
+
},
|
|
2152
|
+
validationRules: {},
|
|
2153
|
+
operationMetadata: {
|
|
2154
|
+
common_errors: [
|
|
2155
|
+
{
|
|
2156
|
+
code: 401,
|
|
2157
|
+
message: "Authentication required",
|
|
2158
|
+
solution: "Provide valid API credentials",
|
|
2159
|
+
},
|
|
2160
|
+
{
|
|
2161
|
+
code: 403,
|
|
2162
|
+
message: "Permission denied",
|
|
2163
|
+
solution: "Check access permissions for this operation",
|
|
2164
|
+
},
|
|
2165
|
+
{
|
|
2166
|
+
code: 404,
|
|
2167
|
+
message: "Resource not found",
|
|
2168
|
+
solution: "Verify resource name, namespace, and path",
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
code: 409,
|
|
2172
|
+
message: "Resource already exists",
|
|
2173
|
+
solution: "Use different name or update existing resource",
|
|
2174
|
+
},
|
|
2175
|
+
{
|
|
2176
|
+
code: 429,
|
|
2177
|
+
message: "Rate limit exceeded",
|
|
2178
|
+
solution: "Wait before retrying the operation",
|
|
2179
|
+
},
|
|
2180
|
+
{
|
|
2181
|
+
code: 500,
|
|
2182
|
+
message: "Server error",
|
|
2183
|
+
solution: "Retry operation or contact support",
|
|
2184
|
+
},
|
|
2185
|
+
],
|
|
2186
|
+
conditions: {
|
|
2187
|
+
postconditions: [],
|
|
2188
|
+
prerequisites: ["Active namespace"],
|
|
2189
|
+
},
|
|
2190
|
+
confirmation_required: false,
|
|
2191
|
+
danger_level: "low",
|
|
2192
|
+
examples: [
|
|
2193
|
+
{
|
|
2194
|
+
command: "f5xcctl config data-group list --namespace {namespace}",
|
|
2195
|
+
description: "List all data-groups",
|
|
2196
|
+
use_case: "list_all",
|
|
2197
|
+
},
|
|
2198
|
+
],
|
|
2199
|
+
field_docs: {},
|
|
2200
|
+
optional_fields: [],
|
|
2201
|
+
performance_impact: {
|
|
2202
|
+
latency: "moderate",
|
|
2203
|
+
resource_usage: "moderate",
|
|
2204
|
+
},
|
|
2205
|
+
purpose: "List all data-groups",
|
|
2206
|
+
required_fields: ["path.namespace"],
|
|
2207
|
+
side_effects: {},
|
|
2208
|
+
},
|
|
831
2209
|
},
|
|
832
2210
|
{
|
|
833
2211
|
toolName: "f5xc-api-bigip-data-group-update",
|
|
@@ -847,6 +2225,8 @@ export const bigipTools = [
|
|
|
847
2225
|
schema: {
|
|
848
2226
|
type: "string",
|
|
849
2227
|
},
|
|
2228
|
+
"x-displayname": "Name",
|
|
2229
|
+
"x-ves-example": "Example-corp-web.",
|
|
850
2230
|
},
|
|
851
2231
|
{
|
|
852
2232
|
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 +2236,8 @@ export const bigipTools = [
|
|
|
856
2236
|
schema: {
|
|
857
2237
|
type: "string",
|
|
858
2238
|
},
|
|
2239
|
+
"x-displayname": "Namespace",
|
|
2240
|
+
"x-ves-example": "Staging",
|
|
859
2241
|
},
|
|
860
2242
|
],
|
|
861
2243
|
queryParameters: [],
|
|
@@ -869,6 +2251,83 @@ export const bigipTools = [
|
|
|
869
2251
|
operationId: "ves.io.schema.bigcne.data_group.API.Replace",
|
|
870
2252
|
tags: ["Other"],
|
|
871
2253
|
sourceFile: "domains/bigip.json",
|
|
2254
|
+
displayName: null,
|
|
2255
|
+
dangerLevel: "medium",
|
|
2256
|
+
sideEffects: {
|
|
2257
|
+
modifies: ["data-group"],
|
|
2258
|
+
},
|
|
2259
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2260
|
+
cliExamples: [
|
|
2261
|
+
{
|
|
2262
|
+
command: "f5xcctl config data-group update {name} --namespace {namespace} -f {file}.yaml",
|
|
2263
|
+
description: "Update data-group",
|
|
2264
|
+
use_case: "update",
|
|
2265
|
+
},
|
|
2266
|
+
],
|
|
2267
|
+
confirmationRequired: false,
|
|
2268
|
+
parameterExamples: {
|
|
2269
|
+
"metadata.name": "Example-corp-web.",
|
|
2270
|
+
"metadata.namespace": "Staging",
|
|
2271
|
+
},
|
|
2272
|
+
validationRules: {},
|
|
2273
|
+
operationMetadata: {
|
|
2274
|
+
common_errors: [
|
|
2275
|
+
{
|
|
2276
|
+
code: 401,
|
|
2277
|
+
message: "Authentication required",
|
|
2278
|
+
solution: "Provide valid API credentials",
|
|
2279
|
+
},
|
|
2280
|
+
{
|
|
2281
|
+
code: 403,
|
|
2282
|
+
message: "Permission denied",
|
|
2283
|
+
solution: "Check access permissions for this operation",
|
|
2284
|
+
},
|
|
2285
|
+
{
|
|
2286
|
+
code: 404,
|
|
2287
|
+
message: "Resource not found",
|
|
2288
|
+
solution: "Verify resource name, namespace, and path",
|
|
2289
|
+
},
|
|
2290
|
+
{
|
|
2291
|
+
code: 409,
|
|
2292
|
+
message: "Resource already exists",
|
|
2293
|
+
solution: "Use different name or update existing resource",
|
|
2294
|
+
},
|
|
2295
|
+
{
|
|
2296
|
+
code: 429,
|
|
2297
|
+
message: "Rate limit exceeded",
|
|
2298
|
+
solution: "Wait before retrying the operation",
|
|
2299
|
+
},
|
|
2300
|
+
{
|
|
2301
|
+
code: 500,
|
|
2302
|
+
message: "Server error",
|
|
2303
|
+
solution: "Retry operation or contact support",
|
|
2304
|
+
},
|
|
2305
|
+
],
|
|
2306
|
+
conditions: {
|
|
2307
|
+
postconditions: ["Resource updated with new values"],
|
|
2308
|
+
prerequisites: ["Active namespace"],
|
|
2309
|
+
},
|
|
2310
|
+
confirmation_required: false,
|
|
2311
|
+
danger_level: "medium",
|
|
2312
|
+
examples: [
|
|
2313
|
+
{
|
|
2314
|
+
command: "f5xcctl config data-group update {name} --namespace {namespace} -f {file}.yaml",
|
|
2315
|
+
description: "Update data-group",
|
|
2316
|
+
use_case: "update",
|
|
2317
|
+
},
|
|
2318
|
+
],
|
|
2319
|
+
field_docs: {},
|
|
2320
|
+
optional_fields: [],
|
|
2321
|
+
performance_impact: {
|
|
2322
|
+
latency: "low",
|
|
2323
|
+
resource_usage: "low",
|
|
2324
|
+
},
|
|
2325
|
+
purpose: "Replace existing data-group",
|
|
2326
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2327
|
+
side_effects: {
|
|
2328
|
+
modifies: ["data-group"],
|
|
2329
|
+
},
|
|
2330
|
+
},
|
|
872
2331
|
},
|
|
873
2332
|
{
|
|
874
2333
|
toolName: "f5xc-api-bigip-get-security-config-create",
|
|
@@ -888,6 +2347,8 @@ export const bigipTools = [
|
|
|
888
2347
|
schema: {
|
|
889
2348
|
type: "string",
|
|
890
2349
|
},
|
|
2350
|
+
"x-displayname": "Namespace",
|
|
2351
|
+
"x-ves-example": "Shared",
|
|
891
2352
|
},
|
|
892
2353
|
],
|
|
893
2354
|
queryParameters: [],
|
|
@@ -901,6 +2362,95 @@ export const bigipTools = [
|
|
|
901
2362
|
operationId: "ves.io.schema.views.bigip_virtual_server.CustomAPI.GetSecurityConfig",
|
|
902
2363
|
tags: ["Other"],
|
|
903
2364
|
sourceFile: "domains/bigip.json",
|
|
2365
|
+
displayName: null,
|
|
2366
|
+
dangerLevel: "medium",
|
|
2367
|
+
sideEffects: {
|
|
2368
|
+
creates: ["get-security-config"],
|
|
2369
|
+
},
|
|
2370
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2371
|
+
cliExamples: [
|
|
2372
|
+
{
|
|
2373
|
+
command: "f5xcctl config get-security-config create -f {file}.yaml",
|
|
2374
|
+
description: "Create from YAML file",
|
|
2375
|
+
use_case: "file_based",
|
|
2376
|
+
},
|
|
2377
|
+
{
|
|
2378
|
+
command: "f5xcctl config get-security-config create {name} --namespace {namespace}",
|
|
2379
|
+
description: "Create get-security-config",
|
|
2380
|
+
use_case: "basic_create",
|
|
2381
|
+
},
|
|
2382
|
+
],
|
|
2383
|
+
confirmationRequired: false,
|
|
2384
|
+
parameterExamples: {
|
|
2385
|
+
namespace: "Shared",
|
|
2386
|
+
},
|
|
2387
|
+
validationRules: {},
|
|
2388
|
+
operationMetadata: {
|
|
2389
|
+
common_errors: [
|
|
2390
|
+
{
|
|
2391
|
+
code: 401,
|
|
2392
|
+
message: "Authentication required",
|
|
2393
|
+
solution: "Provide valid API credentials",
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
code: 403,
|
|
2397
|
+
message: "Permission denied",
|
|
2398
|
+
solution: "Check access permissions for this operation",
|
|
2399
|
+
},
|
|
2400
|
+
{
|
|
2401
|
+
code: 404,
|
|
2402
|
+
message: "Resource not found",
|
|
2403
|
+
solution: "Verify resource name, namespace, and path",
|
|
2404
|
+
},
|
|
2405
|
+
{
|
|
2406
|
+
code: 409,
|
|
2407
|
+
message: "Resource already exists",
|
|
2408
|
+
solution: "Use different name or update existing resource",
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
code: 429,
|
|
2412
|
+
message: "Rate limit exceeded",
|
|
2413
|
+
solution: "Wait before retrying the operation",
|
|
2414
|
+
},
|
|
2415
|
+
{
|
|
2416
|
+
code: 500,
|
|
2417
|
+
message: "Server error",
|
|
2418
|
+
solution: "Retry operation or contact support",
|
|
2419
|
+
},
|
|
2420
|
+
],
|
|
2421
|
+
conditions: {
|
|
2422
|
+
postconditions: [
|
|
2423
|
+
"Get-security-config resource created",
|
|
2424
|
+
"Resource assigned unique identifier",
|
|
2425
|
+
],
|
|
2426
|
+
prerequisites: ["Active namespace"],
|
|
2427
|
+
},
|
|
2428
|
+
confirmation_required: false,
|
|
2429
|
+
danger_level: "medium",
|
|
2430
|
+
examples: [
|
|
2431
|
+
{
|
|
2432
|
+
command: "f5xcctl config get-security-config create {name} --namespace {namespace}",
|
|
2433
|
+
description: "Create get-security-config",
|
|
2434
|
+
use_case: "basic_create",
|
|
2435
|
+
},
|
|
2436
|
+
{
|
|
2437
|
+
command: "f5xcctl config get-security-config create -f {file}.yaml",
|
|
2438
|
+
description: "Create from YAML file",
|
|
2439
|
+
use_case: "file_based",
|
|
2440
|
+
},
|
|
2441
|
+
],
|
|
2442
|
+
field_docs: {},
|
|
2443
|
+
optional_fields: [],
|
|
2444
|
+
performance_impact: {
|
|
2445
|
+
latency: "low",
|
|
2446
|
+
resource_usage: "low",
|
|
2447
|
+
},
|
|
2448
|
+
purpose: "Create new get-security-config",
|
|
2449
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2450
|
+
side_effects: {
|
|
2451
|
+
creates: ["get-security-config"],
|
|
2452
|
+
},
|
|
2453
|
+
},
|
|
904
2454
|
},
|
|
905
2455
|
{
|
|
906
2456
|
toolName: "f5xc-api-bigip-irule-create",
|
|
@@ -920,6 +2470,8 @@ export const bigipTools = [
|
|
|
920
2470
|
schema: {
|
|
921
2471
|
type: "string",
|
|
922
2472
|
},
|
|
2473
|
+
"x-displayname": "Namespace",
|
|
2474
|
+
"x-ves-example": "Staging",
|
|
923
2475
|
},
|
|
924
2476
|
],
|
|
925
2477
|
queryParameters: [],
|
|
@@ -933,6 +2485,92 @@ export const bigipTools = [
|
|
|
933
2485
|
operationId: "ves.io.schema.bigcne.irule.API.Create",
|
|
934
2486
|
tags: ["Other"],
|
|
935
2487
|
sourceFile: "domains/bigip.json",
|
|
2488
|
+
displayName: null,
|
|
2489
|
+
dangerLevel: "medium",
|
|
2490
|
+
sideEffects: {
|
|
2491
|
+
creates: ["irule"],
|
|
2492
|
+
},
|
|
2493
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2494
|
+
cliExamples: [
|
|
2495
|
+
{
|
|
2496
|
+
command: "f5xcctl config irule create -f {file}.yaml",
|
|
2497
|
+
description: "Create from YAML file",
|
|
2498
|
+
use_case: "file_based",
|
|
2499
|
+
},
|
|
2500
|
+
{
|
|
2501
|
+
command: "f5xcctl config irule create {name} --namespace {namespace}",
|
|
2502
|
+
description: "Create irule",
|
|
2503
|
+
use_case: "basic_create",
|
|
2504
|
+
},
|
|
2505
|
+
],
|
|
2506
|
+
confirmationRequired: false,
|
|
2507
|
+
parameterExamples: {
|
|
2508
|
+
"metadata.namespace": "Staging",
|
|
2509
|
+
},
|
|
2510
|
+
validationRules: {},
|
|
2511
|
+
operationMetadata: {
|
|
2512
|
+
common_errors: [
|
|
2513
|
+
{
|
|
2514
|
+
code: 401,
|
|
2515
|
+
message: "Authentication required",
|
|
2516
|
+
solution: "Provide valid API credentials",
|
|
2517
|
+
},
|
|
2518
|
+
{
|
|
2519
|
+
code: 403,
|
|
2520
|
+
message: "Permission denied",
|
|
2521
|
+
solution: "Check access permissions for this operation",
|
|
2522
|
+
},
|
|
2523
|
+
{
|
|
2524
|
+
code: 404,
|
|
2525
|
+
message: "Resource not found",
|
|
2526
|
+
solution: "Verify resource name, namespace, and path",
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
code: 409,
|
|
2530
|
+
message: "Resource already exists",
|
|
2531
|
+
solution: "Use different name or update existing resource",
|
|
2532
|
+
},
|
|
2533
|
+
{
|
|
2534
|
+
code: 429,
|
|
2535
|
+
message: "Rate limit exceeded",
|
|
2536
|
+
solution: "Wait before retrying the operation",
|
|
2537
|
+
},
|
|
2538
|
+
{
|
|
2539
|
+
code: 500,
|
|
2540
|
+
message: "Server error",
|
|
2541
|
+
solution: "Retry operation or contact support",
|
|
2542
|
+
},
|
|
2543
|
+
],
|
|
2544
|
+
conditions: {
|
|
2545
|
+
postconditions: ["Irule resource created", "Resource assigned unique identifier"],
|
|
2546
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2547
|
+
},
|
|
2548
|
+
confirmation_required: false,
|
|
2549
|
+
danger_level: "medium",
|
|
2550
|
+
examples: [
|
|
2551
|
+
{
|
|
2552
|
+
command: "f5xcctl config irule create {name} --namespace {namespace}",
|
|
2553
|
+
description: "Create irule",
|
|
2554
|
+
use_case: "basic_create",
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
command: "f5xcctl config irule create -f {file}.yaml",
|
|
2558
|
+
description: "Create from YAML file",
|
|
2559
|
+
use_case: "file_based",
|
|
2560
|
+
},
|
|
2561
|
+
],
|
|
2562
|
+
field_docs: {},
|
|
2563
|
+
optional_fields: [],
|
|
2564
|
+
performance_impact: {
|
|
2565
|
+
latency: "low",
|
|
2566
|
+
resource_usage: "low",
|
|
2567
|
+
},
|
|
2568
|
+
purpose: "Create new irule",
|
|
2569
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2570
|
+
side_effects: {
|
|
2571
|
+
creates: ["irule"],
|
|
2572
|
+
},
|
|
2573
|
+
},
|
|
936
2574
|
},
|
|
937
2575
|
{
|
|
938
2576
|
toolName: "f5xc-api-bigip-irule-delete",
|
|
@@ -952,6 +2590,8 @@ export const bigipTools = [
|
|
|
952
2590
|
schema: {
|
|
953
2591
|
type: "string",
|
|
954
2592
|
},
|
|
2593
|
+
"x-displayname": "Name",
|
|
2594
|
+
"x-ves-example": "Name",
|
|
955
2595
|
},
|
|
956
2596
|
{
|
|
957
2597
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -961,6 +2601,8 @@ export const bigipTools = [
|
|
|
961
2601
|
schema: {
|
|
962
2602
|
type: "string",
|
|
963
2603
|
},
|
|
2604
|
+
"x-displayname": "Namespace",
|
|
2605
|
+
"x-ves-example": "Ns1",
|
|
964
2606
|
},
|
|
965
2607
|
],
|
|
966
2608
|
queryParameters: [],
|
|
@@ -972,6 +2614,83 @@ export const bigipTools = [
|
|
|
972
2614
|
operationId: "ves.io.schema.bigcne.irule.API.Delete",
|
|
973
2615
|
tags: ["Other"],
|
|
974
2616
|
sourceFile: "domains/bigip.json",
|
|
2617
|
+
displayName: null,
|
|
2618
|
+
dangerLevel: "high",
|
|
2619
|
+
sideEffects: {
|
|
2620
|
+
deletes: ["irule", "contained_resources"],
|
|
2621
|
+
},
|
|
2622
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2623
|
+
cliExamples: [
|
|
2624
|
+
{
|
|
2625
|
+
command: "f5xcctl config irule delete {name} --namespace {namespace}",
|
|
2626
|
+
description: "Delete irule",
|
|
2627
|
+
use_case: "delete",
|
|
2628
|
+
},
|
|
2629
|
+
],
|
|
2630
|
+
confirmationRequired: true,
|
|
2631
|
+
parameterExamples: {
|
|
2632
|
+
name: "Name",
|
|
2633
|
+
namespace: "Ns1",
|
|
2634
|
+
},
|
|
2635
|
+
validationRules: {},
|
|
2636
|
+
operationMetadata: {
|
|
2637
|
+
common_errors: [
|
|
2638
|
+
{
|
|
2639
|
+
code: 401,
|
|
2640
|
+
message: "Authentication required",
|
|
2641
|
+
solution: "Provide valid API credentials",
|
|
2642
|
+
},
|
|
2643
|
+
{
|
|
2644
|
+
code: 403,
|
|
2645
|
+
message: "Permission denied",
|
|
2646
|
+
solution: "Check access permissions for this operation",
|
|
2647
|
+
},
|
|
2648
|
+
{
|
|
2649
|
+
code: 404,
|
|
2650
|
+
message: "Resource not found",
|
|
2651
|
+
solution: "Verify resource name, namespace, and path",
|
|
2652
|
+
},
|
|
2653
|
+
{
|
|
2654
|
+
code: 409,
|
|
2655
|
+
message: "Resource already exists",
|
|
2656
|
+
solution: "Use different name or update existing resource",
|
|
2657
|
+
},
|
|
2658
|
+
{
|
|
2659
|
+
code: 429,
|
|
2660
|
+
message: "Rate limit exceeded",
|
|
2661
|
+
solution: "Wait before retrying the operation",
|
|
2662
|
+
},
|
|
2663
|
+
{
|
|
2664
|
+
code: 500,
|
|
2665
|
+
message: "Server error",
|
|
2666
|
+
solution: "Retry operation or contact support",
|
|
2667
|
+
},
|
|
2668
|
+
],
|
|
2669
|
+
conditions: {
|
|
2670
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2671
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2672
|
+
},
|
|
2673
|
+
confirmation_required: true,
|
|
2674
|
+
danger_level: "high",
|
|
2675
|
+
examples: [
|
|
2676
|
+
{
|
|
2677
|
+
command: "f5xcctl config irule delete {name} --namespace {namespace}",
|
|
2678
|
+
description: "Delete irule",
|
|
2679
|
+
use_case: "delete",
|
|
2680
|
+
},
|
|
2681
|
+
],
|
|
2682
|
+
field_docs: {},
|
|
2683
|
+
optional_fields: [],
|
|
2684
|
+
performance_impact: {
|
|
2685
|
+
latency: "high",
|
|
2686
|
+
resource_usage: "moderate",
|
|
2687
|
+
},
|
|
2688
|
+
purpose: "Delete irule",
|
|
2689
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2690
|
+
side_effects: {
|
|
2691
|
+
deletes: ["irule", "contained_resources"],
|
|
2692
|
+
},
|
|
2693
|
+
},
|
|
975
2694
|
},
|
|
976
2695
|
{
|
|
977
2696
|
toolName: "f5xc-api-bigip-irule-get",
|
|
@@ -991,6 +2710,8 @@ export const bigipTools = [
|
|
|
991
2710
|
schema: {
|
|
992
2711
|
type: "string",
|
|
993
2712
|
},
|
|
2713
|
+
"x-displayname": "Name",
|
|
2714
|
+
"x-ves-example": "Name",
|
|
994
2715
|
},
|
|
995
2716
|
{
|
|
996
2717
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -1000,6 +2721,8 @@ export const bigipTools = [
|
|
|
1000
2721
|
schema: {
|
|
1001
2722
|
type: "string",
|
|
1002
2723
|
},
|
|
2724
|
+
"x-displayname": "Namespace",
|
|
2725
|
+
"x-ves-example": "Ns1",
|
|
1003
2726
|
},
|
|
1004
2727
|
],
|
|
1005
2728
|
queryParameters: [
|
|
@@ -1020,6 +2743,7 @@ export const bigipTools = [
|
|
|
1020
2743
|
],
|
|
1021
2744
|
type: "string",
|
|
1022
2745
|
},
|
|
2746
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1023
2747
|
},
|
|
1024
2748
|
],
|
|
1025
2749
|
requestBodySchema: null,
|
|
@@ -1030,6 +2754,79 @@ export const bigipTools = [
|
|
|
1030
2754
|
operationId: "ves.io.schema.bigcne.irule.API.Get",
|
|
1031
2755
|
tags: ["Other"],
|
|
1032
2756
|
sourceFile: "domains/bigip.json",
|
|
2757
|
+
displayName: null,
|
|
2758
|
+
dangerLevel: "low",
|
|
2759
|
+
sideEffects: null,
|
|
2760
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2761
|
+
cliExamples: [
|
|
2762
|
+
{
|
|
2763
|
+
command: "f5xcctl config irule get {name} --namespace {namespace}",
|
|
2764
|
+
description: "Get specific irule",
|
|
2765
|
+
use_case: "get_specific",
|
|
2766
|
+
},
|
|
2767
|
+
],
|
|
2768
|
+
confirmationRequired: false,
|
|
2769
|
+
parameterExamples: {
|
|
2770
|
+
name: "Name",
|
|
2771
|
+
namespace: "Ns1",
|
|
2772
|
+
},
|
|
2773
|
+
validationRules: {},
|
|
2774
|
+
operationMetadata: {
|
|
2775
|
+
common_errors: [
|
|
2776
|
+
{
|
|
2777
|
+
code: 401,
|
|
2778
|
+
message: "Authentication required",
|
|
2779
|
+
solution: "Provide valid API credentials",
|
|
2780
|
+
},
|
|
2781
|
+
{
|
|
2782
|
+
code: 403,
|
|
2783
|
+
message: "Permission denied",
|
|
2784
|
+
solution: "Check access permissions for this operation",
|
|
2785
|
+
},
|
|
2786
|
+
{
|
|
2787
|
+
code: 404,
|
|
2788
|
+
message: "Resource not found",
|
|
2789
|
+
solution: "Verify resource name, namespace, and path",
|
|
2790
|
+
},
|
|
2791
|
+
{
|
|
2792
|
+
code: 409,
|
|
2793
|
+
message: "Resource already exists",
|
|
2794
|
+
solution: "Use different name or update existing resource",
|
|
2795
|
+
},
|
|
2796
|
+
{
|
|
2797
|
+
code: 429,
|
|
2798
|
+
message: "Rate limit exceeded",
|
|
2799
|
+
solution: "Wait before retrying the operation",
|
|
2800
|
+
},
|
|
2801
|
+
{
|
|
2802
|
+
code: 500,
|
|
2803
|
+
message: "Server error",
|
|
2804
|
+
solution: "Retry operation or contact support",
|
|
2805
|
+
},
|
|
2806
|
+
],
|
|
2807
|
+
conditions: {
|
|
2808
|
+
postconditions: [],
|
|
2809
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2810
|
+
},
|
|
2811
|
+
confirmation_required: false,
|
|
2812
|
+
danger_level: "low",
|
|
2813
|
+
examples: [
|
|
2814
|
+
{
|
|
2815
|
+
command: "f5xcctl config irule get {name} --namespace {namespace}",
|
|
2816
|
+
description: "Get specific irule",
|
|
2817
|
+
use_case: "get_specific",
|
|
2818
|
+
},
|
|
2819
|
+
],
|
|
2820
|
+
field_docs: {},
|
|
2821
|
+
optional_fields: [],
|
|
2822
|
+
performance_impact: {
|
|
2823
|
+
latency: "low",
|
|
2824
|
+
resource_usage: "low",
|
|
2825
|
+
},
|
|
2826
|
+
purpose: "Retrieve specific irule",
|
|
2827
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2828
|
+
side_effects: {},
|
|
2829
|
+
},
|
|
1033
2830
|
},
|
|
1034
2831
|
{
|
|
1035
2832
|
toolName: "f5xc-api-bigip-irule-list",
|
|
@@ -1049,6 +2846,8 @@ export const bigipTools = [
|
|
|
1049
2846
|
schema: {
|
|
1050
2847
|
type: "string",
|
|
1051
2848
|
},
|
|
2849
|
+
"x-displayname": "Namespace",
|
|
2850
|
+
"x-ves-example": "Ns1",
|
|
1052
2851
|
},
|
|
1053
2852
|
],
|
|
1054
2853
|
queryParameters: [
|
|
@@ -1060,6 +2859,8 @@ export const bigipTools = [
|
|
|
1060
2859
|
schema: {
|
|
1061
2860
|
type: "string",
|
|
1062
2861
|
},
|
|
2862
|
+
"x-displayname": "Label Filter.",
|
|
2863
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1063
2864
|
},
|
|
1064
2865
|
{
|
|
1065
2866
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -1072,6 +2873,7 @@ export const bigipTools = [
|
|
|
1072
2873
|
},
|
|
1073
2874
|
type: "array",
|
|
1074
2875
|
},
|
|
2876
|
+
"x-displayname": "Report Fields.",
|
|
1075
2877
|
},
|
|
1076
2878
|
{
|
|
1077
2879
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -1084,6 +2886,7 @@ export const bigipTools = [
|
|
|
1084
2886
|
},
|
|
1085
2887
|
type: "array",
|
|
1086
2888
|
},
|
|
2889
|
+
"x-displayname": "Report Status Fields.",
|
|
1087
2890
|
},
|
|
1088
2891
|
],
|
|
1089
2892
|
requestBodySchema: null,
|
|
@@ -1094,6 +2897,79 @@ export const bigipTools = [
|
|
|
1094
2897
|
operationId: "ves.io.schema.bigcne.irule.API.List",
|
|
1095
2898
|
tags: ["Other"],
|
|
1096
2899
|
sourceFile: "domains/bigip.json",
|
|
2900
|
+
displayName: null,
|
|
2901
|
+
dangerLevel: "low",
|
|
2902
|
+
sideEffects: null,
|
|
2903
|
+
requiredFields: ["path.namespace"],
|
|
2904
|
+
cliExamples: [
|
|
2905
|
+
{
|
|
2906
|
+
command: "f5xcctl config irule list --namespace {namespace}",
|
|
2907
|
+
description: "List all irules",
|
|
2908
|
+
use_case: "list_all",
|
|
2909
|
+
},
|
|
2910
|
+
],
|
|
2911
|
+
confirmationRequired: false,
|
|
2912
|
+
parameterExamples: {
|
|
2913
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2914
|
+
namespace: "Ns1",
|
|
2915
|
+
},
|
|
2916
|
+
validationRules: {},
|
|
2917
|
+
operationMetadata: {
|
|
2918
|
+
common_errors: [
|
|
2919
|
+
{
|
|
2920
|
+
code: 401,
|
|
2921
|
+
message: "Authentication required",
|
|
2922
|
+
solution: "Provide valid API credentials",
|
|
2923
|
+
},
|
|
2924
|
+
{
|
|
2925
|
+
code: 403,
|
|
2926
|
+
message: "Permission denied",
|
|
2927
|
+
solution: "Check access permissions for this operation",
|
|
2928
|
+
},
|
|
2929
|
+
{
|
|
2930
|
+
code: 404,
|
|
2931
|
+
message: "Resource not found",
|
|
2932
|
+
solution: "Verify resource name, namespace, and path",
|
|
2933
|
+
},
|
|
2934
|
+
{
|
|
2935
|
+
code: 409,
|
|
2936
|
+
message: "Resource already exists",
|
|
2937
|
+
solution: "Use different name or update existing resource",
|
|
2938
|
+
},
|
|
2939
|
+
{
|
|
2940
|
+
code: 429,
|
|
2941
|
+
message: "Rate limit exceeded",
|
|
2942
|
+
solution: "Wait before retrying the operation",
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
code: 500,
|
|
2946
|
+
message: "Server error",
|
|
2947
|
+
solution: "Retry operation or contact support",
|
|
2948
|
+
},
|
|
2949
|
+
],
|
|
2950
|
+
conditions: {
|
|
2951
|
+
postconditions: [],
|
|
2952
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2953
|
+
},
|
|
2954
|
+
confirmation_required: false,
|
|
2955
|
+
danger_level: "low",
|
|
2956
|
+
examples: [
|
|
2957
|
+
{
|
|
2958
|
+
command: "f5xcctl config irule list --namespace {namespace}",
|
|
2959
|
+
description: "List all irules",
|
|
2960
|
+
use_case: "list_all",
|
|
2961
|
+
},
|
|
2962
|
+
],
|
|
2963
|
+
field_docs: {},
|
|
2964
|
+
optional_fields: [],
|
|
2965
|
+
performance_impact: {
|
|
2966
|
+
latency: "moderate",
|
|
2967
|
+
resource_usage: "moderate",
|
|
2968
|
+
},
|
|
2969
|
+
purpose: "List all irules",
|
|
2970
|
+
required_fields: ["path.namespace"],
|
|
2971
|
+
side_effects: {},
|
|
2972
|
+
},
|
|
1097
2973
|
},
|
|
1098
2974
|
{
|
|
1099
2975
|
toolName: "f5xc-api-bigip-irule-update",
|
|
@@ -1113,6 +2989,8 @@ export const bigipTools = [
|
|
|
1113
2989
|
schema: {
|
|
1114
2990
|
type: "string",
|
|
1115
2991
|
},
|
|
2992
|
+
"x-displayname": "Name",
|
|
2993
|
+
"x-ves-example": "Example-corp-web.",
|
|
1116
2994
|
},
|
|
1117
2995
|
{
|
|
1118
2996
|
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 +3000,8 @@ export const bigipTools = [
|
|
|
1122
3000
|
schema: {
|
|
1123
3001
|
type: "string",
|
|
1124
3002
|
},
|
|
3003
|
+
"x-displayname": "Namespace",
|
|
3004
|
+
"x-ves-example": "Staging",
|
|
1125
3005
|
},
|
|
1126
3006
|
],
|
|
1127
3007
|
queryParameters: [],
|
|
@@ -1135,6 +3015,83 @@ export const bigipTools = [
|
|
|
1135
3015
|
operationId: "ves.io.schema.bigcne.irule.API.Replace",
|
|
1136
3016
|
tags: ["Other"],
|
|
1137
3017
|
sourceFile: "domains/bigip.json",
|
|
3018
|
+
displayName: null,
|
|
3019
|
+
dangerLevel: "medium",
|
|
3020
|
+
sideEffects: {
|
|
3021
|
+
modifies: ["irule"],
|
|
3022
|
+
},
|
|
3023
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3024
|
+
cliExamples: [
|
|
3025
|
+
{
|
|
3026
|
+
command: "f5xcctl config irule update {name} --namespace {namespace} -f {file}.yaml",
|
|
3027
|
+
description: "Update irule",
|
|
3028
|
+
use_case: "update",
|
|
3029
|
+
},
|
|
3030
|
+
],
|
|
3031
|
+
confirmationRequired: false,
|
|
3032
|
+
parameterExamples: {
|
|
3033
|
+
"metadata.name": "Example-corp-web.",
|
|
3034
|
+
"metadata.namespace": "Staging",
|
|
3035
|
+
},
|
|
3036
|
+
validationRules: {},
|
|
3037
|
+
operationMetadata: {
|
|
3038
|
+
common_errors: [
|
|
3039
|
+
{
|
|
3040
|
+
code: 401,
|
|
3041
|
+
message: "Authentication required",
|
|
3042
|
+
solution: "Provide valid API credentials",
|
|
3043
|
+
},
|
|
3044
|
+
{
|
|
3045
|
+
code: 403,
|
|
3046
|
+
message: "Permission denied",
|
|
3047
|
+
solution: "Check access permissions for this operation",
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
code: 404,
|
|
3051
|
+
message: "Resource not found",
|
|
3052
|
+
solution: "Verify resource name, namespace, and path",
|
|
3053
|
+
},
|
|
3054
|
+
{
|
|
3055
|
+
code: 409,
|
|
3056
|
+
message: "Resource already exists",
|
|
3057
|
+
solution: "Use different name or update existing resource",
|
|
3058
|
+
},
|
|
3059
|
+
{
|
|
3060
|
+
code: 429,
|
|
3061
|
+
message: "Rate limit exceeded",
|
|
3062
|
+
solution: "Wait before retrying the operation",
|
|
3063
|
+
},
|
|
3064
|
+
{
|
|
3065
|
+
code: 500,
|
|
3066
|
+
message: "Server error",
|
|
3067
|
+
solution: "Retry operation or contact support",
|
|
3068
|
+
},
|
|
3069
|
+
],
|
|
3070
|
+
conditions: {
|
|
3071
|
+
postconditions: ["Resource updated with new values"],
|
|
3072
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3073
|
+
},
|
|
3074
|
+
confirmation_required: false,
|
|
3075
|
+
danger_level: "medium",
|
|
3076
|
+
examples: [
|
|
3077
|
+
{
|
|
3078
|
+
command: "f5xcctl config irule update {name} --namespace {namespace} -f {file}.yaml",
|
|
3079
|
+
description: "Update irule",
|
|
3080
|
+
use_case: "update",
|
|
3081
|
+
},
|
|
3082
|
+
],
|
|
3083
|
+
field_docs: {},
|
|
3084
|
+
optional_fields: [],
|
|
3085
|
+
performance_impact: {
|
|
3086
|
+
latency: "low",
|
|
3087
|
+
resource_usage: "low",
|
|
3088
|
+
},
|
|
3089
|
+
purpose: "Replace existing irule",
|
|
3090
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3091
|
+
side_effects: {
|
|
3092
|
+
modifies: ["irule"],
|
|
3093
|
+
},
|
|
3094
|
+
},
|
|
1138
3095
|
},
|
|
1139
3096
|
{
|
|
1140
3097
|
toolName: "f5xc-api-bigip-metric-create",
|
|
@@ -1154,6 +3111,8 @@ export const bigipTools = [
|
|
|
1154
3111
|
schema: {
|
|
1155
3112
|
type: "string",
|
|
1156
3113
|
},
|
|
3114
|
+
"x-displayname": "Namespace",
|
|
3115
|
+
"x-ves-example": "System",
|
|
1157
3116
|
},
|
|
1158
3117
|
],
|
|
1159
3118
|
queryParameters: [],
|
|
@@ -1167,6 +3126,92 @@ export const bigipTools = [
|
|
|
1167
3126
|
operationId: "ves.io.schema.bigip.apm.CustomDataAPI.Metrics",
|
|
1168
3127
|
tags: ["BIG-IP"],
|
|
1169
3128
|
sourceFile: "domains/bigip.json",
|
|
3129
|
+
displayName: null,
|
|
3130
|
+
dangerLevel: "medium",
|
|
3131
|
+
sideEffects: {
|
|
3132
|
+
creates: ["metric"],
|
|
3133
|
+
},
|
|
3134
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
3135
|
+
cliExamples: [
|
|
3136
|
+
{
|
|
3137
|
+
command: "f5xcctl data metric create -f {file}.yaml",
|
|
3138
|
+
description: "Create from YAML file",
|
|
3139
|
+
use_case: "file_based",
|
|
3140
|
+
},
|
|
3141
|
+
{
|
|
3142
|
+
command: "f5xcctl data metric create {name} --namespace {namespace}",
|
|
3143
|
+
description: "Create metric",
|
|
3144
|
+
use_case: "basic_create",
|
|
3145
|
+
},
|
|
3146
|
+
],
|
|
3147
|
+
confirmationRequired: false,
|
|
3148
|
+
parameterExamples: {
|
|
3149
|
+
namespace: "System",
|
|
3150
|
+
},
|
|
3151
|
+
validationRules: {},
|
|
3152
|
+
operationMetadata: {
|
|
3153
|
+
common_errors: [
|
|
3154
|
+
{
|
|
3155
|
+
code: 401,
|
|
3156
|
+
message: "Authentication required",
|
|
3157
|
+
solution: "Provide valid API credentials",
|
|
3158
|
+
},
|
|
3159
|
+
{
|
|
3160
|
+
code: 403,
|
|
3161
|
+
message: "Permission denied",
|
|
3162
|
+
solution: "Check access permissions for this operation",
|
|
3163
|
+
},
|
|
3164
|
+
{
|
|
3165
|
+
code: 404,
|
|
3166
|
+
message: "Resource not found",
|
|
3167
|
+
solution: "Verify resource name, namespace, and path",
|
|
3168
|
+
},
|
|
3169
|
+
{
|
|
3170
|
+
code: 409,
|
|
3171
|
+
message: "Resource already exists",
|
|
3172
|
+
solution: "Use different name or update existing resource",
|
|
3173
|
+
},
|
|
3174
|
+
{
|
|
3175
|
+
code: 429,
|
|
3176
|
+
message: "Rate limit exceeded",
|
|
3177
|
+
solution: "Wait before retrying the operation",
|
|
3178
|
+
},
|
|
3179
|
+
{
|
|
3180
|
+
code: 500,
|
|
3181
|
+
message: "Server error",
|
|
3182
|
+
solution: "Retry operation or contact support",
|
|
3183
|
+
},
|
|
3184
|
+
],
|
|
3185
|
+
conditions: {
|
|
3186
|
+
postconditions: ["Metric resource created", "Resource assigned unique identifier"],
|
|
3187
|
+
prerequisites: ["Active namespace"],
|
|
3188
|
+
},
|
|
3189
|
+
confirmation_required: false,
|
|
3190
|
+
danger_level: "medium",
|
|
3191
|
+
examples: [
|
|
3192
|
+
{
|
|
3193
|
+
command: "f5xcctl data metric create {name} --namespace {namespace}",
|
|
3194
|
+
description: "Create metric",
|
|
3195
|
+
use_case: "basic_create",
|
|
3196
|
+
},
|
|
3197
|
+
{
|
|
3198
|
+
command: "f5xcctl data metric create -f {file}.yaml",
|
|
3199
|
+
description: "Create from YAML file",
|
|
3200
|
+
use_case: "file_based",
|
|
3201
|
+
},
|
|
3202
|
+
],
|
|
3203
|
+
field_docs: {},
|
|
3204
|
+
optional_fields: [],
|
|
3205
|
+
performance_impact: {
|
|
3206
|
+
latency: "low",
|
|
3207
|
+
resource_usage: "low",
|
|
3208
|
+
},
|
|
3209
|
+
purpose: "Create new metric",
|
|
3210
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
3211
|
+
side_effects: {
|
|
3212
|
+
creates: ["metric"],
|
|
3213
|
+
},
|
|
3214
|
+
},
|
|
1170
3215
|
},
|
|
1171
3216
|
];
|
|
1172
3217
|
export default bigipTools;
|