@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 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
|
@@ -0,0 +1,3963 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for ce_management domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const ce_managementTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-cemanagement-approve-create",
|
|
8
|
+
method: "POST",
|
|
9
|
+
path: "/api/register/namespaces/{namespace}/registration/{name}/approve",
|
|
10
|
+
operation: "create",
|
|
11
|
+
domain: "ce_management",
|
|
12
|
+
resource: "approve",
|
|
13
|
+
summary: "Registration Approve.",
|
|
14
|
+
description: "RegistrationApprove approved pending registration and it can also decommission by changing state to RETIRED.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
description: 'Name\n\nx-required\nRegistration name (= "r-" + uid) to approve. Registration name is taken from listing pending registrations.',
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "name",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
"x-displayname": "Name",
|
|
25
|
+
"x-ves-example": "R-e9030963-639e-41cd-aba6-261504f4a6be.",
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
|
|
29
|
+
in: "path",
|
|
30
|
+
name: "namespace",
|
|
31
|
+
required: true,
|
|
32
|
+
schema: {
|
|
33
|
+
type: "string",
|
|
34
|
+
},
|
|
35
|
+
"x-displayname": "Namespace",
|
|
36
|
+
"x-ves-example": "System",
|
|
37
|
+
},
|
|
38
|
+
],
|
|
39
|
+
queryParameters: [],
|
|
40
|
+
requestBodySchema: {
|
|
41
|
+
$ref: "#/components/schemas/registrationApprovalReq",
|
|
42
|
+
},
|
|
43
|
+
responseSchema: {
|
|
44
|
+
$ref: "#/components/schemas/registrationObjectChangeResp",
|
|
45
|
+
},
|
|
46
|
+
requiredParams: ["body", "name", "namespace"],
|
|
47
|
+
operationId: "ves.io.schema.registration.CustomAPI.RegistrationApprove",
|
|
48
|
+
tags: ["Infrastructure"],
|
|
49
|
+
sourceFile: "domains/ce_management.json",
|
|
50
|
+
displayName: null,
|
|
51
|
+
dangerLevel: "medium",
|
|
52
|
+
sideEffects: {
|
|
53
|
+
creates: ["approve"],
|
|
54
|
+
},
|
|
55
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
56
|
+
cliExamples: [
|
|
57
|
+
{
|
|
58
|
+
command: "f5xcctl register approve create {name} --namespace {namespace}",
|
|
59
|
+
description: "Create approve",
|
|
60
|
+
use_case: "basic_create",
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
command: "f5xcctl register approve create -f {file}.yaml",
|
|
64
|
+
description: "Create from YAML file",
|
|
65
|
+
use_case: "file_based",
|
|
66
|
+
},
|
|
67
|
+
],
|
|
68
|
+
confirmationRequired: false,
|
|
69
|
+
parameterExamples: {
|
|
70
|
+
name: "R-e9030963-639e-41cd-aba6-261504f4a6be.",
|
|
71
|
+
namespace: "System",
|
|
72
|
+
},
|
|
73
|
+
validationRules: {},
|
|
74
|
+
operationMetadata: {
|
|
75
|
+
common_errors: [
|
|
76
|
+
{
|
|
77
|
+
code: 401,
|
|
78
|
+
message: "Authentication required",
|
|
79
|
+
solution: "Provide valid API credentials",
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
code: 403,
|
|
83
|
+
message: "Permission denied",
|
|
84
|
+
solution: "Check access permissions for this operation",
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
code: 404,
|
|
88
|
+
message: "Resource not found",
|
|
89
|
+
solution: "Verify resource name, namespace, and path",
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
code: 409,
|
|
93
|
+
message: "Resource already exists",
|
|
94
|
+
solution: "Use different name or update existing resource",
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
code: 429,
|
|
98
|
+
message: "Rate limit exceeded",
|
|
99
|
+
solution: "Wait before retrying the operation",
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
code: 500,
|
|
103
|
+
message: "Server error",
|
|
104
|
+
solution: "Retry operation or contact support",
|
|
105
|
+
},
|
|
106
|
+
],
|
|
107
|
+
conditions: {
|
|
108
|
+
postconditions: ["Approve resource created", "Resource assigned unique identifier"],
|
|
109
|
+
prerequisites: ["Active namespace"],
|
|
110
|
+
},
|
|
111
|
+
confirmation_required: false,
|
|
112
|
+
danger_level: "medium",
|
|
113
|
+
examples: [
|
|
114
|
+
{
|
|
115
|
+
command: "f5xcctl register approve create {name} --namespace {namespace}",
|
|
116
|
+
description: "Create approve",
|
|
117
|
+
use_case: "basic_create",
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
command: "f5xcctl register approve create -f {file}.yaml",
|
|
121
|
+
description: "Create from YAML file",
|
|
122
|
+
use_case: "file_based",
|
|
123
|
+
},
|
|
124
|
+
],
|
|
125
|
+
field_docs: {},
|
|
126
|
+
optional_fields: [],
|
|
127
|
+
performance_impact: {
|
|
128
|
+
latency: "low",
|
|
129
|
+
resource_usage: "low",
|
|
130
|
+
},
|
|
131
|
+
purpose: "Create new approve",
|
|
132
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
133
|
+
side_effects: {
|
|
134
|
+
creates: ["approve"],
|
|
135
|
+
},
|
|
136
|
+
},
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
toolName: "f5xc-api-cemanagement-fleet-create",
|
|
140
|
+
method: "POST",
|
|
141
|
+
path: "/api/config/namespaces/{metadata.namespace}/fleets",
|
|
142
|
+
operation: "create",
|
|
143
|
+
domain: "ce_management",
|
|
144
|
+
resource: "fleet",
|
|
145
|
+
summary: "Create Fleet.",
|
|
146
|
+
description: "Create fleet will create a fleet object in 'system' namespace of the user.",
|
|
147
|
+
pathParameters: [
|
|
148
|
+
{
|
|
149
|
+
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 ""',
|
|
150
|
+
in: "path",
|
|
151
|
+
name: "metadata.namespace",
|
|
152
|
+
required: true,
|
|
153
|
+
schema: {
|
|
154
|
+
type: "string",
|
|
155
|
+
},
|
|
156
|
+
"x-displayname": "Namespace",
|
|
157
|
+
"x-ves-example": "Staging",
|
|
158
|
+
},
|
|
159
|
+
],
|
|
160
|
+
queryParameters: [],
|
|
161
|
+
requestBodySchema: {
|
|
162
|
+
$ref: "#/components/schemas/fleetCreateRequest",
|
|
163
|
+
},
|
|
164
|
+
responseSchema: {
|
|
165
|
+
$ref: "#/components/schemas/fleetCreateResponse",
|
|
166
|
+
},
|
|
167
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
168
|
+
operationId: "ves.io.schema.fleet.API.Create",
|
|
169
|
+
tags: ["Other"],
|
|
170
|
+
sourceFile: "domains/ce_management.json",
|
|
171
|
+
displayName: null,
|
|
172
|
+
dangerLevel: "medium",
|
|
173
|
+
sideEffects: {
|
|
174
|
+
creates: ["fleet"],
|
|
175
|
+
},
|
|
176
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
177
|
+
cliExamples: [
|
|
178
|
+
{
|
|
179
|
+
command: "f5xcctl config fleet create {name} --namespace {namespace}",
|
|
180
|
+
description: "Create fleet",
|
|
181
|
+
use_case: "basic_create",
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
command: "f5xcctl config fleet create -f {file}.yaml",
|
|
185
|
+
description: "Create from YAML file",
|
|
186
|
+
use_case: "file_based",
|
|
187
|
+
},
|
|
188
|
+
],
|
|
189
|
+
confirmationRequired: false,
|
|
190
|
+
parameterExamples: {
|
|
191
|
+
"metadata.namespace": "Staging",
|
|
192
|
+
},
|
|
193
|
+
validationRules: {},
|
|
194
|
+
operationMetadata: {
|
|
195
|
+
common_errors: [
|
|
196
|
+
{
|
|
197
|
+
code: 401,
|
|
198
|
+
message: "Authentication required",
|
|
199
|
+
solution: "Provide valid API credentials",
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
code: 403,
|
|
203
|
+
message: "Permission denied",
|
|
204
|
+
solution: "Check access permissions for this operation",
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
code: 404,
|
|
208
|
+
message: "Resource not found",
|
|
209
|
+
solution: "Verify resource name, namespace, and path",
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
code: 409,
|
|
213
|
+
message: "Resource already exists",
|
|
214
|
+
solution: "Use different name or update existing resource",
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
code: 429,
|
|
218
|
+
message: "Rate limit exceeded",
|
|
219
|
+
solution: "Wait before retrying the operation",
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
code: 500,
|
|
223
|
+
message: "Server error",
|
|
224
|
+
solution: "Retry operation or contact support",
|
|
225
|
+
},
|
|
226
|
+
],
|
|
227
|
+
conditions: {
|
|
228
|
+
postconditions: ["Fleet resource created", "Resource assigned unique identifier"],
|
|
229
|
+
prerequisites: ["Active namespace"],
|
|
230
|
+
},
|
|
231
|
+
confirmation_required: false,
|
|
232
|
+
danger_level: "medium",
|
|
233
|
+
examples: [
|
|
234
|
+
{
|
|
235
|
+
command: "f5xcctl config fleet create {name} --namespace {namespace}",
|
|
236
|
+
description: "Create fleet",
|
|
237
|
+
use_case: "basic_create",
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
command: "f5xcctl config fleet create -f {file}.yaml",
|
|
241
|
+
description: "Create from YAML file",
|
|
242
|
+
use_case: "file_based",
|
|
243
|
+
},
|
|
244
|
+
],
|
|
245
|
+
field_docs: {},
|
|
246
|
+
optional_fields: [],
|
|
247
|
+
performance_impact: {
|
|
248
|
+
latency: "low",
|
|
249
|
+
resource_usage: "low",
|
|
250
|
+
},
|
|
251
|
+
purpose: "Create new fleet",
|
|
252
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
253
|
+
side_effects: {
|
|
254
|
+
creates: ["fleet"],
|
|
255
|
+
},
|
|
256
|
+
},
|
|
257
|
+
},
|
|
258
|
+
{
|
|
259
|
+
toolName: "f5xc-api-cemanagement-fleet-delete",
|
|
260
|
+
method: "DELETE",
|
|
261
|
+
path: "/api/config/namespaces/{namespace}/fleets/{name}",
|
|
262
|
+
operation: "delete",
|
|
263
|
+
domain: "ce_management",
|
|
264
|
+
resource: "fleet",
|
|
265
|
+
summary: "DELETE Fleet.",
|
|
266
|
+
description: "DELETE the specified fleet.",
|
|
267
|
+
pathParameters: [
|
|
268
|
+
{
|
|
269
|
+
description: "Name\nName of the configuration object.",
|
|
270
|
+
in: "path",
|
|
271
|
+
name: "name",
|
|
272
|
+
required: true,
|
|
273
|
+
schema: {
|
|
274
|
+
type: "string",
|
|
275
|
+
},
|
|
276
|
+
"x-displayname": "Name",
|
|
277
|
+
"x-ves-example": "Name",
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
281
|
+
in: "path",
|
|
282
|
+
name: "namespace",
|
|
283
|
+
required: true,
|
|
284
|
+
schema: {
|
|
285
|
+
type: "string",
|
|
286
|
+
},
|
|
287
|
+
"x-displayname": "Namespace",
|
|
288
|
+
"x-ves-example": "Ns1",
|
|
289
|
+
},
|
|
290
|
+
],
|
|
291
|
+
queryParameters: [],
|
|
292
|
+
requestBodySchema: {
|
|
293
|
+
$ref: "#/components/schemas/fleetDeleteRequest",
|
|
294
|
+
},
|
|
295
|
+
responseSchema: {},
|
|
296
|
+
requiredParams: ["body", "name", "namespace"],
|
|
297
|
+
operationId: "ves.io.schema.fleet.API.Delete",
|
|
298
|
+
tags: ["Other"],
|
|
299
|
+
sourceFile: "domains/ce_management.json",
|
|
300
|
+
displayName: null,
|
|
301
|
+
dangerLevel: "high",
|
|
302
|
+
sideEffects: {
|
|
303
|
+
deletes: ["fleet", "contained_resources"],
|
|
304
|
+
},
|
|
305
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
306
|
+
cliExamples: [
|
|
307
|
+
{
|
|
308
|
+
command: "f5xcctl config fleet delete {name} --namespace {namespace}",
|
|
309
|
+
description: "Delete fleet",
|
|
310
|
+
use_case: "delete",
|
|
311
|
+
},
|
|
312
|
+
],
|
|
313
|
+
confirmationRequired: true,
|
|
314
|
+
parameterExamples: {
|
|
315
|
+
name: "Name",
|
|
316
|
+
namespace: "Ns1",
|
|
317
|
+
},
|
|
318
|
+
validationRules: {},
|
|
319
|
+
operationMetadata: {
|
|
320
|
+
common_errors: [
|
|
321
|
+
{
|
|
322
|
+
code: 401,
|
|
323
|
+
message: "Authentication required",
|
|
324
|
+
solution: "Provide valid API credentials",
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
code: 403,
|
|
328
|
+
message: "Permission denied",
|
|
329
|
+
solution: "Check access permissions for this operation",
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
code: 404,
|
|
333
|
+
message: "Resource not found",
|
|
334
|
+
solution: "Verify resource name, namespace, and path",
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
code: 409,
|
|
338
|
+
message: "Resource already exists",
|
|
339
|
+
solution: "Use different name or update existing resource",
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
code: 429,
|
|
343
|
+
message: "Rate limit exceeded",
|
|
344
|
+
solution: "Wait before retrying the operation",
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
code: 500,
|
|
348
|
+
message: "Server error",
|
|
349
|
+
solution: "Retry operation or contact support",
|
|
350
|
+
},
|
|
351
|
+
],
|
|
352
|
+
conditions: {
|
|
353
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
354
|
+
prerequisites: ["Active namespace"],
|
|
355
|
+
},
|
|
356
|
+
confirmation_required: true,
|
|
357
|
+
danger_level: "high",
|
|
358
|
+
examples: [
|
|
359
|
+
{
|
|
360
|
+
command: "f5xcctl config fleet delete {name} --namespace {namespace}",
|
|
361
|
+
description: "Delete fleet",
|
|
362
|
+
use_case: "delete",
|
|
363
|
+
},
|
|
364
|
+
],
|
|
365
|
+
field_docs: {},
|
|
366
|
+
optional_fields: [],
|
|
367
|
+
performance_impact: {
|
|
368
|
+
latency: "high",
|
|
369
|
+
resource_usage: "moderate",
|
|
370
|
+
},
|
|
371
|
+
purpose: "Delete fleet",
|
|
372
|
+
required_fields: ["path.name", "path.namespace"],
|
|
373
|
+
side_effects: {
|
|
374
|
+
deletes: ["fleet", "contained_resources"],
|
|
375
|
+
},
|
|
376
|
+
},
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
toolName: "f5xc-api-cemanagement-fleet-get",
|
|
380
|
+
method: "GET",
|
|
381
|
+
path: "/api/config/namespaces/{namespace}/fleets/{name}",
|
|
382
|
+
operation: "get",
|
|
383
|
+
domain: "ce_management",
|
|
384
|
+
resource: "fleet",
|
|
385
|
+
summary: "GET Fleet",
|
|
386
|
+
description: "GET fleet will GET fleet object from system namespace.",
|
|
387
|
+
pathParameters: [
|
|
388
|
+
{
|
|
389
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
390
|
+
in: "path",
|
|
391
|
+
name: "name",
|
|
392
|
+
required: true,
|
|
393
|
+
schema: {
|
|
394
|
+
type: "string",
|
|
395
|
+
},
|
|
396
|
+
"x-displayname": "Name",
|
|
397
|
+
"x-ves-example": "Name",
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
401
|
+
in: "path",
|
|
402
|
+
name: "namespace",
|
|
403
|
+
required: true,
|
|
404
|
+
schema: {
|
|
405
|
+
type: "string",
|
|
406
|
+
},
|
|
407
|
+
"x-displayname": "Namespace",
|
|
408
|
+
"x-ves-example": "Ns1",
|
|
409
|
+
},
|
|
410
|
+
],
|
|
411
|
+
queryParameters: [
|
|
412
|
+
{
|
|
413
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
414
|
+
in: "query",
|
|
415
|
+
name: "response_format",
|
|
416
|
+
required: false,
|
|
417
|
+
schema: {
|
|
418
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
419
|
+
enum: [
|
|
420
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
421
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
422
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
423
|
+
"GET_RSP_FORMAT_STATUS",
|
|
424
|
+
"GET_RSP_FORMAT_READ",
|
|
425
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
426
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
427
|
+
],
|
|
428
|
+
type: "string",
|
|
429
|
+
},
|
|
430
|
+
"x-displayname": "Broken Referred Objects.",
|
|
431
|
+
},
|
|
432
|
+
],
|
|
433
|
+
requestBodySchema: null,
|
|
434
|
+
responseSchema: {
|
|
435
|
+
$ref: "#/components/schemas/fleetGetResponse",
|
|
436
|
+
},
|
|
437
|
+
requiredParams: ["name", "namespace"],
|
|
438
|
+
operationId: "ves.io.schema.fleet.API.Get",
|
|
439
|
+
tags: ["Other"],
|
|
440
|
+
sourceFile: "domains/ce_management.json",
|
|
441
|
+
displayName: null,
|
|
442
|
+
dangerLevel: "low",
|
|
443
|
+
sideEffects: null,
|
|
444
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
445
|
+
cliExamples: [
|
|
446
|
+
{
|
|
447
|
+
command: "f5xcctl config fleet get {name} --namespace {namespace}",
|
|
448
|
+
description: "Get specific fleet",
|
|
449
|
+
use_case: "get_specific",
|
|
450
|
+
},
|
|
451
|
+
],
|
|
452
|
+
confirmationRequired: false,
|
|
453
|
+
parameterExamples: {
|
|
454
|
+
name: "Name",
|
|
455
|
+
namespace: "Ns1",
|
|
456
|
+
},
|
|
457
|
+
validationRules: {},
|
|
458
|
+
operationMetadata: {
|
|
459
|
+
common_errors: [
|
|
460
|
+
{
|
|
461
|
+
code: 401,
|
|
462
|
+
message: "Authentication required",
|
|
463
|
+
solution: "Provide valid API credentials",
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
code: 403,
|
|
467
|
+
message: "Permission denied",
|
|
468
|
+
solution: "Check access permissions for this operation",
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
code: 404,
|
|
472
|
+
message: "Resource not found",
|
|
473
|
+
solution: "Verify resource name, namespace, and path",
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
code: 409,
|
|
477
|
+
message: "Resource already exists",
|
|
478
|
+
solution: "Use different name or update existing resource",
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
code: 429,
|
|
482
|
+
message: "Rate limit exceeded",
|
|
483
|
+
solution: "Wait before retrying the operation",
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
code: 500,
|
|
487
|
+
message: "Server error",
|
|
488
|
+
solution: "Retry operation or contact support",
|
|
489
|
+
},
|
|
490
|
+
],
|
|
491
|
+
conditions: {
|
|
492
|
+
postconditions: [],
|
|
493
|
+
prerequisites: ["Active namespace"],
|
|
494
|
+
},
|
|
495
|
+
confirmation_required: false,
|
|
496
|
+
danger_level: "low",
|
|
497
|
+
examples: [
|
|
498
|
+
{
|
|
499
|
+
command: "f5xcctl config fleet get {name} --namespace {namespace}",
|
|
500
|
+
description: "Get specific fleet",
|
|
501
|
+
use_case: "get_specific",
|
|
502
|
+
},
|
|
503
|
+
],
|
|
504
|
+
field_docs: {},
|
|
505
|
+
optional_fields: [],
|
|
506
|
+
performance_impact: {
|
|
507
|
+
latency: "low",
|
|
508
|
+
resource_usage: "low",
|
|
509
|
+
},
|
|
510
|
+
purpose: "Retrieve specific fleet",
|
|
511
|
+
required_fields: ["path.name", "path.namespace"],
|
|
512
|
+
side_effects: {},
|
|
513
|
+
},
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
toolName: "f5xc-api-cemanagement-fleet-list",
|
|
517
|
+
method: "GET",
|
|
518
|
+
path: "/api/config/namespaces/{namespace}/fleets",
|
|
519
|
+
operation: "list",
|
|
520
|
+
domain: "ce_management",
|
|
521
|
+
resource: "fleet",
|
|
522
|
+
summary: "List Fleet.",
|
|
523
|
+
description: "List the set of fleet in a namespace.",
|
|
524
|
+
pathParameters: [
|
|
525
|
+
{
|
|
526
|
+
description: "Namespace\nNamespace to scope the listing of fleet.",
|
|
527
|
+
in: "path",
|
|
528
|
+
name: "namespace",
|
|
529
|
+
required: true,
|
|
530
|
+
schema: {
|
|
531
|
+
type: "string",
|
|
532
|
+
},
|
|
533
|
+
"x-displayname": "Namespace",
|
|
534
|
+
"x-ves-example": "Ns1",
|
|
535
|
+
},
|
|
536
|
+
],
|
|
537
|
+
queryParameters: [
|
|
538
|
+
{
|
|
539
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
540
|
+
in: "query",
|
|
541
|
+
name: "label_filter",
|
|
542
|
+
required: false,
|
|
543
|
+
schema: {
|
|
544
|
+
type: "string",
|
|
545
|
+
},
|
|
546
|
+
"x-displayname": "Label Filter.",
|
|
547
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
551
|
+
in: "query",
|
|
552
|
+
name: "report_fields",
|
|
553
|
+
required: false,
|
|
554
|
+
schema: {
|
|
555
|
+
items: {
|
|
556
|
+
type: "string",
|
|
557
|
+
},
|
|
558
|
+
type: "array",
|
|
559
|
+
},
|
|
560
|
+
"x-displayname": "Report Fields.",
|
|
561
|
+
},
|
|
562
|
+
{
|
|
563
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
564
|
+
in: "query",
|
|
565
|
+
name: "report_status_fields",
|
|
566
|
+
required: false,
|
|
567
|
+
schema: {
|
|
568
|
+
items: {
|
|
569
|
+
type: "string",
|
|
570
|
+
},
|
|
571
|
+
type: "array",
|
|
572
|
+
},
|
|
573
|
+
"x-displayname": "Report Status Fields.",
|
|
574
|
+
},
|
|
575
|
+
],
|
|
576
|
+
requestBodySchema: null,
|
|
577
|
+
responseSchema: {
|
|
578
|
+
$ref: "#/components/schemas/fleetListResponse",
|
|
579
|
+
},
|
|
580
|
+
requiredParams: ["namespace"],
|
|
581
|
+
operationId: "ves.io.schema.fleet.API.List",
|
|
582
|
+
tags: ["Other"],
|
|
583
|
+
sourceFile: "domains/ce_management.json",
|
|
584
|
+
displayName: null,
|
|
585
|
+
dangerLevel: "low",
|
|
586
|
+
sideEffects: null,
|
|
587
|
+
requiredFields: ["path.namespace"],
|
|
588
|
+
cliExamples: [
|
|
589
|
+
{
|
|
590
|
+
command: "f5xcctl config fleet list --namespace {namespace}",
|
|
591
|
+
description: "List all fleets",
|
|
592
|
+
use_case: "list_all",
|
|
593
|
+
},
|
|
594
|
+
],
|
|
595
|
+
confirmationRequired: false,
|
|
596
|
+
parameterExamples: {
|
|
597
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
598
|
+
namespace: "Ns1",
|
|
599
|
+
},
|
|
600
|
+
validationRules: {},
|
|
601
|
+
operationMetadata: {
|
|
602
|
+
common_errors: [
|
|
603
|
+
{
|
|
604
|
+
code: 401,
|
|
605
|
+
message: "Authentication required",
|
|
606
|
+
solution: "Provide valid API credentials",
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
code: 403,
|
|
610
|
+
message: "Permission denied",
|
|
611
|
+
solution: "Check access permissions for this operation",
|
|
612
|
+
},
|
|
613
|
+
{
|
|
614
|
+
code: 404,
|
|
615
|
+
message: "Resource not found",
|
|
616
|
+
solution: "Verify resource name, namespace, and path",
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
code: 409,
|
|
620
|
+
message: "Resource already exists",
|
|
621
|
+
solution: "Use different name or update existing resource",
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
code: 429,
|
|
625
|
+
message: "Rate limit exceeded",
|
|
626
|
+
solution: "Wait before retrying the operation",
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
code: 500,
|
|
630
|
+
message: "Server error",
|
|
631
|
+
solution: "Retry operation or contact support",
|
|
632
|
+
},
|
|
633
|
+
],
|
|
634
|
+
conditions: {
|
|
635
|
+
postconditions: [],
|
|
636
|
+
prerequisites: ["Active namespace"],
|
|
637
|
+
},
|
|
638
|
+
confirmation_required: false,
|
|
639
|
+
danger_level: "low",
|
|
640
|
+
examples: [
|
|
641
|
+
{
|
|
642
|
+
command: "f5xcctl config fleet list --namespace {namespace}",
|
|
643
|
+
description: "List all fleets",
|
|
644
|
+
use_case: "list_all",
|
|
645
|
+
},
|
|
646
|
+
],
|
|
647
|
+
field_docs: {},
|
|
648
|
+
optional_fields: [],
|
|
649
|
+
performance_impact: {
|
|
650
|
+
latency: "moderate",
|
|
651
|
+
resource_usage: "moderate",
|
|
652
|
+
},
|
|
653
|
+
purpose: "List all fleets",
|
|
654
|
+
required_fields: ["path.namespace"],
|
|
655
|
+
side_effects: {},
|
|
656
|
+
},
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
toolName: "f5xc-api-cemanagement-fleet-update",
|
|
660
|
+
method: "PUT",
|
|
661
|
+
path: "/api/config/namespaces/{metadata.namespace}/fleets/{metadata.name}",
|
|
662
|
+
operation: "update",
|
|
663
|
+
domain: "ce_management",
|
|
664
|
+
resource: "fleet",
|
|
665
|
+
summary: "Replace Fleet.",
|
|
666
|
+
description: "Replace fleet will replace the contents of given fleet object.",
|
|
667
|
+
pathParameters: [
|
|
668
|
+
{
|
|
669
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
670
|
+
in: "path",
|
|
671
|
+
name: "metadata.name",
|
|
672
|
+
required: true,
|
|
673
|
+
schema: {
|
|
674
|
+
type: "string",
|
|
675
|
+
},
|
|
676
|
+
"x-displayname": "Name",
|
|
677
|
+
"x-ves-example": "Example-corp-web.",
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
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 ""',
|
|
681
|
+
in: "path",
|
|
682
|
+
name: "metadata.namespace",
|
|
683
|
+
required: true,
|
|
684
|
+
schema: {
|
|
685
|
+
type: "string",
|
|
686
|
+
},
|
|
687
|
+
"x-displayname": "Namespace",
|
|
688
|
+
"x-ves-example": "Staging",
|
|
689
|
+
},
|
|
690
|
+
],
|
|
691
|
+
queryParameters: [],
|
|
692
|
+
requestBodySchema: {
|
|
693
|
+
$ref: "#/components/schemas/fleetReplaceRequest",
|
|
694
|
+
},
|
|
695
|
+
responseSchema: {
|
|
696
|
+
$ref: "#/components/schemas/fleetReplaceResponse",
|
|
697
|
+
},
|
|
698
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
699
|
+
operationId: "ves.io.schema.fleet.API.Replace",
|
|
700
|
+
tags: ["Other"],
|
|
701
|
+
sourceFile: "domains/ce_management.json",
|
|
702
|
+
displayName: null,
|
|
703
|
+
dangerLevel: "medium",
|
|
704
|
+
sideEffects: {
|
|
705
|
+
modifies: ["fleet"],
|
|
706
|
+
},
|
|
707
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
708
|
+
cliExamples: [
|
|
709
|
+
{
|
|
710
|
+
command: "f5xcctl config fleet update {name} --namespace {namespace} -f {file}.yaml",
|
|
711
|
+
description: "Update fleet",
|
|
712
|
+
use_case: "update",
|
|
713
|
+
},
|
|
714
|
+
],
|
|
715
|
+
confirmationRequired: false,
|
|
716
|
+
parameterExamples: {
|
|
717
|
+
"metadata.name": "Example-corp-web.",
|
|
718
|
+
"metadata.namespace": "Staging",
|
|
719
|
+
},
|
|
720
|
+
validationRules: {},
|
|
721
|
+
operationMetadata: {
|
|
722
|
+
common_errors: [
|
|
723
|
+
{
|
|
724
|
+
code: 401,
|
|
725
|
+
message: "Authentication required",
|
|
726
|
+
solution: "Provide valid API credentials",
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
code: 403,
|
|
730
|
+
message: "Permission denied",
|
|
731
|
+
solution: "Check access permissions for this operation",
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
code: 404,
|
|
735
|
+
message: "Resource not found",
|
|
736
|
+
solution: "Verify resource name, namespace, and path",
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
code: 409,
|
|
740
|
+
message: "Resource already exists",
|
|
741
|
+
solution: "Use different name or update existing resource",
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
code: 429,
|
|
745
|
+
message: "Rate limit exceeded",
|
|
746
|
+
solution: "Wait before retrying the operation",
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
code: 500,
|
|
750
|
+
message: "Server error",
|
|
751
|
+
solution: "Retry operation or contact support",
|
|
752
|
+
},
|
|
753
|
+
],
|
|
754
|
+
conditions: {
|
|
755
|
+
postconditions: ["Resource updated with new values"],
|
|
756
|
+
prerequisites: ["Active namespace"],
|
|
757
|
+
},
|
|
758
|
+
confirmation_required: false,
|
|
759
|
+
danger_level: "medium",
|
|
760
|
+
examples: [
|
|
761
|
+
{
|
|
762
|
+
command: "f5xcctl config fleet update {name} --namespace {namespace} -f {file}.yaml",
|
|
763
|
+
description: "Update fleet",
|
|
764
|
+
use_case: "update",
|
|
765
|
+
},
|
|
766
|
+
],
|
|
767
|
+
field_docs: {},
|
|
768
|
+
optional_fields: [],
|
|
769
|
+
performance_impact: {
|
|
770
|
+
latency: "low",
|
|
771
|
+
resource_usage: "low",
|
|
772
|
+
},
|
|
773
|
+
purpose: "Replace existing fleet",
|
|
774
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
775
|
+
side_effects: {
|
|
776
|
+
modifies: ["fleet"],
|
|
777
|
+
},
|
|
778
|
+
},
|
|
779
|
+
},
|
|
780
|
+
{
|
|
781
|
+
toolName: "f5xc-api-cemanagement-get-image-download-url-create",
|
|
782
|
+
method: "POST",
|
|
783
|
+
path: "/api/register/namespaces/system/get-image-download-url",
|
|
784
|
+
operation: "create",
|
|
785
|
+
domain: "ce_management",
|
|
786
|
+
resource: "get-image-download-url",
|
|
787
|
+
summary: "GET Image Download URL.",
|
|
788
|
+
description: "Returns image download URL for each provider.",
|
|
789
|
+
pathParameters: [],
|
|
790
|
+
queryParameters: [],
|
|
791
|
+
requestBodySchema: {
|
|
792
|
+
$ref: "#/components/schemas/registrationGetImageDownloadUrlReq",
|
|
793
|
+
},
|
|
794
|
+
responseSchema: {
|
|
795
|
+
$ref: "#/components/schemas/registrationGetImageDownloadUrlResp",
|
|
796
|
+
},
|
|
797
|
+
requiredParams: ["body"],
|
|
798
|
+
operationId: "ves.io.schema.registration.CustomAPI.GetImageDownloadUrl",
|
|
799
|
+
tags: ["Other"],
|
|
800
|
+
sourceFile: "domains/ce_management.json",
|
|
801
|
+
displayName: null,
|
|
802
|
+
dangerLevel: "medium",
|
|
803
|
+
sideEffects: {
|
|
804
|
+
creates: ["get-image-download-url"],
|
|
805
|
+
},
|
|
806
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
807
|
+
cliExamples: [
|
|
808
|
+
{
|
|
809
|
+
command: "f5xcctl register get-image-download-url create -f {file}.yaml",
|
|
810
|
+
description: "Create from YAML file",
|
|
811
|
+
use_case: "file_based",
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
command: "f5xcctl register get-image-download-url create {name} --namespace {namespace}",
|
|
815
|
+
description: "Create get-image-download-url",
|
|
816
|
+
use_case: "basic_create",
|
|
817
|
+
},
|
|
818
|
+
],
|
|
819
|
+
confirmationRequired: false,
|
|
820
|
+
parameterExamples: {},
|
|
821
|
+
validationRules: {},
|
|
822
|
+
operationMetadata: {
|
|
823
|
+
common_errors: [
|
|
824
|
+
{
|
|
825
|
+
code: 401,
|
|
826
|
+
message: "Authentication required",
|
|
827
|
+
solution: "Provide valid API credentials",
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
code: 403,
|
|
831
|
+
message: "Permission denied",
|
|
832
|
+
solution: "Check access permissions for this operation",
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
code: 404,
|
|
836
|
+
message: "Resource not found",
|
|
837
|
+
solution: "Verify resource name, namespace, and path",
|
|
838
|
+
},
|
|
839
|
+
{
|
|
840
|
+
code: 409,
|
|
841
|
+
message: "Resource already exists",
|
|
842
|
+
solution: "Use different name or update existing resource",
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
code: 429,
|
|
846
|
+
message: "Rate limit exceeded",
|
|
847
|
+
solution: "Wait before retrying the operation",
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
code: 500,
|
|
851
|
+
message: "Server error",
|
|
852
|
+
solution: "Retry operation or contact support",
|
|
853
|
+
},
|
|
854
|
+
],
|
|
855
|
+
conditions: {
|
|
856
|
+
postconditions: [
|
|
857
|
+
"Get-image-download-url resource created",
|
|
858
|
+
"Resource assigned unique identifier",
|
|
859
|
+
],
|
|
860
|
+
prerequisites: ["Active namespace"],
|
|
861
|
+
},
|
|
862
|
+
confirmation_required: false,
|
|
863
|
+
danger_level: "medium",
|
|
864
|
+
examples: [
|
|
865
|
+
{
|
|
866
|
+
command: "f5xcctl register get-image-download-url create {name} --namespace {namespace}",
|
|
867
|
+
description: "Create get-image-download-url",
|
|
868
|
+
use_case: "basic_create",
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
command: "f5xcctl register get-image-download-url create -f {file}.yaml",
|
|
872
|
+
description: "Create from YAML file",
|
|
873
|
+
use_case: "file_based",
|
|
874
|
+
},
|
|
875
|
+
],
|
|
876
|
+
field_docs: {},
|
|
877
|
+
optional_fields: [],
|
|
878
|
+
performance_impact: {
|
|
879
|
+
latency: "low",
|
|
880
|
+
resource_usage: "low",
|
|
881
|
+
},
|
|
882
|
+
purpose: "Create new get-image-download-url",
|
|
883
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
884
|
+
side_effects: {
|
|
885
|
+
creates: ["get-image-download-url"],
|
|
886
|
+
},
|
|
887
|
+
},
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
toolName: "f5xc-api-cemanagement-get-registrations-by-token-create",
|
|
891
|
+
method: "POST",
|
|
892
|
+
path: "/api/register/namespaces/system/get-registrations-by-token",
|
|
893
|
+
operation: "create",
|
|
894
|
+
domain: "ce_management",
|
|
895
|
+
resource: "get-registrations-by-token",
|
|
896
|
+
summary: "GET Registration UID by Site Token.",
|
|
897
|
+
description: "Returns list of registration uids that are using particular site token.",
|
|
898
|
+
pathParameters: [],
|
|
899
|
+
queryParameters: [],
|
|
900
|
+
requestBodySchema: {
|
|
901
|
+
$ref: "#/components/schemas/registrationGetRegistrationsBySiteTokenReq",
|
|
902
|
+
},
|
|
903
|
+
responseSchema: {
|
|
904
|
+
$ref: "#/components/schemas/registrationGetRegistrationsBySiteTokenResp",
|
|
905
|
+
},
|
|
906
|
+
requiredParams: ["body"],
|
|
907
|
+
operationId: "ves.io.schema.registration.CustomAPI.GetRegistrationsBySiteToken",
|
|
908
|
+
tags: ["Other"],
|
|
909
|
+
sourceFile: "domains/ce_management.json",
|
|
910
|
+
displayName: null,
|
|
911
|
+
dangerLevel: "medium",
|
|
912
|
+
sideEffects: {
|
|
913
|
+
creates: ["get-registrations-by-token"],
|
|
914
|
+
},
|
|
915
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
916
|
+
cliExamples: [
|
|
917
|
+
{
|
|
918
|
+
command: "f5xcctl register get-registrations-by-token create -f {file}.yaml",
|
|
919
|
+
description: "Create from YAML file",
|
|
920
|
+
use_case: "file_based",
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
command: "f5xcctl register get-registrations-by-token create {name} --namespace {namespace}",
|
|
924
|
+
description: "Create get-registrations-by-token",
|
|
925
|
+
use_case: "basic_create",
|
|
926
|
+
},
|
|
927
|
+
],
|
|
928
|
+
confirmationRequired: false,
|
|
929
|
+
parameterExamples: {},
|
|
930
|
+
validationRules: {},
|
|
931
|
+
operationMetadata: {
|
|
932
|
+
common_errors: [
|
|
933
|
+
{
|
|
934
|
+
code: 401,
|
|
935
|
+
message: "Authentication required",
|
|
936
|
+
solution: "Provide valid API credentials",
|
|
937
|
+
},
|
|
938
|
+
{
|
|
939
|
+
code: 403,
|
|
940
|
+
message: "Permission denied",
|
|
941
|
+
solution: "Check access permissions for this operation",
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
code: 404,
|
|
945
|
+
message: "Resource not found",
|
|
946
|
+
solution: "Verify resource name, namespace, and path",
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
code: 409,
|
|
950
|
+
message: "Resource already exists",
|
|
951
|
+
solution: "Use different name or update existing resource",
|
|
952
|
+
},
|
|
953
|
+
{
|
|
954
|
+
code: 429,
|
|
955
|
+
message: "Rate limit exceeded",
|
|
956
|
+
solution: "Wait before retrying the operation",
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
code: 500,
|
|
960
|
+
message: "Server error",
|
|
961
|
+
solution: "Retry operation or contact support",
|
|
962
|
+
},
|
|
963
|
+
],
|
|
964
|
+
conditions: {
|
|
965
|
+
postconditions: [
|
|
966
|
+
"Get-registrations-by-token resource created",
|
|
967
|
+
"Resource assigned unique identifier",
|
|
968
|
+
],
|
|
969
|
+
prerequisites: ["Active namespace"],
|
|
970
|
+
},
|
|
971
|
+
confirmation_required: false,
|
|
972
|
+
danger_level: "medium",
|
|
973
|
+
examples: [
|
|
974
|
+
{
|
|
975
|
+
command: "f5xcctl register get-registrations-by-token create {name} --namespace {namespace}",
|
|
976
|
+
description: "Create get-registrations-by-token",
|
|
977
|
+
use_case: "basic_create",
|
|
978
|
+
},
|
|
979
|
+
{
|
|
980
|
+
command: "f5xcctl register get-registrations-by-token create -f {file}.yaml",
|
|
981
|
+
description: "Create from YAML file",
|
|
982
|
+
use_case: "file_based",
|
|
983
|
+
},
|
|
984
|
+
],
|
|
985
|
+
field_docs: {},
|
|
986
|
+
optional_fields: [],
|
|
987
|
+
performance_impact: {
|
|
988
|
+
latency: "low",
|
|
989
|
+
resource_usage: "low",
|
|
990
|
+
},
|
|
991
|
+
purpose: "Create new get-registrations-by-token",
|
|
992
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
993
|
+
side_effects: {
|
|
994
|
+
creates: ["get-registrations-by-token"],
|
|
995
|
+
},
|
|
996
|
+
},
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
toolName: "f5xc-api-cemanagement-listregistrationsbystate-create",
|
|
1000
|
+
method: "POST",
|
|
1001
|
+
path: "/api/register/namespaces/{namespace}/listregistrationsbystate",
|
|
1002
|
+
operation: "create",
|
|
1003
|
+
domain: "ce_management",
|
|
1004
|
+
resource: "listregistrationsbystate",
|
|
1005
|
+
summary: "List Registrations By State.",
|
|
1006
|
+
description: "API endpoint for returning Registrations by status, e.g APPROVED, NEW, or RETIRED.",
|
|
1007
|
+
pathParameters: [
|
|
1008
|
+
{
|
|
1009
|
+
description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
|
|
1010
|
+
in: "path",
|
|
1011
|
+
name: "namespace",
|
|
1012
|
+
required: true,
|
|
1013
|
+
schema: {
|
|
1014
|
+
type: "string",
|
|
1015
|
+
},
|
|
1016
|
+
"x-displayname": "Namespace",
|
|
1017
|
+
"x-ves-example": "System",
|
|
1018
|
+
},
|
|
1019
|
+
],
|
|
1020
|
+
queryParameters: [],
|
|
1021
|
+
requestBodySchema: {
|
|
1022
|
+
$ref: "#/components/schemas/registrationListStateReq",
|
|
1023
|
+
},
|
|
1024
|
+
responseSchema: {
|
|
1025
|
+
$ref: "#/components/schemas/registrationListResponse",
|
|
1026
|
+
},
|
|
1027
|
+
requiredParams: ["body", "namespace"],
|
|
1028
|
+
operationId: "ves.io.schema.registration.CustomAPI.ListRegistrationsByState",
|
|
1029
|
+
tags: ["Other"],
|
|
1030
|
+
sourceFile: "domains/ce_management.json",
|
|
1031
|
+
displayName: null,
|
|
1032
|
+
dangerLevel: "medium",
|
|
1033
|
+
sideEffects: {
|
|
1034
|
+
creates: ["listregistrationsbystate"],
|
|
1035
|
+
},
|
|
1036
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1037
|
+
cliExamples: [
|
|
1038
|
+
{
|
|
1039
|
+
command: "f5xcctl register listregistrationsbystate create -f {file}.yaml",
|
|
1040
|
+
description: "Create from YAML file",
|
|
1041
|
+
use_case: "file_based",
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
command: "f5xcctl register listregistrationsbystate create {name} --namespace {namespace}",
|
|
1045
|
+
description: "Create listregistrationsbystate",
|
|
1046
|
+
use_case: "basic_create",
|
|
1047
|
+
},
|
|
1048
|
+
],
|
|
1049
|
+
confirmationRequired: false,
|
|
1050
|
+
parameterExamples: {
|
|
1051
|
+
namespace: "System",
|
|
1052
|
+
},
|
|
1053
|
+
validationRules: {},
|
|
1054
|
+
operationMetadata: {
|
|
1055
|
+
common_errors: [
|
|
1056
|
+
{
|
|
1057
|
+
code: 401,
|
|
1058
|
+
message: "Authentication required",
|
|
1059
|
+
solution: "Provide valid API credentials",
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
code: 403,
|
|
1063
|
+
message: "Permission denied",
|
|
1064
|
+
solution: "Check access permissions for this operation",
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
code: 404,
|
|
1068
|
+
message: "Resource not found",
|
|
1069
|
+
solution: "Verify resource name, namespace, and path",
|
|
1070
|
+
},
|
|
1071
|
+
{
|
|
1072
|
+
code: 409,
|
|
1073
|
+
message: "Resource already exists",
|
|
1074
|
+
solution: "Use different name or update existing resource",
|
|
1075
|
+
},
|
|
1076
|
+
{
|
|
1077
|
+
code: 429,
|
|
1078
|
+
message: "Rate limit exceeded",
|
|
1079
|
+
solution: "Wait before retrying the operation",
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
code: 500,
|
|
1083
|
+
message: "Server error",
|
|
1084
|
+
solution: "Retry operation or contact support",
|
|
1085
|
+
},
|
|
1086
|
+
],
|
|
1087
|
+
conditions: {
|
|
1088
|
+
postconditions: [
|
|
1089
|
+
"Listregistrationsbystate resource created",
|
|
1090
|
+
"Resource assigned unique identifier",
|
|
1091
|
+
],
|
|
1092
|
+
prerequisites: ["Active namespace"],
|
|
1093
|
+
},
|
|
1094
|
+
confirmation_required: false,
|
|
1095
|
+
danger_level: "medium",
|
|
1096
|
+
examples: [
|
|
1097
|
+
{
|
|
1098
|
+
command: "f5xcctl register listregistrationsbystate create {name} --namespace {namespace}",
|
|
1099
|
+
description: "Create listregistrationsbystate",
|
|
1100
|
+
use_case: "basic_create",
|
|
1101
|
+
},
|
|
1102
|
+
{
|
|
1103
|
+
command: "f5xcctl register listregistrationsbystate create -f {file}.yaml",
|
|
1104
|
+
description: "Create from YAML file",
|
|
1105
|
+
use_case: "file_based",
|
|
1106
|
+
},
|
|
1107
|
+
],
|
|
1108
|
+
field_docs: {},
|
|
1109
|
+
optional_fields: [],
|
|
1110
|
+
performance_impact: {
|
|
1111
|
+
latency: "low",
|
|
1112
|
+
resource_usage: "low",
|
|
1113
|
+
},
|
|
1114
|
+
purpose: "Create new listregistrationsbystate",
|
|
1115
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1116
|
+
side_effects: {
|
|
1117
|
+
creates: ["listregistrationsbystate"],
|
|
1118
|
+
},
|
|
1119
|
+
},
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
toolName: "f5xc-api-cemanagement-network-interface-create",
|
|
1123
|
+
method: "POST",
|
|
1124
|
+
path: "/api/config/namespaces/{metadata.namespace}/network_interfaces",
|
|
1125
|
+
operation: "create",
|
|
1126
|
+
domain: "ce_management",
|
|
1127
|
+
resource: "network-interface",
|
|
1128
|
+
summary: "Create Network Interface.",
|
|
1129
|
+
description: "Network interface represents configuration of a network device.\nIt is created by users in system namespace.",
|
|
1130
|
+
pathParameters: [
|
|
1131
|
+
{
|
|
1132
|
+
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 ""',
|
|
1133
|
+
in: "path",
|
|
1134
|
+
name: "metadata.namespace",
|
|
1135
|
+
required: true,
|
|
1136
|
+
schema: {
|
|
1137
|
+
type: "string",
|
|
1138
|
+
},
|
|
1139
|
+
"x-displayname": "Namespace",
|
|
1140
|
+
"x-ves-example": "Staging",
|
|
1141
|
+
},
|
|
1142
|
+
],
|
|
1143
|
+
queryParameters: [],
|
|
1144
|
+
requestBodySchema: {
|
|
1145
|
+
$ref: "#/components/schemas/network_interfaceCreateRequest",
|
|
1146
|
+
},
|
|
1147
|
+
responseSchema: {
|
|
1148
|
+
$ref: "#/components/schemas/network_interfaceCreateResponse",
|
|
1149
|
+
},
|
|
1150
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1151
|
+
operationId: "ves.io.schema.network_interface.API.Create",
|
|
1152
|
+
tags: ["Other"],
|
|
1153
|
+
sourceFile: "domains/ce_management.json",
|
|
1154
|
+
displayName: null,
|
|
1155
|
+
dangerLevel: "medium",
|
|
1156
|
+
sideEffects: {
|
|
1157
|
+
creates: ["network-interface"],
|
|
1158
|
+
},
|
|
1159
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1160
|
+
cliExamples: [
|
|
1161
|
+
{
|
|
1162
|
+
command: "f5xcctl config network-interface create -f {file}.yaml",
|
|
1163
|
+
description: "Create from YAML file",
|
|
1164
|
+
use_case: "file_based",
|
|
1165
|
+
},
|
|
1166
|
+
{
|
|
1167
|
+
command: "f5xcctl config network-interface create {name} --namespace {namespace}",
|
|
1168
|
+
description: "Create network-interface",
|
|
1169
|
+
use_case: "basic_create",
|
|
1170
|
+
},
|
|
1171
|
+
],
|
|
1172
|
+
confirmationRequired: false,
|
|
1173
|
+
parameterExamples: {
|
|
1174
|
+
"metadata.namespace": "Staging",
|
|
1175
|
+
},
|
|
1176
|
+
validationRules: {},
|
|
1177
|
+
operationMetadata: {
|
|
1178
|
+
common_errors: [
|
|
1179
|
+
{
|
|
1180
|
+
code: 401,
|
|
1181
|
+
message: "Authentication required",
|
|
1182
|
+
solution: "Provide valid API credentials",
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
code: 403,
|
|
1186
|
+
message: "Permission denied",
|
|
1187
|
+
solution: "Check access permissions for this operation",
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
code: 404,
|
|
1191
|
+
message: "Resource not found",
|
|
1192
|
+
solution: "Verify resource name, namespace, and path",
|
|
1193
|
+
},
|
|
1194
|
+
{
|
|
1195
|
+
code: 409,
|
|
1196
|
+
message: "Resource already exists",
|
|
1197
|
+
solution: "Use different name or update existing resource",
|
|
1198
|
+
},
|
|
1199
|
+
{
|
|
1200
|
+
code: 429,
|
|
1201
|
+
message: "Rate limit exceeded",
|
|
1202
|
+
solution: "Wait before retrying the operation",
|
|
1203
|
+
},
|
|
1204
|
+
{
|
|
1205
|
+
code: 500,
|
|
1206
|
+
message: "Server error",
|
|
1207
|
+
solution: "Retry operation or contact support",
|
|
1208
|
+
},
|
|
1209
|
+
],
|
|
1210
|
+
conditions: {
|
|
1211
|
+
postconditions: [
|
|
1212
|
+
"Network-interface resource created",
|
|
1213
|
+
"Resource assigned unique identifier",
|
|
1214
|
+
],
|
|
1215
|
+
prerequisites: ["Active namespace"],
|
|
1216
|
+
},
|
|
1217
|
+
confirmation_required: false,
|
|
1218
|
+
danger_level: "medium",
|
|
1219
|
+
examples: [
|
|
1220
|
+
{
|
|
1221
|
+
command: "f5xcctl config network-interface create {name} --namespace {namespace}",
|
|
1222
|
+
description: "Create network-interface",
|
|
1223
|
+
use_case: "basic_create",
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
command: "f5xcctl config network-interface create -f {file}.yaml",
|
|
1227
|
+
description: "Create from YAML file",
|
|
1228
|
+
use_case: "file_based",
|
|
1229
|
+
},
|
|
1230
|
+
],
|
|
1231
|
+
field_docs: {},
|
|
1232
|
+
optional_fields: [],
|
|
1233
|
+
performance_impact: {
|
|
1234
|
+
latency: "low",
|
|
1235
|
+
resource_usage: "low",
|
|
1236
|
+
},
|
|
1237
|
+
purpose: "Create new network-interface",
|
|
1238
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1239
|
+
side_effects: {
|
|
1240
|
+
creates: ["network-interface"],
|
|
1241
|
+
},
|
|
1242
|
+
},
|
|
1243
|
+
},
|
|
1244
|
+
{
|
|
1245
|
+
toolName: "f5xc-api-cemanagement-network-interface-delete",
|
|
1246
|
+
method: "DELETE",
|
|
1247
|
+
path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
|
|
1248
|
+
operation: "delete",
|
|
1249
|
+
domain: "ce_management",
|
|
1250
|
+
resource: "network-interface",
|
|
1251
|
+
summary: "DELETE Network Interface.",
|
|
1252
|
+
description: "DELETE the specified network_interface.",
|
|
1253
|
+
pathParameters: [
|
|
1254
|
+
{
|
|
1255
|
+
description: "Name\nName of the configuration object.",
|
|
1256
|
+
in: "path",
|
|
1257
|
+
name: "name",
|
|
1258
|
+
required: true,
|
|
1259
|
+
schema: {
|
|
1260
|
+
type: "string",
|
|
1261
|
+
},
|
|
1262
|
+
"x-displayname": "Name",
|
|
1263
|
+
"x-ves-example": "Name",
|
|
1264
|
+
},
|
|
1265
|
+
{
|
|
1266
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1267
|
+
in: "path",
|
|
1268
|
+
name: "namespace",
|
|
1269
|
+
required: true,
|
|
1270
|
+
schema: {
|
|
1271
|
+
type: "string",
|
|
1272
|
+
},
|
|
1273
|
+
"x-displayname": "Namespace",
|
|
1274
|
+
"x-ves-example": "Ns1",
|
|
1275
|
+
},
|
|
1276
|
+
],
|
|
1277
|
+
queryParameters: [],
|
|
1278
|
+
requestBodySchema: {
|
|
1279
|
+
$ref: "#/components/schemas/network_interfaceDeleteRequest",
|
|
1280
|
+
},
|
|
1281
|
+
responseSchema: {},
|
|
1282
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1283
|
+
operationId: "ves.io.schema.network_interface.API.Delete",
|
|
1284
|
+
tags: ["Other"],
|
|
1285
|
+
sourceFile: "domains/ce_management.json",
|
|
1286
|
+
displayName: null,
|
|
1287
|
+
dangerLevel: "high",
|
|
1288
|
+
sideEffects: {
|
|
1289
|
+
deletes: ["network-interface", "contained_resources"],
|
|
1290
|
+
},
|
|
1291
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1292
|
+
cliExamples: [
|
|
1293
|
+
{
|
|
1294
|
+
command: "f5xcctl config network-interface delete {name} --namespace {namespace}",
|
|
1295
|
+
description: "Delete network-interface",
|
|
1296
|
+
use_case: "delete",
|
|
1297
|
+
},
|
|
1298
|
+
],
|
|
1299
|
+
confirmationRequired: true,
|
|
1300
|
+
parameterExamples: {
|
|
1301
|
+
name: "Name",
|
|
1302
|
+
namespace: "Ns1",
|
|
1303
|
+
},
|
|
1304
|
+
validationRules: {},
|
|
1305
|
+
operationMetadata: {
|
|
1306
|
+
common_errors: [
|
|
1307
|
+
{
|
|
1308
|
+
code: 401,
|
|
1309
|
+
message: "Authentication required",
|
|
1310
|
+
solution: "Provide valid API credentials",
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
code: 403,
|
|
1314
|
+
message: "Permission denied",
|
|
1315
|
+
solution: "Check access permissions for this operation",
|
|
1316
|
+
},
|
|
1317
|
+
{
|
|
1318
|
+
code: 404,
|
|
1319
|
+
message: "Resource not found",
|
|
1320
|
+
solution: "Verify resource name, namespace, and path",
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
code: 409,
|
|
1324
|
+
message: "Resource already exists",
|
|
1325
|
+
solution: "Use different name or update existing resource",
|
|
1326
|
+
},
|
|
1327
|
+
{
|
|
1328
|
+
code: 429,
|
|
1329
|
+
message: "Rate limit exceeded",
|
|
1330
|
+
solution: "Wait before retrying the operation",
|
|
1331
|
+
},
|
|
1332
|
+
{
|
|
1333
|
+
code: 500,
|
|
1334
|
+
message: "Server error",
|
|
1335
|
+
solution: "Retry operation or contact support",
|
|
1336
|
+
},
|
|
1337
|
+
],
|
|
1338
|
+
conditions: {
|
|
1339
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1340
|
+
prerequisites: ["Active namespace"],
|
|
1341
|
+
},
|
|
1342
|
+
confirmation_required: true,
|
|
1343
|
+
danger_level: "high",
|
|
1344
|
+
examples: [
|
|
1345
|
+
{
|
|
1346
|
+
command: "f5xcctl config network-interface delete {name} --namespace {namespace}",
|
|
1347
|
+
description: "Delete network-interface",
|
|
1348
|
+
use_case: "delete",
|
|
1349
|
+
},
|
|
1350
|
+
],
|
|
1351
|
+
field_docs: {},
|
|
1352
|
+
optional_fields: [],
|
|
1353
|
+
performance_impact: {
|
|
1354
|
+
latency: "high",
|
|
1355
|
+
resource_usage: "moderate",
|
|
1356
|
+
},
|
|
1357
|
+
purpose: "Delete network-interface",
|
|
1358
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1359
|
+
side_effects: {
|
|
1360
|
+
deletes: ["network-interface", "contained_resources"],
|
|
1361
|
+
},
|
|
1362
|
+
},
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
toolName: "f5xc-api-cemanagement-network-interface-get",
|
|
1366
|
+
method: "GET",
|
|
1367
|
+
path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
|
|
1368
|
+
operation: "get",
|
|
1369
|
+
domain: "ce_management",
|
|
1370
|
+
resource: "network-interface",
|
|
1371
|
+
summary: "GET Network Interface.",
|
|
1372
|
+
description: "GET network interface from system namespace.",
|
|
1373
|
+
pathParameters: [
|
|
1374
|
+
{
|
|
1375
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1376
|
+
in: "path",
|
|
1377
|
+
name: "name",
|
|
1378
|
+
required: true,
|
|
1379
|
+
schema: {
|
|
1380
|
+
type: "string",
|
|
1381
|
+
},
|
|
1382
|
+
"x-displayname": "Name",
|
|
1383
|
+
"x-ves-example": "Name",
|
|
1384
|
+
},
|
|
1385
|
+
{
|
|
1386
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1387
|
+
in: "path",
|
|
1388
|
+
name: "namespace",
|
|
1389
|
+
required: true,
|
|
1390
|
+
schema: {
|
|
1391
|
+
type: "string",
|
|
1392
|
+
},
|
|
1393
|
+
"x-displayname": "Namespace",
|
|
1394
|
+
"x-ves-example": "Ns1",
|
|
1395
|
+
},
|
|
1396
|
+
],
|
|
1397
|
+
queryParameters: [
|
|
1398
|
+
{
|
|
1399
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
1400
|
+
in: "query",
|
|
1401
|
+
name: "response_format",
|
|
1402
|
+
required: false,
|
|
1403
|
+
schema: {
|
|
1404
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1405
|
+
enum: [
|
|
1406
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1407
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1408
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1409
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1410
|
+
"GET_RSP_FORMAT_READ",
|
|
1411
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1412
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1413
|
+
],
|
|
1414
|
+
type: "string",
|
|
1415
|
+
},
|
|
1416
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1417
|
+
},
|
|
1418
|
+
],
|
|
1419
|
+
requestBodySchema: null,
|
|
1420
|
+
responseSchema: {
|
|
1421
|
+
$ref: "#/components/schemas/network_interfaceGetResponse",
|
|
1422
|
+
},
|
|
1423
|
+
requiredParams: ["name", "namespace"],
|
|
1424
|
+
operationId: "ves.io.schema.network_interface.API.Get",
|
|
1425
|
+
tags: ["Other"],
|
|
1426
|
+
sourceFile: "domains/ce_management.json",
|
|
1427
|
+
displayName: null,
|
|
1428
|
+
dangerLevel: "low",
|
|
1429
|
+
sideEffects: null,
|
|
1430
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1431
|
+
cliExamples: [
|
|
1432
|
+
{
|
|
1433
|
+
command: "f5xcctl config network-interface get {name} --namespace {namespace}",
|
|
1434
|
+
description: "Get specific network-interface",
|
|
1435
|
+
use_case: "get_specific",
|
|
1436
|
+
},
|
|
1437
|
+
],
|
|
1438
|
+
confirmationRequired: false,
|
|
1439
|
+
parameterExamples: {
|
|
1440
|
+
name: "Name",
|
|
1441
|
+
namespace: "Ns1",
|
|
1442
|
+
},
|
|
1443
|
+
validationRules: {},
|
|
1444
|
+
operationMetadata: {
|
|
1445
|
+
common_errors: [
|
|
1446
|
+
{
|
|
1447
|
+
code: 401,
|
|
1448
|
+
message: "Authentication required",
|
|
1449
|
+
solution: "Provide valid API credentials",
|
|
1450
|
+
},
|
|
1451
|
+
{
|
|
1452
|
+
code: 403,
|
|
1453
|
+
message: "Permission denied",
|
|
1454
|
+
solution: "Check access permissions for this operation",
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
code: 404,
|
|
1458
|
+
message: "Resource not found",
|
|
1459
|
+
solution: "Verify resource name, namespace, and path",
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
code: 409,
|
|
1463
|
+
message: "Resource already exists",
|
|
1464
|
+
solution: "Use different name or update existing resource",
|
|
1465
|
+
},
|
|
1466
|
+
{
|
|
1467
|
+
code: 429,
|
|
1468
|
+
message: "Rate limit exceeded",
|
|
1469
|
+
solution: "Wait before retrying the operation",
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
code: 500,
|
|
1473
|
+
message: "Server error",
|
|
1474
|
+
solution: "Retry operation or contact support",
|
|
1475
|
+
},
|
|
1476
|
+
],
|
|
1477
|
+
conditions: {
|
|
1478
|
+
postconditions: [],
|
|
1479
|
+
prerequisites: ["Active namespace"],
|
|
1480
|
+
},
|
|
1481
|
+
confirmation_required: false,
|
|
1482
|
+
danger_level: "low",
|
|
1483
|
+
examples: [
|
|
1484
|
+
{
|
|
1485
|
+
command: "f5xcctl config network-interface get {name} --namespace {namespace}",
|
|
1486
|
+
description: "Get specific network-interface",
|
|
1487
|
+
use_case: "get_specific",
|
|
1488
|
+
},
|
|
1489
|
+
],
|
|
1490
|
+
field_docs: {},
|
|
1491
|
+
optional_fields: [],
|
|
1492
|
+
performance_impact: {
|
|
1493
|
+
latency: "low",
|
|
1494
|
+
resource_usage: "low",
|
|
1495
|
+
},
|
|
1496
|
+
purpose: "Retrieve specific network-interface",
|
|
1497
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1498
|
+
side_effects: {},
|
|
1499
|
+
},
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
toolName: "f5xc-api-cemanagement-network-interface-list",
|
|
1503
|
+
method: "GET",
|
|
1504
|
+
path: "/api/config/namespaces/{namespace}/network_interfaces",
|
|
1505
|
+
operation: "list",
|
|
1506
|
+
domain: "ce_management",
|
|
1507
|
+
resource: "network-interface",
|
|
1508
|
+
summary: "List Network Interface.",
|
|
1509
|
+
description: "List the set of network_interface in a namespace.",
|
|
1510
|
+
pathParameters: [
|
|
1511
|
+
{
|
|
1512
|
+
description: "Namespace\nNamespace to scope the listing of network_interface.",
|
|
1513
|
+
in: "path",
|
|
1514
|
+
name: "namespace",
|
|
1515
|
+
required: true,
|
|
1516
|
+
schema: {
|
|
1517
|
+
type: "string",
|
|
1518
|
+
},
|
|
1519
|
+
"x-displayname": "Namespace",
|
|
1520
|
+
"x-ves-example": "Ns1",
|
|
1521
|
+
},
|
|
1522
|
+
],
|
|
1523
|
+
queryParameters: [
|
|
1524
|
+
{
|
|
1525
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1526
|
+
in: "query",
|
|
1527
|
+
name: "label_filter",
|
|
1528
|
+
required: false,
|
|
1529
|
+
schema: {
|
|
1530
|
+
type: "string",
|
|
1531
|
+
},
|
|
1532
|
+
"x-displayname": "Label Filter.",
|
|
1533
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1534
|
+
},
|
|
1535
|
+
{
|
|
1536
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1537
|
+
in: "query",
|
|
1538
|
+
name: "report_fields",
|
|
1539
|
+
required: false,
|
|
1540
|
+
schema: {
|
|
1541
|
+
items: {
|
|
1542
|
+
type: "string",
|
|
1543
|
+
},
|
|
1544
|
+
type: "array",
|
|
1545
|
+
},
|
|
1546
|
+
"x-displayname": "Report Fields.",
|
|
1547
|
+
},
|
|
1548
|
+
{
|
|
1549
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1550
|
+
in: "query",
|
|
1551
|
+
name: "report_status_fields",
|
|
1552
|
+
required: false,
|
|
1553
|
+
schema: {
|
|
1554
|
+
items: {
|
|
1555
|
+
type: "string",
|
|
1556
|
+
},
|
|
1557
|
+
type: "array",
|
|
1558
|
+
},
|
|
1559
|
+
"x-displayname": "Report Status Fields.",
|
|
1560
|
+
},
|
|
1561
|
+
],
|
|
1562
|
+
requestBodySchema: null,
|
|
1563
|
+
responseSchema: {
|
|
1564
|
+
$ref: "#/components/schemas/network_interfaceListResponse",
|
|
1565
|
+
},
|
|
1566
|
+
requiredParams: ["namespace"],
|
|
1567
|
+
operationId: "ves.io.schema.network_interface.API.List",
|
|
1568
|
+
tags: ["Other"],
|
|
1569
|
+
sourceFile: "domains/ce_management.json",
|
|
1570
|
+
displayName: null,
|
|
1571
|
+
dangerLevel: "low",
|
|
1572
|
+
sideEffects: null,
|
|
1573
|
+
requiredFields: ["path.namespace"],
|
|
1574
|
+
cliExamples: [
|
|
1575
|
+
{
|
|
1576
|
+
command: "f5xcctl config network-interface list --namespace {namespace}",
|
|
1577
|
+
description: "List all network-interfaces",
|
|
1578
|
+
use_case: "list_all",
|
|
1579
|
+
},
|
|
1580
|
+
],
|
|
1581
|
+
confirmationRequired: false,
|
|
1582
|
+
parameterExamples: {
|
|
1583
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1584
|
+
namespace: "Ns1",
|
|
1585
|
+
},
|
|
1586
|
+
validationRules: {},
|
|
1587
|
+
operationMetadata: {
|
|
1588
|
+
common_errors: [
|
|
1589
|
+
{
|
|
1590
|
+
code: 401,
|
|
1591
|
+
message: "Authentication required",
|
|
1592
|
+
solution: "Provide valid API credentials",
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
code: 403,
|
|
1596
|
+
message: "Permission denied",
|
|
1597
|
+
solution: "Check access permissions for this operation",
|
|
1598
|
+
},
|
|
1599
|
+
{
|
|
1600
|
+
code: 404,
|
|
1601
|
+
message: "Resource not found",
|
|
1602
|
+
solution: "Verify resource name, namespace, and path",
|
|
1603
|
+
},
|
|
1604
|
+
{
|
|
1605
|
+
code: 409,
|
|
1606
|
+
message: "Resource already exists",
|
|
1607
|
+
solution: "Use different name or update existing resource",
|
|
1608
|
+
},
|
|
1609
|
+
{
|
|
1610
|
+
code: 429,
|
|
1611
|
+
message: "Rate limit exceeded",
|
|
1612
|
+
solution: "Wait before retrying the operation",
|
|
1613
|
+
},
|
|
1614
|
+
{
|
|
1615
|
+
code: 500,
|
|
1616
|
+
message: "Server error",
|
|
1617
|
+
solution: "Retry operation or contact support",
|
|
1618
|
+
},
|
|
1619
|
+
],
|
|
1620
|
+
conditions: {
|
|
1621
|
+
postconditions: [],
|
|
1622
|
+
prerequisites: ["Active namespace"],
|
|
1623
|
+
},
|
|
1624
|
+
confirmation_required: false,
|
|
1625
|
+
danger_level: "low",
|
|
1626
|
+
examples: [
|
|
1627
|
+
{
|
|
1628
|
+
command: "f5xcctl config network-interface list --namespace {namespace}",
|
|
1629
|
+
description: "List all network-interfaces",
|
|
1630
|
+
use_case: "list_all",
|
|
1631
|
+
},
|
|
1632
|
+
],
|
|
1633
|
+
field_docs: {},
|
|
1634
|
+
optional_fields: [],
|
|
1635
|
+
performance_impact: {
|
|
1636
|
+
latency: "moderate",
|
|
1637
|
+
resource_usage: "moderate",
|
|
1638
|
+
},
|
|
1639
|
+
purpose: "List all network-interfaces",
|
|
1640
|
+
required_fields: ["path.namespace"],
|
|
1641
|
+
side_effects: {},
|
|
1642
|
+
},
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
toolName: "f5xc-api-cemanagement-network-interface-update",
|
|
1646
|
+
method: "PUT",
|
|
1647
|
+
path: "/api/config/namespaces/{metadata.namespace}/network_interfaces/{metadata.name}",
|
|
1648
|
+
operation: "update",
|
|
1649
|
+
domain: "ce_management",
|
|
1650
|
+
resource: "network-interface",
|
|
1651
|
+
summary: "Replace Network Interface.",
|
|
1652
|
+
description: "Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.",
|
|
1653
|
+
pathParameters: [
|
|
1654
|
+
{
|
|
1655
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1656
|
+
in: "path",
|
|
1657
|
+
name: "metadata.name",
|
|
1658
|
+
required: true,
|
|
1659
|
+
schema: {
|
|
1660
|
+
type: "string",
|
|
1661
|
+
},
|
|
1662
|
+
"x-displayname": "Name",
|
|
1663
|
+
"x-ves-example": "Example-corp-web.",
|
|
1664
|
+
},
|
|
1665
|
+
{
|
|
1666
|
+
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 ""',
|
|
1667
|
+
in: "path",
|
|
1668
|
+
name: "metadata.namespace",
|
|
1669
|
+
required: true,
|
|
1670
|
+
schema: {
|
|
1671
|
+
type: "string",
|
|
1672
|
+
},
|
|
1673
|
+
"x-displayname": "Namespace",
|
|
1674
|
+
"x-ves-example": "Staging",
|
|
1675
|
+
},
|
|
1676
|
+
],
|
|
1677
|
+
queryParameters: [],
|
|
1678
|
+
requestBodySchema: {
|
|
1679
|
+
$ref: "#/components/schemas/network_interfaceReplaceRequest",
|
|
1680
|
+
},
|
|
1681
|
+
responseSchema: {
|
|
1682
|
+
$ref: "#/components/schemas/network_interfaceReplaceResponse",
|
|
1683
|
+
},
|
|
1684
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1685
|
+
operationId: "ves.io.schema.network_interface.API.Replace",
|
|
1686
|
+
tags: ["Other"],
|
|
1687
|
+
sourceFile: "domains/ce_management.json",
|
|
1688
|
+
displayName: null,
|
|
1689
|
+
dangerLevel: "medium",
|
|
1690
|
+
sideEffects: {
|
|
1691
|
+
modifies: ["network-interface"],
|
|
1692
|
+
},
|
|
1693
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1694
|
+
cliExamples: [
|
|
1695
|
+
{
|
|
1696
|
+
command: "f5xcctl config network-interface update {name} --namespace {namespace} -f {file}.yaml",
|
|
1697
|
+
description: "Update network-interface",
|
|
1698
|
+
use_case: "update",
|
|
1699
|
+
},
|
|
1700
|
+
],
|
|
1701
|
+
confirmationRequired: false,
|
|
1702
|
+
parameterExamples: {
|
|
1703
|
+
"metadata.name": "Example-corp-web.",
|
|
1704
|
+
"metadata.namespace": "Staging",
|
|
1705
|
+
},
|
|
1706
|
+
validationRules: {},
|
|
1707
|
+
operationMetadata: {
|
|
1708
|
+
common_errors: [
|
|
1709
|
+
{
|
|
1710
|
+
code: 401,
|
|
1711
|
+
message: "Authentication required",
|
|
1712
|
+
solution: "Provide valid API credentials",
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
code: 403,
|
|
1716
|
+
message: "Permission denied",
|
|
1717
|
+
solution: "Check access permissions for this operation",
|
|
1718
|
+
},
|
|
1719
|
+
{
|
|
1720
|
+
code: 404,
|
|
1721
|
+
message: "Resource not found",
|
|
1722
|
+
solution: "Verify resource name, namespace, and path",
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
code: 409,
|
|
1726
|
+
message: "Resource already exists",
|
|
1727
|
+
solution: "Use different name or update existing resource",
|
|
1728
|
+
},
|
|
1729
|
+
{
|
|
1730
|
+
code: 429,
|
|
1731
|
+
message: "Rate limit exceeded",
|
|
1732
|
+
solution: "Wait before retrying the operation",
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
code: 500,
|
|
1736
|
+
message: "Server error",
|
|
1737
|
+
solution: "Retry operation or contact support",
|
|
1738
|
+
},
|
|
1739
|
+
],
|
|
1740
|
+
conditions: {
|
|
1741
|
+
postconditions: ["Resource updated with new values"],
|
|
1742
|
+
prerequisites: ["Active namespace"],
|
|
1743
|
+
},
|
|
1744
|
+
confirmation_required: false,
|
|
1745
|
+
danger_level: "medium",
|
|
1746
|
+
examples: [
|
|
1747
|
+
{
|
|
1748
|
+
command: "f5xcctl config network-interface update {name} --namespace {namespace} -f {file}.yaml",
|
|
1749
|
+
description: "Update network-interface",
|
|
1750
|
+
use_case: "update",
|
|
1751
|
+
},
|
|
1752
|
+
],
|
|
1753
|
+
field_docs: {},
|
|
1754
|
+
optional_fields: [],
|
|
1755
|
+
performance_impact: {
|
|
1756
|
+
latency: "low",
|
|
1757
|
+
resource_usage: "low",
|
|
1758
|
+
},
|
|
1759
|
+
purpose: "Replace existing network-interface",
|
|
1760
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1761
|
+
side_effects: {
|
|
1762
|
+
modifies: ["network-interface"],
|
|
1763
|
+
},
|
|
1764
|
+
},
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
toolName: "f5xc-api-cemanagement-pre-upgrade-check-get",
|
|
1768
|
+
method: "GET",
|
|
1769
|
+
path: "/api/maurice/namespaces/{namespace}/sites/{name}/pre_upgrade_check",
|
|
1770
|
+
operation: "get",
|
|
1771
|
+
domain: "ce_management",
|
|
1772
|
+
resource: "pre-upgrade-check",
|
|
1773
|
+
summary: "Pre upgrade check.",
|
|
1774
|
+
description: "API to check if site is ready for upgrade.",
|
|
1775
|
+
pathParameters: [
|
|
1776
|
+
{
|
|
1777
|
+
description: "Name\nFetch upgrade status for the name of site.",
|
|
1778
|
+
in: "path",
|
|
1779
|
+
name: "name",
|
|
1780
|
+
required: true,
|
|
1781
|
+
schema: {
|
|
1782
|
+
type: "string",
|
|
1783
|
+
},
|
|
1784
|
+
"x-displayname": "Site Name",
|
|
1785
|
+
"x-ves-example": "Blogging-app.",
|
|
1786
|
+
},
|
|
1787
|
+
{
|
|
1788
|
+
description: "Namespace\nFetch upgrade status for the given namespace.",
|
|
1789
|
+
in: "path",
|
|
1790
|
+
name: "namespace",
|
|
1791
|
+
required: true,
|
|
1792
|
+
schema: {
|
|
1793
|
+
type: "string",
|
|
1794
|
+
},
|
|
1795
|
+
"x-displayname": "Namespace",
|
|
1796
|
+
"x-ves-example": "Shared",
|
|
1797
|
+
},
|
|
1798
|
+
],
|
|
1799
|
+
queryParameters: [
|
|
1800
|
+
{
|
|
1801
|
+
description: "Software version to upgrade to.",
|
|
1802
|
+
in: "query",
|
|
1803
|
+
name: "sw_version",
|
|
1804
|
+
required: false,
|
|
1805
|
+
schema: {
|
|
1806
|
+
type: "string",
|
|
1807
|
+
},
|
|
1808
|
+
"x-displayname": "SW Version to upgrade to.",
|
|
1809
|
+
"x-ves-example": "Crt-20241107-1123.",
|
|
1810
|
+
},
|
|
1811
|
+
],
|
|
1812
|
+
requestBodySchema: null,
|
|
1813
|
+
responseSchema: {
|
|
1814
|
+
$ref: "#/components/schemas/upgrade_statusPreUpgradeCheckResponse",
|
|
1815
|
+
},
|
|
1816
|
+
requiredParams: ["name", "namespace"],
|
|
1817
|
+
operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck",
|
|
1818
|
+
tags: ["Other"],
|
|
1819
|
+
sourceFile: "domains/ce_management.json",
|
|
1820
|
+
displayName: null,
|
|
1821
|
+
dangerLevel: "low",
|
|
1822
|
+
sideEffects: null,
|
|
1823
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1824
|
+
cliExamples: [
|
|
1825
|
+
{
|
|
1826
|
+
command: "f5xcctl maurice pre-upgrade-check get {name} --namespace {namespace}",
|
|
1827
|
+
description: "Get specific pre-upgrade-check",
|
|
1828
|
+
use_case: "get_specific",
|
|
1829
|
+
},
|
|
1830
|
+
],
|
|
1831
|
+
confirmationRequired: false,
|
|
1832
|
+
parameterExamples: {
|
|
1833
|
+
name: "Blogging-app.",
|
|
1834
|
+
namespace: "Shared",
|
|
1835
|
+
sw_version: "Crt-20241107-1123.",
|
|
1836
|
+
},
|
|
1837
|
+
validationRules: {},
|
|
1838
|
+
operationMetadata: {
|
|
1839
|
+
common_errors: [
|
|
1840
|
+
{
|
|
1841
|
+
code: 401,
|
|
1842
|
+
message: "Authentication required",
|
|
1843
|
+
solution: "Provide valid API credentials",
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
code: 403,
|
|
1847
|
+
message: "Permission denied",
|
|
1848
|
+
solution: "Check access permissions for this operation",
|
|
1849
|
+
},
|
|
1850
|
+
{
|
|
1851
|
+
code: 404,
|
|
1852
|
+
message: "Resource not found",
|
|
1853
|
+
solution: "Verify resource name, namespace, and path",
|
|
1854
|
+
},
|
|
1855
|
+
{
|
|
1856
|
+
code: 409,
|
|
1857
|
+
message: "Resource already exists",
|
|
1858
|
+
solution: "Use different name or update existing resource",
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
code: 429,
|
|
1862
|
+
message: "Rate limit exceeded",
|
|
1863
|
+
solution: "Wait before retrying the operation",
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
code: 500,
|
|
1867
|
+
message: "Server error",
|
|
1868
|
+
solution: "Retry operation or contact support",
|
|
1869
|
+
},
|
|
1870
|
+
],
|
|
1871
|
+
conditions: {
|
|
1872
|
+
postconditions: [],
|
|
1873
|
+
prerequisites: ["Active namespace"],
|
|
1874
|
+
},
|
|
1875
|
+
confirmation_required: false,
|
|
1876
|
+
danger_level: "low",
|
|
1877
|
+
examples: [
|
|
1878
|
+
{
|
|
1879
|
+
command: "f5xcctl maurice pre-upgrade-check get {name} --namespace {namespace}",
|
|
1880
|
+
description: "Get specific pre-upgrade-check",
|
|
1881
|
+
use_case: "get_specific",
|
|
1882
|
+
},
|
|
1883
|
+
],
|
|
1884
|
+
field_docs: {},
|
|
1885
|
+
optional_fields: [],
|
|
1886
|
+
performance_impact: {
|
|
1887
|
+
latency: "moderate",
|
|
1888
|
+
resource_usage: "moderate",
|
|
1889
|
+
},
|
|
1890
|
+
purpose: "Retrieve specific pre-upgrade-check",
|
|
1891
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1892
|
+
side_effects: {},
|
|
1893
|
+
},
|
|
1894
|
+
},
|
|
1895
|
+
{
|
|
1896
|
+
toolName: "f5xc-api-cemanagement-registerbootstrap-create",
|
|
1897
|
+
method: "POST",
|
|
1898
|
+
path: "/api/register/registerBootstrap",
|
|
1899
|
+
operation: "create",
|
|
1900
|
+
domain: "ce_management",
|
|
1901
|
+
resource: "registerBootstrap",
|
|
1902
|
+
summary: "Registration Create.",
|
|
1903
|
+
description: "Registration request to create registration is sent by the node on first boot. User never creates registration on her own.",
|
|
1904
|
+
pathParameters: [],
|
|
1905
|
+
queryParameters: [],
|
|
1906
|
+
requestBodySchema: {
|
|
1907
|
+
$ref: "#/components/schemas/registrationRegistrationCreateRequest",
|
|
1908
|
+
},
|
|
1909
|
+
responseSchema: {
|
|
1910
|
+
$ref: "#/components/schemas/registrationObject",
|
|
1911
|
+
},
|
|
1912
|
+
requiredParams: ["body"],
|
|
1913
|
+
operationId: "ves.io.schema.registration.CustomAPI.RegistrationCreate",
|
|
1914
|
+
tags: ["Other"],
|
|
1915
|
+
sourceFile: "domains/ce_management.json",
|
|
1916
|
+
displayName: null,
|
|
1917
|
+
dangerLevel: "medium",
|
|
1918
|
+
sideEffects: {
|
|
1919
|
+
creates: ["registerBootstrap"],
|
|
1920
|
+
},
|
|
1921
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
1922
|
+
cliExamples: [
|
|
1923
|
+
{
|
|
1924
|
+
command: "f5xcctl register registerBootstrap create -f {file}.yaml",
|
|
1925
|
+
description: "Create from YAML file",
|
|
1926
|
+
use_case: "file_based",
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
command: "f5xcctl register registerBootstrap create {name} --namespace {namespace}",
|
|
1930
|
+
description: "Create registerBootstrap",
|
|
1931
|
+
use_case: "basic_create",
|
|
1932
|
+
},
|
|
1933
|
+
],
|
|
1934
|
+
confirmationRequired: false,
|
|
1935
|
+
parameterExamples: {},
|
|
1936
|
+
validationRules: {},
|
|
1937
|
+
operationMetadata: {
|
|
1938
|
+
common_errors: [
|
|
1939
|
+
{
|
|
1940
|
+
code: 401,
|
|
1941
|
+
message: "Authentication required",
|
|
1942
|
+
solution: "Provide valid API credentials",
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
code: 403,
|
|
1946
|
+
message: "Permission denied",
|
|
1947
|
+
solution: "Check access permissions for this operation",
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
code: 404,
|
|
1951
|
+
message: "Resource not found",
|
|
1952
|
+
solution: "Verify resource name, namespace, and path",
|
|
1953
|
+
},
|
|
1954
|
+
{
|
|
1955
|
+
code: 409,
|
|
1956
|
+
message: "Resource already exists",
|
|
1957
|
+
solution: "Use different name or update existing resource",
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
code: 429,
|
|
1961
|
+
message: "Rate limit exceeded",
|
|
1962
|
+
solution: "Wait before retrying the operation",
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
code: 500,
|
|
1966
|
+
message: "Server error",
|
|
1967
|
+
solution: "Retry operation or contact support",
|
|
1968
|
+
},
|
|
1969
|
+
],
|
|
1970
|
+
conditions: {
|
|
1971
|
+
postconditions: [
|
|
1972
|
+
"Registerbootstrap resource created",
|
|
1973
|
+
"Resource assigned unique identifier",
|
|
1974
|
+
],
|
|
1975
|
+
prerequisites: [],
|
|
1976
|
+
},
|
|
1977
|
+
confirmation_required: false,
|
|
1978
|
+
danger_level: "medium",
|
|
1979
|
+
examples: [
|
|
1980
|
+
{
|
|
1981
|
+
command: "f5xcctl register registerBootstrap create {name} --namespace {namespace}",
|
|
1982
|
+
description: "Create registerBootstrap",
|
|
1983
|
+
use_case: "basic_create",
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
command: "f5xcctl register registerBootstrap create -f {file}.yaml",
|
|
1987
|
+
description: "Create from YAML file",
|
|
1988
|
+
use_case: "file_based",
|
|
1989
|
+
},
|
|
1990
|
+
],
|
|
1991
|
+
field_docs: {},
|
|
1992
|
+
optional_fields: [],
|
|
1993
|
+
performance_impact: {
|
|
1994
|
+
latency: "low",
|
|
1995
|
+
resource_usage: "low",
|
|
1996
|
+
},
|
|
1997
|
+
purpose: "Create new registerBootstrap",
|
|
1998
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
1999
|
+
side_effects: {
|
|
2000
|
+
creates: ["registerBootstrap"],
|
|
2001
|
+
},
|
|
2002
|
+
},
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
toolName: "f5xc-api-cemanagement-registration-create",
|
|
2006
|
+
method: "POST",
|
|
2007
|
+
path: "/api/register/namespaces/{metadata.namespace}/registrations",
|
|
2008
|
+
operation: "create",
|
|
2009
|
+
domain: "ce_management",
|
|
2010
|
+
resource: "registration",
|
|
2011
|
+
summary: "Create Registration.",
|
|
2012
|
+
description: "VPM creates registration using this message, never used by users.",
|
|
2013
|
+
pathParameters: [
|
|
2014
|
+
{
|
|
2015
|
+
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 ""',
|
|
2016
|
+
in: "path",
|
|
2017
|
+
name: "metadata.namespace",
|
|
2018
|
+
required: true,
|
|
2019
|
+
schema: {
|
|
2020
|
+
type: "string",
|
|
2021
|
+
},
|
|
2022
|
+
"x-displayname": "Namespace",
|
|
2023
|
+
"x-ves-example": "Staging",
|
|
2024
|
+
},
|
|
2025
|
+
],
|
|
2026
|
+
queryParameters: [],
|
|
2027
|
+
requestBodySchema: {
|
|
2028
|
+
$ref: "#/components/schemas/registrationCreateRequest",
|
|
2029
|
+
},
|
|
2030
|
+
responseSchema: {
|
|
2031
|
+
$ref: "#/components/schemas/registrationCreateResponse",
|
|
2032
|
+
},
|
|
2033
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
2034
|
+
operationId: "ves.io.schema.registration.API.Create",
|
|
2035
|
+
tags: ["Other"],
|
|
2036
|
+
sourceFile: "domains/ce_management.json",
|
|
2037
|
+
displayName: null,
|
|
2038
|
+
dangerLevel: "medium",
|
|
2039
|
+
sideEffects: {
|
|
2040
|
+
creates: ["registration"],
|
|
2041
|
+
},
|
|
2042
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2043
|
+
cliExamples: [
|
|
2044
|
+
{
|
|
2045
|
+
command: "f5xcctl register registration create -f {file}.yaml",
|
|
2046
|
+
description: "Create from YAML file",
|
|
2047
|
+
use_case: "file_based",
|
|
2048
|
+
},
|
|
2049
|
+
{
|
|
2050
|
+
command: "f5xcctl register registration create {name} --namespace {namespace}",
|
|
2051
|
+
description: "Create registration",
|
|
2052
|
+
use_case: "basic_create",
|
|
2053
|
+
},
|
|
2054
|
+
],
|
|
2055
|
+
confirmationRequired: false,
|
|
2056
|
+
parameterExamples: {
|
|
2057
|
+
"metadata.namespace": "Staging",
|
|
2058
|
+
},
|
|
2059
|
+
validationRules: {},
|
|
2060
|
+
operationMetadata: {
|
|
2061
|
+
common_errors: [
|
|
2062
|
+
{
|
|
2063
|
+
code: 401,
|
|
2064
|
+
message: "Authentication required",
|
|
2065
|
+
solution: "Provide valid API credentials",
|
|
2066
|
+
},
|
|
2067
|
+
{
|
|
2068
|
+
code: 403,
|
|
2069
|
+
message: "Permission denied",
|
|
2070
|
+
solution: "Check access permissions for this operation",
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
code: 404,
|
|
2074
|
+
message: "Resource not found",
|
|
2075
|
+
solution: "Verify resource name, namespace, and path",
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
code: 409,
|
|
2079
|
+
message: "Resource already exists",
|
|
2080
|
+
solution: "Use different name or update existing resource",
|
|
2081
|
+
},
|
|
2082
|
+
{
|
|
2083
|
+
code: 429,
|
|
2084
|
+
message: "Rate limit exceeded",
|
|
2085
|
+
solution: "Wait before retrying the operation",
|
|
2086
|
+
},
|
|
2087
|
+
{
|
|
2088
|
+
code: 500,
|
|
2089
|
+
message: "Server error",
|
|
2090
|
+
solution: "Retry operation or contact support",
|
|
2091
|
+
},
|
|
2092
|
+
],
|
|
2093
|
+
conditions: {
|
|
2094
|
+
postconditions: ["Registration resource created", "Resource assigned unique identifier"],
|
|
2095
|
+
prerequisites: ["Active namespace"],
|
|
2096
|
+
},
|
|
2097
|
+
confirmation_required: false,
|
|
2098
|
+
danger_level: "medium",
|
|
2099
|
+
examples: [
|
|
2100
|
+
{
|
|
2101
|
+
command: "f5xcctl register registration create {name} --namespace {namespace}",
|
|
2102
|
+
description: "Create registration",
|
|
2103
|
+
use_case: "basic_create",
|
|
2104
|
+
},
|
|
2105
|
+
{
|
|
2106
|
+
command: "f5xcctl register registration create -f {file}.yaml",
|
|
2107
|
+
description: "Create from YAML file",
|
|
2108
|
+
use_case: "file_based",
|
|
2109
|
+
},
|
|
2110
|
+
],
|
|
2111
|
+
field_docs: {},
|
|
2112
|
+
optional_fields: [],
|
|
2113
|
+
performance_impact: {
|
|
2114
|
+
latency: "low",
|
|
2115
|
+
resource_usage: "low",
|
|
2116
|
+
},
|
|
2117
|
+
purpose: "Create new registration",
|
|
2118
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2119
|
+
side_effects: {
|
|
2120
|
+
creates: ["registration"],
|
|
2121
|
+
},
|
|
2122
|
+
},
|
|
2123
|
+
},
|
|
2124
|
+
{
|
|
2125
|
+
toolName: "f5xc-api-cemanagement-registration-delete",
|
|
2126
|
+
method: "DELETE",
|
|
2127
|
+
path: "/api/register/namespaces/{namespace}/registrations/{name}",
|
|
2128
|
+
operation: "delete",
|
|
2129
|
+
domain: "ce_management",
|
|
2130
|
+
resource: "registration",
|
|
2131
|
+
summary: "DELETE Registration.",
|
|
2132
|
+
description: "DELETE the specified registration.",
|
|
2133
|
+
pathParameters: [
|
|
2134
|
+
{
|
|
2135
|
+
description: "Name\nName of the configuration object.",
|
|
2136
|
+
in: "path",
|
|
2137
|
+
name: "name",
|
|
2138
|
+
required: true,
|
|
2139
|
+
schema: {
|
|
2140
|
+
type: "string",
|
|
2141
|
+
},
|
|
2142
|
+
"x-displayname": "Name",
|
|
2143
|
+
"x-ves-example": "Name",
|
|
2144
|
+
},
|
|
2145
|
+
{
|
|
2146
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
2147
|
+
in: "path",
|
|
2148
|
+
name: "namespace",
|
|
2149
|
+
required: true,
|
|
2150
|
+
schema: {
|
|
2151
|
+
type: "string",
|
|
2152
|
+
},
|
|
2153
|
+
"x-displayname": "Namespace",
|
|
2154
|
+
"x-ves-example": "Ns1",
|
|
2155
|
+
},
|
|
2156
|
+
],
|
|
2157
|
+
queryParameters: [
|
|
2158
|
+
{
|
|
2159
|
+
description: "Fail the DELETE operation if this object is being referred by other objects.",
|
|
2160
|
+
in: "query",
|
|
2161
|
+
name: "fail_if_referred",
|
|
2162
|
+
required: false,
|
|
2163
|
+
schema: {
|
|
2164
|
+
format: "boolean",
|
|
2165
|
+
type: "boolean",
|
|
2166
|
+
},
|
|
2167
|
+
"x-displayname": "Fail-If-Referred.",
|
|
2168
|
+
},
|
|
2169
|
+
],
|
|
2170
|
+
requestBodySchema: null,
|
|
2171
|
+
responseSchema: {},
|
|
2172
|
+
requiredParams: ["name", "namespace"],
|
|
2173
|
+
operationId: "ves.io.schema.registration.CustomAPI.Delete",
|
|
2174
|
+
tags: ["Other"],
|
|
2175
|
+
sourceFile: "domains/ce_management.json",
|
|
2176
|
+
displayName: null,
|
|
2177
|
+
dangerLevel: "high",
|
|
2178
|
+
sideEffects: {
|
|
2179
|
+
deletes: ["registration", "contained_resources"],
|
|
2180
|
+
},
|
|
2181
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2182
|
+
cliExamples: [
|
|
2183
|
+
{
|
|
2184
|
+
command: "f5xcctl register registration delete {name} --namespace {namespace}",
|
|
2185
|
+
description: "Delete registration",
|
|
2186
|
+
use_case: "delete",
|
|
2187
|
+
},
|
|
2188
|
+
],
|
|
2189
|
+
confirmationRequired: true,
|
|
2190
|
+
parameterExamples: {
|
|
2191
|
+
name: "Name",
|
|
2192
|
+
namespace: "Ns1",
|
|
2193
|
+
},
|
|
2194
|
+
validationRules: {},
|
|
2195
|
+
operationMetadata: {
|
|
2196
|
+
common_errors: [
|
|
2197
|
+
{
|
|
2198
|
+
code: 401,
|
|
2199
|
+
message: "Authentication required",
|
|
2200
|
+
solution: "Provide valid API credentials",
|
|
2201
|
+
},
|
|
2202
|
+
{
|
|
2203
|
+
code: 403,
|
|
2204
|
+
message: "Permission denied",
|
|
2205
|
+
solution: "Check access permissions for this operation",
|
|
2206
|
+
},
|
|
2207
|
+
{
|
|
2208
|
+
code: 404,
|
|
2209
|
+
message: "Resource not found",
|
|
2210
|
+
solution: "Verify resource name, namespace, and path",
|
|
2211
|
+
},
|
|
2212
|
+
{
|
|
2213
|
+
code: 409,
|
|
2214
|
+
message: "Resource already exists",
|
|
2215
|
+
solution: "Use different name or update existing resource",
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
code: 429,
|
|
2219
|
+
message: "Rate limit exceeded",
|
|
2220
|
+
solution: "Wait before retrying the operation",
|
|
2221
|
+
},
|
|
2222
|
+
{
|
|
2223
|
+
code: 500,
|
|
2224
|
+
message: "Server error",
|
|
2225
|
+
solution: "Retry operation or contact support",
|
|
2226
|
+
},
|
|
2227
|
+
],
|
|
2228
|
+
conditions: {
|
|
2229
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2230
|
+
prerequisites: ["Active namespace"],
|
|
2231
|
+
},
|
|
2232
|
+
confirmation_required: true,
|
|
2233
|
+
danger_level: "high",
|
|
2234
|
+
examples: [
|
|
2235
|
+
{
|
|
2236
|
+
command: "f5xcctl register registration delete {name} --namespace {namespace}",
|
|
2237
|
+
description: "Delete registration",
|
|
2238
|
+
use_case: "delete",
|
|
2239
|
+
},
|
|
2240
|
+
],
|
|
2241
|
+
field_docs: {},
|
|
2242
|
+
optional_fields: [],
|
|
2243
|
+
performance_impact: {
|
|
2244
|
+
latency: "high",
|
|
2245
|
+
resource_usage: "moderate",
|
|
2246
|
+
},
|
|
2247
|
+
purpose: "Delete registration",
|
|
2248
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2249
|
+
side_effects: {
|
|
2250
|
+
deletes: ["registration", "contained_resources"],
|
|
2251
|
+
},
|
|
2252
|
+
},
|
|
2253
|
+
},
|
|
2254
|
+
{
|
|
2255
|
+
toolName: "f5xc-api-cemanagement-registration-get",
|
|
2256
|
+
method: "GET",
|
|
2257
|
+
path: "/api/register/namespaces/{namespace}/registrations/{name}",
|
|
2258
|
+
operation: "get",
|
|
2259
|
+
domain: "ce_management",
|
|
2260
|
+
resource: "registration",
|
|
2261
|
+
summary: "GET Registration.",
|
|
2262
|
+
description: "GET registration specification.",
|
|
2263
|
+
pathParameters: [
|
|
2264
|
+
{
|
|
2265
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2266
|
+
in: "path",
|
|
2267
|
+
name: "name",
|
|
2268
|
+
required: true,
|
|
2269
|
+
schema: {
|
|
2270
|
+
type: "string",
|
|
2271
|
+
},
|
|
2272
|
+
"x-displayname": "Name",
|
|
2273
|
+
"x-ves-example": "Name",
|
|
2274
|
+
},
|
|
2275
|
+
{
|
|
2276
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2277
|
+
in: "path",
|
|
2278
|
+
name: "namespace",
|
|
2279
|
+
required: true,
|
|
2280
|
+
schema: {
|
|
2281
|
+
type: "string",
|
|
2282
|
+
},
|
|
2283
|
+
"x-displayname": "Namespace",
|
|
2284
|
+
"x-ves-example": "Ns1",
|
|
2285
|
+
},
|
|
2286
|
+
],
|
|
2287
|
+
queryParameters: [
|
|
2288
|
+
{
|
|
2289
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
2290
|
+
in: "query",
|
|
2291
|
+
name: "response_format",
|
|
2292
|
+
required: false,
|
|
2293
|
+
schema: {
|
|
2294
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2295
|
+
enum: [
|
|
2296
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2297
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2298
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
2299
|
+
"GET_RSP_FORMAT_READ",
|
|
2300
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2301
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2302
|
+
],
|
|
2303
|
+
type: "string",
|
|
2304
|
+
},
|
|
2305
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2306
|
+
},
|
|
2307
|
+
],
|
|
2308
|
+
requestBodySchema: null,
|
|
2309
|
+
responseSchema: {
|
|
2310
|
+
$ref: "#/components/schemas/registrationGetResponse",
|
|
2311
|
+
},
|
|
2312
|
+
requiredParams: ["name", "namespace"],
|
|
2313
|
+
operationId: "ves.io.schema.registration.CustomAPI.Get",
|
|
2314
|
+
tags: ["Other"],
|
|
2315
|
+
sourceFile: "domains/ce_management.json",
|
|
2316
|
+
displayName: null,
|
|
2317
|
+
dangerLevel: "low",
|
|
2318
|
+
sideEffects: null,
|
|
2319
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2320
|
+
cliExamples: [
|
|
2321
|
+
{
|
|
2322
|
+
command: "f5xcctl register registration get {name} --namespace {namespace}",
|
|
2323
|
+
description: "Get specific registration",
|
|
2324
|
+
use_case: "get_specific",
|
|
2325
|
+
},
|
|
2326
|
+
],
|
|
2327
|
+
confirmationRequired: false,
|
|
2328
|
+
parameterExamples: {
|
|
2329
|
+
name: "Name",
|
|
2330
|
+
namespace: "Ns1",
|
|
2331
|
+
},
|
|
2332
|
+
validationRules: {},
|
|
2333
|
+
operationMetadata: {
|
|
2334
|
+
common_errors: [
|
|
2335
|
+
{
|
|
2336
|
+
code: 401,
|
|
2337
|
+
message: "Authentication required",
|
|
2338
|
+
solution: "Provide valid API credentials",
|
|
2339
|
+
},
|
|
2340
|
+
{
|
|
2341
|
+
code: 403,
|
|
2342
|
+
message: "Permission denied",
|
|
2343
|
+
solution: "Check access permissions for this operation",
|
|
2344
|
+
},
|
|
2345
|
+
{
|
|
2346
|
+
code: 404,
|
|
2347
|
+
message: "Resource not found",
|
|
2348
|
+
solution: "Verify resource name, namespace, and path",
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
code: 409,
|
|
2352
|
+
message: "Resource already exists",
|
|
2353
|
+
solution: "Use different name or update existing resource",
|
|
2354
|
+
},
|
|
2355
|
+
{
|
|
2356
|
+
code: 429,
|
|
2357
|
+
message: "Rate limit exceeded",
|
|
2358
|
+
solution: "Wait before retrying the operation",
|
|
2359
|
+
},
|
|
2360
|
+
{
|
|
2361
|
+
code: 500,
|
|
2362
|
+
message: "Server error",
|
|
2363
|
+
solution: "Retry operation or contact support",
|
|
2364
|
+
},
|
|
2365
|
+
],
|
|
2366
|
+
conditions: {
|
|
2367
|
+
postconditions: [],
|
|
2368
|
+
prerequisites: ["Active namespace"],
|
|
2369
|
+
},
|
|
2370
|
+
confirmation_required: false,
|
|
2371
|
+
danger_level: "low",
|
|
2372
|
+
examples: [
|
|
2373
|
+
{
|
|
2374
|
+
command: "f5xcctl register registration get {name} --namespace {namespace}",
|
|
2375
|
+
description: "Get specific registration",
|
|
2376
|
+
use_case: "get_specific",
|
|
2377
|
+
},
|
|
2378
|
+
],
|
|
2379
|
+
field_docs: {},
|
|
2380
|
+
optional_fields: [],
|
|
2381
|
+
performance_impact: {
|
|
2382
|
+
latency: "low",
|
|
2383
|
+
resource_usage: "low",
|
|
2384
|
+
},
|
|
2385
|
+
purpose: "Retrieve specific registration",
|
|
2386
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2387
|
+
side_effects: {},
|
|
2388
|
+
},
|
|
2389
|
+
},
|
|
2390
|
+
{
|
|
2391
|
+
toolName: "f5xc-api-cemanagement-registration-list",
|
|
2392
|
+
method: "GET",
|
|
2393
|
+
path: "/api/register/namespaces/{namespace}/registrations",
|
|
2394
|
+
operation: "list",
|
|
2395
|
+
domain: "ce_management",
|
|
2396
|
+
resource: "registration",
|
|
2397
|
+
summary: "List Registration.",
|
|
2398
|
+
description: "List the set of registration in a namespace.",
|
|
2399
|
+
pathParameters: [
|
|
2400
|
+
{
|
|
2401
|
+
description: "Namespace\nNamespace to scope the listing of registration.",
|
|
2402
|
+
in: "path",
|
|
2403
|
+
name: "namespace",
|
|
2404
|
+
required: true,
|
|
2405
|
+
schema: {
|
|
2406
|
+
type: "string",
|
|
2407
|
+
},
|
|
2408
|
+
"x-displayname": "Namespace",
|
|
2409
|
+
"x-ves-example": "Ns1",
|
|
2410
|
+
},
|
|
2411
|
+
],
|
|
2412
|
+
queryParameters: [
|
|
2413
|
+
{
|
|
2414
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2415
|
+
in: "query",
|
|
2416
|
+
name: "label_filter",
|
|
2417
|
+
required: false,
|
|
2418
|
+
schema: {
|
|
2419
|
+
type: "string",
|
|
2420
|
+
},
|
|
2421
|
+
"x-displayname": "Label Filter.",
|
|
2422
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2423
|
+
},
|
|
2424
|
+
{
|
|
2425
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2426
|
+
in: "query",
|
|
2427
|
+
name: "report_fields",
|
|
2428
|
+
required: false,
|
|
2429
|
+
schema: {
|
|
2430
|
+
items: {
|
|
2431
|
+
type: "string",
|
|
2432
|
+
},
|
|
2433
|
+
type: "array",
|
|
2434
|
+
},
|
|
2435
|
+
"x-displayname": "Report Fields.",
|
|
2436
|
+
},
|
|
2437
|
+
{
|
|
2438
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2439
|
+
in: "query",
|
|
2440
|
+
name: "report_status_fields",
|
|
2441
|
+
required: false,
|
|
2442
|
+
schema: {
|
|
2443
|
+
items: {
|
|
2444
|
+
type: "string",
|
|
2445
|
+
},
|
|
2446
|
+
type: "array",
|
|
2447
|
+
},
|
|
2448
|
+
"x-displayname": "Report Status Fields.",
|
|
2449
|
+
},
|
|
2450
|
+
],
|
|
2451
|
+
requestBodySchema: null,
|
|
2452
|
+
responseSchema: {
|
|
2453
|
+
$ref: "#/components/schemas/registrationListResponse",
|
|
2454
|
+
},
|
|
2455
|
+
requiredParams: ["namespace"],
|
|
2456
|
+
operationId: "ves.io.schema.registration.CustomAPI.List",
|
|
2457
|
+
tags: ["Other"],
|
|
2458
|
+
sourceFile: "domains/ce_management.json",
|
|
2459
|
+
displayName: null,
|
|
2460
|
+
dangerLevel: "low",
|
|
2461
|
+
sideEffects: null,
|
|
2462
|
+
requiredFields: ["path.namespace"],
|
|
2463
|
+
cliExamples: [
|
|
2464
|
+
{
|
|
2465
|
+
command: "f5xcctl register registration list --namespace {namespace}",
|
|
2466
|
+
description: "List all registrations",
|
|
2467
|
+
use_case: "list_all",
|
|
2468
|
+
},
|
|
2469
|
+
],
|
|
2470
|
+
confirmationRequired: false,
|
|
2471
|
+
parameterExamples: {
|
|
2472
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2473
|
+
namespace: "Ns1",
|
|
2474
|
+
},
|
|
2475
|
+
validationRules: {},
|
|
2476
|
+
operationMetadata: {
|
|
2477
|
+
common_errors: [
|
|
2478
|
+
{
|
|
2479
|
+
code: 401,
|
|
2480
|
+
message: "Authentication required",
|
|
2481
|
+
solution: "Provide valid API credentials",
|
|
2482
|
+
},
|
|
2483
|
+
{
|
|
2484
|
+
code: 403,
|
|
2485
|
+
message: "Permission denied",
|
|
2486
|
+
solution: "Check access permissions for this operation",
|
|
2487
|
+
},
|
|
2488
|
+
{
|
|
2489
|
+
code: 404,
|
|
2490
|
+
message: "Resource not found",
|
|
2491
|
+
solution: "Verify resource name, namespace, and path",
|
|
2492
|
+
},
|
|
2493
|
+
{
|
|
2494
|
+
code: 409,
|
|
2495
|
+
message: "Resource already exists",
|
|
2496
|
+
solution: "Use different name or update existing resource",
|
|
2497
|
+
},
|
|
2498
|
+
{
|
|
2499
|
+
code: 429,
|
|
2500
|
+
message: "Rate limit exceeded",
|
|
2501
|
+
solution: "Wait before retrying the operation",
|
|
2502
|
+
},
|
|
2503
|
+
{
|
|
2504
|
+
code: 500,
|
|
2505
|
+
message: "Server error",
|
|
2506
|
+
solution: "Retry operation or contact support",
|
|
2507
|
+
},
|
|
2508
|
+
],
|
|
2509
|
+
conditions: {
|
|
2510
|
+
postconditions: [],
|
|
2511
|
+
prerequisites: ["Active namespace"],
|
|
2512
|
+
},
|
|
2513
|
+
confirmation_required: false,
|
|
2514
|
+
danger_level: "low",
|
|
2515
|
+
examples: [
|
|
2516
|
+
{
|
|
2517
|
+
command: "f5xcctl register registration list --namespace {namespace}",
|
|
2518
|
+
description: "List all registrations",
|
|
2519
|
+
use_case: "list_all",
|
|
2520
|
+
},
|
|
2521
|
+
],
|
|
2522
|
+
field_docs: {},
|
|
2523
|
+
optional_fields: [],
|
|
2524
|
+
performance_impact: {
|
|
2525
|
+
latency: "moderate",
|
|
2526
|
+
resource_usage: "moderate",
|
|
2527
|
+
},
|
|
2528
|
+
purpose: "List all registrations",
|
|
2529
|
+
required_fields: ["path.namespace"],
|
|
2530
|
+
side_effects: {},
|
|
2531
|
+
},
|
|
2532
|
+
},
|
|
2533
|
+
{
|
|
2534
|
+
toolName: "f5xc-api-cemanagement-registration-update",
|
|
2535
|
+
method: "PUT",
|
|
2536
|
+
path: "/api/register/namespaces/{metadata.namespace}/registrations/{metadata.name}",
|
|
2537
|
+
operation: "update",
|
|
2538
|
+
domain: "ce_management",
|
|
2539
|
+
resource: "registration",
|
|
2540
|
+
summary: "Replace Registration.",
|
|
2541
|
+
description: "NO fields are allowed to be replaced.",
|
|
2542
|
+
pathParameters: [
|
|
2543
|
+
{
|
|
2544
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
2545
|
+
in: "path",
|
|
2546
|
+
name: "metadata.name",
|
|
2547
|
+
required: true,
|
|
2548
|
+
schema: {
|
|
2549
|
+
type: "string",
|
|
2550
|
+
},
|
|
2551
|
+
"x-displayname": "Name",
|
|
2552
|
+
"x-ves-example": "Example-corp-web.",
|
|
2553
|
+
},
|
|
2554
|
+
{
|
|
2555
|
+
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 ""',
|
|
2556
|
+
in: "path",
|
|
2557
|
+
name: "metadata.namespace",
|
|
2558
|
+
required: true,
|
|
2559
|
+
schema: {
|
|
2560
|
+
type: "string",
|
|
2561
|
+
},
|
|
2562
|
+
"x-displayname": "Namespace",
|
|
2563
|
+
"x-ves-example": "Staging",
|
|
2564
|
+
},
|
|
2565
|
+
],
|
|
2566
|
+
queryParameters: [],
|
|
2567
|
+
requestBodySchema: {
|
|
2568
|
+
$ref: "#/components/schemas/registrationReplaceRequest",
|
|
2569
|
+
},
|
|
2570
|
+
responseSchema: {
|
|
2571
|
+
$ref: "#/components/schemas/registrationReplaceResponse",
|
|
2572
|
+
},
|
|
2573
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
2574
|
+
operationId: "ves.io.schema.registration.API.Replace",
|
|
2575
|
+
tags: ["Other"],
|
|
2576
|
+
sourceFile: "domains/ce_management.json",
|
|
2577
|
+
displayName: null,
|
|
2578
|
+
dangerLevel: "medium",
|
|
2579
|
+
sideEffects: {
|
|
2580
|
+
modifies: ["registration"],
|
|
2581
|
+
},
|
|
2582
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2583
|
+
cliExamples: [
|
|
2584
|
+
{
|
|
2585
|
+
command: "f5xcctl register registration update {name} --namespace {namespace} -f {file}.yaml",
|
|
2586
|
+
description: "Update registration",
|
|
2587
|
+
use_case: "update",
|
|
2588
|
+
},
|
|
2589
|
+
],
|
|
2590
|
+
confirmationRequired: false,
|
|
2591
|
+
parameterExamples: {
|
|
2592
|
+
"metadata.name": "Example-corp-web.",
|
|
2593
|
+
"metadata.namespace": "Staging",
|
|
2594
|
+
},
|
|
2595
|
+
validationRules: {},
|
|
2596
|
+
operationMetadata: {
|
|
2597
|
+
common_errors: [
|
|
2598
|
+
{
|
|
2599
|
+
code: 401,
|
|
2600
|
+
message: "Authentication required",
|
|
2601
|
+
solution: "Provide valid API credentials",
|
|
2602
|
+
},
|
|
2603
|
+
{
|
|
2604
|
+
code: 403,
|
|
2605
|
+
message: "Permission denied",
|
|
2606
|
+
solution: "Check access permissions for this operation",
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
code: 404,
|
|
2610
|
+
message: "Resource not found",
|
|
2611
|
+
solution: "Verify resource name, namespace, and path",
|
|
2612
|
+
},
|
|
2613
|
+
{
|
|
2614
|
+
code: 409,
|
|
2615
|
+
message: "Resource already exists",
|
|
2616
|
+
solution: "Use different name or update existing resource",
|
|
2617
|
+
},
|
|
2618
|
+
{
|
|
2619
|
+
code: 429,
|
|
2620
|
+
message: "Rate limit exceeded",
|
|
2621
|
+
solution: "Wait before retrying the operation",
|
|
2622
|
+
},
|
|
2623
|
+
{
|
|
2624
|
+
code: 500,
|
|
2625
|
+
message: "Server error",
|
|
2626
|
+
solution: "Retry operation or contact support",
|
|
2627
|
+
},
|
|
2628
|
+
],
|
|
2629
|
+
conditions: {
|
|
2630
|
+
postconditions: ["Resource updated with new values"],
|
|
2631
|
+
prerequisites: ["Active namespace"],
|
|
2632
|
+
},
|
|
2633
|
+
confirmation_required: false,
|
|
2634
|
+
danger_level: "medium",
|
|
2635
|
+
examples: [
|
|
2636
|
+
{
|
|
2637
|
+
command: "f5xcctl register registration update {name} --namespace {namespace} -f {file}.yaml",
|
|
2638
|
+
description: "Update registration",
|
|
2639
|
+
use_case: "update",
|
|
2640
|
+
},
|
|
2641
|
+
],
|
|
2642
|
+
field_docs: {},
|
|
2643
|
+
optional_fields: [],
|
|
2644
|
+
performance_impact: {
|
|
2645
|
+
latency: "low",
|
|
2646
|
+
resource_usage: "low",
|
|
2647
|
+
},
|
|
2648
|
+
purpose: "Replace existing registration",
|
|
2649
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2650
|
+
side_effects: {
|
|
2651
|
+
modifies: ["registration"],
|
|
2652
|
+
},
|
|
2653
|
+
},
|
|
2654
|
+
},
|
|
2655
|
+
{
|
|
2656
|
+
toolName: "f5xc-api-cemanagement-registrations-by-site-list",
|
|
2657
|
+
method: "GET",
|
|
2658
|
+
path: "/api/register/namespaces/{namespace}/registrations_by_site/{site_name}",
|
|
2659
|
+
operation: "list",
|
|
2660
|
+
domain: "ce_management",
|
|
2661
|
+
resource: "registrations-by-site",
|
|
2662
|
+
summary: "List registrations by site.",
|
|
2663
|
+
description: "List all registration in site.",
|
|
2664
|
+
pathParameters: [
|
|
2665
|
+
{
|
|
2666
|
+
description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
|
|
2667
|
+
in: "path",
|
|
2668
|
+
name: "namespace",
|
|
2669
|
+
required: true,
|
|
2670
|
+
schema: {
|
|
2671
|
+
type: "string",
|
|
2672
|
+
},
|
|
2673
|
+
"x-displayname": "Namespace",
|
|
2674
|
+
"x-ves-example": "System",
|
|
2675
|
+
},
|
|
2676
|
+
{
|
|
2677
|
+
description: "SiteName\n\nx-required\nSite name to be used for registration filtering.",
|
|
2678
|
+
in: "path",
|
|
2679
|
+
name: "site_name",
|
|
2680
|
+
required: true,
|
|
2681
|
+
schema: {
|
|
2682
|
+
type: "string",
|
|
2683
|
+
},
|
|
2684
|
+
"x-displayname": "Site name",
|
|
2685
|
+
"x-ves-example": "Ce02",
|
|
2686
|
+
},
|
|
2687
|
+
],
|
|
2688
|
+
queryParameters: [],
|
|
2689
|
+
requestBodySchema: null,
|
|
2690
|
+
responseSchema: {
|
|
2691
|
+
$ref: "#/components/schemas/registrationListResponse",
|
|
2692
|
+
},
|
|
2693
|
+
requiredParams: ["namespace", "site_name"],
|
|
2694
|
+
operationId: "ves.io.schema.registration.CustomAPI.ListRegistrationsBySite",
|
|
2695
|
+
tags: ["Other"],
|
|
2696
|
+
sourceFile: "domains/ce_management.json",
|
|
2697
|
+
displayName: null,
|
|
2698
|
+
dangerLevel: "low",
|
|
2699
|
+
sideEffects: null,
|
|
2700
|
+
requiredFields: ["path.namespace", "path.site_name"],
|
|
2701
|
+
cliExamples: [
|
|
2702
|
+
{
|
|
2703
|
+
command: "f5xcctl register registrations-by-site list --namespace {namespace}",
|
|
2704
|
+
description: "List all registrations-by-sites",
|
|
2705
|
+
use_case: "list_all",
|
|
2706
|
+
},
|
|
2707
|
+
],
|
|
2708
|
+
confirmationRequired: false,
|
|
2709
|
+
parameterExamples: {
|
|
2710
|
+
namespace: "System",
|
|
2711
|
+
site_name: "Ce02",
|
|
2712
|
+
},
|
|
2713
|
+
validationRules: {},
|
|
2714
|
+
operationMetadata: {
|
|
2715
|
+
common_errors: [
|
|
2716
|
+
{
|
|
2717
|
+
code: 401,
|
|
2718
|
+
message: "Authentication required",
|
|
2719
|
+
solution: "Provide valid API credentials",
|
|
2720
|
+
},
|
|
2721
|
+
{
|
|
2722
|
+
code: 403,
|
|
2723
|
+
message: "Permission denied",
|
|
2724
|
+
solution: "Check access permissions for this operation",
|
|
2725
|
+
},
|
|
2726
|
+
{
|
|
2727
|
+
code: 404,
|
|
2728
|
+
message: "Resource not found",
|
|
2729
|
+
solution: "Verify resource name, namespace, and path",
|
|
2730
|
+
},
|
|
2731
|
+
{
|
|
2732
|
+
code: 409,
|
|
2733
|
+
message: "Resource already exists",
|
|
2734
|
+
solution: "Use different name or update existing resource",
|
|
2735
|
+
},
|
|
2736
|
+
{
|
|
2737
|
+
code: 429,
|
|
2738
|
+
message: "Rate limit exceeded",
|
|
2739
|
+
solution: "Wait before retrying the operation",
|
|
2740
|
+
},
|
|
2741
|
+
{
|
|
2742
|
+
code: 500,
|
|
2743
|
+
message: "Server error",
|
|
2744
|
+
solution: "Retry operation or contact support",
|
|
2745
|
+
},
|
|
2746
|
+
],
|
|
2747
|
+
conditions: {
|
|
2748
|
+
postconditions: [],
|
|
2749
|
+
prerequisites: ["Active namespace"],
|
|
2750
|
+
},
|
|
2751
|
+
confirmation_required: false,
|
|
2752
|
+
danger_level: "low",
|
|
2753
|
+
examples: [
|
|
2754
|
+
{
|
|
2755
|
+
command: "f5xcctl register registrations-by-site list --namespace {namespace}",
|
|
2756
|
+
description: "List all registrations-by-sites",
|
|
2757
|
+
use_case: "list_all",
|
|
2758
|
+
},
|
|
2759
|
+
],
|
|
2760
|
+
field_docs: {},
|
|
2761
|
+
optional_fields: [],
|
|
2762
|
+
performance_impact: {
|
|
2763
|
+
latency: "low",
|
|
2764
|
+
resource_usage: "low",
|
|
2765
|
+
},
|
|
2766
|
+
purpose: "List all registrations-by-sites",
|
|
2767
|
+
required_fields: ["path.namespace", "path.site_name"],
|
|
2768
|
+
side_effects: {},
|
|
2769
|
+
},
|
|
2770
|
+
},
|
|
2771
|
+
{
|
|
2772
|
+
toolName: "f5xc-api-cemanagement-requestconfig-create",
|
|
2773
|
+
method: "POST",
|
|
2774
|
+
path: "/api/register/requestConfig",
|
|
2775
|
+
operation: "create",
|
|
2776
|
+
domain: "ce_management",
|
|
2777
|
+
resource: "requestConfig",
|
|
2778
|
+
summary: "Registration Config.",
|
|
2779
|
+
description: "API endpoint for returning configuration for admitted registrations.\nIt will fail with known error for non-ADMITTED registration.",
|
|
2780
|
+
pathParameters: [],
|
|
2781
|
+
queryParameters: [],
|
|
2782
|
+
requestBodySchema: {
|
|
2783
|
+
$ref: "#/components/schemas/registrationConfigReq",
|
|
2784
|
+
},
|
|
2785
|
+
responseSchema: {
|
|
2786
|
+
$ref: "#/components/schemas/registrationConfigResp",
|
|
2787
|
+
},
|
|
2788
|
+
requiredParams: ["body"],
|
|
2789
|
+
operationId: "ves.io.schema.registration.CustomAPI.RegistrationConfig",
|
|
2790
|
+
tags: ["Other"],
|
|
2791
|
+
sourceFile: "domains/ce_management.json",
|
|
2792
|
+
displayName: null,
|
|
2793
|
+
dangerLevel: "medium",
|
|
2794
|
+
sideEffects: {
|
|
2795
|
+
creates: ["requestConfig"],
|
|
2796
|
+
},
|
|
2797
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2798
|
+
cliExamples: [
|
|
2799
|
+
{
|
|
2800
|
+
command: "f5xcctl register requestConfig create -f {file}.yaml",
|
|
2801
|
+
description: "Create from YAML file",
|
|
2802
|
+
use_case: "file_based",
|
|
2803
|
+
},
|
|
2804
|
+
{
|
|
2805
|
+
command: "f5xcctl register requestConfig create {name} --namespace {namespace}",
|
|
2806
|
+
description: "Create requestConfig",
|
|
2807
|
+
use_case: "basic_create",
|
|
2808
|
+
},
|
|
2809
|
+
],
|
|
2810
|
+
confirmationRequired: false,
|
|
2811
|
+
parameterExamples: {},
|
|
2812
|
+
validationRules: {},
|
|
2813
|
+
operationMetadata: {
|
|
2814
|
+
common_errors: [
|
|
2815
|
+
{
|
|
2816
|
+
code: 401,
|
|
2817
|
+
message: "Authentication required",
|
|
2818
|
+
solution: "Provide valid API credentials",
|
|
2819
|
+
},
|
|
2820
|
+
{
|
|
2821
|
+
code: 403,
|
|
2822
|
+
message: "Permission denied",
|
|
2823
|
+
solution: "Check access permissions for this operation",
|
|
2824
|
+
},
|
|
2825
|
+
{
|
|
2826
|
+
code: 404,
|
|
2827
|
+
message: "Resource not found",
|
|
2828
|
+
solution: "Verify resource name, namespace, and path",
|
|
2829
|
+
},
|
|
2830
|
+
{
|
|
2831
|
+
code: 409,
|
|
2832
|
+
message: "Resource already exists",
|
|
2833
|
+
solution: "Use different name or update existing resource",
|
|
2834
|
+
},
|
|
2835
|
+
{
|
|
2836
|
+
code: 429,
|
|
2837
|
+
message: "Rate limit exceeded",
|
|
2838
|
+
solution: "Wait before retrying the operation",
|
|
2839
|
+
},
|
|
2840
|
+
{
|
|
2841
|
+
code: 500,
|
|
2842
|
+
message: "Server error",
|
|
2843
|
+
solution: "Retry operation or contact support",
|
|
2844
|
+
},
|
|
2845
|
+
],
|
|
2846
|
+
conditions: {
|
|
2847
|
+
postconditions: ["Requestconfig resource created", "Resource assigned unique identifier"],
|
|
2848
|
+
prerequisites: [],
|
|
2849
|
+
},
|
|
2850
|
+
confirmation_required: false,
|
|
2851
|
+
danger_level: "medium",
|
|
2852
|
+
examples: [
|
|
2853
|
+
{
|
|
2854
|
+
command: "f5xcctl register requestConfig create {name} --namespace {namespace}",
|
|
2855
|
+
description: "Create requestConfig",
|
|
2856
|
+
use_case: "basic_create",
|
|
2857
|
+
},
|
|
2858
|
+
{
|
|
2859
|
+
command: "f5xcctl register requestConfig create -f {file}.yaml",
|
|
2860
|
+
description: "Create from YAML file",
|
|
2861
|
+
use_case: "file_based",
|
|
2862
|
+
},
|
|
2863
|
+
],
|
|
2864
|
+
field_docs: {},
|
|
2865
|
+
optional_fields: [],
|
|
2866
|
+
performance_impact: {
|
|
2867
|
+
latency: "low",
|
|
2868
|
+
resource_usage: "low",
|
|
2869
|
+
},
|
|
2870
|
+
purpose: "Create new requestConfig",
|
|
2871
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2872
|
+
side_effects: {
|
|
2873
|
+
creates: ["requestConfig"],
|
|
2874
|
+
},
|
|
2875
|
+
},
|
|
2876
|
+
},
|
|
2877
|
+
{
|
|
2878
|
+
toolName: "f5xc-api-cemanagement-setting-list",
|
|
2879
|
+
method: "GET",
|
|
2880
|
+
path: "/api/config/namespaces/{namespace}/module_management/settings",
|
|
2881
|
+
operation: "list",
|
|
2882
|
+
domain: "ce_management",
|
|
2883
|
+
resource: "setting",
|
|
2884
|
+
summary: "Module Management Settings.",
|
|
2885
|
+
description: "Receive the module settings.",
|
|
2886
|
+
pathParameters: [
|
|
2887
|
+
{
|
|
2888
|
+
description: "Namespace\nThe namespace this item belongs to.",
|
|
2889
|
+
in: "path",
|
|
2890
|
+
name: "namespace",
|
|
2891
|
+
required: true,
|
|
2892
|
+
schema: {
|
|
2893
|
+
type: "string",
|
|
2894
|
+
},
|
|
2895
|
+
"x-displayname": "Namespace",
|
|
2896
|
+
"x-ves-example": "Ns1",
|
|
2897
|
+
},
|
|
2898
|
+
],
|
|
2899
|
+
queryParameters: [],
|
|
2900
|
+
requestBodySchema: null,
|
|
2901
|
+
responseSchema: {
|
|
2902
|
+
$ref: "#/components/schemas/module_managementModuleManagementResponse",
|
|
2903
|
+
},
|
|
2904
|
+
requiredParams: ["namespace"],
|
|
2905
|
+
operationId: "ves.io.schema.module_management.ModuleManagementAPI.GetModuleManagementSettings",
|
|
2906
|
+
tags: ["Infrastructure"],
|
|
2907
|
+
sourceFile: "domains/ce_management.json",
|
|
2908
|
+
displayName: null,
|
|
2909
|
+
dangerLevel: "low",
|
|
2910
|
+
sideEffects: null,
|
|
2911
|
+
requiredFields: ["path.namespace"],
|
|
2912
|
+
cliExamples: [
|
|
2913
|
+
{
|
|
2914
|
+
command: "f5xcctl config setting list --namespace {namespace}",
|
|
2915
|
+
description: "List all settings",
|
|
2916
|
+
use_case: "list_all",
|
|
2917
|
+
},
|
|
2918
|
+
],
|
|
2919
|
+
confirmationRequired: false,
|
|
2920
|
+
parameterExamples: {
|
|
2921
|
+
namespace: "Ns1",
|
|
2922
|
+
},
|
|
2923
|
+
validationRules: {},
|
|
2924
|
+
operationMetadata: {
|
|
2925
|
+
common_errors: [
|
|
2926
|
+
{
|
|
2927
|
+
code: 401,
|
|
2928
|
+
message: "Authentication required",
|
|
2929
|
+
solution: "Provide valid API credentials",
|
|
2930
|
+
},
|
|
2931
|
+
{
|
|
2932
|
+
code: 403,
|
|
2933
|
+
message: "Permission denied",
|
|
2934
|
+
solution: "Check access permissions for this operation",
|
|
2935
|
+
},
|
|
2936
|
+
{
|
|
2937
|
+
code: 404,
|
|
2938
|
+
message: "Resource not found",
|
|
2939
|
+
solution: "Verify resource name, namespace, and path",
|
|
2940
|
+
},
|
|
2941
|
+
{
|
|
2942
|
+
code: 409,
|
|
2943
|
+
message: "Resource already exists",
|
|
2944
|
+
solution: "Use different name or update existing resource",
|
|
2945
|
+
},
|
|
2946
|
+
{
|
|
2947
|
+
code: 429,
|
|
2948
|
+
message: "Rate limit exceeded",
|
|
2949
|
+
solution: "Wait before retrying the operation",
|
|
2950
|
+
},
|
|
2951
|
+
{
|
|
2952
|
+
code: 500,
|
|
2953
|
+
message: "Server error",
|
|
2954
|
+
solution: "Retry operation or contact support",
|
|
2955
|
+
},
|
|
2956
|
+
],
|
|
2957
|
+
conditions: {
|
|
2958
|
+
postconditions: [],
|
|
2959
|
+
prerequisites: ["Active namespace"],
|
|
2960
|
+
},
|
|
2961
|
+
confirmation_required: false,
|
|
2962
|
+
danger_level: "low",
|
|
2963
|
+
examples: [
|
|
2964
|
+
{
|
|
2965
|
+
command: "f5xcctl config setting list --namespace {namespace}",
|
|
2966
|
+
description: "List all settings",
|
|
2967
|
+
use_case: "list_all",
|
|
2968
|
+
},
|
|
2969
|
+
],
|
|
2970
|
+
field_docs: {},
|
|
2971
|
+
optional_fields: [],
|
|
2972
|
+
performance_impact: {
|
|
2973
|
+
latency: "moderate",
|
|
2974
|
+
resource_usage: "moderate",
|
|
2975
|
+
},
|
|
2976
|
+
purpose: "List all settings",
|
|
2977
|
+
required_fields: ["path.namespace"],
|
|
2978
|
+
side_effects: {},
|
|
2979
|
+
},
|
|
2980
|
+
},
|
|
2981
|
+
{
|
|
2982
|
+
toolName: "f5xc-api-cemanagement-suggest-value-create",
|
|
2983
|
+
method: "POST",
|
|
2984
|
+
path: "/api/register/namespaces/system/suggest-values",
|
|
2985
|
+
operation: "create",
|
|
2986
|
+
domain: "ce_management",
|
|
2987
|
+
resource: "suggest-value",
|
|
2988
|
+
summary: "Suggest Values.",
|
|
2989
|
+
description: "Returns suggested values for the specified field in the given Create/Replace/Custom request.",
|
|
2990
|
+
pathParameters: [],
|
|
2991
|
+
queryParameters: [],
|
|
2992
|
+
requestBodySchema: {
|
|
2993
|
+
$ref: "#/components/schemas/registrationSuggestValuesReq",
|
|
2994
|
+
},
|
|
2995
|
+
responseSchema: {
|
|
2996
|
+
$ref: "#/components/schemas/schemaregistrationSuggestValuesResp",
|
|
2997
|
+
},
|
|
2998
|
+
requiredParams: ["body"],
|
|
2999
|
+
operationId: "ves.io.schema.registration.CustomAPI.SuggestValues",
|
|
3000
|
+
tags: ["Other"],
|
|
3001
|
+
sourceFile: "domains/ce_management.json",
|
|
3002
|
+
displayName: null,
|
|
3003
|
+
dangerLevel: "medium",
|
|
3004
|
+
sideEffects: {
|
|
3005
|
+
creates: ["suggest-value"],
|
|
3006
|
+
},
|
|
3007
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
3008
|
+
cliExamples: [
|
|
3009
|
+
{
|
|
3010
|
+
command: "f5xcctl register suggest-value create -f {file}.yaml",
|
|
3011
|
+
description: "Create from YAML file",
|
|
3012
|
+
use_case: "file_based",
|
|
3013
|
+
},
|
|
3014
|
+
{
|
|
3015
|
+
command: "f5xcctl register suggest-value create {name} --namespace {namespace}",
|
|
3016
|
+
description: "Create suggest-value",
|
|
3017
|
+
use_case: "basic_create",
|
|
3018
|
+
},
|
|
3019
|
+
],
|
|
3020
|
+
confirmationRequired: false,
|
|
3021
|
+
parameterExamples: {},
|
|
3022
|
+
validationRules: {},
|
|
3023
|
+
operationMetadata: {
|
|
3024
|
+
common_errors: [
|
|
3025
|
+
{
|
|
3026
|
+
code: 401,
|
|
3027
|
+
message: "Authentication required",
|
|
3028
|
+
solution: "Provide valid API credentials",
|
|
3029
|
+
},
|
|
3030
|
+
{
|
|
3031
|
+
code: 403,
|
|
3032
|
+
message: "Permission denied",
|
|
3033
|
+
solution: "Check access permissions for this operation",
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
code: 404,
|
|
3037
|
+
message: "Resource not found",
|
|
3038
|
+
solution: "Verify resource name, namespace, and path",
|
|
3039
|
+
},
|
|
3040
|
+
{
|
|
3041
|
+
code: 409,
|
|
3042
|
+
message: "Resource already exists",
|
|
3043
|
+
solution: "Use different name or update existing resource",
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
code: 429,
|
|
3047
|
+
message: "Rate limit exceeded",
|
|
3048
|
+
solution: "Wait before retrying the operation",
|
|
3049
|
+
},
|
|
3050
|
+
{
|
|
3051
|
+
code: 500,
|
|
3052
|
+
message: "Server error",
|
|
3053
|
+
solution: "Retry operation or contact support",
|
|
3054
|
+
},
|
|
3055
|
+
],
|
|
3056
|
+
conditions: {
|
|
3057
|
+
postconditions: ["Suggest-value resource created", "Resource assigned unique identifier"],
|
|
3058
|
+
prerequisites: ["Active namespace"],
|
|
3059
|
+
},
|
|
3060
|
+
confirmation_required: false,
|
|
3061
|
+
danger_level: "medium",
|
|
3062
|
+
examples: [
|
|
3063
|
+
{
|
|
3064
|
+
command: "f5xcctl register suggest-value create {name} --namespace {namespace}",
|
|
3065
|
+
description: "Create suggest-value",
|
|
3066
|
+
use_case: "basic_create",
|
|
3067
|
+
},
|
|
3068
|
+
{
|
|
3069
|
+
command: "f5xcctl register suggest-value create -f {file}.yaml",
|
|
3070
|
+
description: "Create from YAML file",
|
|
3071
|
+
use_case: "file_based",
|
|
3072
|
+
},
|
|
3073
|
+
],
|
|
3074
|
+
field_docs: {},
|
|
3075
|
+
optional_fields: [],
|
|
3076
|
+
performance_impact: {
|
|
3077
|
+
latency: "low",
|
|
3078
|
+
resource_usage: "low",
|
|
3079
|
+
},
|
|
3080
|
+
purpose: "Create new suggest-value",
|
|
3081
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
3082
|
+
side_effects: {
|
|
3083
|
+
creates: ["suggest-value"],
|
|
3084
|
+
},
|
|
3085
|
+
},
|
|
3086
|
+
},
|
|
3087
|
+
{
|
|
3088
|
+
toolName: "f5xc-api-cemanagement-upgradable-sw-version-list",
|
|
3089
|
+
method: "GET",
|
|
3090
|
+
path: "/api/maurice/upgradable_sw_versions",
|
|
3091
|
+
operation: "list",
|
|
3092
|
+
domain: "ce_management",
|
|
3093
|
+
resource: "upgradable-sw-version",
|
|
3094
|
+
summary: "GET Upgradable SW Versions.",
|
|
3095
|
+
description: "API to GET list of sw versions that can be upgraded to.",
|
|
3096
|
+
pathParameters: [],
|
|
3097
|
+
queryParameters: [
|
|
3098
|
+
{
|
|
3099
|
+
description: "Fetch upgradable sw versions for site.",
|
|
3100
|
+
in: "query",
|
|
3101
|
+
name: "current_os_version",
|
|
3102
|
+
required: false,
|
|
3103
|
+
schema: {
|
|
3104
|
+
type: "string",
|
|
3105
|
+
},
|
|
3106
|
+
"x-displayname": "Current OS Version.",
|
|
3107
|
+
"x-ves-example": "9.2023.23",
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
description: "Fetch upgradable sw versions for site.",
|
|
3111
|
+
in: "query",
|
|
3112
|
+
name: "current_sw_version",
|
|
3113
|
+
required: false,
|
|
3114
|
+
schema: {
|
|
3115
|
+
type: "string",
|
|
3116
|
+
},
|
|
3117
|
+
"x-displayname": "Current SW Version.",
|
|
3118
|
+
"x-ves-example": "Crt-20241107-1123.",
|
|
3119
|
+
},
|
|
3120
|
+
],
|
|
3121
|
+
requestBodySchema: null,
|
|
3122
|
+
responseSchema: {
|
|
3123
|
+
$ref: "#/components/schemas/upgrade_statusGetUpgradableSWVersionsResponse",
|
|
3124
|
+
},
|
|
3125
|
+
requiredParams: [],
|
|
3126
|
+
operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions",
|
|
3127
|
+
tags: ["Other"],
|
|
3128
|
+
sourceFile: "domains/ce_management.json",
|
|
3129
|
+
displayName: null,
|
|
3130
|
+
dangerLevel: "low",
|
|
3131
|
+
sideEffects: null,
|
|
3132
|
+
requiredFields: [],
|
|
3133
|
+
cliExamples: [
|
|
3134
|
+
{
|
|
3135
|
+
command: "f5xcctl maurice upgradable-sw-version list --namespace {namespace}",
|
|
3136
|
+
description: "List all upgradable-sw-versions",
|
|
3137
|
+
use_case: "list_all",
|
|
3138
|
+
},
|
|
3139
|
+
],
|
|
3140
|
+
confirmationRequired: false,
|
|
3141
|
+
parameterExamples: {
|
|
3142
|
+
current_os_version: "9.2023.23",
|
|
3143
|
+
current_sw_version: "Crt-20241107-1123.",
|
|
3144
|
+
},
|
|
3145
|
+
validationRules: {},
|
|
3146
|
+
operationMetadata: {
|
|
3147
|
+
common_errors: [
|
|
3148
|
+
{
|
|
3149
|
+
code: 401,
|
|
3150
|
+
message: "Authentication required",
|
|
3151
|
+
solution: "Provide valid API credentials",
|
|
3152
|
+
},
|
|
3153
|
+
{
|
|
3154
|
+
code: 403,
|
|
3155
|
+
message: "Permission denied",
|
|
3156
|
+
solution: "Check access permissions for this operation",
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
code: 404,
|
|
3160
|
+
message: "Resource not found",
|
|
3161
|
+
solution: "Verify resource name, namespace, and path",
|
|
3162
|
+
},
|
|
3163
|
+
{
|
|
3164
|
+
code: 409,
|
|
3165
|
+
message: "Resource already exists",
|
|
3166
|
+
solution: "Use different name or update existing resource",
|
|
3167
|
+
},
|
|
3168
|
+
{
|
|
3169
|
+
code: 429,
|
|
3170
|
+
message: "Rate limit exceeded",
|
|
3171
|
+
solution: "Wait before retrying the operation",
|
|
3172
|
+
},
|
|
3173
|
+
{
|
|
3174
|
+
code: 500,
|
|
3175
|
+
message: "Server error",
|
|
3176
|
+
solution: "Retry operation or contact support",
|
|
3177
|
+
},
|
|
3178
|
+
],
|
|
3179
|
+
conditions: {
|
|
3180
|
+
postconditions: [],
|
|
3181
|
+
prerequisites: [],
|
|
3182
|
+
},
|
|
3183
|
+
confirmation_required: false,
|
|
3184
|
+
danger_level: "low",
|
|
3185
|
+
examples: [
|
|
3186
|
+
{
|
|
3187
|
+
command: "f5xcctl maurice upgradable-sw-version list --namespace {namespace}",
|
|
3188
|
+
description: "List all upgradable-sw-versions",
|
|
3189
|
+
use_case: "list_all",
|
|
3190
|
+
},
|
|
3191
|
+
],
|
|
3192
|
+
field_docs: {},
|
|
3193
|
+
optional_fields: [],
|
|
3194
|
+
performance_impact: {
|
|
3195
|
+
latency: "moderate",
|
|
3196
|
+
resource_usage: "moderate",
|
|
3197
|
+
},
|
|
3198
|
+
purpose: "List all upgradable-sw-versions",
|
|
3199
|
+
required_fields: [],
|
|
3200
|
+
side_effects: {},
|
|
3201
|
+
},
|
|
3202
|
+
},
|
|
3203
|
+
{
|
|
3204
|
+
toolName: "f5xc-api-cemanagement-upgrade-statu-get",
|
|
3205
|
+
method: "GET",
|
|
3206
|
+
path: "/api/maurice/namespaces/{namespace}/sites/{name}/upgrade_status",
|
|
3207
|
+
operation: "get",
|
|
3208
|
+
domain: "ce_management",
|
|
3209
|
+
resource: "upgrade-statu",
|
|
3210
|
+
summary: "GET Upgrade Status.",
|
|
3211
|
+
description: "API to GET upgrade status of a site.",
|
|
3212
|
+
pathParameters: [
|
|
3213
|
+
{
|
|
3214
|
+
description: "Name\nFetch upgrade status for the name of site.",
|
|
3215
|
+
in: "path",
|
|
3216
|
+
name: "name",
|
|
3217
|
+
required: true,
|
|
3218
|
+
schema: {
|
|
3219
|
+
type: "string",
|
|
3220
|
+
},
|
|
3221
|
+
"x-displayname": "Site Name",
|
|
3222
|
+
"x-ves-example": "Blogging-app.",
|
|
3223
|
+
},
|
|
3224
|
+
{
|
|
3225
|
+
description: "Namespace\nFetch upgrade status for the given namespace.",
|
|
3226
|
+
in: "path",
|
|
3227
|
+
name: "namespace",
|
|
3228
|
+
required: true,
|
|
3229
|
+
schema: {
|
|
3230
|
+
type: "string",
|
|
3231
|
+
},
|
|
3232
|
+
"x-displayname": "Namespace",
|
|
3233
|
+
"x-ves-example": "Shared",
|
|
3234
|
+
},
|
|
3235
|
+
],
|
|
3236
|
+
queryParameters: [],
|
|
3237
|
+
requestBodySchema: null,
|
|
3238
|
+
responseSchema: {
|
|
3239
|
+
$ref: "#/components/schemas/upgrade_statusGetUpgradeStatusResponse",
|
|
3240
|
+
},
|
|
3241
|
+
requiredParams: ["name", "namespace"],
|
|
3242
|
+
operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus",
|
|
3243
|
+
tags: ["Other"],
|
|
3244
|
+
sourceFile: "domains/ce_management.json",
|
|
3245
|
+
displayName: null,
|
|
3246
|
+
dangerLevel: "low",
|
|
3247
|
+
sideEffects: null,
|
|
3248
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
3249
|
+
cliExamples: [
|
|
3250
|
+
{
|
|
3251
|
+
command: "f5xcctl maurice upgrade-statu get {name} --namespace {namespace}",
|
|
3252
|
+
description: "Get specific upgrade-statu",
|
|
3253
|
+
use_case: "get_specific",
|
|
3254
|
+
},
|
|
3255
|
+
],
|
|
3256
|
+
confirmationRequired: false,
|
|
3257
|
+
parameterExamples: {
|
|
3258
|
+
name: "Blogging-app.",
|
|
3259
|
+
namespace: "Shared",
|
|
3260
|
+
},
|
|
3261
|
+
validationRules: {},
|
|
3262
|
+
operationMetadata: {
|
|
3263
|
+
common_errors: [
|
|
3264
|
+
{
|
|
3265
|
+
code: 401,
|
|
3266
|
+
message: "Authentication required",
|
|
3267
|
+
solution: "Provide valid API credentials",
|
|
3268
|
+
},
|
|
3269
|
+
{
|
|
3270
|
+
code: 403,
|
|
3271
|
+
message: "Permission denied",
|
|
3272
|
+
solution: "Check access permissions for this operation",
|
|
3273
|
+
},
|
|
3274
|
+
{
|
|
3275
|
+
code: 404,
|
|
3276
|
+
message: "Resource not found",
|
|
3277
|
+
solution: "Verify resource name, namespace, and path",
|
|
3278
|
+
},
|
|
3279
|
+
{
|
|
3280
|
+
code: 409,
|
|
3281
|
+
message: "Resource already exists",
|
|
3282
|
+
solution: "Use different name or update existing resource",
|
|
3283
|
+
},
|
|
3284
|
+
{
|
|
3285
|
+
code: 429,
|
|
3286
|
+
message: "Rate limit exceeded",
|
|
3287
|
+
solution: "Wait before retrying the operation",
|
|
3288
|
+
},
|
|
3289
|
+
{
|
|
3290
|
+
code: 500,
|
|
3291
|
+
message: "Server error",
|
|
3292
|
+
solution: "Retry operation or contact support",
|
|
3293
|
+
},
|
|
3294
|
+
],
|
|
3295
|
+
conditions: {
|
|
3296
|
+
postconditions: [],
|
|
3297
|
+
prerequisites: ["Active namespace"],
|
|
3298
|
+
},
|
|
3299
|
+
confirmation_required: false,
|
|
3300
|
+
danger_level: "low",
|
|
3301
|
+
examples: [
|
|
3302
|
+
{
|
|
3303
|
+
command: "f5xcctl maurice upgrade-statu get {name} --namespace {namespace}",
|
|
3304
|
+
description: "Get specific upgrade-statu",
|
|
3305
|
+
use_case: "get_specific",
|
|
3306
|
+
},
|
|
3307
|
+
],
|
|
3308
|
+
field_docs: {},
|
|
3309
|
+
optional_fields: [],
|
|
3310
|
+
performance_impact: {
|
|
3311
|
+
latency: "moderate",
|
|
3312
|
+
resource_usage: "moderate",
|
|
3313
|
+
},
|
|
3314
|
+
purpose: "Retrieve specific upgrade-statu",
|
|
3315
|
+
required_fields: ["path.name", "path.namespace"],
|
|
3316
|
+
side_effects: {},
|
|
3317
|
+
},
|
|
3318
|
+
},
|
|
3319
|
+
{
|
|
3320
|
+
toolName: "f5xc-api-cemanagement-usb-policy-create",
|
|
3321
|
+
method: "POST",
|
|
3322
|
+
path: "/api/config/namespaces/{metadata.namespace}/usb_policys",
|
|
3323
|
+
operation: "create",
|
|
3324
|
+
domain: "ce_management",
|
|
3325
|
+
resource: "usb-policy",
|
|
3326
|
+
summary: "Create USB policy.",
|
|
3327
|
+
description: "Creates a new USB policy object.",
|
|
3328
|
+
pathParameters: [
|
|
3329
|
+
{
|
|
3330
|
+
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 ""',
|
|
3331
|
+
in: "path",
|
|
3332
|
+
name: "metadata.namespace",
|
|
3333
|
+
required: true,
|
|
3334
|
+
schema: {
|
|
3335
|
+
type: "string",
|
|
3336
|
+
},
|
|
3337
|
+
"x-displayname": "Namespace",
|
|
3338
|
+
"x-ves-example": "Staging",
|
|
3339
|
+
},
|
|
3340
|
+
],
|
|
3341
|
+
queryParameters: [],
|
|
3342
|
+
requestBodySchema: {
|
|
3343
|
+
$ref: "#/components/schemas/usb_policyCreateRequest",
|
|
3344
|
+
},
|
|
3345
|
+
responseSchema: {
|
|
3346
|
+
$ref: "#/components/schemas/usb_policyCreateResponse",
|
|
3347
|
+
},
|
|
3348
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
3349
|
+
operationId: "ves.io.schema.usb_policy.API.Create",
|
|
3350
|
+
tags: ["Other"],
|
|
3351
|
+
sourceFile: "domains/ce_management.json",
|
|
3352
|
+
displayName: null,
|
|
3353
|
+
dangerLevel: "medium",
|
|
3354
|
+
sideEffects: {
|
|
3355
|
+
creates: ["usb-policy"],
|
|
3356
|
+
},
|
|
3357
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
3358
|
+
cliExamples: [
|
|
3359
|
+
{
|
|
3360
|
+
command: "f5xcctl config usb-policy create -f {file}.yaml",
|
|
3361
|
+
description: "Create from YAML file",
|
|
3362
|
+
use_case: "file_based",
|
|
3363
|
+
},
|
|
3364
|
+
{
|
|
3365
|
+
command: "f5xcctl config usb-policy create {name} --namespace {namespace}",
|
|
3366
|
+
description: "Create usb-policy",
|
|
3367
|
+
use_case: "basic_create",
|
|
3368
|
+
},
|
|
3369
|
+
],
|
|
3370
|
+
confirmationRequired: false,
|
|
3371
|
+
parameterExamples: {
|
|
3372
|
+
"metadata.namespace": "Staging",
|
|
3373
|
+
},
|
|
3374
|
+
validationRules: {},
|
|
3375
|
+
operationMetadata: {
|
|
3376
|
+
common_errors: [
|
|
3377
|
+
{
|
|
3378
|
+
code: 401,
|
|
3379
|
+
message: "Authentication required",
|
|
3380
|
+
solution: "Provide valid API credentials",
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
code: 403,
|
|
3384
|
+
message: "Permission denied",
|
|
3385
|
+
solution: "Check access permissions for this operation",
|
|
3386
|
+
},
|
|
3387
|
+
{
|
|
3388
|
+
code: 404,
|
|
3389
|
+
message: "Resource not found",
|
|
3390
|
+
solution: "Verify resource name, namespace, and path",
|
|
3391
|
+
},
|
|
3392
|
+
{
|
|
3393
|
+
code: 409,
|
|
3394
|
+
message: "Resource already exists",
|
|
3395
|
+
solution: "Use different name or update existing resource",
|
|
3396
|
+
},
|
|
3397
|
+
{
|
|
3398
|
+
code: 429,
|
|
3399
|
+
message: "Rate limit exceeded",
|
|
3400
|
+
solution: "Wait before retrying the operation",
|
|
3401
|
+
},
|
|
3402
|
+
{
|
|
3403
|
+
code: 500,
|
|
3404
|
+
message: "Server error",
|
|
3405
|
+
solution: "Retry operation or contact support",
|
|
3406
|
+
},
|
|
3407
|
+
],
|
|
3408
|
+
conditions: {
|
|
3409
|
+
postconditions: ["Usb-policy resource created", "Resource assigned unique identifier"],
|
|
3410
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3411
|
+
},
|
|
3412
|
+
confirmation_required: false,
|
|
3413
|
+
danger_level: "medium",
|
|
3414
|
+
examples: [
|
|
3415
|
+
{
|
|
3416
|
+
command: "f5xcctl config usb-policy create {name} --namespace {namespace}",
|
|
3417
|
+
description: "Create usb-policy",
|
|
3418
|
+
use_case: "basic_create",
|
|
3419
|
+
},
|
|
3420
|
+
{
|
|
3421
|
+
command: "f5xcctl config usb-policy create -f {file}.yaml",
|
|
3422
|
+
description: "Create from YAML file",
|
|
3423
|
+
use_case: "file_based",
|
|
3424
|
+
},
|
|
3425
|
+
],
|
|
3426
|
+
field_docs: {},
|
|
3427
|
+
optional_fields: [],
|
|
3428
|
+
performance_impact: {
|
|
3429
|
+
latency: "low",
|
|
3430
|
+
resource_usage: "low",
|
|
3431
|
+
},
|
|
3432
|
+
purpose: "Create new usb-policy",
|
|
3433
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
3434
|
+
side_effects: {
|
|
3435
|
+
creates: ["usb-policy"],
|
|
3436
|
+
},
|
|
3437
|
+
},
|
|
3438
|
+
},
|
|
3439
|
+
{
|
|
3440
|
+
toolName: "f5xc-api-cemanagement-usb-policy-delete",
|
|
3441
|
+
method: "DELETE",
|
|
3442
|
+
path: "/api/config/namespaces/{namespace}/usb_policys/{name}",
|
|
3443
|
+
operation: "delete",
|
|
3444
|
+
domain: "ce_management",
|
|
3445
|
+
resource: "usb-policy",
|
|
3446
|
+
summary: "DELETE USB policy.",
|
|
3447
|
+
description: "DELETE the specified usb_policy.",
|
|
3448
|
+
pathParameters: [
|
|
3449
|
+
{
|
|
3450
|
+
description: "Name\nName of the configuration object.",
|
|
3451
|
+
in: "path",
|
|
3452
|
+
name: "name",
|
|
3453
|
+
required: true,
|
|
3454
|
+
schema: {
|
|
3455
|
+
type: "string",
|
|
3456
|
+
},
|
|
3457
|
+
"x-displayname": "Name",
|
|
3458
|
+
"x-ves-example": "Name",
|
|
3459
|
+
},
|
|
3460
|
+
{
|
|
3461
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
3462
|
+
in: "path",
|
|
3463
|
+
name: "namespace",
|
|
3464
|
+
required: true,
|
|
3465
|
+
schema: {
|
|
3466
|
+
type: "string",
|
|
3467
|
+
},
|
|
3468
|
+
"x-displayname": "Namespace",
|
|
3469
|
+
"x-ves-example": "Ns1",
|
|
3470
|
+
},
|
|
3471
|
+
],
|
|
3472
|
+
queryParameters: [],
|
|
3473
|
+
requestBodySchema: {
|
|
3474
|
+
$ref: "#/components/schemas/usb_policyDeleteRequest",
|
|
3475
|
+
},
|
|
3476
|
+
responseSchema: {},
|
|
3477
|
+
requiredParams: ["body", "name", "namespace"],
|
|
3478
|
+
operationId: "ves.io.schema.usb_policy.API.Delete",
|
|
3479
|
+
tags: ["Other"],
|
|
3480
|
+
sourceFile: "domains/ce_management.json",
|
|
3481
|
+
displayName: null,
|
|
3482
|
+
dangerLevel: "high",
|
|
3483
|
+
sideEffects: {
|
|
3484
|
+
deletes: ["usb-policy", "contained_resources"],
|
|
3485
|
+
},
|
|
3486
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
3487
|
+
cliExamples: [
|
|
3488
|
+
{
|
|
3489
|
+
command: "f5xcctl config usb-policy delete {name} --namespace {namespace}",
|
|
3490
|
+
description: "Delete usb-policy",
|
|
3491
|
+
use_case: "delete",
|
|
3492
|
+
},
|
|
3493
|
+
],
|
|
3494
|
+
confirmationRequired: true,
|
|
3495
|
+
parameterExamples: {
|
|
3496
|
+
name: "Name",
|
|
3497
|
+
namespace: "Ns1",
|
|
3498
|
+
},
|
|
3499
|
+
validationRules: {},
|
|
3500
|
+
operationMetadata: {
|
|
3501
|
+
common_errors: [
|
|
3502
|
+
{
|
|
3503
|
+
code: 401,
|
|
3504
|
+
message: "Authentication required",
|
|
3505
|
+
solution: "Provide valid API credentials",
|
|
3506
|
+
},
|
|
3507
|
+
{
|
|
3508
|
+
code: 403,
|
|
3509
|
+
message: "Permission denied",
|
|
3510
|
+
solution: "Check access permissions for this operation",
|
|
3511
|
+
},
|
|
3512
|
+
{
|
|
3513
|
+
code: 404,
|
|
3514
|
+
message: "Resource not found",
|
|
3515
|
+
solution: "Verify resource name, namespace, and path",
|
|
3516
|
+
},
|
|
3517
|
+
{
|
|
3518
|
+
code: 409,
|
|
3519
|
+
message: "Resource already exists",
|
|
3520
|
+
solution: "Use different name or update existing resource",
|
|
3521
|
+
},
|
|
3522
|
+
{
|
|
3523
|
+
code: 429,
|
|
3524
|
+
message: "Rate limit exceeded",
|
|
3525
|
+
solution: "Wait before retrying the operation",
|
|
3526
|
+
},
|
|
3527
|
+
{
|
|
3528
|
+
code: 500,
|
|
3529
|
+
message: "Server error",
|
|
3530
|
+
solution: "Retry operation or contact support",
|
|
3531
|
+
},
|
|
3532
|
+
],
|
|
3533
|
+
conditions: {
|
|
3534
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
3535
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3536
|
+
},
|
|
3537
|
+
confirmation_required: true,
|
|
3538
|
+
danger_level: "high",
|
|
3539
|
+
examples: [
|
|
3540
|
+
{
|
|
3541
|
+
command: "f5xcctl config usb-policy delete {name} --namespace {namespace}",
|
|
3542
|
+
description: "Delete usb-policy",
|
|
3543
|
+
use_case: "delete",
|
|
3544
|
+
},
|
|
3545
|
+
],
|
|
3546
|
+
field_docs: {},
|
|
3547
|
+
optional_fields: [],
|
|
3548
|
+
performance_impact: {
|
|
3549
|
+
latency: "high",
|
|
3550
|
+
resource_usage: "moderate",
|
|
3551
|
+
},
|
|
3552
|
+
purpose: "Delete usb-policy",
|
|
3553
|
+
required_fields: ["path.name", "path.namespace"],
|
|
3554
|
+
side_effects: {
|
|
3555
|
+
deletes: ["usb-policy", "contained_resources"],
|
|
3556
|
+
},
|
|
3557
|
+
},
|
|
3558
|
+
},
|
|
3559
|
+
{
|
|
3560
|
+
toolName: "f5xc-api-cemanagement-usb-policy-get",
|
|
3561
|
+
method: "GET",
|
|
3562
|
+
path: "/api/config/namespaces/{namespace}/usb_policys/{name}",
|
|
3563
|
+
operation: "get",
|
|
3564
|
+
domain: "ce_management",
|
|
3565
|
+
resource: "usb-policy",
|
|
3566
|
+
summary: "GET USB policy.",
|
|
3567
|
+
description: "GET the USB policy object.",
|
|
3568
|
+
pathParameters: [
|
|
3569
|
+
{
|
|
3570
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
3571
|
+
in: "path",
|
|
3572
|
+
name: "name",
|
|
3573
|
+
required: true,
|
|
3574
|
+
schema: {
|
|
3575
|
+
type: "string",
|
|
3576
|
+
},
|
|
3577
|
+
"x-displayname": "Name",
|
|
3578
|
+
"x-ves-example": "Name",
|
|
3579
|
+
},
|
|
3580
|
+
{
|
|
3581
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
3582
|
+
in: "path",
|
|
3583
|
+
name: "namespace",
|
|
3584
|
+
required: true,
|
|
3585
|
+
schema: {
|
|
3586
|
+
type: "string",
|
|
3587
|
+
},
|
|
3588
|
+
"x-displayname": "Namespace",
|
|
3589
|
+
"x-ves-example": "Ns1",
|
|
3590
|
+
},
|
|
3591
|
+
],
|
|
3592
|
+
queryParameters: [
|
|
3593
|
+
{
|
|
3594
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
3595
|
+
in: "query",
|
|
3596
|
+
name: "response_format",
|
|
3597
|
+
required: false,
|
|
3598
|
+
schema: {
|
|
3599
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
3600
|
+
enum: [
|
|
3601
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
3602
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
3603
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
3604
|
+
"GET_RSP_FORMAT_STATUS",
|
|
3605
|
+
"GET_RSP_FORMAT_READ",
|
|
3606
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
3607
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
3608
|
+
],
|
|
3609
|
+
type: "string",
|
|
3610
|
+
},
|
|
3611
|
+
"x-displayname": "Broken Referred Objects.",
|
|
3612
|
+
},
|
|
3613
|
+
],
|
|
3614
|
+
requestBodySchema: null,
|
|
3615
|
+
responseSchema: {
|
|
3616
|
+
$ref: "#/components/schemas/usb_policyGetResponse",
|
|
3617
|
+
},
|
|
3618
|
+
requiredParams: ["name", "namespace"],
|
|
3619
|
+
operationId: "ves.io.schema.usb_policy.API.Get",
|
|
3620
|
+
tags: ["Other"],
|
|
3621
|
+
sourceFile: "domains/ce_management.json",
|
|
3622
|
+
displayName: null,
|
|
3623
|
+
dangerLevel: "low",
|
|
3624
|
+
sideEffects: null,
|
|
3625
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
3626
|
+
cliExamples: [
|
|
3627
|
+
{
|
|
3628
|
+
command: "f5xcctl config usb-policy get {name} --namespace {namespace}",
|
|
3629
|
+
description: "Get specific usb-policy",
|
|
3630
|
+
use_case: "get_specific",
|
|
3631
|
+
},
|
|
3632
|
+
],
|
|
3633
|
+
confirmationRequired: false,
|
|
3634
|
+
parameterExamples: {
|
|
3635
|
+
name: "Name",
|
|
3636
|
+
namespace: "Ns1",
|
|
3637
|
+
},
|
|
3638
|
+
validationRules: {},
|
|
3639
|
+
operationMetadata: {
|
|
3640
|
+
common_errors: [
|
|
3641
|
+
{
|
|
3642
|
+
code: 401,
|
|
3643
|
+
message: "Authentication required",
|
|
3644
|
+
solution: "Provide valid API credentials",
|
|
3645
|
+
},
|
|
3646
|
+
{
|
|
3647
|
+
code: 403,
|
|
3648
|
+
message: "Permission denied",
|
|
3649
|
+
solution: "Check access permissions for this operation",
|
|
3650
|
+
},
|
|
3651
|
+
{
|
|
3652
|
+
code: 404,
|
|
3653
|
+
message: "Resource not found",
|
|
3654
|
+
solution: "Verify resource name, namespace, and path",
|
|
3655
|
+
},
|
|
3656
|
+
{
|
|
3657
|
+
code: 409,
|
|
3658
|
+
message: "Resource already exists",
|
|
3659
|
+
solution: "Use different name or update existing resource",
|
|
3660
|
+
},
|
|
3661
|
+
{
|
|
3662
|
+
code: 429,
|
|
3663
|
+
message: "Rate limit exceeded",
|
|
3664
|
+
solution: "Wait before retrying the operation",
|
|
3665
|
+
},
|
|
3666
|
+
{
|
|
3667
|
+
code: 500,
|
|
3668
|
+
message: "Server error",
|
|
3669
|
+
solution: "Retry operation or contact support",
|
|
3670
|
+
},
|
|
3671
|
+
],
|
|
3672
|
+
conditions: {
|
|
3673
|
+
postconditions: [],
|
|
3674
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3675
|
+
},
|
|
3676
|
+
confirmation_required: false,
|
|
3677
|
+
danger_level: "low",
|
|
3678
|
+
examples: [
|
|
3679
|
+
{
|
|
3680
|
+
command: "f5xcctl config usb-policy get {name} --namespace {namespace}",
|
|
3681
|
+
description: "Get specific usb-policy",
|
|
3682
|
+
use_case: "get_specific",
|
|
3683
|
+
},
|
|
3684
|
+
],
|
|
3685
|
+
field_docs: {},
|
|
3686
|
+
optional_fields: [],
|
|
3687
|
+
performance_impact: {
|
|
3688
|
+
latency: "low",
|
|
3689
|
+
resource_usage: "low",
|
|
3690
|
+
},
|
|
3691
|
+
purpose: "Retrieve specific usb-policy",
|
|
3692
|
+
required_fields: ["path.name", "path.namespace"],
|
|
3693
|
+
side_effects: {},
|
|
3694
|
+
},
|
|
3695
|
+
},
|
|
3696
|
+
{
|
|
3697
|
+
toolName: "f5xc-api-cemanagement-usb-policy-list",
|
|
3698
|
+
method: "GET",
|
|
3699
|
+
path: "/api/config/namespaces/{namespace}/usb_policys",
|
|
3700
|
+
operation: "list",
|
|
3701
|
+
domain: "ce_management",
|
|
3702
|
+
resource: "usb-policy",
|
|
3703
|
+
summary: "List USB policy.",
|
|
3704
|
+
description: "List the set of usb_policy in a namespace.",
|
|
3705
|
+
pathParameters: [
|
|
3706
|
+
{
|
|
3707
|
+
description: "Namespace\nNamespace to scope the listing of usb_policy.",
|
|
3708
|
+
in: "path",
|
|
3709
|
+
name: "namespace",
|
|
3710
|
+
required: true,
|
|
3711
|
+
schema: {
|
|
3712
|
+
type: "string",
|
|
3713
|
+
},
|
|
3714
|
+
"x-displayname": "Namespace",
|
|
3715
|
+
"x-ves-example": "Ns1",
|
|
3716
|
+
},
|
|
3717
|
+
],
|
|
3718
|
+
queryParameters: [
|
|
3719
|
+
{
|
|
3720
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
3721
|
+
in: "query",
|
|
3722
|
+
name: "label_filter",
|
|
3723
|
+
required: false,
|
|
3724
|
+
schema: {
|
|
3725
|
+
type: "string",
|
|
3726
|
+
},
|
|
3727
|
+
"x-displayname": "Label Filter.",
|
|
3728
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
3729
|
+
},
|
|
3730
|
+
{
|
|
3731
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
3732
|
+
in: "query",
|
|
3733
|
+
name: "report_fields",
|
|
3734
|
+
required: false,
|
|
3735
|
+
schema: {
|
|
3736
|
+
items: {
|
|
3737
|
+
type: "string",
|
|
3738
|
+
},
|
|
3739
|
+
type: "array",
|
|
3740
|
+
},
|
|
3741
|
+
"x-displayname": "Report Fields.",
|
|
3742
|
+
},
|
|
3743
|
+
{
|
|
3744
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
3745
|
+
in: "query",
|
|
3746
|
+
name: "report_status_fields",
|
|
3747
|
+
required: false,
|
|
3748
|
+
schema: {
|
|
3749
|
+
items: {
|
|
3750
|
+
type: "string",
|
|
3751
|
+
},
|
|
3752
|
+
type: "array",
|
|
3753
|
+
},
|
|
3754
|
+
"x-displayname": "Report Status Fields.",
|
|
3755
|
+
},
|
|
3756
|
+
],
|
|
3757
|
+
requestBodySchema: null,
|
|
3758
|
+
responseSchema: {
|
|
3759
|
+
$ref: "#/components/schemas/usb_policyListResponse",
|
|
3760
|
+
},
|
|
3761
|
+
requiredParams: ["namespace"],
|
|
3762
|
+
operationId: "ves.io.schema.usb_policy.API.List",
|
|
3763
|
+
tags: ["Other"],
|
|
3764
|
+
sourceFile: "domains/ce_management.json",
|
|
3765
|
+
displayName: null,
|
|
3766
|
+
dangerLevel: "low",
|
|
3767
|
+
sideEffects: null,
|
|
3768
|
+
requiredFields: ["path.namespace"],
|
|
3769
|
+
cliExamples: [
|
|
3770
|
+
{
|
|
3771
|
+
command: "f5xcctl config usb-policy list --namespace {namespace}",
|
|
3772
|
+
description: "List all usb-policys",
|
|
3773
|
+
use_case: "list_all",
|
|
3774
|
+
},
|
|
3775
|
+
],
|
|
3776
|
+
confirmationRequired: false,
|
|
3777
|
+
parameterExamples: {
|
|
3778
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
3779
|
+
namespace: "Ns1",
|
|
3780
|
+
},
|
|
3781
|
+
validationRules: {},
|
|
3782
|
+
operationMetadata: {
|
|
3783
|
+
common_errors: [
|
|
3784
|
+
{
|
|
3785
|
+
code: 401,
|
|
3786
|
+
message: "Authentication required",
|
|
3787
|
+
solution: "Provide valid API credentials",
|
|
3788
|
+
},
|
|
3789
|
+
{
|
|
3790
|
+
code: 403,
|
|
3791
|
+
message: "Permission denied",
|
|
3792
|
+
solution: "Check access permissions for this operation",
|
|
3793
|
+
},
|
|
3794
|
+
{
|
|
3795
|
+
code: 404,
|
|
3796
|
+
message: "Resource not found",
|
|
3797
|
+
solution: "Verify resource name, namespace, and path",
|
|
3798
|
+
},
|
|
3799
|
+
{
|
|
3800
|
+
code: 409,
|
|
3801
|
+
message: "Resource already exists",
|
|
3802
|
+
solution: "Use different name or update existing resource",
|
|
3803
|
+
},
|
|
3804
|
+
{
|
|
3805
|
+
code: 429,
|
|
3806
|
+
message: "Rate limit exceeded",
|
|
3807
|
+
solution: "Wait before retrying the operation",
|
|
3808
|
+
},
|
|
3809
|
+
{
|
|
3810
|
+
code: 500,
|
|
3811
|
+
message: "Server error",
|
|
3812
|
+
solution: "Retry operation or contact support",
|
|
3813
|
+
},
|
|
3814
|
+
],
|
|
3815
|
+
conditions: {
|
|
3816
|
+
postconditions: [],
|
|
3817
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3818
|
+
},
|
|
3819
|
+
confirmation_required: false,
|
|
3820
|
+
danger_level: "low",
|
|
3821
|
+
examples: [
|
|
3822
|
+
{
|
|
3823
|
+
command: "f5xcctl config usb-policy list --namespace {namespace}",
|
|
3824
|
+
description: "List all usb-policys",
|
|
3825
|
+
use_case: "list_all",
|
|
3826
|
+
},
|
|
3827
|
+
],
|
|
3828
|
+
field_docs: {},
|
|
3829
|
+
optional_fields: [],
|
|
3830
|
+
performance_impact: {
|
|
3831
|
+
latency: "moderate",
|
|
3832
|
+
resource_usage: "moderate",
|
|
3833
|
+
},
|
|
3834
|
+
purpose: "List all usb-policys",
|
|
3835
|
+
required_fields: ["path.namespace"],
|
|
3836
|
+
side_effects: {},
|
|
3837
|
+
},
|
|
3838
|
+
},
|
|
3839
|
+
{
|
|
3840
|
+
toolName: "f5xc-api-cemanagement-usb-policy-update",
|
|
3841
|
+
method: "PUT",
|
|
3842
|
+
path: "/api/config/namespaces/{metadata.namespace}/usb_policys/{metadata.name}",
|
|
3843
|
+
operation: "update",
|
|
3844
|
+
domain: "ce_management",
|
|
3845
|
+
resource: "usb-policy",
|
|
3846
|
+
summary: "Replace USB policy.",
|
|
3847
|
+
description: "Replaces the content of an USB policy object.",
|
|
3848
|
+
pathParameters: [
|
|
3849
|
+
{
|
|
3850
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
3851
|
+
in: "path",
|
|
3852
|
+
name: "metadata.name",
|
|
3853
|
+
required: true,
|
|
3854
|
+
schema: {
|
|
3855
|
+
type: "string",
|
|
3856
|
+
},
|
|
3857
|
+
"x-displayname": "Name",
|
|
3858
|
+
"x-ves-example": "Example-corp-web.",
|
|
3859
|
+
},
|
|
3860
|
+
{
|
|
3861
|
+
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 ""',
|
|
3862
|
+
in: "path",
|
|
3863
|
+
name: "metadata.namespace",
|
|
3864
|
+
required: true,
|
|
3865
|
+
schema: {
|
|
3866
|
+
type: "string",
|
|
3867
|
+
},
|
|
3868
|
+
"x-displayname": "Namespace",
|
|
3869
|
+
"x-ves-example": "Staging",
|
|
3870
|
+
},
|
|
3871
|
+
],
|
|
3872
|
+
queryParameters: [],
|
|
3873
|
+
requestBodySchema: {
|
|
3874
|
+
$ref: "#/components/schemas/usb_policyReplaceRequest",
|
|
3875
|
+
},
|
|
3876
|
+
responseSchema: {
|
|
3877
|
+
$ref: "#/components/schemas/usb_policyReplaceResponse",
|
|
3878
|
+
},
|
|
3879
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
3880
|
+
operationId: "ves.io.schema.usb_policy.API.Replace",
|
|
3881
|
+
tags: ["Other"],
|
|
3882
|
+
sourceFile: "domains/ce_management.json",
|
|
3883
|
+
displayName: null,
|
|
3884
|
+
dangerLevel: "medium",
|
|
3885
|
+
sideEffects: {
|
|
3886
|
+
modifies: ["usb-policy"],
|
|
3887
|
+
},
|
|
3888
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3889
|
+
cliExamples: [
|
|
3890
|
+
{
|
|
3891
|
+
command: "f5xcctl config usb-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3892
|
+
description: "Update usb-policy",
|
|
3893
|
+
use_case: "update",
|
|
3894
|
+
},
|
|
3895
|
+
],
|
|
3896
|
+
confirmationRequired: false,
|
|
3897
|
+
parameterExamples: {
|
|
3898
|
+
"metadata.name": "Example-corp-web.",
|
|
3899
|
+
"metadata.namespace": "Staging",
|
|
3900
|
+
},
|
|
3901
|
+
validationRules: {},
|
|
3902
|
+
operationMetadata: {
|
|
3903
|
+
common_errors: [
|
|
3904
|
+
{
|
|
3905
|
+
code: 401,
|
|
3906
|
+
message: "Authentication required",
|
|
3907
|
+
solution: "Provide valid API credentials",
|
|
3908
|
+
},
|
|
3909
|
+
{
|
|
3910
|
+
code: 403,
|
|
3911
|
+
message: "Permission denied",
|
|
3912
|
+
solution: "Check access permissions for this operation",
|
|
3913
|
+
},
|
|
3914
|
+
{
|
|
3915
|
+
code: 404,
|
|
3916
|
+
message: "Resource not found",
|
|
3917
|
+
solution: "Verify resource name, namespace, and path",
|
|
3918
|
+
},
|
|
3919
|
+
{
|
|
3920
|
+
code: 409,
|
|
3921
|
+
message: "Resource already exists",
|
|
3922
|
+
solution: "Use different name or update existing resource",
|
|
3923
|
+
},
|
|
3924
|
+
{
|
|
3925
|
+
code: 429,
|
|
3926
|
+
message: "Rate limit exceeded",
|
|
3927
|
+
solution: "Wait before retrying the operation",
|
|
3928
|
+
},
|
|
3929
|
+
{
|
|
3930
|
+
code: 500,
|
|
3931
|
+
message: "Server error",
|
|
3932
|
+
solution: "Retry operation or contact support",
|
|
3933
|
+
},
|
|
3934
|
+
],
|
|
3935
|
+
conditions: {
|
|
3936
|
+
postconditions: ["Resource updated with new values"],
|
|
3937
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3938
|
+
},
|
|
3939
|
+
confirmation_required: false,
|
|
3940
|
+
danger_level: "medium",
|
|
3941
|
+
examples: [
|
|
3942
|
+
{
|
|
3943
|
+
command: "f5xcctl config usb-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3944
|
+
description: "Update usb-policy",
|
|
3945
|
+
use_case: "update",
|
|
3946
|
+
},
|
|
3947
|
+
],
|
|
3948
|
+
field_docs: {},
|
|
3949
|
+
optional_fields: [],
|
|
3950
|
+
performance_impact: {
|
|
3951
|
+
latency: "low",
|
|
3952
|
+
resource_usage: "low",
|
|
3953
|
+
},
|
|
3954
|
+
purpose: "Replace existing usb-policy",
|
|
3955
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3956
|
+
side_effects: {
|
|
3957
|
+
modifies: ["usb-policy"],
|
|
3958
|
+
},
|
|
3959
|
+
},
|
|
3960
|
+
},
|
|
3961
|
+
];
|
|
3962
|
+
export default ce_managementTools;
|
|
3963
|
+
//# sourceMappingURL=index.js.map
|