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