@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generator/openapi-parser.d.ts +418 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +132 -0
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -1
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +150 -7
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/tools/discovery/describe.d.ts +1 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -1
- package/dist/tools/discovery/describe.js +10 -8
- package/dist/tools/discovery/describe.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
- package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
- package/dist/tools/generated/api/index.d.ts +8 -0
- package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +6668 -0
- package/dist/tools/generated/api/index.js.map +1 -0
- package/dist/tools/generated/authentication/index.d.ts +8 -0
- package/dist/tools/generated/authentication/index.d.ts.map +1 -0
- package/dist/tools/generated/authentication/index.js +1005 -0
- package/dist/tools/generated/authentication/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +2045 -0
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
- package/dist/tools/generated/billing_and_usage/index.js +2702 -0
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
- package/dist/tools/generated/blindfold/index.d.ts +8 -0
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
- package/dist/tools/generated/blindfold/index.js +3998 -0
- package/dist/tools/generated/blindfold/index.js.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +1904 -0
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts +8 -0
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
- package/dist/tools/generated/ce_management/index.js +3963 -0
- package/dist/tools/generated/ce_management/index.js.map +1 -0
- package/dist/tools/generated/certificates/index.d.ts +8 -0
- package/dist/tools/generated/certificates/index.d.ts.map +1 -0
- package/dist/tools/generated/certificates/index.js +2579 -0
- package/dist/tools/generated/certificates/index.js.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
- package/dist/tools/generated/container_services/index.d.ts +8 -0
- package/dist/tools/generated/container_services/index.d.ts.map +1 -0
- package/dist/tools/generated/container_services/index.js +2054 -0
- package/dist/tools/generated/container_services/index.js.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
- package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/data_intelligence/index.js +1770 -0
- package/dist/tools/generated/data_intelligence/index.js.map +1 -0
- package/dist/tools/generated/ddos/index.d.ts +8 -0
- package/dist/tools/generated/ddos/index.d.ts.map +1 -0
- package/dist/tools/generated/ddos/index.js +8511 -0
- package/dist/tools/generated/ddos/index.js.map +1 -0
- package/dist/tools/generated/dns/index.d.ts +8 -0
- package/dist/tools/generated/dns/index.d.ts.map +1 -0
- package/dist/tools/generated/dns/index.js +6460 -0
- package/dist/tools/generated/dns/index.js.map +1 -0
- package/dist/tools/generated/generative_ai/index.d.ts +8 -0
- package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
- package/dist/tools/generated/generative_ai/index.js +1215 -0
- package/dist/tools/generated/generative_ai/index.js.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
- package/dist/tools/generated/marketplace/index.d.ts +8 -0
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
- package/dist/tools/generated/marketplace/index.js +4580 -0
- package/dist/tools/generated/marketplace/index.js.map +1 -0
- package/dist/tools/generated/network/index.d.ts +8 -0
- package/dist/tools/generated/network/index.d.ts.map +1 -0
- package/dist/tools/generated/network/index.js +12616 -0
- package/dist/tools/generated/network/index.js.map +1 -0
- package/dist/tools/generated/network_security/index.d.ts +8 -0
- package/dist/tools/generated/network_security/index.d.ts.map +1 -0
- package/dist/tools/generated/network_security/index.js +8884 -0
- package/dist/tools/generated/network_security/index.js.map +1 -0
- package/dist/tools/generated/nginx_one/index.d.ts +8 -0
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx_one/index.js +1820 -0
- package/dist/tools/generated/nginx_one/index.js.map +1 -0
- package/dist/tools/generated/object_storage/index.d.ts +8 -0
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
- package/dist/tools/generated/object_storage/index.js +1055 -0
- package/dist/tools/generated/object_storage/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +4243 -4618
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
- package/dist/tools/generated/rate_limiting/index.js +1937 -0
- package/dist/tools/generated/rate_limiting/index.js.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +4532 -438
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts +8 -0
- package/dist/tools/generated/shape/index.d.ts.map +1 -0
- package/dist/tools/generated/shape/index.js +21784 -0
- package/dist/tools/generated/shape/index.js.map +1 -0
- package/dist/tools/generated/sites/index.d.ts +8 -0
- package/dist/tools/generated/sites/index.d.ts.map +1 -0
- package/dist/tools/generated/sites/index.js +13252 -0
- package/dist/tools/generated/sites/index.js.map +1 -0
- package/dist/tools/generated/statistics/index.d.ts +8 -0
- package/dist/tools/generated/statistics/index.d.ts.map +1 -0
- package/dist/tools/generated/statistics/index.js +8837 -0
- package/dist/tools/generated/statistics/index.js.map +1 -0
- package/dist/tools/generated/support/index.d.ts +8 -0
- package/dist/tools/generated/support/index.d.ts.map +1 -0
- package/dist/tools/generated/support/index.js +6215 -0
- package/dist/tools/generated/support/index.js.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
- package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
- package/dist/tools/generated/threat_campaign/index.js +112 -0
- package/dist/tools/generated/threat_campaign/index.js.map +1 -0
- package/dist/tools/generated/users/index.d.ts +8 -0
- package/dist/tools/generated/users/index.d.ts.map +1 -0
- package/dist/tools/generated/users/index.js +1572 -0
- package/dist/tools/generated/users/index.js.map +1 -0
- package/dist/tools/generated/virtual/index.d.ts +8 -0
- package/dist/tools/generated/virtual/index.d.ts.map +1 -0
- package/dist/tools/generated/virtual/index.js +11540 -0
- package/dist/tools/generated/virtual/index.js.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
- package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
- package/dist/tools/generated/waf/index.d.ts +8 -0
- package/dist/tools/generated/waf/index.d.ts.map +1 -0
- package/dist/tools/generated/waf/index.js +4440 -0
- package/dist/tools/generated/waf/index.js.map +1 -0
- package/dist/tools/registry.d.ts.map +1 -1
- package/dist/tools/registry.js +68 -36
- package/dist/tools/registry.js.map +1 -1
- package/package.json +3 -1
- package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.js +0 -282
- package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
- package/dist/tools/generated/api_security/index.d.ts +0 -8
- package/dist/tools/generated/api_security/index.d.ts.map +0 -1
- package/dist/tools/generated/api_security/index.js +0 -1852
- package/dist/tools/generated/api_security/index.js.map +0 -1
- package/dist/tools/generated/applications/index.d.ts +0 -8
- package/dist/tools/generated/applications/index.d.ts.map +0 -1
- package/dist/tools/generated/applications/index.js +0 -1589
- package/dist/tools/generated/applications/index.js.map +0 -1
- package/dist/tools/generated/billing/index.d.ts +0 -8
- package/dist/tools/generated/billing/index.d.ts.map +0 -1
- package/dist/tools/generated/billing/index.js +0 -759
- package/dist/tools/generated/billing/index.js.map +0 -1
- package/dist/tools/generated/config/index.d.ts +0 -8
- package/dist/tools/generated/config/index.d.ts.map +0 -1
- package/dist/tools/generated/config/index.js +0 -316
- package/dist/tools/generated/config/index.js.map +0 -1
- package/dist/tools/generated/identity/index.d.ts +0 -8
- package/dist/tools/generated/identity/index.d.ts.map +0 -1
- package/dist/tools/generated/identity/index.js +0 -5371
- package/dist/tools/generated/identity/index.js.map +0 -1
- package/dist/tools/generated/infrastructure/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure/index.js +0 -5342
- package/dist/tools/generated/infrastructure/index.js.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
- package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
- package/dist/tools/generated/integrations/index.d.ts +0 -8
- package/dist/tools/generated/integrations/index.d.ts.map +0 -1
- package/dist/tools/generated/integrations/index.js +0 -1995
- package/dist/tools/generated/integrations/index.js.map +0 -1
- package/dist/tools/generated/load_balancer/index.d.ts +0 -8
- package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
- package/dist/tools/generated/load_balancer/index.js +0 -2269
- package/dist/tools/generated/load_balancer/index.js.map +0 -1
- package/dist/tools/generated/networking/index.d.ts +0 -8
- package/dist/tools/generated/networking/index.d.ts.map +0 -1
- package/dist/tools/generated/networking/index.js +0 -11289
- package/dist/tools/generated/networking/index.js.map +0 -1
- package/dist/tools/generated/nginx/index.d.ts +0 -8
- package/dist/tools/generated/nginx/index.d.ts.map +0 -1
- package/dist/tools/generated/nginx/index.js +0 -680
- package/dist/tools/generated/nginx/index.js.map +0 -1
- package/dist/tools/generated/operations/index.d.ts +0 -8
- package/dist/tools/generated/operations/index.d.ts.map +0 -1
- package/dist/tools/generated/operations/index.js +0 -1759
- package/dist/tools/generated/operations/index.js.map +0 -1
- package/dist/tools/generated/security/index.d.ts +0 -8
- package/dist/tools/generated/security/index.d.ts.map +0 -1
- package/dist/tools/generated/security/index.js +0 -9111
- package/dist/tools/generated/security/index.js.map +0 -1
- package/dist/tools/generated/shape_security/index.d.ts +0 -8
- package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
- package/dist/tools/generated/shape_security/index.js +0 -4121
- package/dist/tools/generated/shape_security/index.js.map +0 -1
- package/dist/tools/generated/subscriptions/index.d.ts +0 -8
- package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
- package/dist/tools/generated/subscriptions/index.js +0 -778
- package/dist/tools/generated/subscriptions/index.js.map +0 -1
- package/dist/tools/generated/tenant_management/index.d.ts +0 -8
- package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
- package/dist/tools/generated/tenant_management/index.js +0 -2292
- package/dist/tools/generated/tenant_management/index.js.map +0 -1
- package/dist/tools/generated/vpn/index.d.ts +0 -8
- package/dist/tools/generated/vpn/index.js +0 -1183
- package/dist/tools/generated/vpn/index.js.map +0 -1
|
@@ -0,0 +1,2773 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for telemetry_and_insights domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const telemetry_and_insightsTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-telemetryandinsights-all-ns-service-create",
|
|
8
|
+
method: "POST",
|
|
9
|
+
path: "/api/data/namespaces/system/graph/all_ns_service",
|
|
10
|
+
operation: "create",
|
|
11
|
+
domain: "telemetry_and_insights",
|
|
12
|
+
resource: "all-ns-service",
|
|
13
|
+
summary: "Service Graph Query All Namespaces.",
|
|
14
|
+
description: "Request to GET monitoring data for a service mesh of a given application.",
|
|
15
|
+
pathParameters: [],
|
|
16
|
+
queryParameters: [],
|
|
17
|
+
requestBodySchema: null,
|
|
18
|
+
responseSchema: {
|
|
19
|
+
$ref: "#/components/schemas/serviceResponse",
|
|
20
|
+
},
|
|
21
|
+
requiredParams: [],
|
|
22
|
+
operationId: "ves.io.schema.graph.service.CustomAPI.QueryAllNamespaces",
|
|
23
|
+
tags: ["Observability"],
|
|
24
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
25
|
+
displayName: null,
|
|
26
|
+
dangerLevel: "medium",
|
|
27
|
+
sideEffects: {
|
|
28
|
+
creates: ["all-ns-service"],
|
|
29
|
+
},
|
|
30
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
31
|
+
cliExamples: [
|
|
32
|
+
{
|
|
33
|
+
command: "f5xcctl data all-ns-service create {name} --namespace {namespace}",
|
|
34
|
+
description: "Create all-ns-service",
|
|
35
|
+
use_case: "basic_create",
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
command: "f5xcctl data all-ns-service create -f {file}.yaml",
|
|
39
|
+
description: "Create from YAML file",
|
|
40
|
+
use_case: "file_based",
|
|
41
|
+
},
|
|
42
|
+
],
|
|
43
|
+
confirmationRequired: false,
|
|
44
|
+
parameterExamples: {},
|
|
45
|
+
validationRules: {},
|
|
46
|
+
operationMetadata: {
|
|
47
|
+
common_errors: [
|
|
48
|
+
{
|
|
49
|
+
code: 401,
|
|
50
|
+
message: "Authentication required",
|
|
51
|
+
solution: "Provide valid API credentials",
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
code: 403,
|
|
55
|
+
message: "Permission denied",
|
|
56
|
+
solution: "Check access permissions for this operation",
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
code: 404,
|
|
60
|
+
message: "Resource not found",
|
|
61
|
+
solution: "Verify resource name, namespace, and path",
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
code: 409,
|
|
65
|
+
message: "Resource already exists",
|
|
66
|
+
solution: "Use different name or update existing resource",
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
code: 429,
|
|
70
|
+
message: "Rate limit exceeded",
|
|
71
|
+
solution: "Wait before retrying the operation",
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
code: 500,
|
|
75
|
+
message: "Server error",
|
|
76
|
+
solution: "Retry operation or contact support",
|
|
77
|
+
},
|
|
78
|
+
],
|
|
79
|
+
conditions: {
|
|
80
|
+
postconditions: ["All-ns-service resource created", "Resource assigned unique identifier"],
|
|
81
|
+
prerequisites: ["Active namespace"],
|
|
82
|
+
},
|
|
83
|
+
confirmation_required: false,
|
|
84
|
+
danger_level: "medium",
|
|
85
|
+
examples: [
|
|
86
|
+
{
|
|
87
|
+
command: "f5xcctl data all-ns-service create {name} --namespace {namespace}",
|
|
88
|
+
description: "Create all-ns-service",
|
|
89
|
+
use_case: "basic_create",
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
command: "f5xcctl data all-ns-service create -f {file}.yaml",
|
|
93
|
+
description: "Create from YAML file",
|
|
94
|
+
use_case: "file_based",
|
|
95
|
+
},
|
|
96
|
+
],
|
|
97
|
+
field_docs: {},
|
|
98
|
+
optional_fields: [],
|
|
99
|
+
performance_impact: {
|
|
100
|
+
latency: "low",
|
|
101
|
+
resource_usage: "low",
|
|
102
|
+
},
|
|
103
|
+
purpose: "Create new all-ns-service",
|
|
104
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
105
|
+
side_effects: {
|
|
106
|
+
creates: ["all-ns-service"],
|
|
107
|
+
},
|
|
108
|
+
},
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
toolName: "f5xc-api-telemetryandinsights-app-type-list",
|
|
112
|
+
method: "GET",
|
|
113
|
+
path: "/api/data/namespaces/{namespace}/graph/service/app_types",
|
|
114
|
+
operation: "list",
|
|
115
|
+
domain: "telemetry_and_insights",
|
|
116
|
+
resource: "app-type",
|
|
117
|
+
summary: "Application Types.",
|
|
118
|
+
description: "Request to GET list of application types for a given namespace.\nFor system namespace, all the application types for the tenant\nwill be returned in the response.",
|
|
119
|
+
pathParameters: [
|
|
120
|
+
{
|
|
121
|
+
description: "Namespace\nnamespace is used to scope the listing of app types\nFor system namespace, all the app_types for the tenant will be returned in the response.",
|
|
122
|
+
in: "path",
|
|
123
|
+
name: "namespace",
|
|
124
|
+
required: true,
|
|
125
|
+
schema: {
|
|
126
|
+
type: "string",
|
|
127
|
+
},
|
|
128
|
+
"x-displayname": "Namespace",
|
|
129
|
+
"x-ves-example": "Value",
|
|
130
|
+
},
|
|
131
|
+
],
|
|
132
|
+
queryParameters: [
|
|
133
|
+
{
|
|
134
|
+
description: "End time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
|
|
135
|
+
in: "query",
|
|
136
|
+
name: "end_time",
|
|
137
|
+
required: false,
|
|
138
|
+
schema: {
|
|
139
|
+
type: "string",
|
|
140
|
+
},
|
|
141
|
+
"x-displayname": "End Time",
|
|
142
|
+
"x-ves-example": "1570197600.",
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
description: "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
146
|
+
in: "query",
|
|
147
|
+
name: "start_time",
|
|
148
|
+
required: false,
|
|
149
|
+
schema: {
|
|
150
|
+
type: "string",
|
|
151
|
+
},
|
|
152
|
+
"x-displayname": "Start Time.",
|
|
153
|
+
"x-ves-example": "1570194000.",
|
|
154
|
+
},
|
|
155
|
+
],
|
|
156
|
+
requestBodySchema: null,
|
|
157
|
+
responseSchema: {
|
|
158
|
+
$ref: "#/components/schemas/serviceAppTypeListResponse",
|
|
159
|
+
},
|
|
160
|
+
requiredParams: ["namespace"],
|
|
161
|
+
operationId: "ves.io.schema.graph.service.CustomAPI.AppTypeList",
|
|
162
|
+
tags: ["Observability"],
|
|
163
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
164
|
+
displayName: null,
|
|
165
|
+
dangerLevel: "low",
|
|
166
|
+
sideEffects: null,
|
|
167
|
+
requiredFields: ["path.namespace"],
|
|
168
|
+
cliExamples: [
|
|
169
|
+
{
|
|
170
|
+
command: "f5xcctl data app-type list --namespace {namespace}",
|
|
171
|
+
description: "List all app-types",
|
|
172
|
+
use_case: "list_all",
|
|
173
|
+
},
|
|
174
|
+
],
|
|
175
|
+
confirmationRequired: false,
|
|
176
|
+
parameterExamples: {
|
|
177
|
+
end_time: "1570197600.",
|
|
178
|
+
namespace: "Value",
|
|
179
|
+
start_time: "1570194000.",
|
|
180
|
+
},
|
|
181
|
+
validationRules: {},
|
|
182
|
+
operationMetadata: {
|
|
183
|
+
common_errors: [
|
|
184
|
+
{
|
|
185
|
+
code: 401,
|
|
186
|
+
message: "Authentication required",
|
|
187
|
+
solution: "Provide valid API credentials",
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
code: 403,
|
|
191
|
+
message: "Permission denied",
|
|
192
|
+
solution: "Check access permissions for this operation",
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
code: 404,
|
|
196
|
+
message: "Resource not found",
|
|
197
|
+
solution: "Verify resource name, namespace, and path",
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
code: 409,
|
|
201
|
+
message: "Resource already exists",
|
|
202
|
+
solution: "Use different name or update existing resource",
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
code: 429,
|
|
206
|
+
message: "Rate limit exceeded",
|
|
207
|
+
solution: "Wait before retrying the operation",
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
code: 500,
|
|
211
|
+
message: "Server error",
|
|
212
|
+
solution: "Retry operation or contact support",
|
|
213
|
+
},
|
|
214
|
+
],
|
|
215
|
+
conditions: {
|
|
216
|
+
postconditions: [],
|
|
217
|
+
prerequisites: ["Active namespace"],
|
|
218
|
+
},
|
|
219
|
+
confirmation_required: false,
|
|
220
|
+
danger_level: "low",
|
|
221
|
+
examples: [
|
|
222
|
+
{
|
|
223
|
+
command: "f5xcctl data app-type list --namespace {namespace}",
|
|
224
|
+
description: "List all app-types",
|
|
225
|
+
use_case: "list_all",
|
|
226
|
+
},
|
|
227
|
+
],
|
|
228
|
+
field_docs: {},
|
|
229
|
+
optional_fields: [],
|
|
230
|
+
performance_impact: {
|
|
231
|
+
latency: "moderate",
|
|
232
|
+
resource_usage: "moderate",
|
|
233
|
+
},
|
|
234
|
+
purpose: "List all app-types",
|
|
235
|
+
required_fields: ["path.namespace"],
|
|
236
|
+
side_effects: {},
|
|
237
|
+
},
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
toolName: "f5xc-api-telemetryandinsights-connectivity-create",
|
|
241
|
+
method: "POST",
|
|
242
|
+
path: "/api/data/namespaces/{namespace}/graph/connectivity",
|
|
243
|
+
operation: "create",
|
|
244
|
+
domain: "telemetry_and_insights",
|
|
245
|
+
resource: "connectivity",
|
|
246
|
+
summary: "Connectivity Graph Query.",
|
|
247
|
+
description: "Request to GET Connectivity data between the sites.",
|
|
248
|
+
pathParameters: [
|
|
249
|
+
{
|
|
250
|
+
description: "Namespace\nThis request is supported only in system namespace.",
|
|
251
|
+
in: "path",
|
|
252
|
+
name: "namespace",
|
|
253
|
+
required: true,
|
|
254
|
+
schema: {
|
|
255
|
+
type: "string",
|
|
256
|
+
},
|
|
257
|
+
"x-displayname": "Namespace",
|
|
258
|
+
"x-ves-example": "Value",
|
|
259
|
+
},
|
|
260
|
+
],
|
|
261
|
+
queryParameters: [],
|
|
262
|
+
requestBodySchema: {
|
|
263
|
+
$ref: "#/components/schemas/connectivityRequest",
|
|
264
|
+
},
|
|
265
|
+
responseSchema: {
|
|
266
|
+
$ref: "#/components/schemas/connectivityResponse",
|
|
267
|
+
},
|
|
268
|
+
requiredParams: ["body", "namespace"],
|
|
269
|
+
operationId: "ves.io.schema.graph.connectivity.CustomAPI.Query",
|
|
270
|
+
tags: ["Observability"],
|
|
271
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
272
|
+
displayName: null,
|
|
273
|
+
dangerLevel: "medium",
|
|
274
|
+
sideEffects: {
|
|
275
|
+
creates: ["connectivity"],
|
|
276
|
+
},
|
|
277
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
278
|
+
cliExamples: [
|
|
279
|
+
{
|
|
280
|
+
command: "f5xcctl data connectivity create {name} --namespace {namespace}",
|
|
281
|
+
description: "Create connectivity",
|
|
282
|
+
use_case: "basic_create",
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
command: "f5xcctl data connectivity create -f {file}.yaml",
|
|
286
|
+
description: "Create from YAML file",
|
|
287
|
+
use_case: "file_based",
|
|
288
|
+
},
|
|
289
|
+
],
|
|
290
|
+
confirmationRequired: false,
|
|
291
|
+
parameterExamples: {
|
|
292
|
+
namespace: "Value",
|
|
293
|
+
},
|
|
294
|
+
validationRules: {},
|
|
295
|
+
operationMetadata: {
|
|
296
|
+
common_errors: [
|
|
297
|
+
{
|
|
298
|
+
code: 401,
|
|
299
|
+
message: "Authentication required",
|
|
300
|
+
solution: "Provide valid API credentials",
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
code: 403,
|
|
304
|
+
message: "Permission denied",
|
|
305
|
+
solution: "Check access permissions for this operation",
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
code: 404,
|
|
309
|
+
message: "Resource not found",
|
|
310
|
+
solution: "Verify resource name, namespace, and path",
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
code: 409,
|
|
314
|
+
message: "Resource already exists",
|
|
315
|
+
solution: "Use different name or update existing resource",
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
code: 429,
|
|
319
|
+
message: "Rate limit exceeded",
|
|
320
|
+
solution: "Wait before retrying the operation",
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
code: 500,
|
|
324
|
+
message: "Server error",
|
|
325
|
+
solution: "Retry operation or contact support",
|
|
326
|
+
},
|
|
327
|
+
],
|
|
328
|
+
conditions: {
|
|
329
|
+
postconditions: ["Connectivity resource created", "Resource assigned unique identifier"],
|
|
330
|
+
prerequisites: ["Active namespace"],
|
|
331
|
+
},
|
|
332
|
+
confirmation_required: false,
|
|
333
|
+
danger_level: "medium",
|
|
334
|
+
examples: [
|
|
335
|
+
{
|
|
336
|
+
command: "f5xcctl data connectivity create {name} --namespace {namespace}",
|
|
337
|
+
description: "Create connectivity",
|
|
338
|
+
use_case: "basic_create",
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
command: "f5xcctl data connectivity create -f {file}.yaml",
|
|
342
|
+
description: "Create from YAML file",
|
|
343
|
+
use_case: "file_based",
|
|
344
|
+
},
|
|
345
|
+
],
|
|
346
|
+
field_docs: {},
|
|
347
|
+
optional_fields: [],
|
|
348
|
+
performance_impact: {
|
|
349
|
+
latency: "low",
|
|
350
|
+
resource_usage: "low",
|
|
351
|
+
},
|
|
352
|
+
purpose: "Create new connectivity",
|
|
353
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
354
|
+
side_effects: {
|
|
355
|
+
creates: ["connectivity"],
|
|
356
|
+
},
|
|
357
|
+
},
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
toolName: "f5xc-api-telemetryandinsights-create-http-load-balancer-create",
|
|
361
|
+
method: "POST",
|
|
362
|
+
path: "/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_http_load_balancer",
|
|
363
|
+
operation: "create",
|
|
364
|
+
domain: "telemetry_and_insights",
|
|
365
|
+
resource: "create-http-load-balancer",
|
|
366
|
+
summary: "Create HTTP/HTTPS load balancer.",
|
|
367
|
+
description: "Create HTTP/HTTPS load balancer using the discovered virtual server as an origin server.",
|
|
368
|
+
pathParameters: [
|
|
369
|
+
{
|
|
370
|
+
description: "Service Name\nx-required\nIdentifies the discovered service name.",
|
|
371
|
+
in: "path",
|
|
372
|
+
name: "name",
|
|
373
|
+
required: true,
|
|
374
|
+
schema: {
|
|
375
|
+
type: "string",
|
|
376
|
+
},
|
|
377
|
+
"x-displayname": "Service Name.",
|
|
378
|
+
"x-ves-example": "Vs1",
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
description: "Namespace\nx-required\nNamespace of the discovered service for current request.",
|
|
382
|
+
in: "path",
|
|
383
|
+
name: "namespace",
|
|
384
|
+
required: true,
|
|
385
|
+
schema: {
|
|
386
|
+
type: "string",
|
|
387
|
+
},
|
|
388
|
+
"x-displayname": "Namespace",
|
|
389
|
+
"x-ves-example": "Shared",
|
|
390
|
+
},
|
|
391
|
+
],
|
|
392
|
+
queryParameters: [],
|
|
393
|
+
requestBodySchema: {
|
|
394
|
+
$ref: "#/components/schemas/discovered_serviceCreateHTTPLoadBalancerRequest",
|
|
395
|
+
},
|
|
396
|
+
responseSchema: {
|
|
397
|
+
$ref: "#/components/schemas/discovered_serviceCreateHTTPLoadBalancerResponse",
|
|
398
|
+
},
|
|
399
|
+
requiredParams: ["body", "name", "namespace"],
|
|
400
|
+
operationId: "ves.io.schema.discovered_service.CustomAPI.CreateHTTPLoadBalancer",
|
|
401
|
+
tags: ["Service Mesh"],
|
|
402
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
403
|
+
displayName: null,
|
|
404
|
+
dangerLevel: "medium",
|
|
405
|
+
sideEffects: {
|
|
406
|
+
creates: ["create-http-load-balancer"],
|
|
407
|
+
},
|
|
408
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
409
|
+
cliExamples: [
|
|
410
|
+
{
|
|
411
|
+
command: "f5xcctl discovery create-http-load-balancer create {name} --namespace {namespace}",
|
|
412
|
+
description: "Create create-http-load-balancer",
|
|
413
|
+
use_case: "basic_create",
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
command: "f5xcctl discovery create-http-load-balancer create -f {file}.yaml",
|
|
417
|
+
description: "Create from YAML file",
|
|
418
|
+
use_case: "file_based",
|
|
419
|
+
},
|
|
420
|
+
],
|
|
421
|
+
confirmationRequired: false,
|
|
422
|
+
parameterExamples: {
|
|
423
|
+
name: "Vs1",
|
|
424
|
+
namespace: "Shared",
|
|
425
|
+
},
|
|
426
|
+
validationRules: {},
|
|
427
|
+
operationMetadata: {
|
|
428
|
+
common_errors: [
|
|
429
|
+
{
|
|
430
|
+
code: 401,
|
|
431
|
+
message: "Authentication required",
|
|
432
|
+
solution: "Provide valid API credentials",
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
code: 403,
|
|
436
|
+
message: "Permission denied",
|
|
437
|
+
solution: "Check access permissions for this operation",
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
code: 404,
|
|
441
|
+
message: "Resource not found",
|
|
442
|
+
solution: "Verify resource name, namespace, and path",
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
code: 409,
|
|
446
|
+
message: "Resource already exists",
|
|
447
|
+
solution: "Use different name or update existing resource",
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
code: 429,
|
|
451
|
+
message: "Rate limit exceeded",
|
|
452
|
+
solution: "Wait before retrying the operation",
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
code: 500,
|
|
456
|
+
message: "Server error",
|
|
457
|
+
solution: "Retry operation or contact support",
|
|
458
|
+
},
|
|
459
|
+
],
|
|
460
|
+
conditions: {
|
|
461
|
+
postconditions: [
|
|
462
|
+
"Create-http-load-balancer resource created",
|
|
463
|
+
"Resource assigned unique identifier",
|
|
464
|
+
],
|
|
465
|
+
prerequisites: ["Active namespace"],
|
|
466
|
+
},
|
|
467
|
+
confirmation_required: false,
|
|
468
|
+
danger_level: "medium",
|
|
469
|
+
examples: [
|
|
470
|
+
{
|
|
471
|
+
command: "f5xcctl discovery create-http-load-balancer create {name} --namespace {namespace}",
|
|
472
|
+
description: "Create create-http-load-balancer",
|
|
473
|
+
use_case: "basic_create",
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
command: "f5xcctl discovery create-http-load-balancer create -f {file}.yaml",
|
|
477
|
+
description: "Create from YAML file",
|
|
478
|
+
use_case: "file_based",
|
|
479
|
+
},
|
|
480
|
+
],
|
|
481
|
+
field_docs: {},
|
|
482
|
+
optional_fields: [],
|
|
483
|
+
performance_impact: {
|
|
484
|
+
latency: "low",
|
|
485
|
+
resource_usage: "low",
|
|
486
|
+
},
|
|
487
|
+
purpose: "Create new create-http-load-balancer",
|
|
488
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
489
|
+
side_effects: {
|
|
490
|
+
creates: ["create-http-load-balancer"],
|
|
491
|
+
},
|
|
492
|
+
},
|
|
493
|
+
},
|
|
494
|
+
{
|
|
495
|
+
toolName: "f5xc-api-telemetryandinsights-create-tcp-load-balancer-create",
|
|
496
|
+
method: "POST",
|
|
497
|
+
path: "/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_tcp_load_balancer",
|
|
498
|
+
operation: "create",
|
|
499
|
+
domain: "telemetry_and_insights",
|
|
500
|
+
resource: "create-tcp-load-balancer",
|
|
501
|
+
summary: "Create TCP load balancer.",
|
|
502
|
+
description: "Create TCP load balancer using the discovered virtual server as an origin server.",
|
|
503
|
+
pathParameters: [
|
|
504
|
+
{
|
|
505
|
+
description: "Service Name\nx-required\nIdentifies the discovered service name.",
|
|
506
|
+
in: "path",
|
|
507
|
+
name: "name",
|
|
508
|
+
required: true,
|
|
509
|
+
schema: {
|
|
510
|
+
type: "string",
|
|
511
|
+
},
|
|
512
|
+
"x-displayname": "Service Name.",
|
|
513
|
+
"x-ves-example": "Vs1",
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
description: "Namespace\nx-required\nNamespace of the discovered service for current request.",
|
|
517
|
+
in: "path",
|
|
518
|
+
name: "namespace",
|
|
519
|
+
required: true,
|
|
520
|
+
schema: {
|
|
521
|
+
type: "string",
|
|
522
|
+
},
|
|
523
|
+
"x-displayname": "Namespace",
|
|
524
|
+
"x-ves-example": "Shared",
|
|
525
|
+
},
|
|
526
|
+
],
|
|
527
|
+
queryParameters: [],
|
|
528
|
+
requestBodySchema: {
|
|
529
|
+
$ref: "#/components/schemas/discovered_serviceCreateTCPLoadBalancerRequest",
|
|
530
|
+
},
|
|
531
|
+
responseSchema: {
|
|
532
|
+
$ref: "#/components/schemas/discovered_serviceCreateTCPLoadBalancerResponse",
|
|
533
|
+
},
|
|
534
|
+
requiredParams: ["body", "name", "namespace"],
|
|
535
|
+
operationId: "ves.io.schema.discovered_service.CustomAPI.CreateTCPLoadBalancer",
|
|
536
|
+
tags: ["Service Mesh"],
|
|
537
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
538
|
+
displayName: null,
|
|
539
|
+
dangerLevel: "medium",
|
|
540
|
+
sideEffects: {
|
|
541
|
+
creates: ["create-tcp-load-balancer"],
|
|
542
|
+
},
|
|
543
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
544
|
+
cliExamples: [
|
|
545
|
+
{
|
|
546
|
+
command: "f5xcctl discovery create-tcp-load-balancer create {name} --namespace {namespace}",
|
|
547
|
+
description: "Create create-tcp-load-balancer",
|
|
548
|
+
use_case: "basic_create",
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
command: "f5xcctl discovery create-tcp-load-balancer create -f {file}.yaml",
|
|
552
|
+
description: "Create from YAML file",
|
|
553
|
+
use_case: "file_based",
|
|
554
|
+
},
|
|
555
|
+
],
|
|
556
|
+
confirmationRequired: false,
|
|
557
|
+
parameterExamples: {
|
|
558
|
+
name: "Vs1",
|
|
559
|
+
namespace: "Shared",
|
|
560
|
+
},
|
|
561
|
+
validationRules: {},
|
|
562
|
+
operationMetadata: {
|
|
563
|
+
common_errors: [
|
|
564
|
+
{
|
|
565
|
+
code: 401,
|
|
566
|
+
message: "Authentication required",
|
|
567
|
+
solution: "Provide valid API credentials",
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
code: 403,
|
|
571
|
+
message: "Permission denied",
|
|
572
|
+
solution: "Check access permissions for this operation",
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
code: 404,
|
|
576
|
+
message: "Resource not found",
|
|
577
|
+
solution: "Verify resource name, namespace, and path",
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
code: 409,
|
|
581
|
+
message: "Resource already exists",
|
|
582
|
+
solution: "Use different name or update existing resource",
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
code: 429,
|
|
586
|
+
message: "Rate limit exceeded",
|
|
587
|
+
solution: "Wait before retrying the operation",
|
|
588
|
+
},
|
|
589
|
+
{
|
|
590
|
+
code: 500,
|
|
591
|
+
message: "Server error",
|
|
592
|
+
solution: "Retry operation or contact support",
|
|
593
|
+
},
|
|
594
|
+
],
|
|
595
|
+
conditions: {
|
|
596
|
+
postconditions: [
|
|
597
|
+
"Create-tcp-load-balancer resource created",
|
|
598
|
+
"Resource assigned unique identifier",
|
|
599
|
+
],
|
|
600
|
+
prerequisites: ["Active namespace"],
|
|
601
|
+
},
|
|
602
|
+
confirmation_required: false,
|
|
603
|
+
danger_level: "medium",
|
|
604
|
+
examples: [
|
|
605
|
+
{
|
|
606
|
+
command: "f5xcctl discovery create-tcp-load-balancer create {name} --namespace {namespace}",
|
|
607
|
+
description: "Create create-tcp-load-balancer",
|
|
608
|
+
use_case: "basic_create",
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
command: "f5xcctl discovery create-tcp-load-balancer create -f {file}.yaml",
|
|
612
|
+
description: "Create from YAML file",
|
|
613
|
+
use_case: "file_based",
|
|
614
|
+
},
|
|
615
|
+
],
|
|
616
|
+
field_docs: {},
|
|
617
|
+
optional_fields: [],
|
|
618
|
+
performance_impact: {
|
|
619
|
+
latency: "low",
|
|
620
|
+
resource_usage: "low",
|
|
621
|
+
},
|
|
622
|
+
purpose: "Create new create-tcp-load-balancer",
|
|
623
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
624
|
+
side_effects: {
|
|
625
|
+
creates: ["create-tcp-load-balancer"],
|
|
626
|
+
},
|
|
627
|
+
},
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
toolName: "f5xc-api-telemetryandinsights-disable-visibility-create",
|
|
631
|
+
method: "POST",
|
|
632
|
+
path: "/api/discovery/namespaces/{namespace}/discovered_services/{name}/disable_visibility",
|
|
633
|
+
operation: "create",
|
|
634
|
+
domain: "telemetry_and_insights",
|
|
635
|
+
resource: "disable-visibility",
|
|
636
|
+
summary: "Disable visibility in all workspaces.",
|
|
637
|
+
description: "Disable Visibility of the service in all workspaces. This will remove the discovered service\nfrom being visible in other wokspaces like WAAP.",
|
|
638
|
+
pathParameters: [
|
|
639
|
+
{
|
|
640
|
+
description: "Service Name\nx-required\nIdentifies the discovered service name.",
|
|
641
|
+
in: "path",
|
|
642
|
+
name: "name",
|
|
643
|
+
required: true,
|
|
644
|
+
schema: {
|
|
645
|
+
type: "string",
|
|
646
|
+
},
|
|
647
|
+
"x-displayname": "Service Name.",
|
|
648
|
+
"x-ves-example": "Vs1",
|
|
649
|
+
},
|
|
650
|
+
{
|
|
651
|
+
description: "Namespace\nx-required\nNamespace of the discovered service for current request.",
|
|
652
|
+
in: "path",
|
|
653
|
+
name: "namespace",
|
|
654
|
+
required: true,
|
|
655
|
+
schema: {
|
|
656
|
+
type: "string",
|
|
657
|
+
},
|
|
658
|
+
"x-displayname": "Namespace",
|
|
659
|
+
"x-ves-example": "Shared",
|
|
660
|
+
},
|
|
661
|
+
],
|
|
662
|
+
queryParameters: [],
|
|
663
|
+
requestBodySchema: {
|
|
664
|
+
$ref: "#/components/schemas/discovered_serviceDisableVisibilityRequest",
|
|
665
|
+
},
|
|
666
|
+
responseSchema: {
|
|
667
|
+
$ref: "#/components/schemas/discovered_serviceDisableVisibilityResponse",
|
|
668
|
+
},
|
|
669
|
+
requiredParams: ["body", "name", "namespace"],
|
|
670
|
+
operationId: "ves.io.schema.discovered_service.CustomAPI.DisableVisibility",
|
|
671
|
+
tags: ["Service Mesh"],
|
|
672
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
673
|
+
displayName: null,
|
|
674
|
+
dangerLevel: "medium",
|
|
675
|
+
sideEffects: {
|
|
676
|
+
creates: ["disable-visibility"],
|
|
677
|
+
},
|
|
678
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
679
|
+
cliExamples: [
|
|
680
|
+
{
|
|
681
|
+
command: "f5xcctl discovery disable-visibility create {name} --namespace {namespace}",
|
|
682
|
+
description: "Create disable-visibility",
|
|
683
|
+
use_case: "basic_create",
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
command: "f5xcctl discovery disable-visibility create -f {file}.yaml",
|
|
687
|
+
description: "Create from YAML file",
|
|
688
|
+
use_case: "file_based",
|
|
689
|
+
},
|
|
690
|
+
],
|
|
691
|
+
confirmationRequired: false,
|
|
692
|
+
parameterExamples: {
|
|
693
|
+
name: "Vs1",
|
|
694
|
+
namespace: "Shared",
|
|
695
|
+
},
|
|
696
|
+
validationRules: {},
|
|
697
|
+
operationMetadata: {
|
|
698
|
+
common_errors: [
|
|
699
|
+
{
|
|
700
|
+
code: 401,
|
|
701
|
+
message: "Authentication required",
|
|
702
|
+
solution: "Provide valid API credentials",
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
code: 403,
|
|
706
|
+
message: "Permission denied",
|
|
707
|
+
solution: "Check access permissions for this operation",
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
code: 404,
|
|
711
|
+
message: "Resource not found",
|
|
712
|
+
solution: "Verify resource name, namespace, and path",
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
code: 409,
|
|
716
|
+
message: "Resource already exists",
|
|
717
|
+
solution: "Use different name or update existing resource",
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
code: 429,
|
|
721
|
+
message: "Rate limit exceeded",
|
|
722
|
+
solution: "Wait before retrying the operation",
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
code: 500,
|
|
726
|
+
message: "Server error",
|
|
727
|
+
solution: "Retry operation or contact support",
|
|
728
|
+
},
|
|
729
|
+
],
|
|
730
|
+
conditions: {
|
|
731
|
+
postconditions: [
|
|
732
|
+
"Disable-visibility resource created",
|
|
733
|
+
"Resource assigned unique identifier",
|
|
734
|
+
],
|
|
735
|
+
prerequisites: ["Active namespace"],
|
|
736
|
+
},
|
|
737
|
+
confirmation_required: false,
|
|
738
|
+
danger_level: "medium",
|
|
739
|
+
examples: [
|
|
740
|
+
{
|
|
741
|
+
command: "f5xcctl discovery disable-visibility create {name} --namespace {namespace}",
|
|
742
|
+
description: "Create disable-visibility",
|
|
743
|
+
use_case: "basic_create",
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
command: "f5xcctl discovery disable-visibility create -f {file}.yaml",
|
|
747
|
+
description: "Create from YAML file",
|
|
748
|
+
use_case: "file_based",
|
|
749
|
+
},
|
|
750
|
+
],
|
|
751
|
+
field_docs: {},
|
|
752
|
+
optional_fields: [],
|
|
753
|
+
performance_impact: {
|
|
754
|
+
latency: "low",
|
|
755
|
+
resource_usage: "low",
|
|
756
|
+
},
|
|
757
|
+
purpose: "Create new disable-visibility",
|
|
758
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
759
|
+
side_effects: {
|
|
760
|
+
creates: ["disable-visibility"],
|
|
761
|
+
},
|
|
762
|
+
},
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
toolName: "f5xc-api-telemetryandinsights-discovered-service-get",
|
|
766
|
+
method: "GET",
|
|
767
|
+
path: "/api/discovery/namespaces/{namespace}/discovered_services/{name}",
|
|
768
|
+
operation: "get",
|
|
769
|
+
domain: "telemetry_and_insights",
|
|
770
|
+
resource: "discovered-service",
|
|
771
|
+
summary: "GET Discovered Service Object.",
|
|
772
|
+
description: "GET Discovered Service Object.",
|
|
773
|
+
pathParameters: [
|
|
774
|
+
{
|
|
775
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
776
|
+
in: "path",
|
|
777
|
+
name: "name",
|
|
778
|
+
required: true,
|
|
779
|
+
schema: {
|
|
780
|
+
type: "string",
|
|
781
|
+
},
|
|
782
|
+
"x-displayname": "Name",
|
|
783
|
+
"x-ves-example": "Name",
|
|
784
|
+
},
|
|
785
|
+
{
|
|
786
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
787
|
+
in: "path",
|
|
788
|
+
name: "namespace",
|
|
789
|
+
required: true,
|
|
790
|
+
schema: {
|
|
791
|
+
type: "string",
|
|
792
|
+
},
|
|
793
|
+
"x-displayname": "Namespace",
|
|
794
|
+
"x-ves-example": "Ns1",
|
|
795
|
+
},
|
|
796
|
+
],
|
|
797
|
+
queryParameters: [
|
|
798
|
+
{
|
|
799
|
+
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 format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
800
|
+
in: "query",
|
|
801
|
+
name: "response_format",
|
|
802
|
+
required: false,
|
|
803
|
+
schema: {
|
|
804
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
805
|
+
enum: [
|
|
806
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
807
|
+
"GET_RSP_FORMAT_READ",
|
|
808
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
809
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
810
|
+
],
|
|
811
|
+
type: "string",
|
|
812
|
+
},
|
|
813
|
+
"x-displayname": "Broken Referred Objects.",
|
|
814
|
+
},
|
|
815
|
+
],
|
|
816
|
+
requestBodySchema: null,
|
|
817
|
+
responseSchema: {
|
|
818
|
+
$ref: "#/components/schemas/discovered_serviceGetResponse",
|
|
819
|
+
},
|
|
820
|
+
requiredParams: ["name", "namespace"],
|
|
821
|
+
operationId: "ves.io.schema.discovered_service.API.Get",
|
|
822
|
+
tags: ["Service Mesh"],
|
|
823
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
824
|
+
displayName: null,
|
|
825
|
+
dangerLevel: "low",
|
|
826
|
+
sideEffects: null,
|
|
827
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
828
|
+
cliExamples: [
|
|
829
|
+
{
|
|
830
|
+
command: "f5xcctl discovery discovered-service get {name} --namespace {namespace}",
|
|
831
|
+
description: "Get specific discovered-service",
|
|
832
|
+
use_case: "get_specific",
|
|
833
|
+
},
|
|
834
|
+
],
|
|
835
|
+
confirmationRequired: false,
|
|
836
|
+
parameterExamples: {
|
|
837
|
+
name: "Name",
|
|
838
|
+
namespace: "Ns1",
|
|
839
|
+
},
|
|
840
|
+
validationRules: {},
|
|
841
|
+
operationMetadata: {
|
|
842
|
+
common_errors: [
|
|
843
|
+
{
|
|
844
|
+
code: 401,
|
|
845
|
+
message: "Authentication required",
|
|
846
|
+
solution: "Provide valid API credentials",
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
code: 403,
|
|
850
|
+
message: "Permission denied",
|
|
851
|
+
solution: "Check access permissions for this operation",
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
code: 404,
|
|
855
|
+
message: "Resource not found",
|
|
856
|
+
solution: "Verify resource name, namespace, and path",
|
|
857
|
+
},
|
|
858
|
+
{
|
|
859
|
+
code: 409,
|
|
860
|
+
message: "Resource already exists",
|
|
861
|
+
solution: "Use different name or update existing resource",
|
|
862
|
+
},
|
|
863
|
+
{
|
|
864
|
+
code: 429,
|
|
865
|
+
message: "Rate limit exceeded",
|
|
866
|
+
solution: "Wait before retrying the operation",
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
code: 500,
|
|
870
|
+
message: "Server error",
|
|
871
|
+
solution: "Retry operation or contact support",
|
|
872
|
+
},
|
|
873
|
+
],
|
|
874
|
+
conditions: {
|
|
875
|
+
postconditions: [],
|
|
876
|
+
prerequisites: ["Active namespace"],
|
|
877
|
+
},
|
|
878
|
+
confirmation_required: false,
|
|
879
|
+
danger_level: "low",
|
|
880
|
+
examples: [
|
|
881
|
+
{
|
|
882
|
+
command: "f5xcctl discovery discovered-service get {name} --namespace {namespace}",
|
|
883
|
+
description: "Get specific discovered-service",
|
|
884
|
+
use_case: "get_specific",
|
|
885
|
+
},
|
|
886
|
+
],
|
|
887
|
+
field_docs: {},
|
|
888
|
+
optional_fields: [],
|
|
889
|
+
performance_impact: {
|
|
890
|
+
latency: "low",
|
|
891
|
+
resource_usage: "low",
|
|
892
|
+
},
|
|
893
|
+
purpose: "Retrieve specific discovered-service",
|
|
894
|
+
required_fields: ["path.name", "path.namespace"],
|
|
895
|
+
side_effects: {},
|
|
896
|
+
},
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
toolName: "f5xc-api-telemetryandinsights-discovered-service-list",
|
|
900
|
+
method: "GET",
|
|
901
|
+
path: "/api/discovery/custom/namespaces/{namespace}/discovered_services",
|
|
902
|
+
operation: "list",
|
|
903
|
+
domain: "telemetry_and_insights",
|
|
904
|
+
resource: "discovered-service",
|
|
905
|
+
summary: "List discovered services of specific type.",
|
|
906
|
+
description: "List the discovered services of specific type like virtual-servers, K8s, consul, NGINX server, etc.",
|
|
907
|
+
pathParameters: [
|
|
908
|
+
{
|
|
909
|
+
description: "Namespace\nx-required\nNamespace of the discovered service for current request.",
|
|
910
|
+
in: "path",
|
|
911
|
+
name: "namespace",
|
|
912
|
+
required: true,
|
|
913
|
+
schema: {
|
|
914
|
+
type: "string",
|
|
915
|
+
},
|
|
916
|
+
"x-displayname": "Namespace",
|
|
917
|
+
"x-ves-example": "Shared",
|
|
918
|
+
},
|
|
919
|
+
],
|
|
920
|
+
queryParameters: [
|
|
921
|
+
{
|
|
922
|
+
description: "Filter results to only include items referencing this discovery object name.",
|
|
923
|
+
in: "query",
|
|
924
|
+
name: "discovery_name",
|
|
925
|
+
required: false,
|
|
926
|
+
schema: {
|
|
927
|
+
type: "string",
|
|
928
|
+
},
|
|
929
|
+
"x-displayname": "Discovery Name Filter.",
|
|
930
|
+
"x-ves-example": "Disc-cbip-1.",
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
description: "Identifies the discovered service type. Omit for all types.",
|
|
934
|
+
in: "query",
|
|
935
|
+
name: "service_type",
|
|
936
|
+
required: false,
|
|
937
|
+
schema: {
|
|
938
|
+
type: "string",
|
|
939
|
+
},
|
|
940
|
+
"x-displayname": "Service Type.",
|
|
941
|
+
"x-ves-example": "Bigip_virtual_server.",
|
|
942
|
+
},
|
|
943
|
+
],
|
|
944
|
+
requestBodySchema: null,
|
|
945
|
+
responseSchema: {
|
|
946
|
+
$ref: "#/components/schemas/discovered_serviceListServicesResponse",
|
|
947
|
+
},
|
|
948
|
+
requiredParams: ["namespace"],
|
|
949
|
+
operationId: "ves.io.schema.discovered_service.CustomAPI.ListDiscoveredServices",
|
|
950
|
+
tags: ["Service Mesh"],
|
|
951
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
952
|
+
displayName: null,
|
|
953
|
+
dangerLevel: "low",
|
|
954
|
+
sideEffects: null,
|
|
955
|
+
requiredFields: ["path.namespace"],
|
|
956
|
+
cliExamples: [
|
|
957
|
+
{
|
|
958
|
+
command: "f5xcctl discovery discovered-service list --namespace {namespace}",
|
|
959
|
+
description: "List all discovered-services",
|
|
960
|
+
use_case: "list_all",
|
|
961
|
+
},
|
|
962
|
+
],
|
|
963
|
+
confirmationRequired: false,
|
|
964
|
+
parameterExamples: {
|
|
965
|
+
discovery_name: "Disc-cbip-1.",
|
|
966
|
+
namespace: "Shared",
|
|
967
|
+
service_type: "Bigip_virtual_server.",
|
|
968
|
+
},
|
|
969
|
+
validationRules: {},
|
|
970
|
+
operationMetadata: {
|
|
971
|
+
common_errors: [
|
|
972
|
+
{
|
|
973
|
+
code: 401,
|
|
974
|
+
message: "Authentication required",
|
|
975
|
+
solution: "Provide valid API credentials",
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
code: 403,
|
|
979
|
+
message: "Permission denied",
|
|
980
|
+
solution: "Check access permissions for this operation",
|
|
981
|
+
},
|
|
982
|
+
{
|
|
983
|
+
code: 404,
|
|
984
|
+
message: "Resource not found",
|
|
985
|
+
solution: "Verify resource name, namespace, and path",
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
code: 409,
|
|
989
|
+
message: "Resource already exists",
|
|
990
|
+
solution: "Use different name or update existing resource",
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
code: 429,
|
|
994
|
+
message: "Rate limit exceeded",
|
|
995
|
+
solution: "Wait before retrying the operation",
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
code: 500,
|
|
999
|
+
message: "Server error",
|
|
1000
|
+
solution: "Retry operation or contact support",
|
|
1001
|
+
},
|
|
1002
|
+
],
|
|
1003
|
+
conditions: {
|
|
1004
|
+
postconditions: [],
|
|
1005
|
+
prerequisites: ["Active namespace"],
|
|
1006
|
+
},
|
|
1007
|
+
confirmation_required: false,
|
|
1008
|
+
danger_level: "low",
|
|
1009
|
+
examples: [
|
|
1010
|
+
{
|
|
1011
|
+
command: "f5xcctl discovery discovered-service list --namespace {namespace}",
|
|
1012
|
+
description: "List all discovered-services",
|
|
1013
|
+
use_case: "list_all",
|
|
1014
|
+
},
|
|
1015
|
+
],
|
|
1016
|
+
field_docs: {},
|
|
1017
|
+
optional_fields: [],
|
|
1018
|
+
performance_impact: {
|
|
1019
|
+
latency: "moderate",
|
|
1020
|
+
resource_usage: "moderate",
|
|
1021
|
+
},
|
|
1022
|
+
purpose: "List all discovered-services",
|
|
1023
|
+
required_fields: ["path.namespace"],
|
|
1024
|
+
side_effects: {},
|
|
1025
|
+
},
|
|
1026
|
+
},
|
|
1027
|
+
{
|
|
1028
|
+
toolName: "f5xc-api-telemetryandinsights-edge-create",
|
|
1029
|
+
method: "POST",
|
|
1030
|
+
path: "/api/data/namespaces/{namespace}/graph/connectivity/edge",
|
|
1031
|
+
operation: "create",
|
|
1032
|
+
domain: "telemetry_and_insights",
|
|
1033
|
+
resource: "edge",
|
|
1034
|
+
summary: "Connectivity Edge Query.",
|
|
1035
|
+
description: "Request to GET Connectivity data for an edge.\nThis query is used to GET time-series data for a given edge.",
|
|
1036
|
+
pathParameters: [
|
|
1037
|
+
{
|
|
1038
|
+
description: "Namespace\nThis request is supported only in system namespace.",
|
|
1039
|
+
in: "path",
|
|
1040
|
+
name: "namespace",
|
|
1041
|
+
required: true,
|
|
1042
|
+
schema: {
|
|
1043
|
+
type: "string",
|
|
1044
|
+
},
|
|
1045
|
+
"x-displayname": "Namespace",
|
|
1046
|
+
"x-ves-example": "Value",
|
|
1047
|
+
},
|
|
1048
|
+
],
|
|
1049
|
+
queryParameters: [],
|
|
1050
|
+
requestBodySchema: {
|
|
1051
|
+
$ref: "#/components/schemas/connectivityEdgeRequest",
|
|
1052
|
+
},
|
|
1053
|
+
responseSchema: {
|
|
1054
|
+
$ref: "#/components/schemas/connectivityEdgeResponse",
|
|
1055
|
+
},
|
|
1056
|
+
requiredParams: ["body", "namespace"],
|
|
1057
|
+
operationId: "ves.io.schema.graph.connectivity.CustomAPI.EdgeQuery",
|
|
1058
|
+
tags: ["Observability"],
|
|
1059
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1060
|
+
displayName: null,
|
|
1061
|
+
dangerLevel: "medium",
|
|
1062
|
+
sideEffects: {
|
|
1063
|
+
creates: ["edge"],
|
|
1064
|
+
},
|
|
1065
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1066
|
+
cliExamples: [
|
|
1067
|
+
{
|
|
1068
|
+
command: "f5xcctl data edge create {name} --namespace {namespace}",
|
|
1069
|
+
description: "Create edge",
|
|
1070
|
+
use_case: "basic_create",
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
command: "f5xcctl data edge create -f {file}.yaml",
|
|
1074
|
+
description: "Create from YAML file",
|
|
1075
|
+
use_case: "file_based",
|
|
1076
|
+
},
|
|
1077
|
+
],
|
|
1078
|
+
confirmationRequired: false,
|
|
1079
|
+
parameterExamples: {
|
|
1080
|
+
namespace: "Value",
|
|
1081
|
+
},
|
|
1082
|
+
validationRules: {},
|
|
1083
|
+
operationMetadata: {
|
|
1084
|
+
common_errors: [
|
|
1085
|
+
{
|
|
1086
|
+
code: 401,
|
|
1087
|
+
message: "Authentication required",
|
|
1088
|
+
solution: "Provide valid API credentials",
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
code: 403,
|
|
1092
|
+
message: "Permission denied",
|
|
1093
|
+
solution: "Check access permissions for this operation",
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
code: 404,
|
|
1097
|
+
message: "Resource not found",
|
|
1098
|
+
solution: "Verify resource name, namespace, and path",
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
code: 409,
|
|
1102
|
+
message: "Resource already exists",
|
|
1103
|
+
solution: "Use different name or update existing resource",
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
code: 429,
|
|
1107
|
+
message: "Rate limit exceeded",
|
|
1108
|
+
solution: "Wait before retrying the operation",
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
code: 500,
|
|
1112
|
+
message: "Server error",
|
|
1113
|
+
solution: "Retry operation or contact support",
|
|
1114
|
+
},
|
|
1115
|
+
],
|
|
1116
|
+
conditions: {
|
|
1117
|
+
postconditions: ["Edge resource created", "Resource assigned unique identifier"],
|
|
1118
|
+
prerequisites: ["Active namespace"],
|
|
1119
|
+
},
|
|
1120
|
+
confirmation_required: false,
|
|
1121
|
+
danger_level: "medium",
|
|
1122
|
+
examples: [
|
|
1123
|
+
{
|
|
1124
|
+
command: "f5xcctl data edge create {name} --namespace {namespace}",
|
|
1125
|
+
description: "Create edge",
|
|
1126
|
+
use_case: "basic_create",
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
command: "f5xcctl data edge create -f {file}.yaml",
|
|
1130
|
+
description: "Create from YAML file",
|
|
1131
|
+
use_case: "file_based",
|
|
1132
|
+
},
|
|
1133
|
+
],
|
|
1134
|
+
field_docs: {},
|
|
1135
|
+
optional_fields: [],
|
|
1136
|
+
performance_impact: {
|
|
1137
|
+
latency: "low",
|
|
1138
|
+
resource_usage: "low",
|
|
1139
|
+
},
|
|
1140
|
+
purpose: "Create new edge",
|
|
1141
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1142
|
+
side_effects: {
|
|
1143
|
+
creates: ["edge"],
|
|
1144
|
+
},
|
|
1145
|
+
},
|
|
1146
|
+
},
|
|
1147
|
+
{
|
|
1148
|
+
toolName: "f5xc-api-telemetryandinsights-enable-visibility-create",
|
|
1149
|
+
method: "POST",
|
|
1150
|
+
path: "/api/discovery/namespaces/{namespace}/discovered_services/{name}/enable_visibility",
|
|
1151
|
+
operation: "create",
|
|
1152
|
+
domain: "telemetry_and_insights",
|
|
1153
|
+
resource: "enable-visibility",
|
|
1154
|
+
summary: "Enable visibility in all workspaces.",
|
|
1155
|
+
description: "Enable Visibility of the service in all workspaces. This action will make the\ndiscovered service visible within WAAP, App Connect where the user can perform\nthe workspace specific actions.",
|
|
1156
|
+
pathParameters: [
|
|
1157
|
+
{
|
|
1158
|
+
description: "Service Name\nx-required\nIdentifies the discovered service name.",
|
|
1159
|
+
in: "path",
|
|
1160
|
+
name: "name",
|
|
1161
|
+
required: true,
|
|
1162
|
+
schema: {
|
|
1163
|
+
type: "string",
|
|
1164
|
+
},
|
|
1165
|
+
"x-displayname": "Service Name.",
|
|
1166
|
+
"x-ves-example": "Vs1",
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
description: "Namespace\nx-required\nNamespace of the discovered service for current request.",
|
|
1170
|
+
in: "path",
|
|
1171
|
+
name: "namespace",
|
|
1172
|
+
required: true,
|
|
1173
|
+
schema: {
|
|
1174
|
+
type: "string",
|
|
1175
|
+
},
|
|
1176
|
+
"x-displayname": "Namespace",
|
|
1177
|
+
"x-ves-example": "Shared",
|
|
1178
|
+
},
|
|
1179
|
+
],
|
|
1180
|
+
queryParameters: [],
|
|
1181
|
+
requestBodySchema: {
|
|
1182
|
+
$ref: "#/components/schemas/discovered_serviceEnableVisibilityRequest",
|
|
1183
|
+
},
|
|
1184
|
+
responseSchema: {
|
|
1185
|
+
$ref: "#/components/schemas/discovered_serviceEnableVisibilityResponse",
|
|
1186
|
+
},
|
|
1187
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1188
|
+
operationId: "ves.io.schema.discovered_service.CustomAPI.EnableVisibility",
|
|
1189
|
+
tags: ["Service Mesh"],
|
|
1190
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1191
|
+
displayName: null,
|
|
1192
|
+
dangerLevel: "medium",
|
|
1193
|
+
sideEffects: {
|
|
1194
|
+
creates: ["enable-visibility"],
|
|
1195
|
+
},
|
|
1196
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
1197
|
+
cliExamples: [
|
|
1198
|
+
{
|
|
1199
|
+
command: "f5xcctl discovery enable-visibility create {name} --namespace {namespace}",
|
|
1200
|
+
description: "Create enable-visibility",
|
|
1201
|
+
use_case: "basic_create",
|
|
1202
|
+
},
|
|
1203
|
+
{
|
|
1204
|
+
command: "f5xcctl discovery enable-visibility create -f {file}.yaml",
|
|
1205
|
+
description: "Create from YAML file",
|
|
1206
|
+
use_case: "file_based",
|
|
1207
|
+
},
|
|
1208
|
+
],
|
|
1209
|
+
confirmationRequired: false,
|
|
1210
|
+
parameterExamples: {
|
|
1211
|
+
name: "Vs1",
|
|
1212
|
+
namespace: "Shared",
|
|
1213
|
+
},
|
|
1214
|
+
validationRules: {},
|
|
1215
|
+
operationMetadata: {
|
|
1216
|
+
common_errors: [
|
|
1217
|
+
{
|
|
1218
|
+
code: 401,
|
|
1219
|
+
message: "Authentication required",
|
|
1220
|
+
solution: "Provide valid API credentials",
|
|
1221
|
+
},
|
|
1222
|
+
{
|
|
1223
|
+
code: 403,
|
|
1224
|
+
message: "Permission denied",
|
|
1225
|
+
solution: "Check access permissions for this operation",
|
|
1226
|
+
},
|
|
1227
|
+
{
|
|
1228
|
+
code: 404,
|
|
1229
|
+
message: "Resource not found",
|
|
1230
|
+
solution: "Verify resource name, namespace, and path",
|
|
1231
|
+
},
|
|
1232
|
+
{
|
|
1233
|
+
code: 409,
|
|
1234
|
+
message: "Resource already exists",
|
|
1235
|
+
solution: "Use different name or update existing resource",
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
code: 429,
|
|
1239
|
+
message: "Rate limit exceeded",
|
|
1240
|
+
solution: "Wait before retrying the operation",
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
code: 500,
|
|
1244
|
+
message: "Server error",
|
|
1245
|
+
solution: "Retry operation or contact support",
|
|
1246
|
+
},
|
|
1247
|
+
],
|
|
1248
|
+
conditions: {
|
|
1249
|
+
postconditions: [
|
|
1250
|
+
"Enable-visibility resource created",
|
|
1251
|
+
"Resource assigned unique identifier",
|
|
1252
|
+
],
|
|
1253
|
+
prerequisites: ["Active namespace"],
|
|
1254
|
+
},
|
|
1255
|
+
confirmation_required: false,
|
|
1256
|
+
danger_level: "medium",
|
|
1257
|
+
examples: [
|
|
1258
|
+
{
|
|
1259
|
+
command: "f5xcctl discovery enable-visibility create {name} --namespace {namespace}",
|
|
1260
|
+
description: "Create enable-visibility",
|
|
1261
|
+
use_case: "basic_create",
|
|
1262
|
+
},
|
|
1263
|
+
{
|
|
1264
|
+
command: "f5xcctl discovery enable-visibility create -f {file}.yaml",
|
|
1265
|
+
description: "Create from YAML file",
|
|
1266
|
+
use_case: "file_based",
|
|
1267
|
+
},
|
|
1268
|
+
],
|
|
1269
|
+
field_docs: {},
|
|
1270
|
+
optional_fields: [],
|
|
1271
|
+
performance_impact: {
|
|
1272
|
+
latency: "low",
|
|
1273
|
+
resource_usage: "low",
|
|
1274
|
+
},
|
|
1275
|
+
purpose: "Create new enable-visibility",
|
|
1276
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
1277
|
+
side_effects: {
|
|
1278
|
+
creates: ["enable-visibility"],
|
|
1279
|
+
},
|
|
1280
|
+
},
|
|
1281
|
+
},
|
|
1282
|
+
{
|
|
1283
|
+
toolName: "f5xc-api-telemetryandinsights-flow-collection-create",
|
|
1284
|
+
method: "POST",
|
|
1285
|
+
path: "/api/data/namespaces/system/flows/flow_collection",
|
|
1286
|
+
operation: "create",
|
|
1287
|
+
domain: "telemetry_and_insights",
|
|
1288
|
+
resource: "flow-collection",
|
|
1289
|
+
summary: "Flow Collection.",
|
|
1290
|
+
description: "Request to GET flow collection from the flow records.",
|
|
1291
|
+
pathParameters: [],
|
|
1292
|
+
queryParameters: [],
|
|
1293
|
+
requestBodySchema: null,
|
|
1294
|
+
responseSchema: {
|
|
1295
|
+
$ref: "#/components/schemas/flowTopTalkersResponse",
|
|
1296
|
+
},
|
|
1297
|
+
requiredParams: [],
|
|
1298
|
+
operationId: "ves.io.schema.flow.CustomAPI.FlowCollection",
|
|
1299
|
+
tags: ["Other"],
|
|
1300
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1301
|
+
displayName: null,
|
|
1302
|
+
dangerLevel: "medium",
|
|
1303
|
+
sideEffects: {
|
|
1304
|
+
creates: ["flow-collection"],
|
|
1305
|
+
},
|
|
1306
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
1307
|
+
cliExamples: [
|
|
1308
|
+
{
|
|
1309
|
+
command: "f5xcctl data flow-collection create {name} --namespace {namespace}",
|
|
1310
|
+
description: "Create flow-collection",
|
|
1311
|
+
use_case: "basic_create",
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
command: "f5xcctl data flow-collection create -f {file}.yaml",
|
|
1315
|
+
description: "Create from YAML file",
|
|
1316
|
+
use_case: "file_based",
|
|
1317
|
+
},
|
|
1318
|
+
],
|
|
1319
|
+
confirmationRequired: false,
|
|
1320
|
+
parameterExamples: {},
|
|
1321
|
+
validationRules: {},
|
|
1322
|
+
operationMetadata: {
|
|
1323
|
+
common_errors: [
|
|
1324
|
+
{
|
|
1325
|
+
code: 401,
|
|
1326
|
+
message: "Authentication required",
|
|
1327
|
+
solution: "Provide valid API credentials",
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
code: 403,
|
|
1331
|
+
message: "Permission denied",
|
|
1332
|
+
solution: "Check access permissions for this operation",
|
|
1333
|
+
},
|
|
1334
|
+
{
|
|
1335
|
+
code: 404,
|
|
1336
|
+
message: "Resource not found",
|
|
1337
|
+
solution: "Verify resource name, namespace, and path",
|
|
1338
|
+
},
|
|
1339
|
+
{
|
|
1340
|
+
code: 409,
|
|
1341
|
+
message: "Resource already exists",
|
|
1342
|
+
solution: "Use different name or update existing resource",
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
code: 429,
|
|
1346
|
+
message: "Rate limit exceeded",
|
|
1347
|
+
solution: "Wait before retrying the operation",
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
code: 500,
|
|
1351
|
+
message: "Server error",
|
|
1352
|
+
solution: "Retry operation or contact support",
|
|
1353
|
+
},
|
|
1354
|
+
],
|
|
1355
|
+
conditions: {
|
|
1356
|
+
postconditions: ["Flow-collection resource created", "Resource assigned unique identifier"],
|
|
1357
|
+
prerequisites: ["Active namespace"],
|
|
1358
|
+
},
|
|
1359
|
+
confirmation_required: false,
|
|
1360
|
+
danger_level: "medium",
|
|
1361
|
+
examples: [
|
|
1362
|
+
{
|
|
1363
|
+
command: "f5xcctl data flow-collection create {name} --namespace {namespace}",
|
|
1364
|
+
description: "Create flow-collection",
|
|
1365
|
+
use_case: "basic_create",
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
command: "f5xcctl data flow-collection create -f {file}.yaml",
|
|
1369
|
+
description: "Create from YAML file",
|
|
1370
|
+
use_case: "file_based",
|
|
1371
|
+
},
|
|
1372
|
+
],
|
|
1373
|
+
field_docs: {},
|
|
1374
|
+
optional_fields: [],
|
|
1375
|
+
performance_impact: {
|
|
1376
|
+
latency: "low",
|
|
1377
|
+
resource_usage: "low",
|
|
1378
|
+
},
|
|
1379
|
+
purpose: "Create new flow-collection",
|
|
1380
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
1381
|
+
side_effects: {
|
|
1382
|
+
creates: ["flow-collection"],
|
|
1383
|
+
},
|
|
1384
|
+
},
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
toolName: "f5xc-api-telemetryandinsights-health-statu-get",
|
|
1388
|
+
method: "GET",
|
|
1389
|
+
path: "/api/data/namespaces/{namespace}/discovered_services/{name}/health_status",
|
|
1390
|
+
operation: "get",
|
|
1391
|
+
domain: "telemetry_and_insights",
|
|
1392
|
+
resource: "health-statu",
|
|
1393
|
+
summary: "Discovered Service Health Status.",
|
|
1394
|
+
description: "GET Discovered Service Health status.",
|
|
1395
|
+
pathParameters: [
|
|
1396
|
+
{
|
|
1397
|
+
description: "Name\n\nx-required\nName of the Discovered Service.",
|
|
1398
|
+
in: "path",
|
|
1399
|
+
name: "name",
|
|
1400
|
+
required: true,
|
|
1401
|
+
schema: {
|
|
1402
|
+
type: "string",
|
|
1403
|
+
},
|
|
1404
|
+
"x-displayname": "Name",
|
|
1405
|
+
"x-ves-example": "Vs1",
|
|
1406
|
+
},
|
|
1407
|
+
{
|
|
1408
|
+
description: "Namespace\n\nx-required\nNamespace in which the Discovered Service is present.",
|
|
1409
|
+
in: "path",
|
|
1410
|
+
name: "namespace",
|
|
1411
|
+
required: true,
|
|
1412
|
+
schema: {
|
|
1413
|
+
type: "string",
|
|
1414
|
+
},
|
|
1415
|
+
"x-displayname": "Namespace",
|
|
1416
|
+
"x-ves-example": "Ns1",
|
|
1417
|
+
},
|
|
1418
|
+
],
|
|
1419
|
+
queryParameters: [],
|
|
1420
|
+
requestBodySchema: null,
|
|
1421
|
+
responseSchema: {
|
|
1422
|
+
$ref: "#/components/schemas/discovered_serviceDiscoveredServiceHealthStatusResponse",
|
|
1423
|
+
},
|
|
1424
|
+
requiredParams: ["name", "namespace"],
|
|
1425
|
+
operationId: "ves.io.schema.discovered_service.CustomDataAPI.DiscoveredServiceHealthStatus",
|
|
1426
|
+
tags: ["Other"],
|
|
1427
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1428
|
+
displayName: null,
|
|
1429
|
+
dangerLevel: "low",
|
|
1430
|
+
sideEffects: null,
|
|
1431
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1432
|
+
cliExamples: [
|
|
1433
|
+
{
|
|
1434
|
+
command: "f5xcctl data health-statu get {name} --namespace {namespace}",
|
|
1435
|
+
description: "Get specific health-statu",
|
|
1436
|
+
use_case: "get_specific",
|
|
1437
|
+
},
|
|
1438
|
+
],
|
|
1439
|
+
confirmationRequired: false,
|
|
1440
|
+
parameterExamples: {
|
|
1441
|
+
name: "Vs1",
|
|
1442
|
+
namespace: "Ns1",
|
|
1443
|
+
},
|
|
1444
|
+
validationRules: {},
|
|
1445
|
+
operationMetadata: {
|
|
1446
|
+
common_errors: [
|
|
1447
|
+
{
|
|
1448
|
+
code: 401,
|
|
1449
|
+
message: "Authentication required",
|
|
1450
|
+
solution: "Provide valid API credentials",
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
code: 403,
|
|
1454
|
+
message: "Permission denied",
|
|
1455
|
+
solution: "Check access permissions for this operation",
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
code: 404,
|
|
1459
|
+
message: "Resource not found",
|
|
1460
|
+
solution: "Verify resource name, namespace, and path",
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
code: 409,
|
|
1464
|
+
message: "Resource already exists",
|
|
1465
|
+
solution: "Use different name or update existing resource",
|
|
1466
|
+
},
|
|
1467
|
+
{
|
|
1468
|
+
code: 429,
|
|
1469
|
+
message: "Rate limit exceeded",
|
|
1470
|
+
solution: "Wait before retrying the operation",
|
|
1471
|
+
},
|
|
1472
|
+
{
|
|
1473
|
+
code: 500,
|
|
1474
|
+
message: "Server error",
|
|
1475
|
+
solution: "Retry operation or contact support",
|
|
1476
|
+
},
|
|
1477
|
+
],
|
|
1478
|
+
conditions: {
|
|
1479
|
+
postconditions: [],
|
|
1480
|
+
prerequisites: ["Active namespace"],
|
|
1481
|
+
},
|
|
1482
|
+
confirmation_required: false,
|
|
1483
|
+
danger_level: "low",
|
|
1484
|
+
examples: [
|
|
1485
|
+
{
|
|
1486
|
+
command: "f5xcctl data health-statu get {name} --namespace {namespace}",
|
|
1487
|
+
description: "Get specific health-statu",
|
|
1488
|
+
use_case: "get_specific",
|
|
1489
|
+
},
|
|
1490
|
+
],
|
|
1491
|
+
field_docs: {},
|
|
1492
|
+
optional_fields: [],
|
|
1493
|
+
performance_impact: {
|
|
1494
|
+
latency: "moderate",
|
|
1495
|
+
resource_usage: "moderate",
|
|
1496
|
+
},
|
|
1497
|
+
purpose: "Retrieve specific health-statu",
|
|
1498
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1499
|
+
side_effects: {},
|
|
1500
|
+
},
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
toolName: "f5xc-api-telemetryandinsights-instance-create",
|
|
1504
|
+
method: "POST",
|
|
1505
|
+
path: "/api/data/namespaces/{namespace}/graph/service/node/instance",
|
|
1506
|
+
operation: "create",
|
|
1507
|
+
domain: "telemetry_and_insights",
|
|
1508
|
+
resource: "instance",
|
|
1509
|
+
summary: "Service Instance Query.",
|
|
1510
|
+
description: "Request to GET time-series data for a service instance.",
|
|
1511
|
+
pathParameters: [
|
|
1512
|
+
{
|
|
1513
|
+
description: "Namespace\nnamespace is used to scope application traffic to a given namespace.",
|
|
1514
|
+
in: "path",
|
|
1515
|
+
name: "namespace",
|
|
1516
|
+
required: true,
|
|
1517
|
+
schema: {
|
|
1518
|
+
type: "string",
|
|
1519
|
+
},
|
|
1520
|
+
"x-displayname": "Namespace",
|
|
1521
|
+
"x-ves-example": "Value",
|
|
1522
|
+
},
|
|
1523
|
+
],
|
|
1524
|
+
queryParameters: [],
|
|
1525
|
+
requestBodySchema: {
|
|
1526
|
+
$ref: "#/components/schemas/serviceInstanceRequest",
|
|
1527
|
+
},
|
|
1528
|
+
responseSchema: {
|
|
1529
|
+
$ref: "#/components/schemas/serviceInstanceResponse",
|
|
1530
|
+
},
|
|
1531
|
+
requiredParams: ["body", "namespace"],
|
|
1532
|
+
operationId: "ves.io.schema.graph.service.CustomAPI.InstanceQuery",
|
|
1533
|
+
tags: ["Observability"],
|
|
1534
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1535
|
+
displayName: null,
|
|
1536
|
+
dangerLevel: "medium",
|
|
1537
|
+
sideEffects: {
|
|
1538
|
+
creates: ["instance"],
|
|
1539
|
+
},
|
|
1540
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1541
|
+
cliExamples: [
|
|
1542
|
+
{
|
|
1543
|
+
command: "f5xcctl data instance create -f {file}.yaml",
|
|
1544
|
+
description: "Create from YAML file",
|
|
1545
|
+
use_case: "file_based",
|
|
1546
|
+
},
|
|
1547
|
+
{
|
|
1548
|
+
command: "f5xcctl data instance create {name} --namespace {namespace}",
|
|
1549
|
+
description: "Create instance",
|
|
1550
|
+
use_case: "basic_create",
|
|
1551
|
+
},
|
|
1552
|
+
],
|
|
1553
|
+
confirmationRequired: false,
|
|
1554
|
+
parameterExamples: {
|
|
1555
|
+
namespace: "Value",
|
|
1556
|
+
},
|
|
1557
|
+
validationRules: {},
|
|
1558
|
+
operationMetadata: {
|
|
1559
|
+
common_errors: [
|
|
1560
|
+
{
|
|
1561
|
+
code: 401,
|
|
1562
|
+
message: "Authentication required",
|
|
1563
|
+
solution: "Provide valid API credentials",
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
code: 403,
|
|
1567
|
+
message: "Permission denied",
|
|
1568
|
+
solution: "Check access permissions for this operation",
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
code: 404,
|
|
1572
|
+
message: "Resource not found",
|
|
1573
|
+
solution: "Verify resource name, namespace, and path",
|
|
1574
|
+
},
|
|
1575
|
+
{
|
|
1576
|
+
code: 409,
|
|
1577
|
+
message: "Resource already exists",
|
|
1578
|
+
solution: "Use different name or update existing resource",
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
code: 429,
|
|
1582
|
+
message: "Rate limit exceeded",
|
|
1583
|
+
solution: "Wait before retrying the operation",
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
code: 500,
|
|
1587
|
+
message: "Server error",
|
|
1588
|
+
solution: "Retry operation or contact support",
|
|
1589
|
+
},
|
|
1590
|
+
],
|
|
1591
|
+
conditions: {
|
|
1592
|
+
postconditions: ["Instance resource created", "Resource assigned unique identifier"],
|
|
1593
|
+
prerequisites: ["Active namespace"],
|
|
1594
|
+
},
|
|
1595
|
+
confirmation_required: false,
|
|
1596
|
+
danger_level: "medium",
|
|
1597
|
+
examples: [
|
|
1598
|
+
{
|
|
1599
|
+
command: "f5xcctl data instance create {name} --namespace {namespace}",
|
|
1600
|
+
description: "Create instance",
|
|
1601
|
+
use_case: "basic_create",
|
|
1602
|
+
},
|
|
1603
|
+
{
|
|
1604
|
+
command: "f5xcctl data instance create -f {file}.yaml",
|
|
1605
|
+
description: "Create from YAML file",
|
|
1606
|
+
use_case: "file_based",
|
|
1607
|
+
},
|
|
1608
|
+
],
|
|
1609
|
+
field_docs: {},
|
|
1610
|
+
optional_fields: [],
|
|
1611
|
+
performance_impact: {
|
|
1612
|
+
latency: "low",
|
|
1613
|
+
resource_usage: "low",
|
|
1614
|
+
},
|
|
1615
|
+
purpose: "Create new instance",
|
|
1616
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1617
|
+
side_effects: {
|
|
1618
|
+
creates: ["instance"],
|
|
1619
|
+
},
|
|
1620
|
+
},
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
toolName: "f5xc-api-telemetryandinsights-lb-cache-content-create",
|
|
1624
|
+
method: "POST",
|
|
1625
|
+
path: "/api/data/namespaces/{namespace}/graph/lb_cache_content",
|
|
1626
|
+
operation: "create",
|
|
1627
|
+
domain: "telemetry_and_insights",
|
|
1628
|
+
resource: "lb-cache-content",
|
|
1629
|
+
summary: "Cacheability query Query.",
|
|
1630
|
+
description: "Request to GET time-series cacheable data for HTTP-LBs.",
|
|
1631
|
+
pathParameters: [
|
|
1632
|
+
{
|
|
1633
|
+
description: "Namespace\nnamespace is used to scope load balancers. Only LB's in given namespace will be considered.",
|
|
1634
|
+
in: "path",
|
|
1635
|
+
name: "namespace",
|
|
1636
|
+
required: true,
|
|
1637
|
+
schema: {
|
|
1638
|
+
type: "string",
|
|
1639
|
+
},
|
|
1640
|
+
"x-displayname": "Namespace",
|
|
1641
|
+
"x-ves-example": "Value",
|
|
1642
|
+
},
|
|
1643
|
+
],
|
|
1644
|
+
queryParameters: [],
|
|
1645
|
+
requestBodySchema: {
|
|
1646
|
+
$ref: "#/components/schemas/serviceLBCacheContentRequest",
|
|
1647
|
+
},
|
|
1648
|
+
responseSchema: {
|
|
1649
|
+
$ref: "#/components/schemas/serviceLBCacheContentResponse",
|
|
1650
|
+
},
|
|
1651
|
+
requiredParams: ["body", "namespace"],
|
|
1652
|
+
operationId: "ves.io.schema.graph.service.CustomAPI.LBCacheContent",
|
|
1653
|
+
tags: ["Observability"],
|
|
1654
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1655
|
+
displayName: null,
|
|
1656
|
+
dangerLevel: "medium",
|
|
1657
|
+
sideEffects: {
|
|
1658
|
+
creates: ["lb-cache-content"],
|
|
1659
|
+
},
|
|
1660
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1661
|
+
cliExamples: [
|
|
1662
|
+
{
|
|
1663
|
+
command: "f5xcctl data lb-cache-content create -f {file}.yaml",
|
|
1664
|
+
description: "Create from YAML file",
|
|
1665
|
+
use_case: "file_based",
|
|
1666
|
+
},
|
|
1667
|
+
{
|
|
1668
|
+
command: "f5xcctl data lb-cache-content create {name} --namespace {namespace}",
|
|
1669
|
+
description: "Create lb-cache-content",
|
|
1670
|
+
use_case: "basic_create",
|
|
1671
|
+
},
|
|
1672
|
+
],
|
|
1673
|
+
confirmationRequired: false,
|
|
1674
|
+
parameterExamples: {
|
|
1675
|
+
namespace: "Value",
|
|
1676
|
+
},
|
|
1677
|
+
validationRules: {},
|
|
1678
|
+
operationMetadata: {
|
|
1679
|
+
common_errors: [
|
|
1680
|
+
{
|
|
1681
|
+
code: 401,
|
|
1682
|
+
message: "Authentication required",
|
|
1683
|
+
solution: "Provide valid API credentials",
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
code: 403,
|
|
1687
|
+
message: "Permission denied",
|
|
1688
|
+
solution: "Check access permissions for this operation",
|
|
1689
|
+
},
|
|
1690
|
+
{
|
|
1691
|
+
code: 404,
|
|
1692
|
+
message: "Resource not found",
|
|
1693
|
+
solution: "Verify resource name, namespace, and path",
|
|
1694
|
+
},
|
|
1695
|
+
{
|
|
1696
|
+
code: 409,
|
|
1697
|
+
message: "Resource already exists",
|
|
1698
|
+
solution: "Use different name or update existing resource",
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
code: 429,
|
|
1702
|
+
message: "Rate limit exceeded",
|
|
1703
|
+
solution: "Wait before retrying the operation",
|
|
1704
|
+
},
|
|
1705
|
+
{
|
|
1706
|
+
code: 500,
|
|
1707
|
+
message: "Server error",
|
|
1708
|
+
solution: "Retry operation or contact support",
|
|
1709
|
+
},
|
|
1710
|
+
],
|
|
1711
|
+
conditions: {
|
|
1712
|
+
postconditions: [
|
|
1713
|
+
"Lb-cache-content resource created",
|
|
1714
|
+
"Resource assigned unique identifier",
|
|
1715
|
+
],
|
|
1716
|
+
prerequisites: ["Active namespace"],
|
|
1717
|
+
},
|
|
1718
|
+
confirmation_required: false,
|
|
1719
|
+
danger_level: "medium",
|
|
1720
|
+
examples: [
|
|
1721
|
+
{
|
|
1722
|
+
command: "f5xcctl data lb-cache-content create {name} --namespace {namespace}",
|
|
1723
|
+
description: "Create lb-cache-content",
|
|
1724
|
+
use_case: "basic_create",
|
|
1725
|
+
},
|
|
1726
|
+
{
|
|
1727
|
+
command: "f5xcctl data lb-cache-content create -f {file}.yaml",
|
|
1728
|
+
description: "Create from YAML file",
|
|
1729
|
+
use_case: "file_based",
|
|
1730
|
+
},
|
|
1731
|
+
],
|
|
1732
|
+
field_docs: {},
|
|
1733
|
+
optional_fields: [],
|
|
1734
|
+
performance_impact: {
|
|
1735
|
+
latency: "low",
|
|
1736
|
+
resource_usage: "low",
|
|
1737
|
+
},
|
|
1738
|
+
purpose: "Create new lb-cache-content",
|
|
1739
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1740
|
+
side_effects: {
|
|
1741
|
+
creates: ["lb-cache-content"],
|
|
1742
|
+
},
|
|
1743
|
+
},
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
toolName: "f5xc-api-telemetryandinsights-node-create",
|
|
1747
|
+
method: "POST",
|
|
1748
|
+
path: "/api/data/namespaces/{namespace}/graph/connectivity/node",
|
|
1749
|
+
operation: "create",
|
|
1750
|
+
domain: "telemetry_and_insights",
|
|
1751
|
+
resource: "node",
|
|
1752
|
+
summary: "Connectivity Node Query.",
|
|
1753
|
+
description: "Request to GET Connectivity data for a site.\nThis query is used to GET time-series data for a given site.",
|
|
1754
|
+
pathParameters: [
|
|
1755
|
+
{
|
|
1756
|
+
description: "Namespace\nThis request is supported only in system namespace.",
|
|
1757
|
+
in: "path",
|
|
1758
|
+
name: "namespace",
|
|
1759
|
+
required: true,
|
|
1760
|
+
schema: {
|
|
1761
|
+
type: "string",
|
|
1762
|
+
},
|
|
1763
|
+
"x-displayname": "Namespace",
|
|
1764
|
+
"x-ves-example": "Value",
|
|
1765
|
+
},
|
|
1766
|
+
],
|
|
1767
|
+
queryParameters: [],
|
|
1768
|
+
requestBodySchema: {
|
|
1769
|
+
$ref: "#/components/schemas/connectivityNodeRequest",
|
|
1770
|
+
},
|
|
1771
|
+
responseSchema: {
|
|
1772
|
+
$ref: "#/components/schemas/connectivityNodeResponse",
|
|
1773
|
+
},
|
|
1774
|
+
requiredParams: ["body", "namespace"],
|
|
1775
|
+
operationId: "ves.io.schema.graph.connectivity.CustomAPI.NodeQuery",
|
|
1776
|
+
tags: ["Observability"],
|
|
1777
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1778
|
+
displayName: null,
|
|
1779
|
+
dangerLevel: "medium",
|
|
1780
|
+
sideEffects: {
|
|
1781
|
+
creates: ["node"],
|
|
1782
|
+
},
|
|
1783
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1784
|
+
cliExamples: [
|
|
1785
|
+
{
|
|
1786
|
+
command: "f5xcctl data node create -f {file}.yaml",
|
|
1787
|
+
description: "Create from YAML file",
|
|
1788
|
+
use_case: "file_based",
|
|
1789
|
+
},
|
|
1790
|
+
{
|
|
1791
|
+
command: "f5xcctl data node create {name} --namespace {namespace}",
|
|
1792
|
+
description: "Create node",
|
|
1793
|
+
use_case: "basic_create",
|
|
1794
|
+
},
|
|
1795
|
+
],
|
|
1796
|
+
confirmationRequired: false,
|
|
1797
|
+
parameterExamples: {
|
|
1798
|
+
namespace: "Value",
|
|
1799
|
+
},
|
|
1800
|
+
validationRules: {},
|
|
1801
|
+
operationMetadata: {
|
|
1802
|
+
common_errors: [
|
|
1803
|
+
{
|
|
1804
|
+
code: 401,
|
|
1805
|
+
message: "Authentication required",
|
|
1806
|
+
solution: "Provide valid API credentials",
|
|
1807
|
+
},
|
|
1808
|
+
{
|
|
1809
|
+
code: 403,
|
|
1810
|
+
message: "Permission denied",
|
|
1811
|
+
solution: "Check access permissions for this operation",
|
|
1812
|
+
},
|
|
1813
|
+
{
|
|
1814
|
+
code: 404,
|
|
1815
|
+
message: "Resource not found",
|
|
1816
|
+
solution: "Verify resource name, namespace, and path",
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
code: 409,
|
|
1820
|
+
message: "Resource already exists",
|
|
1821
|
+
solution: "Use different name or update existing resource",
|
|
1822
|
+
},
|
|
1823
|
+
{
|
|
1824
|
+
code: 429,
|
|
1825
|
+
message: "Rate limit exceeded",
|
|
1826
|
+
solution: "Wait before retrying the operation",
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
code: 500,
|
|
1830
|
+
message: "Server error",
|
|
1831
|
+
solution: "Retry operation or contact support",
|
|
1832
|
+
},
|
|
1833
|
+
],
|
|
1834
|
+
conditions: {
|
|
1835
|
+
postconditions: ["Node resource created", "Resource assigned unique identifier"],
|
|
1836
|
+
prerequisites: ["Active namespace"],
|
|
1837
|
+
},
|
|
1838
|
+
confirmation_required: false,
|
|
1839
|
+
danger_level: "medium",
|
|
1840
|
+
examples: [
|
|
1841
|
+
{
|
|
1842
|
+
command: "f5xcctl data node create {name} --namespace {namespace}",
|
|
1843
|
+
description: "Create node",
|
|
1844
|
+
use_case: "basic_create",
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
command: "f5xcctl data node create -f {file}.yaml",
|
|
1848
|
+
description: "Create from YAML file",
|
|
1849
|
+
use_case: "file_based",
|
|
1850
|
+
},
|
|
1851
|
+
],
|
|
1852
|
+
field_docs: {},
|
|
1853
|
+
optional_fields: [],
|
|
1854
|
+
performance_impact: {
|
|
1855
|
+
latency: "low",
|
|
1856
|
+
resource_usage: "low",
|
|
1857
|
+
},
|
|
1858
|
+
purpose: "Create new node",
|
|
1859
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1860
|
+
side_effects: {
|
|
1861
|
+
creates: ["node"],
|
|
1862
|
+
},
|
|
1863
|
+
},
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
toolName: "f5xc-api-telemetryandinsights-service-create",
|
|
1867
|
+
method: "POST",
|
|
1868
|
+
path: "/api/data/namespaces/{namespace}/graph/service",
|
|
1869
|
+
operation: "create",
|
|
1870
|
+
domain: "telemetry_and_insights",
|
|
1871
|
+
resource: "service",
|
|
1872
|
+
summary: "Service Graph Query.",
|
|
1873
|
+
description: "Request to GET monitoring data for a service mesh of a given application.",
|
|
1874
|
+
pathParameters: [
|
|
1875
|
+
{
|
|
1876
|
+
description: "Namespace\nnamespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
|
|
1877
|
+
in: "path",
|
|
1878
|
+
name: "namespace",
|
|
1879
|
+
required: true,
|
|
1880
|
+
schema: {
|
|
1881
|
+
type: "string",
|
|
1882
|
+
},
|
|
1883
|
+
"x-displayname": "Namespace",
|
|
1884
|
+
"x-ves-example": "Value",
|
|
1885
|
+
},
|
|
1886
|
+
],
|
|
1887
|
+
queryParameters: [],
|
|
1888
|
+
requestBodySchema: null,
|
|
1889
|
+
responseSchema: {
|
|
1890
|
+
$ref: "#/components/schemas/serviceResponse",
|
|
1891
|
+
},
|
|
1892
|
+
requiredParams: ["namespace"],
|
|
1893
|
+
operationId: "ves.io.schema.graph.service.CustomAPI.Query",
|
|
1894
|
+
tags: ["Observability"],
|
|
1895
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
1896
|
+
displayName: null,
|
|
1897
|
+
dangerLevel: "medium",
|
|
1898
|
+
sideEffects: {
|
|
1899
|
+
creates: ["service"],
|
|
1900
|
+
},
|
|
1901
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1902
|
+
cliExamples: [
|
|
1903
|
+
{
|
|
1904
|
+
command: "f5xcctl data service create -f {file}.yaml",
|
|
1905
|
+
description: "Create from YAML file",
|
|
1906
|
+
use_case: "file_based",
|
|
1907
|
+
},
|
|
1908
|
+
{
|
|
1909
|
+
command: "f5xcctl data service create {name} --namespace {namespace}",
|
|
1910
|
+
description: "Create service",
|
|
1911
|
+
use_case: "basic_create",
|
|
1912
|
+
},
|
|
1913
|
+
],
|
|
1914
|
+
confirmationRequired: false,
|
|
1915
|
+
parameterExamples: {
|
|
1916
|
+
namespace: "Value",
|
|
1917
|
+
},
|
|
1918
|
+
validationRules: {},
|
|
1919
|
+
operationMetadata: {
|
|
1920
|
+
common_errors: [
|
|
1921
|
+
{
|
|
1922
|
+
code: 401,
|
|
1923
|
+
message: "Authentication required",
|
|
1924
|
+
solution: "Provide valid API credentials",
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
code: 403,
|
|
1928
|
+
message: "Permission denied",
|
|
1929
|
+
solution: "Check access permissions for this operation",
|
|
1930
|
+
},
|
|
1931
|
+
{
|
|
1932
|
+
code: 404,
|
|
1933
|
+
message: "Resource not found",
|
|
1934
|
+
solution: "Verify resource name, namespace, and path",
|
|
1935
|
+
},
|
|
1936
|
+
{
|
|
1937
|
+
code: 409,
|
|
1938
|
+
message: "Resource already exists",
|
|
1939
|
+
solution: "Use different name or update existing resource",
|
|
1940
|
+
},
|
|
1941
|
+
{
|
|
1942
|
+
code: 429,
|
|
1943
|
+
message: "Rate limit exceeded",
|
|
1944
|
+
solution: "Wait before retrying the operation",
|
|
1945
|
+
},
|
|
1946
|
+
{
|
|
1947
|
+
code: 500,
|
|
1948
|
+
message: "Server error",
|
|
1949
|
+
solution: "Retry operation or contact support",
|
|
1950
|
+
},
|
|
1951
|
+
],
|
|
1952
|
+
conditions: {
|
|
1953
|
+
postconditions: ["Service resource created", "Resource assigned unique identifier"],
|
|
1954
|
+
prerequisites: ["Active namespace"],
|
|
1955
|
+
},
|
|
1956
|
+
confirmation_required: false,
|
|
1957
|
+
danger_level: "medium",
|
|
1958
|
+
examples: [
|
|
1959
|
+
{
|
|
1960
|
+
command: "f5xcctl data service create {name} --namespace {namespace}",
|
|
1961
|
+
description: "Create service",
|
|
1962
|
+
use_case: "basic_create",
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
command: "f5xcctl data service create -f {file}.yaml",
|
|
1966
|
+
description: "Create from YAML file",
|
|
1967
|
+
use_case: "file_based",
|
|
1968
|
+
},
|
|
1969
|
+
],
|
|
1970
|
+
field_docs: {},
|
|
1971
|
+
optional_fields: [],
|
|
1972
|
+
performance_impact: {
|
|
1973
|
+
latency: "low",
|
|
1974
|
+
resource_usage: "low",
|
|
1975
|
+
},
|
|
1976
|
+
purpose: "Create new service",
|
|
1977
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1978
|
+
side_effects: {
|
|
1979
|
+
creates: ["service"],
|
|
1980
|
+
},
|
|
1981
|
+
},
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
toolName: "f5xc-api-telemetryandinsights-status-at-site-get",
|
|
1985
|
+
method: "GET",
|
|
1986
|
+
path: "/api/data/namespaces/{namespace}/{kind}/{name}/status_at_site",
|
|
1987
|
+
operation: "get",
|
|
1988
|
+
domain: "telemetry_and_insights",
|
|
1989
|
+
resource: "status-at-site",
|
|
1990
|
+
summary: "GET Status.",
|
|
1991
|
+
description: "GET status of an object in a given site.",
|
|
1992
|
+
pathParameters: [
|
|
1993
|
+
{
|
|
1994
|
+
description: "Kind\n\nx-required\nObject type.",
|
|
1995
|
+
in: "path",
|
|
1996
|
+
name: "kind",
|
|
1997
|
+
required: true,
|
|
1998
|
+
schema: {
|
|
1999
|
+
type: "string",
|
|
2000
|
+
},
|
|
2001
|
+
"x-displayname": "Kind",
|
|
2002
|
+
"x-ves-example": "Virtual_host.",
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
description: "Name\n\nx-required\nObject name.",
|
|
2006
|
+
in: "path",
|
|
2007
|
+
name: "name",
|
|
2008
|
+
required: true,
|
|
2009
|
+
schema: {
|
|
2010
|
+
type: "string",
|
|
2011
|
+
},
|
|
2012
|
+
"x-displayname": "Name",
|
|
2013
|
+
"x-ves-example": "Productpage.",
|
|
2014
|
+
},
|
|
2015
|
+
{
|
|
2016
|
+
description: "Namespace\n\nx-required\nNamespace of the configured object.",
|
|
2017
|
+
in: "path",
|
|
2018
|
+
name: "namespace",
|
|
2019
|
+
required: true,
|
|
2020
|
+
schema: {
|
|
2021
|
+
type: "string",
|
|
2022
|
+
},
|
|
2023
|
+
"x-displayname": "Namespace",
|
|
2024
|
+
"x-ves-example": "Bookinfo",
|
|
2025
|
+
},
|
|
2026
|
+
],
|
|
2027
|
+
queryParameters: [
|
|
2028
|
+
{
|
|
2029
|
+
description: "Site name",
|
|
2030
|
+
in: "query",
|
|
2031
|
+
name: "site",
|
|
2032
|
+
required: false,
|
|
2033
|
+
schema: {
|
|
2034
|
+
type: "string",
|
|
2035
|
+
},
|
|
2036
|
+
"x-displayname": "Site",
|
|
2037
|
+
"x-ves-example": "Ce01",
|
|
2038
|
+
},
|
|
2039
|
+
{
|
|
2040
|
+
description: "Site type indicates whether the site is CE or RE\noptional: If not specified, the value for site_type defaults to CUSTOMER_EDGE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.",
|
|
2041
|
+
in: "query",
|
|
2042
|
+
name: "site_type",
|
|
2043
|
+
required: false,
|
|
2044
|
+
schema: {
|
|
2045
|
+
default: "INVALID",
|
|
2046
|
+
enum: ["INVALID", "REGIONAL_EDGE", "CUSTOMER_EDGE", "NGINX_ONE"],
|
|
2047
|
+
type: "string",
|
|
2048
|
+
},
|
|
2049
|
+
"x-displayname": "NginxOne",
|
|
2050
|
+
},
|
|
2051
|
+
],
|
|
2052
|
+
requestBodySchema: null,
|
|
2053
|
+
responseSchema: {
|
|
2054
|
+
$ref: "#/components/schemas/status_at_siteStatusResponse",
|
|
2055
|
+
},
|
|
2056
|
+
requiredParams: ["kind", "name", "namespace"],
|
|
2057
|
+
operationId: "ves.io.schema.status_at_site.CustomAPI.GetStatus",
|
|
2058
|
+
tags: ["Other"],
|
|
2059
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2060
|
+
displayName: null,
|
|
2061
|
+
dangerLevel: "low",
|
|
2062
|
+
sideEffects: null,
|
|
2063
|
+
requiredFields: ["path.kind", "path.name", "path.namespace"],
|
|
2064
|
+
cliExamples: [
|
|
2065
|
+
{
|
|
2066
|
+
command: "f5xcctl data status-at-site get {name} --namespace {namespace}",
|
|
2067
|
+
description: "Get specific status-at-site",
|
|
2068
|
+
use_case: "get_specific",
|
|
2069
|
+
},
|
|
2070
|
+
],
|
|
2071
|
+
confirmationRequired: false,
|
|
2072
|
+
parameterExamples: {
|
|
2073
|
+
kind: "Virtual_host.",
|
|
2074
|
+
name: "Productpage.",
|
|
2075
|
+
namespace: "Bookinfo",
|
|
2076
|
+
site: "Ce01",
|
|
2077
|
+
},
|
|
2078
|
+
validationRules: {},
|
|
2079
|
+
operationMetadata: {
|
|
2080
|
+
common_errors: [
|
|
2081
|
+
{
|
|
2082
|
+
code: 401,
|
|
2083
|
+
message: "Authentication required",
|
|
2084
|
+
solution: "Provide valid API credentials",
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
code: 403,
|
|
2088
|
+
message: "Permission denied",
|
|
2089
|
+
solution: "Check access permissions for this operation",
|
|
2090
|
+
},
|
|
2091
|
+
{
|
|
2092
|
+
code: 404,
|
|
2093
|
+
message: "Resource not found",
|
|
2094
|
+
solution: "Verify resource name, namespace, and path",
|
|
2095
|
+
},
|
|
2096
|
+
{
|
|
2097
|
+
code: 409,
|
|
2098
|
+
message: "Resource already exists",
|
|
2099
|
+
solution: "Use different name or update existing resource",
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
code: 429,
|
|
2103
|
+
message: "Rate limit exceeded",
|
|
2104
|
+
solution: "Wait before retrying the operation",
|
|
2105
|
+
},
|
|
2106
|
+
{
|
|
2107
|
+
code: 500,
|
|
2108
|
+
message: "Server error",
|
|
2109
|
+
solution: "Retry operation or contact support",
|
|
2110
|
+
},
|
|
2111
|
+
],
|
|
2112
|
+
conditions: {
|
|
2113
|
+
postconditions: [],
|
|
2114
|
+
prerequisites: ["Active namespace"],
|
|
2115
|
+
},
|
|
2116
|
+
confirmation_required: false,
|
|
2117
|
+
danger_level: "low",
|
|
2118
|
+
examples: [
|
|
2119
|
+
{
|
|
2120
|
+
command: "f5xcctl data status-at-site get {name} --namespace {namespace}",
|
|
2121
|
+
description: "Get specific status-at-site",
|
|
2122
|
+
use_case: "get_specific",
|
|
2123
|
+
},
|
|
2124
|
+
],
|
|
2125
|
+
field_docs: {},
|
|
2126
|
+
optional_fields: [],
|
|
2127
|
+
performance_impact: {
|
|
2128
|
+
latency: "moderate",
|
|
2129
|
+
resource_usage: "moderate",
|
|
2130
|
+
},
|
|
2131
|
+
purpose: "Retrieve specific status-at-site",
|
|
2132
|
+
required_fields: ["path.kind", "path.name", "path.namespace"],
|
|
2133
|
+
side_effects: {},
|
|
2134
|
+
},
|
|
2135
|
+
},
|
|
2136
|
+
{
|
|
2137
|
+
toolName: "f5xc-api-telemetryandinsights-subscribe-create",
|
|
2138
|
+
method: "POST",
|
|
2139
|
+
path: "/api/config/namespaces/system/flow-collection/addon/subscribe",
|
|
2140
|
+
operation: "create",
|
|
2141
|
+
domain: "telemetry_and_insights",
|
|
2142
|
+
resource: "subscribe",
|
|
2143
|
+
summary: "Subscribe to Flow Collection.",
|
|
2144
|
+
description: "Subscribe to Flow Collection.",
|
|
2145
|
+
pathParameters: [],
|
|
2146
|
+
queryParameters: [],
|
|
2147
|
+
requestBodySchema: {
|
|
2148
|
+
$ref: "#/components/schemas/flowSubscribeRequest",
|
|
2149
|
+
},
|
|
2150
|
+
responseSchema: {
|
|
2151
|
+
$ref: "#/components/schemas/flowSubscribeResponse",
|
|
2152
|
+
},
|
|
2153
|
+
requiredParams: ["body"],
|
|
2154
|
+
operationId: "ves.io.schema.flow.CustomFlowConnectionAPI.Subscribe",
|
|
2155
|
+
tags: ["Other"],
|
|
2156
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2157
|
+
displayName: null,
|
|
2158
|
+
dangerLevel: "medium",
|
|
2159
|
+
sideEffects: {
|
|
2160
|
+
creates: ["subscribe"],
|
|
2161
|
+
},
|
|
2162
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2163
|
+
cliExamples: [
|
|
2164
|
+
{
|
|
2165
|
+
command: "f5xcctl config subscribe create -f {file}.yaml",
|
|
2166
|
+
description: "Create from YAML file",
|
|
2167
|
+
use_case: "file_based",
|
|
2168
|
+
},
|
|
2169
|
+
{
|
|
2170
|
+
command: "f5xcctl config subscribe create {name} --namespace {namespace}",
|
|
2171
|
+
description: "Create subscribe",
|
|
2172
|
+
use_case: "basic_create",
|
|
2173
|
+
},
|
|
2174
|
+
],
|
|
2175
|
+
confirmationRequired: false,
|
|
2176
|
+
parameterExamples: {},
|
|
2177
|
+
validationRules: {},
|
|
2178
|
+
operationMetadata: {
|
|
2179
|
+
common_errors: [
|
|
2180
|
+
{
|
|
2181
|
+
code: 401,
|
|
2182
|
+
message: "Authentication required",
|
|
2183
|
+
solution: "Provide valid API credentials",
|
|
2184
|
+
},
|
|
2185
|
+
{
|
|
2186
|
+
code: 403,
|
|
2187
|
+
message: "Permission denied",
|
|
2188
|
+
solution: "Check access permissions for this operation",
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
code: 404,
|
|
2192
|
+
message: "Resource not found",
|
|
2193
|
+
solution: "Verify resource name, namespace, and path",
|
|
2194
|
+
},
|
|
2195
|
+
{
|
|
2196
|
+
code: 409,
|
|
2197
|
+
message: "Resource already exists",
|
|
2198
|
+
solution: "Use different name or update existing resource",
|
|
2199
|
+
},
|
|
2200
|
+
{
|
|
2201
|
+
code: 429,
|
|
2202
|
+
message: "Rate limit exceeded",
|
|
2203
|
+
solution: "Wait before retrying the operation",
|
|
2204
|
+
},
|
|
2205
|
+
{
|
|
2206
|
+
code: 500,
|
|
2207
|
+
message: "Server error",
|
|
2208
|
+
solution: "Retry operation or contact support",
|
|
2209
|
+
},
|
|
2210
|
+
],
|
|
2211
|
+
conditions: {
|
|
2212
|
+
postconditions: ["Subscribe resource created", "Resource assigned unique identifier"],
|
|
2213
|
+
prerequisites: ["Active namespace"],
|
|
2214
|
+
},
|
|
2215
|
+
confirmation_required: false,
|
|
2216
|
+
danger_level: "medium",
|
|
2217
|
+
examples: [
|
|
2218
|
+
{
|
|
2219
|
+
command: "f5xcctl config subscribe create {name} --namespace {namespace}",
|
|
2220
|
+
description: "Create subscribe",
|
|
2221
|
+
use_case: "basic_create",
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
command: "f5xcctl config subscribe create -f {file}.yaml",
|
|
2225
|
+
description: "Create from YAML file",
|
|
2226
|
+
use_case: "file_based",
|
|
2227
|
+
},
|
|
2228
|
+
],
|
|
2229
|
+
field_docs: {},
|
|
2230
|
+
optional_fields: [],
|
|
2231
|
+
performance_impact: {
|
|
2232
|
+
latency: "low",
|
|
2233
|
+
resource_usage: "low",
|
|
2234
|
+
},
|
|
2235
|
+
purpose: "Create new subscribe",
|
|
2236
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2237
|
+
side_effects: {
|
|
2238
|
+
creates: ["subscribe"],
|
|
2239
|
+
},
|
|
2240
|
+
},
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
toolName: "f5xc-api-telemetryandinsights-subscription-statu-list",
|
|
2244
|
+
method: "GET",
|
|
2245
|
+
path: "/api/config/namespaces/system/flow-collection/addon/subscription-status",
|
|
2246
|
+
operation: "list",
|
|
2247
|
+
domain: "telemetry_and_insights",
|
|
2248
|
+
resource: "subscription-statu",
|
|
2249
|
+
summary: "Check subscription status for Flow Collection.",
|
|
2250
|
+
description: "Check subscription status flow Flow Collection.",
|
|
2251
|
+
pathParameters: [],
|
|
2252
|
+
queryParameters: [],
|
|
2253
|
+
requestBodySchema: null,
|
|
2254
|
+
responseSchema: {
|
|
2255
|
+
$ref: "#/components/schemas/flowSubscriptionStatusResponse",
|
|
2256
|
+
},
|
|
2257
|
+
requiredParams: [],
|
|
2258
|
+
operationId: "ves.io.schema.flow.CustomFlowConnectionAPI.GetSubscriptionStatus",
|
|
2259
|
+
tags: ["Other"],
|
|
2260
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2261
|
+
displayName: null,
|
|
2262
|
+
dangerLevel: "low",
|
|
2263
|
+
sideEffects: null,
|
|
2264
|
+
requiredFields: [],
|
|
2265
|
+
cliExamples: [
|
|
2266
|
+
{
|
|
2267
|
+
command: "f5xcctl config subscription-statu list --namespace {namespace}",
|
|
2268
|
+
description: "List all subscription-status",
|
|
2269
|
+
use_case: "list_all",
|
|
2270
|
+
},
|
|
2271
|
+
],
|
|
2272
|
+
confirmationRequired: false,
|
|
2273
|
+
parameterExamples: {},
|
|
2274
|
+
validationRules: {},
|
|
2275
|
+
operationMetadata: {
|
|
2276
|
+
common_errors: [
|
|
2277
|
+
{
|
|
2278
|
+
code: 401,
|
|
2279
|
+
message: "Authentication required",
|
|
2280
|
+
solution: "Provide valid API credentials",
|
|
2281
|
+
},
|
|
2282
|
+
{
|
|
2283
|
+
code: 403,
|
|
2284
|
+
message: "Permission denied",
|
|
2285
|
+
solution: "Check access permissions for this operation",
|
|
2286
|
+
},
|
|
2287
|
+
{
|
|
2288
|
+
code: 404,
|
|
2289
|
+
message: "Resource not found",
|
|
2290
|
+
solution: "Verify resource name, namespace, and path",
|
|
2291
|
+
},
|
|
2292
|
+
{
|
|
2293
|
+
code: 409,
|
|
2294
|
+
message: "Resource already exists",
|
|
2295
|
+
solution: "Use different name or update existing resource",
|
|
2296
|
+
},
|
|
2297
|
+
{
|
|
2298
|
+
code: 429,
|
|
2299
|
+
message: "Rate limit exceeded",
|
|
2300
|
+
solution: "Wait before retrying the operation",
|
|
2301
|
+
},
|
|
2302
|
+
{
|
|
2303
|
+
code: 500,
|
|
2304
|
+
message: "Server error",
|
|
2305
|
+
solution: "Retry operation or contact support",
|
|
2306
|
+
},
|
|
2307
|
+
],
|
|
2308
|
+
conditions: {
|
|
2309
|
+
postconditions: [],
|
|
2310
|
+
prerequisites: ["Active namespace"],
|
|
2311
|
+
},
|
|
2312
|
+
confirmation_required: false,
|
|
2313
|
+
danger_level: "low",
|
|
2314
|
+
examples: [
|
|
2315
|
+
{
|
|
2316
|
+
command: "f5xcctl config subscription-statu list --namespace {namespace}",
|
|
2317
|
+
description: "List all subscription-status",
|
|
2318
|
+
use_case: "list_all",
|
|
2319
|
+
},
|
|
2320
|
+
],
|
|
2321
|
+
field_docs: {},
|
|
2322
|
+
optional_fields: [],
|
|
2323
|
+
performance_impact: {
|
|
2324
|
+
latency: "moderate",
|
|
2325
|
+
resource_usage: "moderate",
|
|
2326
|
+
},
|
|
2327
|
+
purpose: "List all subscription-status",
|
|
2328
|
+
required_fields: [],
|
|
2329
|
+
side_effects: {},
|
|
2330
|
+
},
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
toolName: "f5xc-api-telemetryandinsights-suggest-value-create",
|
|
2334
|
+
method: "POST",
|
|
2335
|
+
path: "/api/discovery/namespaces/{namespace}/suggest-values",
|
|
2336
|
+
operation: "create",
|
|
2337
|
+
domain: "telemetry_and_insights",
|
|
2338
|
+
resource: "suggest-value",
|
|
2339
|
+
summary: "Suggest Values.",
|
|
2340
|
+
description: "SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.",
|
|
2341
|
+
pathParameters: [
|
|
2342
|
+
{
|
|
2343
|
+
description: "Namespace\nNamespace in which the suggestions are scoped.",
|
|
2344
|
+
in: "path",
|
|
2345
|
+
name: "namespace",
|
|
2346
|
+
required: true,
|
|
2347
|
+
schema: {
|
|
2348
|
+
type: "string",
|
|
2349
|
+
},
|
|
2350
|
+
"x-displayname": "Namespace",
|
|
2351
|
+
"x-ves-example": "Foobar",
|
|
2352
|
+
},
|
|
2353
|
+
],
|
|
2354
|
+
queryParameters: [],
|
|
2355
|
+
requestBodySchema: {
|
|
2356
|
+
$ref: "#/components/schemas/discovered_serviceSuggestValuesReq",
|
|
2357
|
+
},
|
|
2358
|
+
responseSchema: {
|
|
2359
|
+
$ref: "#/components/schemas/schemadiscovered_serviceSuggestValuesResp",
|
|
2360
|
+
},
|
|
2361
|
+
requiredParams: ["body", "namespace"],
|
|
2362
|
+
operationId: "ves.io.schema.discovered_service.CustomAPI.SuggestValues",
|
|
2363
|
+
tags: ["Service Mesh"],
|
|
2364
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2365
|
+
displayName: null,
|
|
2366
|
+
dangerLevel: "medium",
|
|
2367
|
+
sideEffects: {
|
|
2368
|
+
creates: ["suggest-value"],
|
|
2369
|
+
},
|
|
2370
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2371
|
+
cliExamples: [
|
|
2372
|
+
{
|
|
2373
|
+
command: "f5xcctl discovery suggest-value create -f {file}.yaml",
|
|
2374
|
+
description: "Create from YAML file",
|
|
2375
|
+
use_case: "file_based",
|
|
2376
|
+
},
|
|
2377
|
+
{
|
|
2378
|
+
command: "f5xcctl discovery suggest-value create {name} --namespace {namespace}",
|
|
2379
|
+
description: "Create suggest-value",
|
|
2380
|
+
use_case: "basic_create",
|
|
2381
|
+
},
|
|
2382
|
+
],
|
|
2383
|
+
confirmationRequired: false,
|
|
2384
|
+
parameterExamples: {
|
|
2385
|
+
namespace: "Foobar",
|
|
2386
|
+
},
|
|
2387
|
+
validationRules: {},
|
|
2388
|
+
operationMetadata: {
|
|
2389
|
+
common_errors: [
|
|
2390
|
+
{
|
|
2391
|
+
code: 401,
|
|
2392
|
+
message: "Authentication required",
|
|
2393
|
+
solution: "Provide valid API credentials",
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
code: 403,
|
|
2397
|
+
message: "Permission denied",
|
|
2398
|
+
solution: "Check access permissions for this operation",
|
|
2399
|
+
},
|
|
2400
|
+
{
|
|
2401
|
+
code: 404,
|
|
2402
|
+
message: "Resource not found",
|
|
2403
|
+
solution: "Verify resource name, namespace, and path",
|
|
2404
|
+
},
|
|
2405
|
+
{
|
|
2406
|
+
code: 409,
|
|
2407
|
+
message: "Resource already exists",
|
|
2408
|
+
solution: "Use different name or update existing resource",
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
code: 429,
|
|
2412
|
+
message: "Rate limit exceeded",
|
|
2413
|
+
solution: "Wait before retrying the operation",
|
|
2414
|
+
},
|
|
2415
|
+
{
|
|
2416
|
+
code: 500,
|
|
2417
|
+
message: "Server error",
|
|
2418
|
+
solution: "Retry operation or contact support",
|
|
2419
|
+
},
|
|
2420
|
+
],
|
|
2421
|
+
conditions: {
|
|
2422
|
+
postconditions: ["Suggest-value resource created", "Resource assigned unique identifier"],
|
|
2423
|
+
prerequisites: ["Active namespace"],
|
|
2424
|
+
},
|
|
2425
|
+
confirmation_required: false,
|
|
2426
|
+
danger_level: "medium",
|
|
2427
|
+
examples: [
|
|
2428
|
+
{
|
|
2429
|
+
command: "f5xcctl discovery suggest-value create {name} --namespace {namespace}",
|
|
2430
|
+
description: "Create suggest-value",
|
|
2431
|
+
use_case: "basic_create",
|
|
2432
|
+
},
|
|
2433
|
+
{
|
|
2434
|
+
command: "f5xcctl discovery suggest-value create -f {file}.yaml",
|
|
2435
|
+
description: "Create from YAML file",
|
|
2436
|
+
use_case: "file_based",
|
|
2437
|
+
},
|
|
2438
|
+
],
|
|
2439
|
+
field_docs: {},
|
|
2440
|
+
optional_fields: [],
|
|
2441
|
+
performance_impact: {
|
|
2442
|
+
latency: "low",
|
|
2443
|
+
resource_usage: "low",
|
|
2444
|
+
},
|
|
2445
|
+
purpose: "Create new suggest-value",
|
|
2446
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2447
|
+
side_effects: {
|
|
2448
|
+
creates: ["suggest-value"],
|
|
2449
|
+
},
|
|
2450
|
+
},
|
|
2451
|
+
},
|
|
2452
|
+
{
|
|
2453
|
+
toolName: "f5xc-api-telemetryandinsights-top-flow-anomalie-create",
|
|
2454
|
+
method: "POST",
|
|
2455
|
+
path: "/api/data/namespaces/system/flows/top_flow_anomalies",
|
|
2456
|
+
operation: "create",
|
|
2457
|
+
domain: "telemetry_and_insights",
|
|
2458
|
+
resource: "top-flow-anomalie",
|
|
2459
|
+
summary: "Flow Anomaly detection.",
|
|
2460
|
+
description: "Request to GET flow anomaly records.",
|
|
2461
|
+
pathParameters: [],
|
|
2462
|
+
queryParameters: [],
|
|
2463
|
+
requestBodySchema: {
|
|
2464
|
+
$ref: "#/components/schemas/flowTopFlowAnomaliesRequest",
|
|
2465
|
+
},
|
|
2466
|
+
responseSchema: {
|
|
2467
|
+
$ref: "#/components/schemas/flowTopFlowAnomaliesResponse",
|
|
2468
|
+
},
|
|
2469
|
+
requiredParams: ["body"],
|
|
2470
|
+
operationId: "ves.io.schema.flow.CustomAPI.TopFlowAnomalies",
|
|
2471
|
+
tags: ["Other"],
|
|
2472
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2473
|
+
displayName: null,
|
|
2474
|
+
dangerLevel: "medium",
|
|
2475
|
+
sideEffects: {
|
|
2476
|
+
creates: ["top-flow-anomalie"],
|
|
2477
|
+
},
|
|
2478
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2479
|
+
cliExamples: [
|
|
2480
|
+
{
|
|
2481
|
+
command: "f5xcctl data top-flow-anomalie create -f {file}.yaml",
|
|
2482
|
+
description: "Create from YAML file",
|
|
2483
|
+
use_case: "file_based",
|
|
2484
|
+
},
|
|
2485
|
+
{
|
|
2486
|
+
command: "f5xcctl data top-flow-anomalie create {name} --namespace {namespace}",
|
|
2487
|
+
description: "Create top-flow-anomalie",
|
|
2488
|
+
use_case: "basic_create",
|
|
2489
|
+
},
|
|
2490
|
+
],
|
|
2491
|
+
confirmationRequired: false,
|
|
2492
|
+
parameterExamples: {},
|
|
2493
|
+
validationRules: {},
|
|
2494
|
+
operationMetadata: {
|
|
2495
|
+
common_errors: [
|
|
2496
|
+
{
|
|
2497
|
+
code: 401,
|
|
2498
|
+
message: "Authentication required",
|
|
2499
|
+
solution: "Provide valid API credentials",
|
|
2500
|
+
},
|
|
2501
|
+
{
|
|
2502
|
+
code: 403,
|
|
2503
|
+
message: "Permission denied",
|
|
2504
|
+
solution: "Check access permissions for this operation",
|
|
2505
|
+
},
|
|
2506
|
+
{
|
|
2507
|
+
code: 404,
|
|
2508
|
+
message: "Resource not found",
|
|
2509
|
+
solution: "Verify resource name, namespace, and path",
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
code: 409,
|
|
2513
|
+
message: "Resource already exists",
|
|
2514
|
+
solution: "Use different name or update existing resource",
|
|
2515
|
+
},
|
|
2516
|
+
{
|
|
2517
|
+
code: 429,
|
|
2518
|
+
message: "Rate limit exceeded",
|
|
2519
|
+
solution: "Wait before retrying the operation",
|
|
2520
|
+
},
|
|
2521
|
+
{
|
|
2522
|
+
code: 500,
|
|
2523
|
+
message: "Server error",
|
|
2524
|
+
solution: "Retry operation or contact support",
|
|
2525
|
+
},
|
|
2526
|
+
],
|
|
2527
|
+
conditions: {
|
|
2528
|
+
postconditions: [
|
|
2529
|
+
"Top-flow-anomalie resource created",
|
|
2530
|
+
"Resource assigned unique identifier",
|
|
2531
|
+
],
|
|
2532
|
+
prerequisites: ["Active namespace"],
|
|
2533
|
+
},
|
|
2534
|
+
confirmation_required: false,
|
|
2535
|
+
danger_level: "medium",
|
|
2536
|
+
examples: [
|
|
2537
|
+
{
|
|
2538
|
+
command: "f5xcctl data top-flow-anomalie create {name} --namespace {namespace}",
|
|
2539
|
+
description: "Create top-flow-anomalie",
|
|
2540
|
+
use_case: "basic_create",
|
|
2541
|
+
},
|
|
2542
|
+
{
|
|
2543
|
+
command: "f5xcctl data top-flow-anomalie create -f {file}.yaml",
|
|
2544
|
+
description: "Create from YAML file",
|
|
2545
|
+
use_case: "file_based",
|
|
2546
|
+
},
|
|
2547
|
+
],
|
|
2548
|
+
field_docs: {},
|
|
2549
|
+
optional_fields: [],
|
|
2550
|
+
performance_impact: {
|
|
2551
|
+
latency: "low",
|
|
2552
|
+
resource_usage: "low",
|
|
2553
|
+
},
|
|
2554
|
+
purpose: "Create new top-flow-anomalie",
|
|
2555
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2556
|
+
side_effects: {
|
|
2557
|
+
creates: ["top-flow-anomalie"],
|
|
2558
|
+
},
|
|
2559
|
+
},
|
|
2560
|
+
},
|
|
2561
|
+
{
|
|
2562
|
+
toolName: "f5xc-api-telemetryandinsights-top-talker-create",
|
|
2563
|
+
method: "POST",
|
|
2564
|
+
path: "/api/data/namespaces/system/flows/top_talkers",
|
|
2565
|
+
operation: "create",
|
|
2566
|
+
domain: "telemetry_and_insights",
|
|
2567
|
+
resource: "top-talker",
|
|
2568
|
+
summary: "Top Talkers.",
|
|
2569
|
+
description: "Request to GET top talkers from the flow records.",
|
|
2570
|
+
pathParameters: [],
|
|
2571
|
+
queryParameters: [],
|
|
2572
|
+
requestBodySchema: null,
|
|
2573
|
+
responseSchema: {
|
|
2574
|
+
$ref: "#/components/schemas/flowTopTalkersResponse",
|
|
2575
|
+
},
|
|
2576
|
+
requiredParams: [],
|
|
2577
|
+
operationId: "ves.io.schema.flow.CustomAPI.TopTalkers",
|
|
2578
|
+
tags: ["Other"],
|
|
2579
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2580
|
+
displayName: null,
|
|
2581
|
+
dangerLevel: "medium",
|
|
2582
|
+
sideEffects: {
|
|
2583
|
+
creates: ["top-talker"],
|
|
2584
|
+
},
|
|
2585
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2586
|
+
cliExamples: [
|
|
2587
|
+
{
|
|
2588
|
+
command: "f5xcctl data top-talker create -f {file}.yaml",
|
|
2589
|
+
description: "Create from YAML file",
|
|
2590
|
+
use_case: "file_based",
|
|
2591
|
+
},
|
|
2592
|
+
{
|
|
2593
|
+
command: "f5xcctl data top-talker create {name} --namespace {namespace}",
|
|
2594
|
+
description: "Create top-talker",
|
|
2595
|
+
use_case: "basic_create",
|
|
2596
|
+
},
|
|
2597
|
+
],
|
|
2598
|
+
confirmationRequired: false,
|
|
2599
|
+
parameterExamples: {},
|
|
2600
|
+
validationRules: {},
|
|
2601
|
+
operationMetadata: {
|
|
2602
|
+
common_errors: [
|
|
2603
|
+
{
|
|
2604
|
+
code: 401,
|
|
2605
|
+
message: "Authentication required",
|
|
2606
|
+
solution: "Provide valid API credentials",
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
code: 403,
|
|
2610
|
+
message: "Permission denied",
|
|
2611
|
+
solution: "Check access permissions for this operation",
|
|
2612
|
+
},
|
|
2613
|
+
{
|
|
2614
|
+
code: 404,
|
|
2615
|
+
message: "Resource not found",
|
|
2616
|
+
solution: "Verify resource name, namespace, and path",
|
|
2617
|
+
},
|
|
2618
|
+
{
|
|
2619
|
+
code: 409,
|
|
2620
|
+
message: "Resource already exists",
|
|
2621
|
+
solution: "Use different name or update existing resource",
|
|
2622
|
+
},
|
|
2623
|
+
{
|
|
2624
|
+
code: 429,
|
|
2625
|
+
message: "Rate limit exceeded",
|
|
2626
|
+
solution: "Wait before retrying the operation",
|
|
2627
|
+
},
|
|
2628
|
+
{
|
|
2629
|
+
code: 500,
|
|
2630
|
+
message: "Server error",
|
|
2631
|
+
solution: "Retry operation or contact support",
|
|
2632
|
+
},
|
|
2633
|
+
],
|
|
2634
|
+
conditions: {
|
|
2635
|
+
postconditions: ["Top-talker resource created", "Resource assigned unique identifier"],
|
|
2636
|
+
prerequisites: ["Active namespace"],
|
|
2637
|
+
},
|
|
2638
|
+
confirmation_required: false,
|
|
2639
|
+
danger_level: "medium",
|
|
2640
|
+
examples: [
|
|
2641
|
+
{
|
|
2642
|
+
command: "f5xcctl data top-talker create {name} --namespace {namespace}",
|
|
2643
|
+
description: "Create top-talker",
|
|
2644
|
+
use_case: "basic_create",
|
|
2645
|
+
},
|
|
2646
|
+
{
|
|
2647
|
+
command: "f5xcctl data top-talker create -f {file}.yaml",
|
|
2648
|
+
description: "Create from YAML file",
|
|
2649
|
+
use_case: "file_based",
|
|
2650
|
+
},
|
|
2651
|
+
],
|
|
2652
|
+
field_docs: {},
|
|
2653
|
+
optional_fields: [],
|
|
2654
|
+
performance_impact: {
|
|
2655
|
+
latency: "low",
|
|
2656
|
+
resource_usage: "low",
|
|
2657
|
+
},
|
|
2658
|
+
purpose: "Create new top-talker",
|
|
2659
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2660
|
+
side_effects: {
|
|
2661
|
+
creates: ["top-talker"],
|
|
2662
|
+
},
|
|
2663
|
+
},
|
|
2664
|
+
},
|
|
2665
|
+
{
|
|
2666
|
+
toolName: "f5xc-api-telemetryandinsights-unsubscribe-create",
|
|
2667
|
+
method: "POST",
|
|
2668
|
+
path: "/api/config/namespaces/system/flow-collection/addon/unsubscribe",
|
|
2669
|
+
operation: "create",
|
|
2670
|
+
domain: "telemetry_and_insights",
|
|
2671
|
+
resource: "unsubscribe",
|
|
2672
|
+
summary: "Unsubscribe to Flow Collection.",
|
|
2673
|
+
description: "Unsubscribe to Flow Collection.",
|
|
2674
|
+
pathParameters: [],
|
|
2675
|
+
queryParameters: [],
|
|
2676
|
+
requestBodySchema: {
|
|
2677
|
+
$ref: "#/components/schemas/flowUnsubscribeRequest",
|
|
2678
|
+
},
|
|
2679
|
+
responseSchema: {
|
|
2680
|
+
$ref: "#/components/schemas/flowUnsubscribeResponse",
|
|
2681
|
+
},
|
|
2682
|
+
requiredParams: ["body"],
|
|
2683
|
+
operationId: "ves.io.schema.flow.CustomFlowConnectionAPI.Unsubscribe",
|
|
2684
|
+
tags: ["Other"],
|
|
2685
|
+
sourceFile: "domains/telemetry_and_insights.json",
|
|
2686
|
+
displayName: null,
|
|
2687
|
+
dangerLevel: "medium",
|
|
2688
|
+
sideEffects: {
|
|
2689
|
+
creates: ["unsubscribe"],
|
|
2690
|
+
},
|
|
2691
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2692
|
+
cliExamples: [
|
|
2693
|
+
{
|
|
2694
|
+
command: "f5xcctl config unsubscribe create -f {file}.yaml",
|
|
2695
|
+
description: "Create from YAML file",
|
|
2696
|
+
use_case: "file_based",
|
|
2697
|
+
},
|
|
2698
|
+
{
|
|
2699
|
+
command: "f5xcctl config unsubscribe create {name} --namespace {namespace}",
|
|
2700
|
+
description: "Create unsubscribe",
|
|
2701
|
+
use_case: "basic_create",
|
|
2702
|
+
},
|
|
2703
|
+
],
|
|
2704
|
+
confirmationRequired: false,
|
|
2705
|
+
parameterExamples: {},
|
|
2706
|
+
validationRules: {},
|
|
2707
|
+
operationMetadata: {
|
|
2708
|
+
common_errors: [
|
|
2709
|
+
{
|
|
2710
|
+
code: 401,
|
|
2711
|
+
message: "Authentication required",
|
|
2712
|
+
solution: "Provide valid API credentials",
|
|
2713
|
+
},
|
|
2714
|
+
{
|
|
2715
|
+
code: 403,
|
|
2716
|
+
message: "Permission denied",
|
|
2717
|
+
solution: "Check access permissions for this operation",
|
|
2718
|
+
},
|
|
2719
|
+
{
|
|
2720
|
+
code: 404,
|
|
2721
|
+
message: "Resource not found",
|
|
2722
|
+
solution: "Verify resource name, namespace, and path",
|
|
2723
|
+
},
|
|
2724
|
+
{
|
|
2725
|
+
code: 409,
|
|
2726
|
+
message: "Resource already exists",
|
|
2727
|
+
solution: "Use different name or update existing resource",
|
|
2728
|
+
},
|
|
2729
|
+
{
|
|
2730
|
+
code: 429,
|
|
2731
|
+
message: "Rate limit exceeded",
|
|
2732
|
+
solution: "Wait before retrying the operation",
|
|
2733
|
+
},
|
|
2734
|
+
{
|
|
2735
|
+
code: 500,
|
|
2736
|
+
message: "Server error",
|
|
2737
|
+
solution: "Retry operation or contact support",
|
|
2738
|
+
},
|
|
2739
|
+
],
|
|
2740
|
+
conditions: {
|
|
2741
|
+
postconditions: ["Unsubscribe resource created", "Resource assigned unique identifier"],
|
|
2742
|
+
prerequisites: ["Active namespace"],
|
|
2743
|
+
},
|
|
2744
|
+
confirmation_required: false,
|
|
2745
|
+
danger_level: "medium",
|
|
2746
|
+
examples: [
|
|
2747
|
+
{
|
|
2748
|
+
command: "f5xcctl config unsubscribe create {name} --namespace {namespace}",
|
|
2749
|
+
description: "Create unsubscribe",
|
|
2750
|
+
use_case: "basic_create",
|
|
2751
|
+
},
|
|
2752
|
+
{
|
|
2753
|
+
command: "f5xcctl config unsubscribe create -f {file}.yaml",
|
|
2754
|
+
description: "Create from YAML file",
|
|
2755
|
+
use_case: "file_based",
|
|
2756
|
+
},
|
|
2757
|
+
],
|
|
2758
|
+
field_docs: {},
|
|
2759
|
+
optional_fields: [],
|
|
2760
|
+
performance_impact: {
|
|
2761
|
+
latency: "low",
|
|
2762
|
+
resource_usage: "low",
|
|
2763
|
+
},
|
|
2764
|
+
purpose: "Create new unsubscribe",
|
|
2765
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2766
|
+
side_effects: {
|
|
2767
|
+
creates: ["unsubscribe"],
|
|
2768
|
+
},
|
|
2769
|
+
},
|
|
2770
|
+
},
|
|
2771
|
+
];
|
|
2772
|
+
export default telemetry_and_insightsTools;
|
|
2773
|
+
//# sourceMappingURL=index.js.map
|