{ "openapi": "3.0.3", "info": { "title": "Sites", "description": "Multi-cloud node provisioning spanning major public cloud environments including TGW, VNet, and VPC architectures. VPN tunnel configuration handles secure connectivity while IP prefix management controls address allocation. Customer edge deployments support external container orchestration platforms. Geographic distribution with resource sharing enables consistent policy enforcement across deployment points.", "version": "8.0.2", "contact": { "name": "F5 Distributed Cloud", "url": "https://docs.cloud.f5.com" }, "license": { "name": "Proprietary", "url": "https://www.f5.com/company/policies/eula" }, "x-f5xc-description-long": "Multi-cloud node provisioning spanning major public cloud environments including TGW, VNet, and VPC architectures. VPN tunnel configuration handles secure connectivity while IP prefix management controls address allocation. Customer edge deployments support external container orchestration platforms. Geographic distribution with resource sharing enables consistent policy enforcement across deployment points.", "x-f5xc-summary": "AWS, Azure, GCP VPC integration with transit gateways. Label-based selection for policy application across regions.", "x-f5xc-cli-domain": "sites", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/site-management", "description": "F5 XC Documentation - Site Management" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Site registration token invalid", "resolution": "Generate new registration token and retry", "prevention": "Use tokens within validity period" }, { "code": 504, "message": "Site not responding", "resolution": "Check site connectivity and agent status", "prevention": "Configure monitoring for site health" }, { "code": 400, "message": "Expanded Secure Mesh interfaces lack authoritative evidence", "resolution": "Keep optional roles unconfigured and collect the sanitized CE evidence matrix", "prevention": "Bind roles by Azure NIC position, MAC, IP configuration, subnet, and control-plane reference; never by guest interface name" } ], "security_notes": [ "Rotate site tokens after initial registration", "Configure site-level firewall policies", "Enable audit logging for site operations", "Treat guest interface names as diagnostics only; they are not stable configuration identities" ], "performance_tips": [ "Deploy sites close to workloads for low latency", "Configure appropriate resource allocation", "Use site mesh for efficient inter-site communication", "Schedule interface additions or removals in a maintenance window because CE data-plane services restart" ] }, "x-f5xc-guided-workflows": [ { "id": "register_site", "name": "Register Customer Edge Site", "description": "Register and configure a CE site", "complexity": "high", "estimated_steps": 6, "prerequisites": [ "Site hardware or VM provisioned", "Network connectivity to F5 XC", "Registration token generated" ], "steps": [ { "order": 1, "action": "generate_token", "name": "Generate Registration Token", "description": "Create site registration token", "resource": "site_token" }, { "order": 2, "action": "configure_site", "name": "Configure Site Settings", "description": "Define site parameters", "resource": "site", "required_fields": [ "name", "site_type" ] }, { "order": 3, "action": "install_software", "name": "Install CE Software", "description": "Deploy F5 XC software on site", "depends_on": [ 1 ] }, { "order": 4, "action": "complete_registration", "name": "Complete Registration", "description": "Finalize site registration", "depends_on": [ 2, 3 ] }, { "order": 5, "action": "configure_network", "name": "Configure Site Network", "description": "Set up site networking", "depends_on": [ 4 ] }, { "order": 6, "action": "verify_site", "name": "Verify Site Status", "description": "Confirm site is operational", "verification": [ "Site shows online status", "Tunnel connectivity established", "Services deployed successfully" ] } ] }, { "id": "evidence_gated_secure_mesh_interfaces", "name": "Configure Evidence-Gated Secure Mesh Site v2 Interfaces", "description": "Configure the mandatory SLO first and enable optional interface roles only after authoritative Azure and CE evidence agrees.", "complexity": "high", "estimated_steps": 5, "prerequisites": [ "Three-node HA topology with identical declared role and VRF shape", "Sanitized Azure and CE evidence including a replacement registration observation", "Approved maintenance window for any interface addition or removal" ], "steps": [ { "order": 1, "action": "inventory_cloud_nics", "name": "Inventory Azure NICs", "description": "Record each node hostname, NIC position, MAC, IP configuration, subnet, and control-plane interface reference.", "resource": "securemesh_site_v2" }, { "order": 2, "action": "collect_runtime_evidence", "name": "Collect CE Evidence", "description": "Normalize supported CE diagnostics by MAC, IP, subnet, and control-plane role without using guest interface names as keys.", "resource": "securemesh_site_v2", "depends_on": [ 1 ] }, { "order": 3, "action": "validate_role_mapping", "name": "Validate Role Mapping", "description": "Require authoritative mapping confidence and provenance before optional roles become bindable.", "resource": "securemesh_site_v2", "depends_on": [ 2 ] }, { "order": 4, "action": "configure_slo", "name": "Configure SLO", "description": "Bind the first Azure NIC to the required Site Local Outside role; BGP may bind only to this role.", "resource": "securemesh_site_v2", "depends_on": [ 3 ] }, { "order": 5, "action": "enable_optional_roles", "name": "Enable Approved Optional Roles", "description": "During the maintenance window, configure external or SLI only where the approved contract declares their network option and VRF.", "resource": "securemesh_site_v2", "depends_on": [ 4 ], "verification": [ "Every HA node has the same role and VRF shape", "BGP binds only to the SLO role", "Evidence provenance is retained without credentials or raw diagnostics" ] } ] } ], "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "servers": [ { "url": "https://{tenant}.{console_url}/api/v1/{domain_prefix}/{environment}/{region}/namespaces/{namespace}", "description": "F5 Distributed Cloud Console", "variables": { "tenant": { "default": "example-corp", "description": "F5 Distributed Cloud tenant identifier (e.g., example-corp, example-partners)" }, "console_url": { "default": "console.ves.volterra.io", "description": "Console URL base (e.g., console.ves.volterra.io for production, staging.volterra.us for staging)", "enum": [ "console.ves.volterra.io", "staging.volterra.us" ] }, "environment": { "default": "production", "description": "Environment designation (production, staging, development)", "enum": [ "production", "staging", "development" ] }, "domain_prefix": { "default": "api", "description": "Domain naming prefix for consistent naming conventions" }, "region": { "default": "us-east-1", "description": "Geographic region for API deployment (e.g., us-east-1, eu-west-1)" }, "namespace": { "default": "default", "description": "Kubernetes-style namespace for environment separation (e.g., 'default', 'production', 'staging')" } } } ], "security": [ { "ApiToken": [] } ], "tags": [ { "name": "config" }, { "name": "data" }, { "name": "register" }, { "name": "sync-cloud-data" }, { "name": "web" } ], "paths": { "/api/config/namespaces/{metadata.namespace}/aws_tgw_sites": { "post": { "summary": "Create AWS TGW site.", "description": "Shape of the AWS TGW site specification.", "operationId": "ves.io.schema.views.aws_tgw_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aws-tgw-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aws-tgw-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aws-tgw-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/aws_tgw_sites/{metadata.name}": { "put": { "summary": "Replace AWS TGW site.", "description": "Shape of the AWS TGW site replace specification.", "operationId": "ves.io.schema.views.aws_tgw_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "aws-tgw-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "aws-tgw-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_tgw_info": { "post": { "summary": "Configure TGW Information.", "description": "Configure TGW Information like tgw-ID, F5 Distributed Cloud site's VPC-ID.", "operationId": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetTGWInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetTGWInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-tgw-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetTGWInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetTGWInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-tgw-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-tgw-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-tgw-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vip_info": { "post": { "summary": "Configure AWS TGW Site VIP Information.", "description": "Configure AWS TGW Site VIP Information.", "operationId": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetVIPInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetVIPInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-tgw-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetVIPInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetVIPInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-vip-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-vip-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-vip-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpc_ip_prefixes": { "post": { "summary": "Configure VPC IP prefixes.", "description": "Configure VPC IP prefix set.", "operationId": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPCIpPrefixes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetVPCIpPrefixesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-tgw-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetVPCIpPrefixesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPCIpPrefixes", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-vpc-ip-prefixe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-vpc-ip-prefixe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-vpc-ip-prefixe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpn_tunnels": { "post": { "summary": "Configure VPN Tunnels.", "description": "Configure VPC IP prefix set.", "operationId": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPNTunnels", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetVPNTunnelsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-tgw-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteSetVPNTunnelsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPNTunnels", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-vpn-tunnel resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-vpn-tunnel" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-vpn-tunnel" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_site/{name}/validate_config": { "post": { "summary": "Validate AWS TGW Config.", "description": "Validate AWS TGW Config.", "operationId": "ves.io.schema.views.aws_tgw_site.CustomAPI.ValidateConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.CustomAPI.ValidateConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Validate-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_sites": { "get": { "summary": "List Configure AWS TGW Site.", "description": "List the set of aws_tgw_site in a namespace.", "operationId": "ves.io.schema.views.aws_tgw_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of aws_tgw_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 152.3, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 152.3, "p95_ms": 304.6, "p99_ms": 456.9, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_tgw_sites/{name}": { "get": { "summary": "GET AWS TGW site.", "description": "Shape of the AWS TGW site specification.", "operationId": "ves.io.schema.views.aws_tgw_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure AWS TGW Site.", "description": "DELETE the specified aws_tgw_site.", "operationId": "ves.io.schema.views.aws_tgw_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_tgw_siteDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_tgw_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "aws-tgw-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "aws-tgw-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS TGW Site.", "x-ves-proto-service": "ves.io.schema.views.aws_tgw_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/aws_vpc_sites": { "post": { "summary": "Create AWS VPC site.", "description": "Shape of the AWS VPC site specification.", "operationId": "ves.io.schema.views.aws_vpc_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "AWS VPC site for cloud deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aws-vpc-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aws-vpc-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aws-vpc-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/aws_vpc_sites/{metadata.name}": { "put": { "summary": "Replace AWS VPC site.", "description": "Shape of the AWS VPC site replace specification.", "operationId": "ves.io.schema.views.aws_vpc_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "AWS VPC site for cloud deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "aws-vpc-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "aws-vpc-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_cloud_site_info": { "post": { "summary": "Configure AWS VPC Site Information.", "description": "Configure AWS VPC Site Information like public, private ips, subnet IDs and others.", "operationId": "ves.io.schema.views.aws_vpc_site.CustomAPI.SetCloudSiteInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteSetCloudSiteInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteSetCloudSiteInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.CustomAPI.SetCloudSiteInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-cloud-site-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-cloud-site-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-cloud-site-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_vip_info": { "post": { "summary": "Configure AWS VPC Site VIP Information.", "description": "Configure AWS VPC Site VIP Information.", "operationId": "ves.io.schema.views.aws_vpc_site.CustomAPI.SetVIPInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteSetVIPInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteSetVIPInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.CustomAPI.SetVIPInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-vip-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-vip-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-vip-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_vpc_site/{name}/storage/set_vpc_k8s_hostnames": { "post": { "summary": "Configure VPC K8s hostnames.", "description": "Configure VPC K8s node hostname set.", "operationId": "ves.io.schema.views.aws_vpc_site.CustomAPI.SetVPCK8SHostnames", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteSetVPCK8SHostnamesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteSetVPCK8SHostnamesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.CustomAPI.SetVPCK8SHostnames", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-vpc-k8s-hostname resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-vpc-k8s-hostname" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-vpc-k8s-hostname" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_vpc_site/{name}/validate_config": { "post": { "summary": "Validate AWS VPC Site Config.", "description": "Validate AWS VPC Site Config.", "operationId": "ves.io.schema.views.aws_vpc_site.CustomAPI.ValidateConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.CustomAPI.ValidateConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Validate-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_vpc_sites": { "get": { "summary": "List Configure AWS VPC Site.", "description": "List the set of aws_vpc_site in a namespace.", "operationId": "ves.io.schema.views.aws_vpc_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of aws_vpc_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "AWS VPC site for cloud deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 149.25, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 149.25, "p95_ms": 298.5, "p99_ms": 447.75, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/aws_vpc_sites/{name}": { "get": { "summary": "GET AWS VPC site.", "description": "Shape of the AWS VPC site specification.", "operationId": "ves.io.schema.views.aws_vpc_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "AWS VPC site for cloud deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure AWS VPC Site.", "description": "DELETE the specified aws_vpc_site.", "operationId": "ves.io.schema.views.aws_vpc_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aws_vpc_siteDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.aws_vpc_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "AWS VPC site for cloud deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "aws-vpc-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "aws-vpc-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure AWS VPC Site.", "x-ves-proto-service": "ves.io.schema.views.aws_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/voltstack_sites": { "post": { "summary": "Create App Stack site.", "description": "Shape of the App Stack site specification.", "operationId": "ves.io.schema.views.voltstack_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.voltstack_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Customer Edge site for on-premises deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Voltstack-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "voltstack-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "voltstack-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure App Stack Site.", "x-ves-proto-service": "ves.io.schema.views.voltstack_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/voltstack_sites/{metadata.name}": { "put": { "summary": "Replace App Stack site.", "description": "Shape of the App Stack site replace specification.", "operationId": "ves.io.schema.views.voltstack_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.voltstack_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Customer Edge site for on-premises deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "voltstack-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "voltstack-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure App Stack Site.", "x-ves-proto-service": "ves.io.schema.views.voltstack_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/voltstack_sites": { "get": { "summary": "List Configure App Stack Site.", "description": "List the set of customer_edge_site in a namespace.", "operationId": "ves.io.schema.views.voltstack_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of customer_edge_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.voltstack_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Customer Edge site for on-premises deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 190.16, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 190.16, "p95_ms": 380.32, "p99_ms": 570.48, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure App Stack Site.", "x-ves-proto-service": "ves.io.schema.views.voltstack_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/voltstack_sites/{name}": { "get": { "summary": "GET App Stack site.", "description": "Shape of the App Stack site specification.", "operationId": "ves.io.schema.views.voltstack_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.voltstack_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Customer Edge site for on-premises deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure App Stack Site.", "description": "DELETE the specified customer_edge_site.", "operationId": "ves.io.schema.views.voltstack_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/voltstack_siteDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.voltstack_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Customer Edge site for on-premises deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "voltstack-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "voltstack-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure App Stack Site.", "x-ves-proto-service": "ves.io.schema.views.voltstack_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/azure_vnet_sites": { "post": { "summary": "Create Azure VNet site.", "description": "Shape of the Azure VNet site specification.", "operationId": "ves.io.schema.views.azure_vnet_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteCreateRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Azure VNet site for cloud deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Azure-vnet-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "azure-vnet-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "azure-vnet-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/azure_vnet_sites/{metadata.name}": { "put": { "summary": "Replace Azure VNet site.", "description": "Shape of the Azure VNet site replace specification.", "operationId": "ves.io.schema.views.azure_vnet_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteReplaceRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Azure VNet site for cloud deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "azure-vnet-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "azure-vnet-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_cloud_site_info": { "post": { "summary": "Configure Azure VNet Site Information.", "description": "Configure Azure VNet Site Information like public, private ips, subnet IDs and others.", "operationId": "ves.io.schema.views.azure_vnet_site.CustomAPI.SetCloudSiteInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteSetCloudSiteInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "vnet-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteSetCloudSiteInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.CustomAPI.SetCloudSiteInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-cloud-site-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-cloud-site-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-cloud-site-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_vip_info": { "post": { "summary": "Configure Azure VNet Site VIP Information.", "description": "Configure Azure VNet Site VIP Information.", "operationId": "ves.io.schema.views.azure_vnet_site.CustomAPI.SetVIPInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteSetVIPInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "vnet-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteSetVIPInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.CustomAPI.SetVIPInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-vip-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-vip-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-vip-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/azure_vnet_site/{name}/validate_config": { "post": { "summary": "Validate Azure VNet Site Config.", "description": "Validate Azure VNet Site Config.", "operationId": "ves.io.schema.views.azure_vnet_site.CustomAPI.ValidateConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.CustomAPI.ValidateConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Validate-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/azure_vnet_sites": { "get": { "summary": "List Configure Azure VNet Site.", "description": "List the set of azure_vnet_site in a namespace.", "operationId": "ves.io.schema.views.azure_vnet_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of azure_vnet_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Azure VNet site for cloud deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 154.19, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 154.19, "p95_ms": 308.38, "p99_ms": 462.57, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/azure_vnet_sites/{name}": { "get": { "summary": "GET Azure VNet site.", "description": "Shape of the Azure VNet site specification.", "operationId": "ves.io.schema.views.azure_vnet_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Azure VNet site for cloud deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure Azure VNet Site.", "description": "DELETE the specified azure_vnet_site.", "operationId": "ves.io.schema.views.azure_vnet_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/azure_vnet_siteDeleteRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.views.azure_vnet_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Azure VNet site for cloud deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "azure-vnet-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "azure-vnet-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Azure VNet Site.", "x-ves-proto-service": "ves.io.schema.views.azure_vnet_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/gcp_vpc_sites": { "post": { "summary": "Create GCP VPC site.", "description": "Shape of the GCP VPC site specification.", "operationId": "ves.io.schema.views.gcp_vpc_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteCreateRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "GCP VPC site for cloud deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Gcp-vpc-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "gcp-vpc-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "gcp-vpc-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure GCP VPC Site.", "x-ves-proto-service": "ves.io.schema.views.gcp_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/gcp_vpc_sites/{metadata.name}": { "put": { "summary": "Replace GCP VPC site.", "description": "Shape of the GCP VPC site replace specification.", "operationId": "ves.io.schema.views.gcp_vpc_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteReplaceRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "GCP VPC site for cloud deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "gcp-vpc-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "gcp-vpc-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure GCP VPC Site.", "x-ves-proto-service": "ves.io.schema.views.gcp_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/gcp_vpc_site/{name}/set_cloud_site_info": { "post": { "summary": "Configure GCP VPC Site Information.", "description": "Configure GCP VPC Site Information like public, private ips, subnet IDs and others.", "operationId": "ves.io.schema.views.gcp_vpc_site.CustomAPI.SetCloudSiteInfo", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteSetCloudSiteInfoResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "gcp-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteSetCloudSiteInfoRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.CustomAPI.SetCloudSiteInfo", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Set-cloud-site-info resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "set-cloud-site-info" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "set-cloud-site-info" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure GCP VPC Site.", "x-ves-proto-service": "ves.io.schema.views.gcp_vpc_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/gcp_vpc_site/{name}/validate_config": { "post": { "summary": "Validate GCP VPC Site Config.", "description": "Validate GCP VPC Site Config.", "operationId": "ves.io.schema.views.gcp_vpc_site.CustomAPI.ValidateConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace for the object to be configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name\nName of the object to be configured.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-vpc-site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/viewsValidateConfigRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.CustomAPI.ValidateConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Validate-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "validate-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "validate-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure GCP VPC Site.", "x-ves-proto-service": "ves.io.schema.views.gcp_vpc_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/gcp_vpc_sites": { "get": { "summary": "List Configure GCP VPC Site.", "description": "List the set of gcp_vpc_site in a namespace.", "operationId": "ves.io.schema.views.gcp_vpc_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of gcp_vpc_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "GCP VPC site for cloud deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 158.57, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 158.57, "p95_ms": 317.14, "p99_ms": 475.71, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure GCP VPC Site.", "x-ves-proto-service": "ves.io.schema.views.gcp_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/gcp_vpc_sites/{name}": { "get": { "summary": "GET GCP VPC site.", "description": "Shape of the GCP VPC site specification.", "operationId": "ves.io.schema.views.gcp_vpc_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "GCP VPC site for cloud deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure GCP VPC Site.", "description": "DELETE the specified gcp_vpc_site.", "operationId": "ves.io.schema.views.gcp_vpc_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gcp_vpc_siteDeleteRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.views.gcp_vpc_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "GCP VPC site for cloud deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "gcp-vpc-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "gcp-vpc-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure GCP VPC Site.", "x-ves-proto-service": "ves.io.schema.views.gcp_vpc_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/securemesh_sites": { "post": { "summary": "Create Secure Mesh site.", "description": "Shape of the Secure Mesh site specification.", "operationId": "ves.io.schema.views.securemesh_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Securemesh-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "securemesh-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "securemesh-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/securemesh_sites/{metadata.name}": { "put": { "summary": "Replace Secure Mesh site.", "description": "Shape of the Secure Mesh site specification.", "operationId": "ves.io.schema.views.securemesh_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "securemesh-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "securemesh-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/securemesh_sites": { "get": { "summary": "List Configure Secure Mesh Site.", "description": "List the set of securemesh_site in a namespace.", "operationId": "ves.io.schema.views.securemesh_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of securemesh_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 152.21, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 152.21, "p95_ms": 304.42, "p99_ms": 456.63, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/securemesh_sites/{name}": { "get": { "summary": "GET Secure Mesh site.", "description": "Shape of the Secure Mesh site specification.", "operationId": "ves.io.schema.views.securemesh_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure Secure Mesh Site.", "description": "DELETE the specified securemesh_site.", "operationId": "ves.io.schema.views.securemesh_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_siteDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "securemesh-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "securemesh-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/sync-cloud-data/namespaces/system/securemesh_site_v2/{site_name}/cloud_resources": { "get": { "summary": "List Cloud Resources.", "description": "API to list all resource for given site.", "operationId": "ves.io.schema.views.securemesh_site_v2.ManagedSecureMeshSiteV2CustomAPI.ListCloudResources", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2ListCloudResourceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site_name", "description": "Site name\n\nsite name.", "in": "path", "required": true, "x-displayname": "Site Name", "schema": { "type": "string" } }, { "name": "deletion", "description": "Query param deletion to GET only to be deleted and all resource.", "in": "query", "required": false, "x-displayname": "Deletion", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site_v2.ManagedSecureMeshSiteV2CustomAPI.ListCloudResources", "tags": [ "sync-cloud-data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site_name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site_name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site_v2.ManagedSecureMeshSiteV2CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s": { "post": { "summary": "Create Secure Mesh site.", "description": "Shape of the Secure Mesh site specification.", "operationId": "ves.io.schema.views.securemesh_site_v2.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2CreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2CreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site_v2.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Securemesh-site-v2 resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "securemesh-site-v2" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "securemesh-site-v2" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site_v2.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s/{metadata.name}": { "put": { "summary": "Replace Secure Mesh site.", "description": "Shape of the Secure Mesh site specification.", "operationId": "ves.io.schema.views.securemesh_site_v2.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2ReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2ReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site_v2.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "securemesh-site-v2" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "securemesh-site-v2" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site_v2.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/securemesh_site_v2s": { "get": { "summary": "List Configure Secure Mesh Site.", "description": "List the set of securemesh_site_v2 in a namespace.", "operationId": "ves.io.schema.views.securemesh_site_v2.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2ListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of securemesh_site_v2.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site_v2.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 168.38, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 168.38, "p95_ms": 336.76, "p99_ms": 505.14, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site_v2.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}": { "get": { "summary": "GET Secure Mesh site.", "description": "Shape of the Secure Mesh site specification.", "operationId": "ves.io.schema.views.securemesh_site_v2.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2GetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site_v2.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Configure Secure Mesh Site.", "description": "DELETE the specified securemesh_site_v2.", "operationId": "ves.io.schema.views.securemesh_site_v2.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/securemesh_site_v2DeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.views.securemesh_site_v2.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "securemesh-site-v2", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "securemesh-site-v2", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure Secure Mesh Site.", "x-ves-proto-service": "ves.io.schema.views.securemesh_site_v2.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/k8s_clusters": { "post": { "summary": "Create Configuration Specification.", "description": "Create k8s_cluster will create the object in the storage backend for namespace metadata.namespace.", "operationId": "ves.io.schema.k8s_cluster.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.k8s_cluster.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "K8s-cluster resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "k8s-cluster" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "k8s-cluster" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "K8s Cluster.", "x-ves-proto-service": "ves.io.schema.k8s_cluster.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/k8s_clusters/{metadata.name}": { "put": { "summary": "Replace Configuration Specification.", "description": "Replacing an k8s_cluster object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.", "operationId": "ves.io.schema.k8s_cluster.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.k8s_cluster.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "k8s-cluster" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "k8s-cluster" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "K8s Cluster.", "x-ves-proto-service": "ves.io.schema.k8s_cluster.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/k8s_clusters": { "get": { "summary": "List K8s Cluster.", "description": "List the set of k8s_cluster in a namespace.", "operationId": "ves.io.schema.k8s_cluster.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of k8s_cluster.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.k8s_cluster.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 176.41, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 176.41, "p95_ms": 352.82, "p99_ms": 529.23, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "K8s Cluster.", "x-ves-proto-service": "ves.io.schema.k8s_cluster.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/k8s_clusters/{name}": { "get": { "summary": "GET Configuration Specification.", "description": "GET k8s_cluster will GET the object from the storage backend for namespace metadata.namespace.", "operationId": "ves.io.schema.k8s_cluster.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.k8s_cluster.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE K8s Cluster.", "description": "DELETE the specified k8s_cluster.", "operationId": "ves.io.schema.k8s_cluster.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/k8s_clusterDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.k8s_cluster.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "k8s-cluster", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "k8s-cluster", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "K8s Cluster.", "x-ves-proto-service": "ves.io.schema.k8s_cluster.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/data/namespaces/{namespace}/firewall_logs": { "post": { "summary": "Firewall Logs Query.", "description": "Request to GET access logs and network logs with policy hits.\nBy default, the firewall logs in the response are sorted in the reverse chronological order.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch Firewall logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logFirewallLogRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Firewall-log resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "firewall-log" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "firewall-log" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/firewall_logs/aggregation": { "post": { "summary": "Firewall Logs Aggregation Query.", "description": "Request to GET summary/analytics data for the firewall logs that matches the query in request for a given namespace.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logFirewallLogAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogAggregationQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/firewall_logs/scroll": { "get": { "summary": "Firewall Logs Scroll Query.", "description": "The response for firewall log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\nfirewall log query in multiple batches. EOF is indicated by empty scroll_id in the response.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Firewall Logs Scroll Query.", "description": "The response for firewall log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\nfirewall log query in multiple batches. EOF is indicated by empty scroll_id in the response.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/k8s_audit_logs/scroll": { "get": { "summary": "K8s Audit Log Scroll Query.", "description": "The response for K8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "K8s Audit Log Scroll Query.", "description": "The response for K8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/k8s_events/scroll": { "get": { "summary": "K8s Events Scroll Query.", "description": "The response for K8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "K8s Events Scroll Query.", "description": "The response for K8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/platform_events": { "post": { "summary": "Platform event Query.", "description": "Request to GET platform event that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for platform events across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch audit logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logPlatformEventRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Platform-event resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "platform-event" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "platform-event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/platform_events/aggregation": { "post": { "summary": "Platform event Aggregation Query.", "description": "Request to GET summary/analytics data for the audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for platform event across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logPlatformEventAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventAggregationQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/platform_events/scroll": { "get": { "summary": "Platform event Scroll Query.", "description": "The response for platform event query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Platform event Scroll Query.", "description": "The response for platform event query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs": { "post": { "summary": "K8s Audit Log Query.", "description": "Request to GET Physical K8s audit logs that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for audit logs across all namespaces in a K8s Cluster.", "operationId": "ves.io.schema.log.CustomAPI.K8SAuditLogQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch K8s audit logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "site", "description": "Site\nSite where the K8s Cluster is running.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logK8SAuditLogRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SAuditLogQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "K8s-audit-log resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "k8s-audit-log" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "k8s-audit-log" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs/aggregation": { "post": { "summary": "K8s Audit Log Aggregation Query.", "description": "Request to GET summary/analytics data for the K8s audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for audit logs across all namespaces in a K8s Cluster.", "operationId": "ves.io.schema.log.CustomAPI.K8SAuditLogAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "site", "description": "Site\nSite where the K8s Cluster is running.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logK8SAuditLogAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SAuditLogAggregationQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/site/{site}/k8s_events": { "post": { "summary": "K8s Events Query.", "description": "Request to GET physical K8s events that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nK8s events in the namespace. User with access to the `system` namespace may query for K8s events across\nall namespaces in a K8s Cluster.", "operationId": "ves.io.schema.log.CustomAPI.K8SEventsQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch K8s events for the given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "site", "description": "Site\nSite where the K8s Cluster is running.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logK8SEventsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SEventsQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "K8s-event resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "k8s-event" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "k8s-event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/site/{site}/k8s_events/aggregation": { "post": { "summary": "K8s Events Aggregation Query.", "description": "Request to GET summary/analytics data for the K8s events that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for K8s events across all namespaces in a K8s Cluster.", "operationId": "ves.io.schema.log.CustomAPI.K8SEventsAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "site", "description": "Site\nSite where the K8s Cluster is running.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logK8SEventsAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SEventsAggregationQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_audit_logs": { "post": { "summary": "VK8s Audit Log Query.", "description": "Request to GET Virtual K8s audit logs that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for audit logs across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch vK8s audit logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SAuditLogRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Vk8s-audit-log resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "vk8s-audit-log" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "vk8s-audit-log" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_audit_logs/aggregation": { "post": { "summary": "VK8s Audit Log Aggregation Query.", "description": "Request to GET summary/analytics data for the vK8s audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for audit logs across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SAuditLogAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogAggregationQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_audit_logs/scroll": { "get": { "summary": "VK8s Audit Log Scroll Query.", "description": "The response for vK8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "VK8s Audit Log Scroll Query.", "description": "The response for vK8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_events": { "post": { "summary": "VK8s Events Query.", "description": "Request to GET Virtual K8s events that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nvK8s events in the namespace. User with access to the `system` namespace may query for vK8s across\nall namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch vK8s events for the given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SEventsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Vk8s-event resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "vk8s-event" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "vk8s-event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_events/aggregation": { "post": { "summary": "VK8s Events Aggregation Query.", "description": "Request to GET summary/analytics data for the vK8s events that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for vK8s events across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SEventsAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsAggregationQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_events/scroll": { "get": { "summary": "VK8s Events Scroll Query.", "description": "The response for vK8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "VK8s Events Scroll Query.", "description": "The response for vK8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/revoke/global-kubeconfigs": { "post": { "summary": "Revoke Global Kubeconfig.", "description": "Kubeconfig credential revoke/deletion.", "operationId": "ves.io.schema.site.UamKubeConfigAPI.RevokeGlobalKubeConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteKubeConfigStatusRsp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteRevokeKubeConfigReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.UamKubeConfigAPI.RevokeGlobalKubeConfig", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Global-kubeconfig resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "global-kubeconfig" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "global-kubeconfig" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.UamKubeConfigAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{name}/status": { "post": { "summary": "Check Site Exist.", "description": "Check Site Exist for a site.", "operationId": "ves.io.schema.site.CustomSiteStatusAPI.CheckSiteExist", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteCheckSiteExistResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\n\nx-required\nName of the site.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "ce01" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteCheckSiteExistRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomSiteStatusAPI.CheckSiteExist", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "statu" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomSiteStatusAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/configmaps": { "get": { "summary": "ConfigMap List.", "description": "API to GET list of configmaps for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.ConfigMapList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ConfigMapList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of configmaps in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.ConfigMapList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 147.8, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 147.8, "p95_ms": 295.6, "p99_ms": 443.4, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/endpoints": { "get": { "summary": "Endpoints List.", "description": "API to GET list of endpoints for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.EndpointsList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EndpointsList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of endpoints in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.EndpointsList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 143.89, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 143.89, "p95_ms": 287.78, "p99_ms": 431.67, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces": { "get": { "summary": "Namespace List.", "description": "API to GET list of namespaces in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.NamespaceList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1NamespaceList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.NamespaceList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Logical resource grouping and multi-tenancy boundary", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 160.25, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 160.25, "p95_ms": 320.5, "p99_ms": 480.75, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/configmaps": { "get": { "summary": "ConfigMap List.", "description": "API to GET list of configmaps for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.ConfigMapList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ConfigMapList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of configmaps in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.ConfigMapList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 148.75, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 148.75, "p95_ms": 297.5, "p99_ms": 446.25, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/endpoints": { "get": { "summary": "Endpoints List.", "description": "API to GET list of endpoints for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.EndpointsList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EndpointsList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of endpoints in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.EndpointsList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 143.71, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 143.71, "p95_ms": 287.42, "p99_ms": 431.13, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/persistentvolumeclaims": { "get": { "summary": "PersistentVolumeClaim List.", "description": "API to GET list of PVCs for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PersistentVolumeClaimList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PersistentVolumeClaimList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of PVCs in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PersistentVolumeClaimList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 153.89, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 153.89, "p95_ms": 307.78, "p99_ms": 461.67, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/pods": { "get": { "summary": "Pod List", "description": "API to GET list of pods in a site for a given namespace.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PodList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PodList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of pods in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PodList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 150.31, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 150.31, "p95_ms": 300.62, "p99_ms": 450.93, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/secrets": { "get": { "summary": "Secret List.", "description": "API to GET list of secrets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.SecretList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SecretList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of secrets in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.SecretList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 149.56, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 149.56, "p95_ms": 299.12, "p99_ms": 448.68, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/services": { "get": { "summary": "Service List.", "description": "API to GET list of services for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.ServiceList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ServiceList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of services in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.ServiceList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 143.9, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 143.9, "p95_ms": 287.8, "p99_ms": 431.7, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/nodes": { "get": { "summary": "Namespace List.", "description": "API to GET list of nodes in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.NodeList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1NodeList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.NodeList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 150.6, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 150.6, "p95_ms": 301.2, "p99_ms": 451.8, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/persistentvolumeclaims": { "get": { "summary": "PersistentVolumeClaim List.", "description": "API to GET list of PVCs for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PersistentVolumeClaimList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PersistentVolumeClaimList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of PVCs in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PersistentVolumeClaimList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 149.38, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 149.38, "p95_ms": 298.76, "p99_ms": 448.14, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/persistentvolumes": { "get": { "summary": "PersistentVolume List.", "description": "API to GET list of Persistent Volumes in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PersistentVolumeList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PersistentVolumeList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PersistentVolumeList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 148.21, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 148.21, "p95_ms": 296.42, "p99_ms": 444.63, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/pods": { "get": { "summary": "Pod List", "description": "API to GET list of pods in a site for a given namespace.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PodList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PodList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of pods in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PodList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 158.88, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 158.88, "p95_ms": 317.76, "p99_ms": 476.64, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/secrets": { "get": { "summary": "Secret List.", "description": "API to GET list of secrets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.SecretList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SecretList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of secrets in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.SecretList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 146.84, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 146.84, "p95_ms": 293.68, "p99_ms": 440.52, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/api/v1/services": { "get": { "summary": "Service List.", "description": "API to GET list of services for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.ServiceList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ServiceList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of services in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.ServiceList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 143.56, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 143.56, "p95_ms": 287.12, "p99_ms": 430.68, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/daemonsets": { "get": { "summary": "DaemonSet List.", "description": "API to GET list of daemon sets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.DaemonSetList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DaemonSetList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of daemon sets in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.DaemonSetList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 150.09, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 150.09, "p95_ms": 300.18, "p99_ms": 450.27, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/deployments": { "get": { "summary": "Deployment List.", "description": "API to GET list of deployments for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.DeploymentList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeploymentList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of deployments in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.DeploymentList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 150.03, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 150.03, "p95_ms": 300.06, "p99_ms": 450.09, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/daemonsets": { "get": { "summary": "DaemonSet List.", "description": "API to GET list of daemon sets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.DaemonSetList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DaemonSetList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of daemon sets in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.DaemonSetList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 144.37, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 144.37, "p95_ms": 288.74, "p99_ms": 433.11, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/deployments": { "get": { "summary": "Deployment List.", "description": "API to GET list of deployments for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.DeploymentList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeploymentList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of deployments in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.DeploymentList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 152.35, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 152.35, "p95_ms": 304.7, "p99_ms": 457.05, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/replicasets": { "get": { "summary": "ReplicaSet List.", "description": "API to GET list of replica sets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.ReplicaSetList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ReplicaSetList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of replication sets in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.ReplicaSetList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 147.33, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 147.33, "p95_ms": 294.66, "p99_ms": 441.99, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/statefulsets": { "get": { "summary": "StatefulSet List.", "description": "API to GET list of stateful sets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.StatefulSetList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1StatefulSetList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of stateful sets in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.StatefulSetList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 145.33, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 145.33, "p95_ms": 290.66, "p99_ms": 435.99, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/replicasets": { "get": { "summary": "ReplicaSet List.", "description": "API to GET list of replica sets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.ReplicaSetList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ReplicaSetList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of replication sets in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.ReplicaSetList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 149.43, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 149.43, "p95_ms": 298.86, "p99_ms": 448.29, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/apps/v1/statefulsets": { "get": { "summary": "StatefulSet List.", "description": "API to GET list of stateful sets for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.StatefulSetList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1StatefulSetList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of stateful sets in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.StatefulSetList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 148.16, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 148.16, "p95_ms": 296.32, "p99_ms": 444.48, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/batch/v1/jobs": { "get": { "summary": "Job List", "description": "API to GET list of jobs for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.JobList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1JobList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of jobs in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.JobList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "high" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 147.79, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 147.79, "p95_ms": 295.58, "p99_ms": 443.37, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/batch/v1/namespaces/{namespace}/jobs": { "get": { "summary": "Job List", "description": "API to GET list of jobs for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.JobList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1JobList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of jobs in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.JobList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "high" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 150.57, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 150.57, "p95_ms": 301.14, "p99_ms": 451.71, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/batch/v1beta1/cronjobs": { "get": { "summary": "CronJob List.", "description": "API to GET list of cronjobs for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.CronJobList_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1beta1CronJobList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace to scope the listing of cronjobs in a site.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.CronJobList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "high" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 146.97, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 146.97, "p95_ms": 293.94, "p99_ms": 440.91, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/apis/batch/v1beta1/namespaces/{namespace}/cronjobs": { "get": { "summary": "CronJob List.", "description": "API to GET list of cronjobs for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.CronJobList_get_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1beta1CronJobList" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of cronjobs in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.CronJobList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "high" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 144.07, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 144.07, "p95_ms": 288.14, "p99_ms": 432.21, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/namespaces/{namespace}/pods/metrics": { "post": { "summary": "Pods Metrics.", "description": "API to GET pods metrics for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PodsMetrics_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sitePodsMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of cronjobs in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sitePodsMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PodsMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/namespaces/{namespace}/virtualmachineinstances/metrics": { "post": { "summary": "VirtualMachineInstances Metrics.", "description": "API to GET virtual machine instances metrics for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.VirtualMachineInstancesMetrics_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" }, { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of cronjobs in a site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.VirtualMachineInstancesMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/pods/metrics": { "post": { "summary": "Pods Metrics.", "description": "API to GET pods metrics for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.PodsMetrics_post_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sitePodsMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sitePodsMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.PodsMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/site/{site}/virtualmachineinstances/metrics": { "post": { "summary": "VirtualMachineInstances Metrics.", "description": "API to GET virtual machine instances metrics for a given namespace in a site.", "operationId": "ves.io.schema.site.CustomDataK8SAPI.VirtualMachineInstancesMetrics_post_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nSite name.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomDataK8SAPI.VirtualMachineInstancesMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomDataK8SAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/sites/{site}/global-kubeconfigs": { "get": { "summary": "List Global Kube Configs.", "description": "Returns list of all global active kubeconfig minted for this site.", "operationId": "ves.io.schema.site.UamKubeConfigAPI.ListGlobalKubeConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteListKubeConfigRsp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\n\nx-required\nName of the site.\nAll global kubeconfigs created by the user under the site will be listed.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.UamKubeConfigAPI.ListGlobalKubeConfig", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.site" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Create Global Kube Config.", "description": "Download kube config for global K8s cluster access.", "operationId": "ves.io.schema.site.UamKubeConfigAPI.CreateGlobalKubeConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\n\nx-required\nName of the site for which kubeconfig is being requested.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteCreateGlobalKubeConfigReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.UamKubeConfigAPI.CreateGlobalKubeConfig", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Global-kubeconfig resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "global-kubeconfig" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "global-kubeconfig" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.UamKubeConfigAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/sites/{metadata.name}": { "put": { "summary": "Replace Site.", "description": "Replace Site will replace address, coordinates of site.", "operationId": "ves.io.schema.site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "F5 XC site for edge deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/register/namespaces/{namespace}/site/{name}/state": { "post": { "summary": "Set site state.", "description": "Request changing site state but this request goes through validation as some\ntrainsitions are not allowed.\nIt can be used to decomission site by sending state DECOMMISSIONING. Example of\nforbidden state is PROVISIONING and UPGRADING.", "operationId": "ves.io.schema.site.CustomStateAPI.SetState", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteSetStateResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nSite namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteSetStateReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomStateAPI.SetState", "tags": [ "register" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "State resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "state" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "state" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomStateAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/site/{site}/status/metrics": { "post": { "summary": "Site Status Metrics.", "description": "GET status metrics for a site.", "operationId": "ves.io.schema.site.CustomSiteStatusAPI.SiteStatusMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteSiteStatusMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nOnly system namespace is valid for this request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "site", "description": "Site\n\nx-required\nName of the site.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce01" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteSiteStatusMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomSiteStatusAPI.SiteStatusMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomSiteStatusAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites": { "get": { "summary": "List Site", "description": "List the set of site in a namespace.", "operationId": "ves.io.schema.site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "F5 XC site for edge deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 173.31, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 173.31, "p95_ms": 346.62, "p99_ms": 519.93, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{name}": { "get": { "summary": "GET Site", "description": "GET of site.", "operationId": "ves.io.schema.site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "F5 XC site for edge deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{name}/local-kubeconfig": { "post": { "summary": "Create K8s Cluster Local Kube Config.", "description": "Down load kube config for local K8s cluster access.", "operationId": "ves.io.schema.site.ConfigKubeConfigAPI.CreateLocalKubeConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiHttpBody" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nK8s Cluster namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\n\nx-required\nK8s Cluster name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteCreateKubeConfigReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.ConfigKubeConfigAPI.CreateLocalKubeConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Local-kubeconfig resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "local-kubeconfig" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "local-kubeconfig" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.ConfigKubeConfigAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{name}/local-kubeconfigs": { "get": { "summary": "List Local Kube Configs.", "description": "Returns list of all local active kubeconfig minted for this site.", "operationId": "ves.io.schema.site.ConfigKubeConfigAPI.ListLocalKubeConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteListKubeConfigRsp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nK8s Cluster namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\n\nx-required\nK8s Cluster name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.ConfigKubeConfigAPI.ListLocalKubeConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 148.06, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 148.06, "p95_ms": 296.12, "p99_ms": 444.18, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.ConfigKubeConfigAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{name}/upgrade_os": { "post": { "summary": "Upgrade OS.", "description": "Upgrade Site OS version.", "operationId": "ves.io.schema.site.UpgradeAPI.UpgradeOS", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteUpgradeOSResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nSite namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteUpgradeOSRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.UpgradeAPI.UpgradeOS", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Request an in-place site operating-system upgrade", "required_fields": [ "namespace", "name", "version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action request accepted by the API", "Asynchronous convergence not implied" ] }, "side_effects": { "modifies": [ "site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-operation-role": "action", "x-f5xc-terraform-name": "site_upgrade_os", "x-f5xc-required-fields": [ "namespace", "name", "version" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.UpgradeAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{name}/upgrade_sw": { "post": { "summary": "Upgrade SW.", "description": "Upgrade Site SW version.", "operationId": "ves.io.schema.site.UpgradeAPI.UpgradeSW", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteUpgradeSWResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nSite namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteUpgradeSWRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.UpgradeAPI.UpgradeSW", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Request an in-place site software upgrade", "required_fields": [ "namespace", "name", "version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action request accepted by the API", "Asynchronous convergence not implied" ] }, "side_effects": { "modifies": [ "site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-operation-role": "action", "x-f5xc-terraform-name": "site_upgrade_sw", "x-f5xc-required-fields": [ "namespace", "name", "version" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.UpgradeAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{site}/global_networks": { "get": { "summary": "Global Network List.", "description": "API to GET list of Global Network in a site.", "operationId": "ves.io.schema.site.CustomVirtualNetworkListAPI.GlobalNetworkList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteGlobalNetworkListResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSite namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "site", "description": "Site\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Site Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomVirtualNetworkListAPI.GlobalNetworkList", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 149.64, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 149.64, "p95_ms": 299.28, "p99_ms": 448.92, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomVirtualNetworkListAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{site}/interface": { "get": { "summary": "Interface List.", "description": "API to GET list of interface in a site.", "operationId": "ves.io.schema.site.CustomInterfaceListAPI.InterfaceList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteInterfaceListResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSite namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "site", "description": "Site\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Site Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" }, { "name": "node", "description": "X-required\nName of the node from which ping is initiated.", "in": "query", "required": false, "x-displayname": "Node Name", "schema": { "type": "string" }, "x-f5xc-example": "master-0" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomInterfaceListAPI.InterfaceList", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomInterfaceListAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/sites/{site}/segments": { "get": { "summary": "Segment List.", "description": "API to GET list of segments in a site.", "operationId": "ves.io.schema.site.CustomVirtualNetworkListAPI.SegmentList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteSegmentListResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nSite namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "site", "description": "Site\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Site Name", "schema": { "type": "string" }, "x-f5xc-example": "ce398" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.site.CustomVirtualNetworkListAPI.SegmentList", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.site" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 148.62, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 148.62, "p95_ms": 297.24, "p99_ms": 445.86, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Site", "x-ves-proto-service": "ves.io.schema.site.CustomVirtualNetworkListAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/graph/site": { "post": { "summary": "Site Graph Query.", "description": "Request to GET inter-site traffic graph for an application.", "operationId": "ves.io.schema.graph.site.CustomAPI.Query", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.graph.site.CustomAPI.Query", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "F5 XC site for edge deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site Graph.", "x-ves-proto-service": "ves.io.schema.graph.site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/graph/site/edge": { "post": { "summary": "Site Edge Query.", "description": "Request to GET time-series data for an edge returned in the site traffic graph.", "operationId": "ves.io.schema.graph.site.CustomAPI.EdgeQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteEdgeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteEdgeRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.graph.site.CustomAPI.EdgeQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Edge resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "edge" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "edge" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site Graph.", "x-ves-proto-service": "ves.io.schema.graph.site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/graph/site/node": { "post": { "summary": "Site Node Query.", "description": "Request to GET time-series data for a site returned in the site traffic graph.", "operationId": "ves.io.schema.graph.site.CustomAPI.NodeQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteNodeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/siteNodeRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.graph.site.CustomAPI.NodeQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Node resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "node" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "node" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Site Graph.", "x-ves-proto-service": "ves.io.schema.graph.site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/dc_cluster_group/{dc_cluster_group}": { "post": { "summary": "DC Cluster Topology.", "description": "GET topology of a DC Cluster.", "operationId": "ves.io.schema.topology.CustomDataAPI.DCClusterTopology", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "dc_cluster_group", "description": "DC Cluster group\nName of the DC Cluster group.", "in": "path", "required": true, "x-displayname": "DC Cluster group.", "schema": { "type": "string" }, "x-f5xc-example": "dcg-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyDCClusterTopologyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.DCClusterTopology", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.dc_cluster_group" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dc-cluster-group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dc-cluster-group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.dc_cluster_group" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dc-cluster-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/dc_cluster_groups": { "get": { "summary": "DC Cluster Groups Summary.", "description": "GET summary of all DC Cluster groups.", "operationId": "ves.io.schema.topology.CustomDataAPI.DCClusterGroupsSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.DCClusterGroupsSummary", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/network/{id}/route_tables": { "get": { "summary": "GET Network Route Tables.", "description": "Gets Route Tables Associated with a Network.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetNetworkRouteTables", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyNetworkRouteTablesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nNetwork ID.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "vpc-1234567898" }, { "name": "route_table_ids", "description": "Route Table IDs used as filters.", "in": "query", "required": false, "x-displayname": "Route Table IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "rtb-1234567898, rtb-2345678901" }, { "name": "subnet_ids", "description": "Subnet IDs used as filters.", "in": "query", "required": false, "x-displayname": "Subnet IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "sub-1234567898, sub-2345678901" }, { "name": "subnet_cidrs", "description": "Subnet cidrs used as filters.", "in": "query", "required": false, "x-displayname": "Subnet Cidrs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "192.0.2.0/24, 192.0.2.0/24" }, { "name": "regions", "description": "Regions used as filters.", "in": "query", "required": false, "x-displayname": "Regions", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "us-west1, us-east1" }, { "name": "site", "description": "Site Name", "in": "query", "required": false, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-name1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetNetworkRouteTables", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Traffic routing configuration", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/route_table/{name}": { "get": { "summary": "GET Route Table.", "description": "GET Route Table.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetRouteTable", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyRouteTableResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\n\nx-required\nRoute table name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "rt-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetRouteTable", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Traffic routing configuration", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/site/{name}/networks": { "get": { "summary": "GET Site Networks.", "description": "Gets Networks Associated to Site.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetSiteNetworks", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologySiteNetworksResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\n\nx-required\nSite name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "site-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetSiteNetworks", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/site/{site}": { "post": { "summary": "Site Topology.", "description": "GET topology of a site and the resources associated/connected to the site such as other Customer sites,\nRegional Sites, VPCs (Virtual Private Cloud) networks, etc., and the associated metrics.", "operationId": "ves.io.schema.topology.CustomDataAPI.SiteTopology", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site", "description": "Site\nName of the site.", "in": "path", "required": true, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce01" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologySiteTopologyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.SiteTopology", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "F5 XC site for edge deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/site_mesh_group/{site_mesh_group}": { "post": { "summary": "Site Mesh Topology.", "description": "GET topology of a site mesh.", "operationId": "ves.io.schema.topology.CustomDataAPI.SiteMeshTopology", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site_mesh_group", "description": "Site Mesh Group\nName of the site mesh group.", "in": "path", "required": true, "x-displayname": "Site Mesh Group.", "schema": { "type": "string" }, "x-f5xc-example": "smg-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologySiteMeshTopologyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.SiteMeshTopology", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.site_mesh_group" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Site-mesh-group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "site-mesh-group" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.site_mesh_group" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "site-mesh-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/site_mesh_groups": { "get": { "summary": "Site Mesh Groups Summary.", "description": "GET summary of all site mesh groups.", "operationId": "ves.io.schema.topology.CustomDataAPI.SiteMeshGroupsSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.SiteMeshGroupsSummary", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/tgw/{id}/route_tables": { "get": { "summary": "GET TGW Route Tables.", "description": "Gets Route Tables Associated with a TGW.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetTGWRouteTables", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTGWRouteTablesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nTGW ID.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "tgw-1234567898" }, { "name": "route_table_ids", "description": "Route Table IDs used as filters.", "in": "query", "required": false, "x-displayname": "Route Table IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "rtb-1234567898, rtb-2345678901" }, { "name": "attachment_ids", "description": "Route Table IDs used as filters.", "in": "query", "required": false, "x-displayname": "TGW Attachment IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "attach-1234567898, attach-2345678901" }, { "name": "site", "description": "Name of the site.", "in": "query", "required": false, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce01" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetTGWRouteTables", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Traffic routing configuration", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/virtual_k8ss": { "post": { "summary": "Create Virtual Kubernetes.", "description": "Create virtual_k8s will create the object in the storage backend for namespace metadata.namespace.", "operationId": "ves.io.schema.virtual_k8s.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/container_services/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_k8s.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Virtual Kubernetes cluster for workload deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Virtual-k8s resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "virtual-k8s" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "virtual-k8s" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Kubernetes.", "x-ves-proto-service": "ves.io.schema.virtual_k8s.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/virtual_k8ss/{metadata.name}": { "put": { "summary": "Replace Virtual Kubernetes.", "description": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.", "operationId": "ves.io.schema.virtual_k8s.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/container_services/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_k8s.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Virtual Kubernetes cluster for workload deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "virtual-k8s" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "virtual-k8s" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Kubernetes.", "x-ves-proto-service": "ves.io.schema.virtual_k8s.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/data/namespaces/{namespace}/virtual_k8s/pvc/metrics": { "post": { "summary": "PVC Metrics.", "description": "API to GET PVC capacity/usage.", "operationId": "ves.io.schema.virtual_k8s.CustomDataAPI.PVCMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sPVCMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sPVCMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_k8s.CustomDataAPI.PVCMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Kubernetes.", "x-ves-proto-service": "ves.io.schema.virtual_k8s.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/virtual_k8ss": { "get": { "summary": "List Virtual Kubernetes.", "description": "List the set of virtual_k8s in a namespace.", "operationId": "ves.io.schema.virtual_k8s.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of virtual_k8s.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/container_services/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_k8s.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Virtual Kubernetes cluster for workload deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 158.53, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 158.53, "p95_ms": 317.06, "p99_ms": 475.59, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Virtual Kubernetes.", "x-ves-proto-service": "ves.io.schema.virtual_k8s.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/virtual_k8ss/{name}": { "get": { "summary": "GET Virtual Kubernetes.", "description": "GET virtual_k8s will GET the object from the storage backend for namespace metadata.namespace.", "operationId": "ves.io.schema.virtual_k8s.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/container_services/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_k8s.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Virtual Kubernetes cluster for workload deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Virtual Kubernetes.", "description": "DELETE the specified virtual_k8s.", "operationId": "ves.io.schema.virtual_k8s.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_k8sDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/container_services/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_k8s.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Virtual Kubernetes cluster for workload deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "virtual-k8s", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "virtual-k8s", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Kubernetes.", "x-ves-proto-service": "ves.io.schema.virtual_k8s.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/virtual_sites": { "post": { "summary": "Create Virtual Site.", "description": "Create a virtual site object in given namespace.", "operationId": "ves.io.schema.virtual_site.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_site.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Virtual-site resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "virtual-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "virtual-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Site.", "x-ves-proto-service": "ves.io.schema.virtual_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/virtual_sites/{metadata.name}": { "put": { "summary": "Replace Virtual Site.", "description": "Replace a given virtual site object in a given namespace.", "operationId": "ves.io.schema.virtual_site.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_site.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "virtual-site" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "virtual-site" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Site.", "x-ves-proto-service": "ves.io.schema.virtual_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/virtual_sites": { "get": { "summary": "List Virtual Site.", "description": "List the set of virtual_site in a namespace.", "operationId": "ves.io.schema.virtual_site.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of virtual_site.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_site.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Site.", "x-ves-proto-service": "ves.io.schema.virtual_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/virtual_sites/{name}": { "get": { "summary": "GET Virtual Site.", "description": "GET a virtual site object in given namespace.", "operationId": "ves.io.schema.virtual_site.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_site.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Virtual Site.", "description": "DELETE the specified virtual_site.", "operationId": "ves.io.schema.virtual_site.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_site.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "virtual-site", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "virtual-site", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Site.", "x-ves-proto-service": "ves.io.schema.virtual_site.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/virtual_sites/{name}/selectees": { "get": { "summary": "GET Selectees.", "description": "GET the list of objects selected by this Virtual Site based on its selector label expression.", "operationId": "ves.io.schema.virtual_site.CustomAPI.GetSelectees", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/virtual_siteSelecteeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the Virtual Site whose Site selections are to be found.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the Virtual Site whose Site selections are to be found.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.virtual_site.CustomAPI.GetSelectees", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Virtual Site.", "x-ves-proto-service": "ves.io.schema.virtual_site.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "aws_tgw_siteAWSTGWInfoConfigType": { "type": "object", "description": "AWS tgw information like tgw-ID and site's VPC-ID.", "title": "AWS TGW Information Config", "x-displayname": "AWS TGW Information Config.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.AWSTGWInfoConfigType", "properties": { "private_ips": { "type": "array", "description": "AWS Private IPs used by the nodes.", "title": "AWS Node Private IPs", "items": { "type": "string" }, "x-displayname": "AWS Node Private IPs.", "x-ves-example": "192.0.2.246, 192.0.2.204, 192.0.2.170.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.246, 192.0.2.204, 192.0.2.170", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "public_ips": { "type": "array", "description": "AWS Elastic IPs used by the nodes.", "title": "AWS Node Elastic IPs", "items": { "type": "string" }, "x-displayname": "AWS Node Elastic IPs.", "x-ves-example": "192.0.2.242, 192.0.2.31, 192.0.2.63.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.242, 192.0.2.31, 192.0.2.63", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "subnet_ids": { "type": "array", "description": "AWS Subnet IDs used by F5 Distributed Cloud site.", "title": "AWS Subnet Ids Info", "items": { "$ref": "#/components/schemas/viewsAWSSubnetIdsType" }, "x-displayname": "AWS Subnet IDs.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3" }, "x-f5xc-description-short": "AWS Subnet IDs used by F5 Distributed Cloud site.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tgw_id": { "type": "string", "description": "TGW ID populated by AWS.", "title": "TGW ID", "x-displayname": "TGW ID", "x-ves-example": "Tgw-12345678.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "tgw-12345678", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vpc_id": { "type": "string", "description": "VPC ID where the F5 Distributed Cloud site exists.", "title": "VPC ID", "x-displayname": "VPC ID", "x-ves-example": "VPC-12345678.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vpc-12345678", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-description-short": "VPC ID where the F5 Distributed Cloud site exists.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vpc_name": { "type": "string", "description": "VPC Name where the F5 Distributed Cloud site exists.", "title": "VPC Name", "x-displayname": "VPC Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "VPC Name where the F5 Distributed Cloud site exists.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AWS tgw information like tgw-ID and site's VPC-ID.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteAWSTGWInfoConfigType", "required_fields": [ "private_ips", "public_ips", "subnet_ids", "tgw_id", "vpc_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"private_ips\": [\n \"value\"\n ],\n \"public_ips\": [\n \"value\"\n ],\n \"subnet_ids\": [\n {}\n ],\n \"tgw_id\": \"tgw-12345678\",\n \"vpc_id\": \"vpc-12345678\"\n}", "example_yaml": "private_ips:\n- value\npublic_ips:\n- value\nsubnet_ids:\n- {}\ntgw_id: tgw-12345678\nvpc_id: vpc-12345678" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of aws_tgw_site", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a aws_tgw_site", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read aws_tgw_site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/aws_tgw_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of aws_tgw_site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/aws_tgw_siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteListResponseItem": { "type": "object", "description": "By default a summary of aws_tgw_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of aws_tgw_site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this aws_tgw_site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this aws_tgw_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this aws_tgw_site.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this aws_tgw_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates aws_tgw_site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates aws_tgw_site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this aws_tgw_site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this aws_tgw_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this aws_tgw_site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/aws_tgw_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this aws_tgw_site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of aws_tgw_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of aws_tgw_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a aws_tgw_site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSecurityConfigType": { "type": "object", "description": "Security Configuration for transit gateway.", "title": "TGW Security Configuration", "x-displayname": "TGW Security Configuration.", "x-ves-oneof-field-east_west_service_policy_choice": "[\"active_east_west_service_policies\",\"east_west_service_policy_allow_all\",\"no_east_west_policy\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SecurityConfigType", "properties": { "active_east_west_service_policies": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteActiveServicePoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active east west service policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "east_west_service_policy_allow_all", "no_east_west_policy" ] }, "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "east_west_service_policy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for east west service policy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_east_west_service_policies", "no_east_west_policy" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "no_east_west_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_east_west_service_policies", "east_west_service_policy_allow_all" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] } }, "x-f5xc-description-short": "Security Configuration for transit gateway.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSecurityConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteServicesVPCReplaceType": { "type": "object", "description": "AWS Services VPC Replace config.", "title": "AWS Services VPC Config", "x-displayname": "AWS Services VPC Config.", "x-ves-oneof-field-deployment": "[\"aws_cred\"]", "x-ves-oneof-field-internet_vip_choice": "[\"disable_internet_vip\",\"enable_internet_vip\"]", "x-ves-oneof-field-security_group_choice": "[\"custom_security_group\",\"f5xc_security_group\"]", "x-ves-oneof-field-service_vpc_choice": "[\"new_vpc\",\"vpc_id\"]", "x-ves-oneof-field-tgw_choice": "[\"existing_tgw\",\"new_tgw\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ServicesVPCReplaceType", "properties": { "aws_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "aws_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "aws_region": { "type": "string", "description": "AWS Region of your services VPC, where F5XC site will be deployed.", "title": "AWS Region", "x-displayname": "AWS Region.", "x-ves-example": "Us-east-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-east-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "AWS Region of your services VPC, where F5XC site will be deployed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "items": { "$ref": "#/components/schemas/viewsAWSVPCTwoInterfaceNodeType" }, "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "custom_security_group": { "allOf": [ { "$ref": "#/components/schemas/viewsSecurityGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5xc_security_group" ] }, "disable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_internet_vip" ] }, "disk_size": { "type": "integer", "description": "Node disk size for all node in the F5XC site. Unit is GiB.", "title": "Node Disk size", "format": "int64", "x-displayname": "Node Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-description-short": "Node disk size for all node in the F5XC site. Unit is GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 64000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_internet_vip" ] }, "existing_tgw": { "allOf": [ { "$ref": "#/components/schemas/viewsExistingTGWType" } ], "x-f5xc-description-short": "Configuration parameter for existing tgw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "new_tgw" ] }, "f5xc_security_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_security_group" ] }, "instance_type": { "type": "string", "description": "Instance size based on the performance.", "maxLength": 64, "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "a1.xlarge", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "new_tgw": { "allOf": [ { "$ref": "#/components/schemas/viewsTGWParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_tgw" ] }, "new_vpc": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVPCParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vpc_id" ] }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "title": "Desired Worker Nodes Per AZ", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing nodes of the site.", "title": "Public SSH key", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Public SSH key for accessing nodes of the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "title": "Total Number of Worker Nodes for a Site", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "vpc_id": { "type": "string", "description": "Exclusive with [new_vpc]\nExisting VPC ID.", "title": "Existing VPC ID", "maxLength": 64, "x-displayname": "Existing VPC ID.", "x-ves-example": "VPC-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vpc-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-description-short": "Exclusive with [new_vpc] Existing VPC ID.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "new_vpc" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteServicesVPCReplaceType", "required_fields": [ "aws_region", "az_nodes", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_region\": \"us-east-1\",\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ],\n \"instance_type\": \"a1.xlarge\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "aws_region: us-east-1\naz_nodes:\n- aws_az_name: us-west-2a\ninstance_type: a1.xlarge\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteServicesVPCType": { "type": "object", "description": "Setup AWS services VPC, transit gateway and site.", "title": "AWS Service VPC and TGW", "x-displayname": "AWS Service VPC and TGW.", "x-ves-oneof-field-deployment": "[\"aws_cred\"]", "x-ves-oneof-field-encryption_choice": "[\"disable_encryption\",\"enable_encryption\"]", "x-ves-oneof-field-internet_vip_choice": "[\"disable_internet_vip\",\"enable_internet_vip\"]", "x-ves-oneof-field-security_group_choice": "[\"custom_security_group\",\"f5xc_security_group\"]", "x-ves-oneof-field-service_vpc_choice": "[\"new_vpc\",\"vpc_id\"]", "x-ves-oneof-field-tgw_choice": "[\"existing_tgw\",\"new_tgw\"]", "x-ves-oneof-field-tgw_cidr_choice": "[\"reserved_tgw_cidr\",\"tgw_cidr\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ServicesVPCType", "properties": { "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "aws_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "aws_region": { "type": "string", "description": "AWS Region of your services VPC, where F5XC site will be deployed.", "title": "AWS Region", "x-displayname": "AWS Region.", "x-ves-example": "Us-east-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-east-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "AWS Region of your services VPC, where F5XC site will be deployed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCTwoInterfaceNodeType" }, "x-displayname": "Ingress/Egress Gateway (two Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "custom_security_group": { "allOf": [ { "$ref": "#/components/schemas/viewsSecurityGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5xc_security_group" ] }, "disable_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_encryption" ] }, "disable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_internet_vip" ] }, "disk_size": { "type": "integer", "description": "Node disk size for all node in the F5XC site. Unit is GiB.", "title": "Node Disk size", "format": "int64", "x-displayname": "Node Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-description-short": "Node disk size for all node in the F5XC site. Unit is GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 64000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_encryption": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSDiskEncryption" } ], "x-f5xc-description-short": "Configuration parameter for enable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_encryption" ] }, "enable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_internet_vip" ] }, "existing_tgw": { "allOf": [ { "$ref": "#/components/schemas/viewsExistingTGWType" } ], "x-f5xc-description-short": "Configuration parameter for existing tgw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "new_tgw" ] }, "f5xc_security_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_security_group" ] }, "instance_type": { "type": "string", "description": "Instance size based on the performance.", "title": "AWS Instance Type", "maxLength": 64, "x-displayname": "AWS Instance Type for Node.", "x-ves-example": "a1.xlarge", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "a1.xlarge", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "new_tgw": { "allOf": [ { "$ref": "#/components/schemas/viewsTGWParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_tgw" ] }, "new_vpc": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVPCParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vpc_id" ] }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "title": "Desired Worker Nodes Per AZ", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "reserved_tgw_cidr": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for reserved tgw cidr.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "tgw_cidr" ] }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing nodes of the site.", "title": "Public SSH key", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Public SSH key for accessing nodes of the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "tgw_cidr": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetParamType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "reserved_tgw_cidr" ] }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "title": "Total Number of Worker Nodes for a Site", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "vpc_id": { "type": "string", "description": "Exclusive with [new_vpc]\nExisting VPC ID.", "title": "Existing VPC ID", "maxLength": 64, "x-displayname": "Existing VPC ID.", "x-ves-example": "VPC-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vpc-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-description-short": "Exclusive with [new_vpc] Existing VPC ID.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "new_vpc" ] } }, "x-f5xc-description-short": "Setup AWS services VPC, transit gateway and site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteServicesVPCType", "required_fields": [ "aws_region", "az_nodes", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_region\": \"us-east-1\",\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ],\n \"instance_type\": \"a1.xlarge\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "aws_region: us-east-1\naz_nodes:\n- aws_az_name: us-west-2a\ninstance_type: a1.xlarge\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetTGWInfoRequest": { "type": "object", "description": "Request to configure TGW Information.", "title": "Request to configure TGW Information", "x-displayname": "Request to configure TGW Information.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetTGWInfoRequest", "properties": { "direct_connect_info": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectInfo" } ], "x-f5xc-description-short": "Configuration parameter for direct connect info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-tgw-site-1.", "x-f5xc-example": "aws-tgw-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tgw_info": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteAWSTGWInfoConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetTGWInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetTGWInfoResponse": { "type": "object", "description": "Response to configure TGW info.", "title": "Response to configure TGW info", "x-displayname": "Response to configure TGW info.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetTGWInfoResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetTGWInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetVIPInfoRequest": { "type": "object", "description": "Request to configure AWS TGW Site VIP information.", "title": "Request to configure AWS TGW Site VIP information", "x-displayname": "Request to configure AWS TGW Site VIP information.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVIPInfoRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-tgw-site-1.", "x-f5xc-example": "aws-tgw-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "vip_params_per_az": { "type": "array", "description": "VIP Parameters per AZ.", "title": "VIP Params Per AZ", "items": { "$ref": "#/components/schemas/sitePublishVIPParamsPerAz__ves_io_schema_views_aws_tgw_site" }, "x-displayname": "VIP Params Per AZ.", "x-ves-example": "Master-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.num_items": "1,2,3" }, "x-f5xc-example": "master-0", "x-validation-rules": { "ves.io.schema.rules.repeated.num_items": "1,2,3" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to configure AWS TGW Site VIP information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetVIPInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetVIPInfoResponse": { "type": "object", "title": "Response to configure AWS TGW Site VIP Information", "x-displayname": "Response to configure AWS TGW Site VIP Information.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVIPInfoResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetVIPInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetVPCIpPrefixesRequest": { "type": "object", "description": "Request to configure VPC IP prefix set.", "title": "Request to configure VPC IP prefix set", "x-displayname": "Request to configure VPC IP prefix set.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVPCIpPrefixesRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-tgw-site-1.", "x-f5xc-example": "aws-tgw-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "vpc_ip_prefixes": { "type": "object", "description": "IP prefixes of subnets in the VPC.", "title": "VPC IP Prefixes", "x-displayname": "VPC IP Prefixes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetVPCIpPrefixesRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetVPCIpPrefixesResponse": { "type": "object", "description": "Response to configure VPC IP prefix set.", "title": "Response to configure VPC IP prefix set", "x-displayname": "Response to configure VPC IP prefix set.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVPCIpPrefixesResponse", "x-f5xc-description-short": "Response to configure VPC IP prefix set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetVPCIpPrefixesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetVPNTunnelsRequest": { "type": "object", "description": "Request to configure VPN Tunnels.", "title": "Request to configure VPN Tunnels", "x-displayname": "Request to configure VPN Tunnels.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVPNTunnelsRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-tgw-site-1.", "x-f5xc-example": "aws-tgw-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetVPNTunnelsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteSetVPNTunnelsResponse": { "type": "object", "description": "Response to configure VPN Tunnels.", "title": "Response to configure VPN Tunnels", "x-displayname": "Response to configure VPN Tunnels.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.SetVPNTunnelsResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteSetVPNTunnelsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersDeploymentStatusType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "AWS TGW view object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_share_status": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteAWSTGWResourceShareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_tgw_siteAWSTGWStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSAttachmentsListStatusType__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteTunnelType": { "type": "string", "description": "This defines Tunnel type towards TGW Site\n\nTUNNEL_IPSEC\nTUNNEL_GRE.", "title": "Tunnel Type", "enum": [ "TUNNEL_IPSEC", "TUNNEL_GRE" ], "default": "TUNNEL_IPSEC", "x-displayname": "Tunnel Type.", "x-ves-proto-enum": "ves.io.schema.views.aws_tgw_site.TunnelType", "x-f5xc-description-short": "Defines Tunnel type towards TGW Site TUNNEL_IPSEC TUNNEL_GRE.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteTunnelType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TUNNEL_IPSEC\"", "example_yaml": "TUNNEL_IPSEC\n..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteVPCAttachmentListType": { "type": "object", "description": "Spoke VPCs to be attached to the AWS TGW Site.", "title": "Spoke VPCs", "x-displayname": "Spoke VPCs.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.VPCAttachmentListType", "properties": { "vpc_list": { "type": "array", "description": "List of VPC attachments to transit gateway.", "title": "vpc_list", "maxItems": 128, "items": { "$ref": "#/components/schemas/aws_tgw_siteVPCAttachmentType" }, "x-displayname": "VPC List", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-f5xc-description-short": "List of VPC attachments to transit gateway.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Spoke VPCs to be attached to the AWS TGW Site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteVPCAttachmentListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteVPCAttachmentType": { "type": "object", "description": "VPC attachments to transit gateway.", "title": "VPC attachment", "x-displayname": "VPC", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.VPCAttachmentType", "properties": { "labels": { "type": "object", "description": "Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.", "title": "Labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.", "x-f5xc-description-medium": "Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "Information about existing VPC.", "title": "VPC ID", "maxLength": 64, "x-displayname": "VPC ID", "x-ves-example": "VPC-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vpc-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteVPCAttachmentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_tgw_siteVnConfiguration": { "type": "object", "description": "Virtual Network Configuration.", "title": "Virtual Network Configuration", "x-displayname": "Virtual Network Configuration.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.VnConfiguration", "properties": { "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allowed_vip_port_sli": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_tgw_siteVnConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSAttachmentsListStatusType__ves_io_schema_views_aws_tgw_site": { "type": "object", "description": "AWS VPC Attachment List Status Type.", "title": "AWS VPC Attachment List Status Type", "x-displayname": "AWS VPC Attachment List Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSAttachmentsListStatusType", "properties": { "attachment_status": { "type": "array", "description": "AWS Attachment Status Type.", "title": "AWS VPC Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSAttachmentsStatusType" }, "x-displayname": "AWS VPC Attachment Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_attachment_status": { "type": "array", "description": "AWS Connect Attachment Status Type.", "title": "AWS Connect Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSConnectAttachmentStatusType" }, "x-displayname": "AWS Connect Attachment Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_route_table_status": { "type": "array", "description": "AWS Transit Gateway Route Table Status Type.", "title": "AWS Transit Gateway Route Table Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWRouteTableStatusType" }, "x-displayname": "AWS Transit Gateway Route Table Status.", "x-f5xc-description-short": "AWS Transit Gateway Route Table Status Type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_status": { "allOf": [ { "$ref": "#/components/schemas/schemacloud_connectAWSTGWStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_resource_share_status": { "allOf": [ { "$ref": "#/components/schemas/schemacloud_connectAWSTGWResourceShareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSAttachmentsListStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSAttachmentsStatusType": { "type": "object", "description": "AWS Attachment Status Type.", "title": "AWS VPC Attachment Status Type", "x-displayname": "AWS Attachment Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSAttachmentsStatusType", "properties": { "association_route_table_id": { "type": "string", "description": "Association route table ID.", "title": "Association route table ID", "x-displayname": "Associated Transit Gateway route table ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "association_state": { "type": "string", "description": "Transit Gateway route table association state.", "title": "Association state", "x-displayname": "Transit Gateway route table association state.", "x-f5xc-description-short": "Transit Gateway route table association state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creation_time": { "type": "string", "description": "Attachment Creation Time.", "title": "Attachment Creation Time", "format": "date-time", "x-displayname": "Attachment Creation Time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Additional VPC attachment deployment status.", "title": "Additional VPC attachment deployment status", "x-displayname": "VPC attachment deployment status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional VPC attachment deployment status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "installed_routes": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSRouteTableListType" } ], "x-f5xc-description-short": "Configuration parameter for installed routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnets": { "type": "array", "description": "Network Interfaces created along with the attachment.", "title": "Subnets", "items": { "$ref": "#/components/schemas/cloud_connectSubnetStatusType" }, "x-displayname": "Network Interfaces.", "x-f5xc-description-short": "Network Interfaces created along with the attachment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_attachment_id": { "type": "string", "description": "TGW Attachment ID.", "title": "TGW Attachment ID", "x-displayname": "TGW Attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tgw_attachment_name": { "type": "string", "description": "TGW Attachment Name.", "title": "TGW Attachment Name", "x-displayname": "TGW Attachment Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_cidr": { "type": "string", "description": "VPC CIDR", "title": "VPC CIDR", "x-displayname": "VPC CIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vpc_name": { "type": "string", "description": "VPC Name", "title": "VPC Name", "x-displayname": "VPC Name", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_owner_id": { "type": "string", "description": "VPC Owner Account.", "title": "VPC Owner Account", "x-displayname": "VPC Owner Account.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSAttachmentsStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSConnectAttachmentStatusType": { "type": "object", "description": "AWS Connect Attachment Status Type.", "title": "AWS Connect Attachment Status Type", "x-displayname": "AWS Connect Attachment Type Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSConnectAttachmentStatusType", "properties": { "association_route_table_id": { "type": "string", "description": "Association route table ID.", "title": "Association route table ID", "x-displayname": "Association route table ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "association_state": { "type": "string", "description": "Transit Gateway route table association state.", "title": "Association state", "x-displayname": "Transit Gateway route table association state.", "x-f5xc-description-short": "Transit Gateway route table association state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Additional information related to the connect attachment deployment.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the connect attachment deployment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "f5xc_site_asn": { "type": "string", "description": "F5XC Site ASN.", "title": "F5XC Site ASN", "x-displayname": "F5XC Site ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peers": { "type": "array", "description": "Connect Peers.", "title": "Connect Peers", "items": { "$ref": "#/components/schemas/cloud_connectAWSConnectPeerStatusType" }, "x-displayname": "Connect Peers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol": { "type": "string", "description": "Connect protocol.", "title": "Connect protocol", "x-displayname": "Connect protocol.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_asn": { "type": "string", "description": "Transit Gateway ASN.", "title": "Transit Gateway ASN", "x-displayname": "Transit Gateway ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_attachment_id": { "type": "string", "description": "Transit Gateway Attachment ID.", "title": "Transit Gateway Attachment ID", "x-displayname": "Transit Gateway Attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "transit_gateway_attachment_name": { "type": "string", "description": "Transit Gateway Attachment Name.", "title": "Transit Gateway Attachment Name", "x-displayname": "Transit Gateway Attachment Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "transport_attachment_id": { "type": "string", "description": "Transport attachment ID.", "title": "Transport attachment ID", "x-displayname": "Transport attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSConnectAttachmentStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSConnectPeerStatusType": { "type": "object", "description": "AWS Connect Peer Status Type.", "title": "AWS Connect Peer Status Type", "x-displayname": "AWS Connect Peer Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSConnectPeerStatusType", "properties": { "connect_attachment_id": { "type": "string", "description": "Connect attachment ID.", "title": "Connect attachment ID", "x-displayname": "Connect attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "connect_peer_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_peer_id": { "type": "string", "description": "Connect Peer ID.", "title": "Connect Peer ID", "x-displayname": "Connect Peer ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deployment_status": { "type": "string", "description": "Additional information related to the connect peer attachment deployment.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the connect peer attachment deployment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Connect Peer Name.", "title": "Connect Peer Name", "x-displayname": "Connect Peer Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "peer_gre_address": { "type": "string", "title": "Peer GRE Address", "x-displayname": "Peer GRE Address.", "description": "Network address or location", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Connect Peer Tags.", "title": "Connect Peer Tags", "x-displayname": "Connect Peer Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_gre_address": { "type": "string", "title": "Transit Gateway GRE Address", "x-displayname": "Transit Gateway GRE Address.", "description": "Network address or location", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSConnectPeerStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSRouteTableListType": { "type": "object", "description": "AWS Route Table List.", "title": "AWS Route Table List", "x-displayname": "AWS Route Table List.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSRouteTableListType", "properties": { "route_tables": { "type": "array", "description": "Route Tables.", "title": "List of route tables", "minItems": 1, "maxItems": 200, "items": { "$ref": "#/components/schemas/cloud_connectAWSRouteTableType" }, "x-displayname": "List of route tables.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "200", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "200", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 200, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSRouteTableListType", "required_fields": [ "route_tables" ], "mutually_exclusive_groups": [], "example_json": "{\n \"route_tables\": [\n {\n \"static_routes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "route_tables:\n- static_routes:\n - value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSRouteTableType": { "type": "object", "description": "AWS Route Table.", "title": "AWS Route Table", "x-displayname": "AWS Route Table.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSRouteTableType", "properties": { "route_table_id": { "type": "string", "description": "Route table ID.", "title": "Route table ID", "maxLength": 64, "x-displayname": "Route table ID.", "x-ves-example": "Rtb-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "rtb-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "static_routes": { "type": "array", "description": "List of Static Routes.", "title": "static_routes", "minItems": 1, "maxItems": 50, "items": { "type": "string" }, "x-displayname": "Static Routes.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 50, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSRouteTableType", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n \"value\"\n ]\n}", "example_yaml": "static_routes:\n- value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWResourceReference": { "type": "object", "description": "AWS Transit Gateway Route Table Associations.", "title": "AWS Transit Gateway Route Table Associations", "x-displayname": "AWS Transit Gateway Route Table Associations.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWResourceReference", "properties": { "attachment_id": { "type": "string", "description": "Attachment ID.", "title": "Attachment ID", "x-displayname": "Attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deployment_status": { "type": "string", "description": "Additional information related to the TGW routing.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the TGW routing.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_id": { "type": "string", "description": "Resource ID.", "title": "Resource ID", "x-displayname": "Resource ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_type": { "type": "string", "description": "Resource type.", "title": "Resource type", "x-displayname": "Resource type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AWS Transit Gateway Route Table Associations.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSTGWResourceReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWRouteTableStatusType": { "type": "object", "description": "AWS Transit Gateway Route Table Status Type.", "title": "AWS Transit Gateway Route Table Status Type", "x-displayname": "AWS Transit Gateway Route Table Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWRouteTableStatusType", "properties": { "associations": { "type": "array", "description": "Associations.", "title": "Associations", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWResourceReference" }, "x-displayname": "Associations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Additional information related to the TGW routing.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the TGW routing.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "propagations": { "type": "array", "description": "Propagations.", "title": "Propagations", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWResourceReference" }, "x-displayname": "Propagations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_rt_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "transit_gateway_route_table_id": { "type": "string", "description": "Transit gateway route table ID.", "title": "Transit gateway route table ID", "x-displayname": "Transit gateway route table ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "transit_gateway_route_table_name": { "type": "string", "description": "Transit gateway route table Name.", "title": "Transit gateway route table Name", "x-displayname": "Transit gateway route table Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AWS Transit Gateway Route Table Status Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSTGWRouteTableStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCloudConnectVPCStateType": { "type": "string", "description": "Cloud Connect VPC State Type\n\n- AVAILABLE: Available\n\nCloud Connect VPC attachment is in available state.\n- PENDING: Pending\n\nCloud Connect VPC attachment is in flight.\n- FAILED: Failed\n\nCloud Connect VPC attachment has failed.\n- DELETED: Deleted\n\nCloud Connect VPC attachment has been deleted.\n- DELETING: Deleting\n\nCloud Connect VPC attachment is being deleted.\n- INITIATED: Initiated\n\nCloud Connect VPC attachment process has been initiated.", "title": "Cloud Connect VPC State", "enum": [ "AVAILABLE", "PENDING", "FAILED", "DELETED", "DELETING", "INITIATED" ], "default": "AVAILABLE", "x-displayname": "Cloud Connect VPC State.", "x-ves-proto-enum": "ves.io.schema.cloud_connect.CloudConnectVPCStateType", "x-f5xc-description-short": "Cloud Connect VPC State Type - AVAILABLE: Available Cloud Connect VPC attachment is in available state. - PENDING: Pending Cloud Connect VPC...", "x-f5xc-description-medium": "Cloud Connect VPC State Type - AVAILABLE: Available Cloud Connect VPC attachment is in available state. - PENDING: Pending Cloud Connect VPC attachment is in flight. - FAILED: Failed Cloud Connect VPC attachment has failed. - DELETED: Deleted Cloud Connect VPC attachment has been deleted. ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCloudConnectVPCStateType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"AVAILABLE\"", "example_yaml": "AVAILABLE\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectSubnetStatusType": { "type": "object", "description": "Network Interface Status.", "title": "SubnetStatusType for AWS VPC Attachment", "x-displayname": "Network Interface Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.SubnetStatusType", "properties": { "availability_zone": { "type": "string", "description": "Availability Zone.", "title": "Availability Zone\nx-displayName: \"Availability Zone\"", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_type": { "type": "string", "description": "Interface Type.", "title": "Interface Type\nx-displayName: \"Interface Type\"", "x-displayname": "Interface Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_interface_id": { "type": "string", "description": "Network Interface ID.", "title": "Network Interface ID", "x-displayname": "Network Interface ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "private_ipv4_address": { "type": "string", "description": "Private IPv4 Address.", "title": "Private IPV4 Address\nx-displayName: \"Private IPV4 Address\"", "x-displayname": "Private IPv4 Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status", "title": "Status\nx-displayName: \"Status\"", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "subnet_id": { "type": "string", "description": "Subnet ID", "title": "Subnet ID\nx-displayName: \"Subnet ID\"", "x-displayname": "Subnet ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectSubnetStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetBlockedServices": { "type": "object", "description": "Disable a node local service on this site.", "title": "Disable Node Local Service", "x-displayname": "Disable Node Local Service.", "x-ves-oneof-field-blocked_services_value_type_choice": "[\"dns\",\"ssh\",\"web_user_interface\"]", "x-ves-proto-message": "ves.io.schema.fleet.BlockedServices", "properties": { "dns": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ssh", "web_user_interface" ] }, "network_type": { "allOf": [ { "$ref": "#/components/schemas/schemaVirtualNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ssh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dns", "web_user_interface" ] }, "web_user_interface": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dns", "ssh" ] } }, "x-f5xc-description-short": "Disable a node local service on this site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetBlockedServices", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetBlockedServicesListType": { "type": "object", "description": "Disable node local services on this site. Note: The chosen services will GET disabled on all nodes in the site.", "title": "Disable Node Local Services", "x-displayname": "Disable Node Local Services.", "x-ves-proto-message": "ves.io.schema.fleet.BlockedServicesListType", "properties": { "blocked_service": { "type": "array", "description": "Blocking or denial configuration", "title": "Disable Node Local Services", "items": { "$ref": "#/components/schemas/fleetBlockedServices" }, "x-displayname": "Disable Node Local Services.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-wire-name": "blocked_sevice", "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Disable node local services on this site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetBlockedServicesListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "ioschemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "ioschemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "network_firewallActiveNetworkPoliciesType": { "type": "object", "description": "List of firewall policy views.", "title": "Active Firewall Policies Type", "x-displayname": "Active Firewall Policies Type.", "x-ves-proto-message": "ves.io.schema.network_firewall.ActiveNetworkPoliciesType", "properties": { "network_policies": { "type": "array", "description": "Ordered List of Firewall Policies active for this network firewall.", "title": "Firewall Policy", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Firewall Policy.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "Ordered List of Firewall Policies active for this network firewall.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_firewallActiveNetworkPoliciesType", "required_fields": [ "network_policies" ], "mutually_exclusive_groups": [], "example_json": "{\n \"network_policies\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "network_policies:\n- name: contacts-route" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network firewall is platform-level security" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaBlindfoldSecretInfoType": { "type": "object", "description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "title": "BlindfoldSecretInfoType", "x-displayname": "Blindfold Secret.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.BlindfoldSecretInfoType", "properties": { "decryption_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "title": "Decryption Provider", "x-displayname": "Decryption Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location": { "type": "string", "description": "Location is the uri_ref. It could be in URL format for string:///\nOr it could be a path if the store provider is an HTTP/HTTPS location.", "title": "Location", "x-displayname": "Location", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "minLength": 4, "maxLength": 131072, "format": "uri", "deterministic": true, "metadata": { "source": "manual-override", "confidence": 1.0, "category": "content", "note": "Blindfold envelope encryption (AES-256-GCM + RSA-OAEP) of an RSA-2048 TLS private key produces ~3700 char string:/// URL. 128KB max secret size = ~175KB base64. Discovery reported 1024 which is incorrect.", "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "store_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Store Provider", "x-displayname": "Store Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBlindfoldSecretInfoType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "location: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "per-tenant" } } }, "schemaClearSecretInfoType": { "type": "object", "description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "title": "ClearSecretInfoType", "x-displayname": "In-Clear Secret.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.ClearSecretInfoType", "properties": { "provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Provider", "x-displayname": "Provider", "x-ves-example": "Box-provider.", "x-f5xc-example": "box-provider", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "url": { "type": "string", "description": "URL of the secret. Currently supported URL schemes is string:///.\nFor string:/// scheme, Secret needs to be encoded Base64 format.\nWhen asked for this secret, caller will GET Secret bytes after Base64 decoding.", "title": "URL", "maxLength": 131072, "x-displayname": "URL", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.", "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding.", "format": "uri", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 131072 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaClearSecretInfoType", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "url: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaConditionType": { "type": "object", "description": "Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.", "title": "ConditionType", "x-displayname": "Status Condition.", "x-ves-proto-message": "ves.io.schema.ConditionType", "properties": { "hostname": { "type": "string", "description": "Hostname of the instance of the site that sent the status.", "title": "hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "last_update_time": { "type": "string", "description": "Last time the condition was updated.", "title": "last_update_time", "format": "date-time", "x-displayname": "Last Updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human readable string explaining the reason for reaching this condition.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Insufficient memory in data plane.", "x-f5xc-example": "Insufficient memory in data plane", "x-f5xc-description-short": "Human readable string explaining the reason for reaching this condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "service_name": { "type": "string", "description": "Name of the service that sent the status.", "title": "service name", "x-displayname": "Service Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the condition\n\"Success\" Validation has succeeded. Requested operation was successful.\n\"Failed\" Validation has failed.\n\"Incomplete\" Validation of configuration has failed due to missing configuration.\n\"Installed\" Validation has passed and configuration has been installed in data path or K8s\n\"Down\" Configuration is operationally down. E.g. Down interface\n\"Disabled\" Configuration is administratively disabled i.e. objectmetatype.disable = true.\n\"NotApplicable\" Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.", "title": "status", "x-displayname": "Status", "x-ves-example": "Failed", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-example": "Failed", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-description-short": "Status of the condition \"Success\" Validation has succeeded.", "x-f5xc-description-medium": "Status of the condition \"Success\" Validation has succeeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...", "maxLength": 1024, "enum": [ "Success", "Failed", "Incomplete", "Installed", "Down", "Disabled", "NotApplicable" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of the condition\n\"Validation\" represents validation user given configuration object\n\"Operational\" represents operational status of a given configuration object.", "title": "type", "x-displayname": "Type", "x-ves-example": "Operational.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-example": "Operational", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...", "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.", "maxLength": 1024, "enum": [ "Validation", "Operational" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.", "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaConditionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaInitializerType": { "type": "object", "description": "Initializer is information about an initializer that has not yet completed.", "title": "InitializerType", "x-displayname": "Initializer.", "x-ves-proto-message": "ves.io.schema.InitializerType", "properties": { "name": { "type": "string", "description": "Name of the service that is responsible for initializing this object.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaInitializersType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "Initializers tracks the progress of initialization of a configuration object.", "title": "InitializersType", "x-displayname": "Initializers.", "x-ves-proto-message": "ves.io.schema.InitializersType", "properties": { "pending": { "type": "array", "description": "Pending is a list of initializers that must execute in order before this object is initialized.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.", "title": "pending", "items": { "$ref": "#/components/schemas/schemaInitializerType" }, "x-displayname": "Pending", "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.", "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaIpAddressType": { "type": "object", "description": "IP Address used to specify an IPv4 or IPv6 address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-displayorder": "3", "x-ves-oneof-field-ver": "[\"ipv4\",\"ipv6\"]", "x-ves-proto-message": "ves.io.schema.IpAddressType", "properties": { "ipv4": { "allOf": [ { "$ref": "#/components/schemas/schemaIpv4AddressType" } ], "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv6" ] }, "ipv6": { "allOf": [ { "$ref": "#/components/schemas/schemaIpv6AddressType" } ], "x-f5xc-example": "2001:db8::1", "x-f5xc-description-short": "IPv6 address in colon-separated hexadecimal format.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv4" ] } }, "x-f5xc-description-short": "IP Address used to specify an IPv4 or IPv6 address.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaIpAddressType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaIpSubnetType": { "type": "object", "description": "IP Address used to specify an IPv4 or IPv6 subnet addresses.", "title": "IP Subnet", "x-displayname": "IP Subnet", "x-ves-displayorder": "3", "x-ves-oneof-field-ver": "[\"ipv4\",\"ipv6\"]", "x-ves-proto-message": "ves.io.schema.IpSubnetType", "properties": { "ipv4": { "allOf": [ { "$ref": "#/components/schemas/schemaIpv4SubnetType" } ], "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv6" ] }, "ipv6": { "allOf": [ { "$ref": "#/components/schemas/schemaIpv6SubnetType" } ], "x-f5xc-example": "2001:db8::1", "x-f5xc-description-short": "IPv6 address in colon-separated hexadecimal format.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv4" ] } }, "x-f5xc-description-short": "IP Address used to specify an IPv4 or IPv6 subnet addresses.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaIpSubnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaIpv4AddressType": { "type": "object", "description": "IPv4 Address in dot-decimal notation.", "title": "IPv4 Address", "x-displayname": "IPv4 Address.", "x-ves-proto-message": "ves.io.schema.Ipv4AddressType", "properties": { "addr": { "type": "string", "description": "IPv4 Address in string form with dot-decimal notation.", "title": "IPv4 Address", "x-displayname": "IPv4 Address.", "x-ves-example": "192.0.2.198.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.198", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "IPv4 Address in string form with dot-decimal notation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaIpv4AddressType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaIpv4SubnetType": { "type": "object", "description": "IPv4 subnets specified as prefix and prefix-length. Prefix length must be <= 32.", "title": "IPv4 Subnet", "x-displayname": "IPv4 Subnet.", "x-ves-proto-message": "ves.io.schema.Ipv4SubnetType", "properties": { "plen": { "type": "integer", "description": "Prefix-length of the IPv4 subnet. Must be <= 32.", "title": "Prefix Length", "format": "int64", "x-displayname": "Prefix Length.", "x-ves-example": "24", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-example": "24", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Prefix-length of the IPv4 subnet. Must be <= 32.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefix": { "type": "string", "description": "Prefix part of the IPv4 subnet in string form with dot-decimal notation.", "title": "Prefix", "x-displayname": "Prefix", "x-ves-example": "192.0.2.104.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.104", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Prefix part of the IPv4 subnet in string form with dot-decimal notation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "IPv4 subnets specified as prefix and prefix-length. Prefix length must be <= 32.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaIpv4SubnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaIpv6AddressType": { "type": "object", "description": "IPv6 Address specified as hexadecimal numbers separated by ':'", "title": "IPv6 Address", "x-displayname": "IPv6 Address.", "x-ves-proto-message": "ves.io.schema.Ipv6AddressType", "properties": { "addr": { "type": "string", "description": "IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':'\nThe address can be compacted by suppressing zeros\ne.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'", "title": "IPv6 Address", "x-displayname": "IPv6 Address.", "x-ves-example": "2001:db8:0:0:0:0:2:1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "2001:db8:0:0:0:0:2:1", "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-medium": "IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':' The address can be compacted by suppressing zeros e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "IPv6 Address specified as hexadecimal numbers separated by ':'.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaIpv6AddressType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaIpv6SubnetType": { "type": "object", "description": "IPv6 subnets specified as prefix and prefix-length. Prefix-legnth must be <= 128.", "title": "IPv6 Subnet", "x-displayname": "IPv6 Subnet.", "x-ves-proto-message": "ves.io.schema.Ipv6SubnetType", "properties": { "plen": { "type": "integer", "description": "Prefix length of the IPv6 subnet. Must be <= 128.", "title": "Prefix length", "format": "int64", "x-displayname": "Prefix Length.", "x-ves-example": "38", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "128" }, "x-f5xc-example": "38", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "128" }, "x-f5xc-description-short": "Prefix length of the IPv6 subnet. Must be <= 128.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 128, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefix": { "type": "string", "description": "Prefix part of the IPv6 subnet given in form of string.\nIPv6 address must be specified as hexadecimal numbers separated by ':'\ne.g. \"2001:db8:0:0:0:2:0:0\"\nThe address can be compacted by suppressing zeros\ne.g. \"2001:db8::2::\"", "title": "Prefix", "x-displayname": "Prefix", "x-ves-example": "2001:db8:0:0:0:0:2:0.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "2001:db8:0:0:0:0:2:0", "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Prefix part of the IPv6 subnet given in form of string.", "x-f5xc-description-medium": "Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':' e.g. \"2001:db8:0:0:0:2:0:0\" The address can be compacted by suppressing zeros e.g. \"2001:db8::2::\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "IPv6 subnets specified as prefix and prefix-length. Prefix-legnth must be <= 128.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaIpv6SubnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaNextHopType": { "type": "object", "description": "Identifies the next-hop for a route.", "title": "Nexthop", "x-displayname": "Nexthop", "x-ves-proto-message": "ves.io.schema.NextHopType", "properties": { "interface": { "type": "array", "description": "Nexthop is network interface when type is \"Network-Interface\"", "title": "Network Interface", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Network Interface.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Nexthop is network interface when type is \"Network-Interface\".", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nexthop_address": { "allOf": [ { "$ref": "#/components/schemas/schemaIpAddressType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/schemaNextHopTypes" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaNextHopType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaNextHopTypes": { "type": "string", "description": "Defines types of next-hop\n\nUse default gateway on the local interface as gateway for route.\nAssumes there is only one local interface on the virtual network.\nUse the specified address as nexthop\nUse the network interface as nexthop\nDiscard nexthop, used when attr type is Advertise\nUsed in VoltADN private virtual network.", "title": "Nexthop Types", "enum": [ "NEXT_HOP_DEFAULT_GATEWAY", "NEXT_HOP_USE_CONFIGURED", "NEXT_HOP_NETWORK_INTERFACE" ], "default": "NEXT_HOP_DEFAULT_GATEWAY", "x-displayname": "Nexthop Types.", "x-ves-proto-enum": "ves.io.schema.NextHopTypes", "x-f5xc-description-short": "Defines types of next-hop Use default gateway on the local interface as gateway for route.", "x-f5xc-description-medium": "Defines types of next-hop Use default gateway on the local interface as gateway for route. Assumes there is only one local interface on the virtual network. Use the specified address as nexthop Use the network interface as nexthop Discard nexthop, used when attr type is Advertise Used in VoltADN...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaNextHopTypes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NEXT_HOP_DEFAULT_GATEWAY\"", "example_yaml": "NEXT_HOP_DEFAULT_GATEWAY\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaObjectCreateMetaType": { "type": "object", "description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "title": "ObjectCreateMetaType", "x-displayname": "Create Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectCreateMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectCreateMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaObjectGetMetaType": { "type": "object", "description": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "title": "ObjectGetMetaType", "x-displayname": "GET Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectGetMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectGetMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaObjectReplaceMetaType": { "type": "object", "description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "title": "ObjectReplaceMetaType", "x-displayname": "Replace Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectReplaceMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectReplaceMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaRouteAttrType": { "type": "string", "description": "Defines attributes associated with route\n\nIgnore attribute\nAdvertise route in all supported routing protocols\nAdd route into host OS - route in host OS will point to interface corresponding to the virtual network.\nHost OS must have an interface in the virtual network.\nUse the route for forwarding decision - adds route into data plane\nmodules with configured next-hop\nMerge Route if they already exist.", "title": "Route Attribute", "enum": [ "ROUTE_ATTR_NO_OP", "ROUTE_ATTR_ADVERTISE", "ROUTE_ATTR_INSTALL_HOST", "ROUTE_ATTR_INSTALL_FORWARDING", "ROUTE_ATTR_MERGE_ONLY" ], "default": "ROUTE_ATTR_NO_OP", "x-displayname": "Route Attribute.", "x-ves-proto-enum": "ves.io.schema.RouteAttrType", "x-f5xc-description-short": "Defines attributes associated with route Ignore attribute Advertise route in all supported routing protocols Add route into host OS - route in...", "x-f5xc-description-medium": "Defines attributes associated with route Ignore attribute Advertise route in all supported routing protocols Add route into host OS - route in host OS will point to interface corresponding to the virtual network. Host OS must have an interface in the virtual network. Use the route for forwarding...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaRouteAttrType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ROUTE_ATTR_NO_OP\"", "example_yaml": "ROUTE_ATTR_NO_OP\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Route configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemaSecretType": { "type": "object", "description": "SecretType is used in an object to indicate a sensitive/confidential field.", "title": "SecretType", "x-displayname": "Secret", "x-ves-oneof-field-secret_info_oneof": "[\"blindfold_secret_info\",\"clear_secret_info\"]", "x-ves-proto-message": "ves.io.schema.SecretType", "properties": { "blindfold_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaBlindfoldSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "clear_secret_info" ] }, "clear_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaClearSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blindfold_secret_info" ] } }, "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSecretType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Secret management is platform-level" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "schemaStaticRouteType": { "type": "object", "description": "Defines a static route, configuring a list of prefixes and a next-hop to be used for them.", "title": "Static Route", "x-displayname": "Static Route.", "x-ves-displayorder": "2,10,11,1", "x-ves-proto-message": "ves.io.schema.StaticRouteType", "properties": { "attrs": { "type": "array", "description": "List of route attributes associated with the static route.", "title": "Attributes", "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaRouteAttrType" }, "x-displayname": "Attributes.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "List of route attributes associated with the static route.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Add Labels for this Static Route, these labels can be used in network policy.", "title": "Static Route labels", "x-displayname": "Static Route Labels.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add Labels for this Static Route, these labels can be used in network policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nexthop": { "allOf": [ { "$ref": "#/components/schemas/schemaNextHopType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnets": { "type": "array", "description": "List of route prefixes.", "title": "Subnets", "maxItems": 256, "items": { "$ref": "#/components/schemas/schemaIpSubnetType" }, "x-displayname": "Subnets", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "256" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "256" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines a static route, configuring a list of prefixes and a next-hop to be used for them.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStaticRouteType", "required_fields": [ "subnets" ], "mutually_exclusive_groups": [], "example_json": "{\n \"subnets\": [\n {}\n ]\n}", "example_yaml": "subnets:\n- {}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaStatusMetaType": { "type": "object", "description": "StatusMetaType is metadata that all status must have.", "title": "StatusMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.StatusMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "Creation_timestamp is when the status object was created. It is used to find/tie-break\nfor latest status object from same origin.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "Class of creator which created this StatusObject. This will be service's DNS FQDN.\nThis will be set by the system based on client certificate information.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "ver.re1.int.ves.I/O.", "x-f5xc-example": "ver.re1.int.F5 XC", "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.", "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\nIdentifying the environment also). This will be set by the system based on client certificate\ninformation.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Ver-instance-1.", "x-f5xc-example": "ver-instance-1", "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.", "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "publish": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusPublishType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_id": { "type": "string", "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)", "title": "status_id", "x-displayname": "Status ID", "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...", "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for a StatusObject.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Origin of this status exchanged by VTRP.", "title": "vtrp_id", "x-displayname": "VTRP ID", "x-f5xc-description-short": "Origin of this status exchanged by VTRP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaStatusPublishType": { "type": "string", "description": "StatusPublishType is all possible publish operations on a StatusObject\n\n- STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n- STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable.", "title": "StatusPublishType", "enum": [ "STATUS_DO_NOT_PUBLISH", "STATUS_PUBLISH" ], "default": "STATUS_DO_NOT_PUBLISH", "x-displayname": "Status Publish Type.", "x-ves-proto-enum": "ves.io.schema.StatusPublishType", "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.", "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusPublishType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_DO_NOT_PUBLISH\"", "example_yaml": "STATUS_DO_NOT_PUBLISH\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaStatusType": { "type": "object", "description": "Status is a return value for calls that don't return other objects.", "title": "StatusType", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.StatusType", "properties": { "code": { "type": "integer", "description": "Suggested HTTP return code for this status, 0 if not set.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".", "title": "status", "x-displayname": "Status", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectGetMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectGetMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Prism", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectGetMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaViewRefType": { "type": "object", "description": "ViewRefType represents a reference to a view.", "title": "ViewRefType", "x-displayname": "View Reference.", "x-ves-proto-message": "ves.io.schema.ViewRefType", "properties": { "kind": { "type": "string", "description": "Kind of the view object.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Http_proxy.", "x-f5xc-example": "http_proxy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UID of the view object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d543fad8e1f8.", "x-f5xc-example": "00000000-0000-4000-8000-d543fad8e1f8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ViewRefType represents a reference to a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaViewRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaVirtualNetworkType": { "type": "string", "description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.", "title": "VirtualNetworkType", "enum": [ "VIRTUAL_NETWORK_SITE_LOCAL", "VIRTUAL_NETWORK_SITE_LOCAL_INSIDE", "VIRTUAL_NETWORK_PER_SITE", "VIRTUAL_NETWORK_PUBLIC", "VIRTUAL_NETWORK_GLOBAL", "VIRTUAL_NETWORK_SITE_SERVICE", "VIRTUAL_NETWORK_VER_INTERNAL", "VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE", "VIRTUAL_NETWORK_IP_AUTO", "VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK", "VIRTUAL_NETWORK_SRV6_NETWORK", "VIRTUAL_NETWORK_IP_FABRIC", "VIRTUAL_NETWORK_SEGMENT", "VIRTUAL_NETWORK_MANAGEMENT" ], "default": "VIRTUAL_NETWORK_SITE_LOCAL", "x-displayname": "Virtual Network Type.", "x-ves-proto-enum": "ves.io.schema.VirtualNetworkType", "x-f5xc-description-short": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public...", "x-f5xc-description-medium": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaVirtualNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VIRTUAL_NETWORK_SITE_LOCAL\"", "example_yaml": "VIRTUAL_NETWORK_SITE_LOCAL\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual network is platform-level infrastructure" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemacloud_connectAWSTGWResourceShareType": { "type": "object", "description": "AWS Resource Share Status Type.", "title": "AWS Resource Share Status Type", "x-displayname": "AWS Resource Share Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWResourceShareType", "properties": { "allow_external_principles": { "type": "boolean", "description": "Manage Sharing Outside AWS Organization.", "title": "Allow External Principles", "format": "boolean", "x-displayname": "Allow External Principles.", "x-f5xc-description-short": "Manage Sharing Outside AWS Organization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Attachment Deployment Status.", "title": "Attachment Deployment Status", "x-displayname": "Attachment Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "owner_account_id": { "type": "string", "description": "Resource Share Owner Account ID.", "title": "Resource Share Owner Account ID", "x-displayname": "Resource Share Owner Account ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "receiver_account_id": { "type": "array", "description": "Resource Share Acceptor Account ID.", "title": "Resource Share Acceptor Account ID", "items": { "type": "string" }, "x-displayname": "Resource Share Acceptor Account ID.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_share_arn": { "type": "string", "description": "Resource Share ARN.", "title": "Resource Share ARN", "x-displayname": "Resource Share ARN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_share_name": { "type": "string", "description": "Resource Share Name.", "title": "Resource Share Name", "x-displayname": "Resource Share Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Resource Share State.", "title": "Resource Share State", "x-displayname": "Resource Share State.", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tags": { "type": "object", "description": "Resource Share Tags.", "title": "Resource Share Tags", "x-displayname": "Resource Share Tags.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacloud_connectAWSTGWResourceShareType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemacloud_connectAWSTGWStatusType": { "type": "object", "description": "AWS Transit Gateway Status Type.", "title": "AWS Transit Gateway Status Type", "x-displayname": "AWS Transit Gateway Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWStatusType", "properties": { "amazon_asn": { "type": "string", "description": "AWS Side ASN of TGW.", "title": "AWS Side ASN of TGW", "format": "int64", "x-displayname": "AWS Side ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "arn": { "type": "string", "description": "TGW ARN", "title": "TGW ARN", "x-displayname": "ARN", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "association_default_route_table_id": { "type": "string", "description": "X-displayName \"Default Association Route Table ID\"\nAssociationDefaultRouteTableId.", "title": "AssociationDefaultRouteTableId", "x-f5xc-description-short": "X-displayName \"Default Association Route Table ID\" AssociationDefaultRouteTableId.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "auto_accept_shared_attachments": { "type": "boolean", "description": "X-displayName \"Auto Accept Shared Attachments\"\nAutoAcceptSharedAttachments.", "title": "AutoAcceptSharedAttachments", "format": "boolean", "x-f5xc-description-short": "X-displayName \"Auto Accept Shared Attachments\" AutoAcceptSharedAttachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidrs": { "type": "array", "description": "X-displayName \"CIDRs\"\nTGW CIDRs.", "title": "TGW CIDRs", "items": { "type": "string" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_route_table_association": { "type": "boolean", "description": "X-displayName \"Default Route Table Association\"\nDefaultRouteTableAssociation.", "title": "DefaultRouteTableAssociation", "format": "boolean", "x-f5xc-description-short": "X-displayName \"Default Route Table Association\" DefaultRouteTableAssociation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_route_table_propagation": { "type": "boolean", "description": "X-displayName \"Default Route Table Propagation\"\nDefaultRouteTablePropagation.", "title": "DefaultRouteTablePropagation", "format": "boolean", "x-f5xc-description-short": "X-displayName \"Default Route Table Propagation\" DefaultRouteTablePropagation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "TGW ID", "title": "TGW ID", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "owner_account": { "type": "string", "description": "TGW Owner Account.", "title": "TGW Owner", "x-displayname": "Owner Account.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "propagation_default_route_table_id": { "type": "string", "description": "X-displayName \"Default Propagation Route Table ID\"\nPropagationDefaultRouteTableId.", "title": "PropagationDefaultRouteTableId", "x-f5xc-description-short": "X-displayName \"Default Propagation Route Table ID\" PropagationDefaultRouteTableId.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "region": { "type": "string", "description": "TGW Region.", "title": "TGW Region", "x-displayname": "Region", "x-f5xc-example": "us-west-2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "TGW State", "title": "TGW State", "x-displayname": "State", "x-f5xc-example": "running", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_msg": { "type": "string", "description": "X-displayName \"Deployment Status\"\nTGW Deployment Status.", "title": "TGW Deployment Status", "x-f5xc-description-short": "X-displayName \"Deployment Status\" TGW Deployment Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "TGW Tags", "title": "TGW Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacloud_connectAWSTGWStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemanetwork_firewallActiveEnhancedFirewallPoliciesType": { "type": "object", "description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.", "title": "Active Enhanced Firewall Policies Type", "x-displayname": "Active Enhanced Network Policies Type.", "x-ves-proto-message": "ves.io.schema.network_firewall.ActiveEnhancedFirewallPoliciesType", "properties": { "enhanced_firewall_policies": { "type": "array", "description": "Ordered List of Enhanced Firewall Policies active.", "title": "Enhanced Firewall Policy", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Enhanced Firewall Policy.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "Ordered List of Enhanced Firewall Policies active.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List of Enhanced Firewall Policies These policies use session-based rules and provide all OPTIONS available under firewall policies with an...", "x-f5xc-description-medium": "List of Enhanced Firewall Policies These policies use session-based rules and provide all OPTIONS available under firewall policies with an additional option for service insertion.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanetwork_firewallActiveEnhancedFirewallPoliciesType", "required_fields": [ "enhanced_firewall_policies" ], "mutually_exclusive_groups": [], "example_json": "{\n \"enhanced_firewall_policies\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "enhanced_firewall_policies:\n- name: contacts-route" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network firewall is platform-level security" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "schemanetwork_firewallActiveForwardProxyPoliciesType": { "type": "object", "description": "Ordered List of Forward Proxy Policies active.", "title": "Active Forward Proxy Policies Type", "x-displayname": "Active Forward Proxy Policies Type.", "x-ves-proto-message": "ves.io.schema.network_firewall.ActiveForwardProxyPoliciesType", "properties": { "forward_proxy_policies": { "type": "array", "description": "Ordered List of Forward Proxy Policies active.", "title": "Forward Proxy Policies", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Forward Proxy Policies.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "Ordered List of Forward Proxy Policies active.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Ordered List of Forward Proxy Policies active.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemanetwork_firewallActiveForwardProxyPoliciesType", "required_fields": [ "forward_proxy_policies" ], "mutually_exclusive_groups": [], "example_json": "{\n \"forward_proxy_policies\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "forward_proxy_policies:\n- name: contacts-route" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network firewall is platform-level security" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "schemaviewsObjectRefType": { "type": "object", "description": "This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name.", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.views.ObjectRefType", "properties": { "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "minLength": 1, "maxLength": 128, "x-displayname": "Name", "x-ves-example": "Contacts-route.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "contacts-route", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "byteLength": { "max": 128, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "maxLength": 64, "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "example-corp", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsObjectRefType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"contacts-route\"\n}", "example_yaml": "name: contacts-route" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCoordinates__ves_io_schema_views_aws_tgw_site": { "type": "object", "description": "Coordinates of the site which provides the site physical location.", "title": "Site Coordinates", "x-displayname": "Site Coordinates.", "x-ves-proto-message": "ves.io.schema.site.Coordinates", "properties": { "latitude": { "type": "number", "description": "Latitude of the site location.", "title": "latitude", "format": "float", "x-displayname": "Latitude", "x-ves-example": "10.0", "x-ves-validation-rules": { "ves.io.schema.rules.float.gte": "-90.0", "ves.io.schema.rules.float.lte": "90.0" }, "x-f5xc-example": "10.0", "x-validation-rules": { "ves.io.schema.rules.float.gte": "-90.0", "ves.io.schema.rules.float.lte": "90.0" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "longitude": { "type": "number", "description": "Longitude of site location.", "title": "longitude", "format": "float", "x-displayname": "Longitude", "x-ves-example": "20.0", "x-ves-validation-rules": { "ves.io.schema.rules.float.gte": "-180.0", "ves.io.schema.rules.float.lte": "180.0" }, "x-f5xc-example": "20.0", "x-validation-rules": { "ves.io.schema.rules.float.gte": "-180.0", "ves.io.schema.rules.float.lte": "180.0" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Coordinates of the site which provides the site physical location.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCoordinates", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePublishVIPParamsPerAz__ves_io_schema_views_aws_tgw_site": { "type": "object", "description": "Per AZ parameters needed to publish VIP for public cloud sites.", "title": "Publish VIP Params Per AZ", "x-displayname": "Publish VIP Params Per AZ.", "x-ves-proto-message": "ves.io.schema.site.PublishVIPParamsPerAz", "properties": { "az_name": { "type": "string", "description": "Name of the Availability zone.", "title": "AZ Name", "x-displayname": "AZ Name", "x-ves-example": "Us-east-2a.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^[1-5]{1}$|^AzureAlternateRegion$|^[a-z]{2}-(?:gov-)?[a-z0-9]{4,20}-[a-z0-9]{2}$|^[a-z]{4,15}-[a-z0-9]{4,20}-[a-z]{1}$" }, "x-f5xc-example": "us-east-2a", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^[1-5]{1}$|^AzureAlternateRegion$|^[a-z]{2}-(?:gov-)?[a-z0-9]{4,20}-[a-z0-9]{2}$|^[a-z]{4,15}-[a-z0-9]{4,20}-[a-z]{1}$" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^[1-5]{1}$|^AzureAlternateRegion$|^[a-z]{2}-(?:gov-)?[a-z0-9]{4,20}-[a-z0-9]{2}$|^[a-z]{4,15}-[a-z0-9]{4,20}-[a-z]{1}$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip": { "type": "array", "description": "List of Inside VIPs for an AZ.", "title": "Inside VIP(s)", "maxItems": 3, "items": { "type": "string" }, "x-displayname": "Inside VIP(s)", "x-ves-example": "192.0.2.102.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.102", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip_cname": { "type": "string", "description": "CNAME value for the inside VIP,\nThese are usually public cloud generated CNAME.", "title": "Inside VIP CNAME", "maxLength": 256, "x-displayname": "Inside VIP CNAME.", "x-ves-example": "test.56670-387196482.useast2.ves.I/O.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "test.56670-387196482.useast2.F5 XC", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "CNAME value for the inside VIP, These are usually public cloud generated CNAME.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip_v6": { "type": "array", "description": "Optional list of Inside IPv6 VIPs for an AZ.", "title": "Inside IPv6 VIP(s)", "maxItems": 3, "items": { "type": "string" }, "x-displayname": "Inside IPv6 VIP(s)", "x-ves-example": "2001::1", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv6": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "2001::1", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv6": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Optional list of Inside IPv6 VIPs for an AZ.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip": { "type": "array", "description": "List of Outside VIPs for an AZ.", "title": "Outside VIP(s)", "minItems": 1, "maxItems": 3, "items": { "type": "string" }, "x-displayname": "Outside VIP(s)", "x-ves-example": "192.0.2.102.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.102", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "outside_vip_cname": { "type": "string", "description": "CNAME value for the outside VIP\nThese are usually public cloud generated CNAME.", "title": "Outside VIP CNAME", "maxLength": 256, "x-displayname": "Outside VIP CNAME.", "x-ves-example": "test.56670-387196482.useast2.ves.I/O.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "test.56670-387196482.useast2.F5 XC", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "CNAME value for the outside VIP These are usually public cloud generated CNAME.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip_v6": { "type": "array", "description": "Optional list of Outside IPv6 VIPs for an AZ.", "title": "Outside IPv6 VIP(s)", "maxItems": 3, "items": { "type": "string" }, "x-displayname": "Outside IPv6 VIP(s)", "x-ves-example": "2001::1", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv6": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "2001::1", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv6": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Optional list of Outside IPv6 VIPs for an AZ.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Per AZ parameters needed to publish VIP for public cloud sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePublishVIPParamsPerAz", "required_fields": [ "outside_vip" ], "mutually_exclusive_groups": [], "example_json": "{\n \"outside_vip\": [\n \"value\"\n ]\n}", "example_yaml": "outside_vip:\n- value" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteState": { "type": "string", "description": "State of Site defines in which operational state site itself is.\n\nSite is online and operational.\nSite is in provisioning state. For instance during site deployment or switching to different connected Regional Edge.\nSite is in process of upgrade. It transition to ONLINE or FAILED state.\nSite is in Standby before goes to ONLINE. This is mainly for Regional Edge sites to do their verification before they go to ONLINE state.\nSite is in failed state. It failed during provisioning or upgrade phase. Site Status Objects contain more details.\nReregistration was requested\nReregistration is in progress and maurice is waiting for nodes\nSite deletion is in progress\nSite is waiting for registration\nSite resources are waiting to be orchestrated for F5XC managed site. Check Status objects for more details\nSite resources are orchestrated for F5XC managed site.\nAn Error occurred while site resource orchestration for F5XC managed site. Check Status objects for more details.\nSite resources are waiting to be orchestrated for F5XC managed site. Check Status objects for more details\nSite resources orchestrated for F5XC managed site are deleted.\nAn Error occurred while site resource DELETE operation for F5XC managed site. Check Status objects for more details.\nValidation for F5XC managed site is in progress. Check Status objects for more details.\nValidation for F5XC managed site succeeded. Orchestration will start for Site resources\nValidation for F5XC managed site failed. Check Status objects for more details.\nSite is in failed state for prolong period of time. Site Status Objects contain more details.\nSite resources are waiting to be updated. Check Status objects for more details\nAn Error occurred while updating cloud resources for F5XC managed site. Check Status objects for more details.\nSite resources orchestration is queued for F5XC managed site. Check Status objects for more details\nSite resources update is queued for F5XC managed site. Check Status objects for more details\nSite resources DELETE is queued for F5XC managed site. Check Status objects for more details.", "title": "SiteState", "enum": [ "ONLINE", "PROVISIONING", "UPGRADING", "STANDBY", "FAILED", "REREGISTRATION", "WAITINGNODES", "DECOMMISSIONING", "WAITING_FOR_REGISTRATION", "ORCHESTRATION_IN_PROGRESS", "ORCHESTRATION_COMPLETE", "ERROR_IN_ORCHESTRATION", "DELETING_CLOUD_RESOURCES", "DELETED_CLOUD_RESOURCES", "ERROR_DELETING_CLOUD_RESOURCES", "VALIDATION_IN_PROGRESS", "VALIDATION_SUCCESS", "VALIDATION_FAILED", "FAILED_INACTIVE", "UPDATING_CLOUD_RESOURCES", "ERROR_UPDATING_CLOUD_RESOURCES", "ORCHESTRATION_QUEUED", "UPDATE_QUEUED", "DELETE_QUEUED" ], "default": "ONLINE", "x-displayname": "Site State.", "x-ves-proto-enum": "ves.io.schema.site.SiteState", "x-f5xc-description-short": "State of Site defines in which operational state site itself is. Site is online and operational.", "x-f5xc-description-medium": "State of Site defines in which operational state site itself is. Site is online and operational. Site is in provisioning state. For instance during site deployment or switching to different connected Regional Edge. Site is in process of upgrade.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ONLINE\"", "example_yaml": "ONLINE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersApplyStageState": { "type": "string", "title": "- APPLIED: x-displayName: \"Applied\"\n - APPLY_ERRORED: x-displayName: \"Apply errored\"\n - APPLY_INIT_ERRORED: x-displayName: \"Apply init errored\"\n - APPLYING: x-displayName: \"Applying\"\n - APPLY_PLANNING: x-displayName: \"Apply planning\"\n - APPLY_PLAN_ERRORED: x-displayName: \"Apply plan errored\"\n - APPLY_QUEUED: x-displayName: \"Apply queued\"", "enum": [ "APPLIED", "APPLY_ERRORED", "APPLY_INIT_ERRORED", "APPLYING", "APPLY_PLANNING", "APPLY_PLAN_ERRORED", "APPLY_QUEUED" ], "default": "APPLIED", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.views.terraform_parameters.ApplyStageState", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersApplyStageState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"APPLIED\"", "example_yaml": "APPLIED\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersApplyStatus": { "type": "object", "x-ves-oneof-field-state": "[\"apply_state\",\"destroy_state\",\"infra_state\"]", "x-ves-proto-message": "ves.io.schema.views.terraform_parameters.ApplyStatus", "properties": { "apply_state": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersApplyStageState" } ], "x-f5xc-description-short": "Configuration parameter for apply state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "destroy_state", "infra_state" ] }, "container_version": { "type": "string", "description": "Container image version.", "title": "container_version", "x-displayname": "Container image version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "destroy_state": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersDestroyStageState" } ], "x-f5xc-description-short": "Configuration parameter for destroy state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "apply_state", "infra_state" ] }, "error_output": { "type": "string", "description": "Error output of terraform run.", "title": "error_output", "x-displayname": "Error Output.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "infra_state": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersInfraState" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "apply_state", "destroy_state" ] }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this status was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "suggested_action": { "type": "string", "description": "Suggested action for customer on error.", "title": "suggested_action", "x-displayname": "Suggested Action.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tf_output": { "type": "string", "description": "The value of an \"output\" variable from the terraform state file.", "title": "tf_output", "x-displayname": "Terraform Output.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "The value of an \"output\" variable from the terraform state file.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tf_stdout": { "type": "string", "description": "The stdout of terraform apply command.", "title": "tf_stdout", "x-displayname": "Terraform Standard Output.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersApplyStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersDeploymentStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.terraform_parameters.DeploymentStatusType", "properties": { "apply_status": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersApplyStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expected_container_version": { "type": "string", "description": "Container version expected.", "title": "Expected container version", "x-displayname": "Expected container version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "plan_status": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersPlanStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersDeploymentStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersDestroyStageState": { "type": "string", "title": "- DESTROYED: x-displayName: \"Destroyed\"\n - DESTROY_ERRORED: x-displayName: \"Destroy errored\"\n - DESTROYING: x-displayName: \"Destroying\"\n - DESTROY_QUEUED: x-displayName: \"Destroy Queued\"", "enum": [ "DESTROYED", "DESTROY_ERRORED", "DESTROYING", "DESTROY_QUEUED" ], "default": "DESTROYED", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.views.terraform_parameters.DestroyStageState", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersDestroyStageState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DESTROYED\"", "example_yaml": "DESTROYED\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersInfraState": { "type": "string", "title": "- PROVISIONED: x-displayName: \"Provisioned\"\n - TIMED_OUT: x-displayName: \"Timed out\"\n - ERRORED: x-displayName: \"Errored\"\n - PROVISIONING: x-displayName: \"Provisioning\"", "enum": [ "PROVISIONED", "TIMED_OUT", "ERRORED", "PROVISIONING" ], "default": "PROVISIONED", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.views.terraform_parameters.InfraState", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersInfraState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PROVISIONED\"", "example_yaml": "PROVISIONED\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersPlanStageState": { "type": "string", "description": "Terraform state during plan stage.", "title": "Plan Stage State", "enum": [ "PLANNING", "PLAN_ERRORED", "NO_CHANGES", "HAS_CHANGES", "DISCARDED", "PLAN_INIT_ERRORED", "PLAN_QUEUED" ], "default": "PLANNING", "x-displayname": "Plan Stage State.", "x-ves-proto-enum": "ves.io.schema.views.terraform_parameters.PlanStageState", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersPlanStageState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PLANNING\"", "example_yaml": "PLANNING\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "terraform_parametersPlanStatus": { "type": "object", "x-ves-oneof-field-state": "[\"infra_state\",\"plan_state\"]", "x-ves-proto-message": "ves.io.schema.views.terraform_parameters.PlanStatus", "properties": { "error_output": { "type": "string", "description": "Error output of terraform run.", "title": "error_output", "x-displayname": "Error Output.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "infra_state": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersInfraState" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "plan_state" ] }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this status was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "plan_state": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersPlanStageState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "infra_state" ] }, "suggested_action": { "type": "string", "description": "Suggested action for customer on error.", "title": "suggested_action", "x-displayname": "Suggested Action.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tf_plan_output": { "type": "string", "description": "Terraform \"plan\" command output. Terraform performs a refresh, unless explicitly disabled, and then\ndetermines what actions are necessary to achieve the desired state specified in the configuration files.", "title": "tf_plan_output", "x-displayname": "Terraform Plan Output.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-medium": "Terraform \"plan\" command output. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for terraform_parametersPlanStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSDiskEncryption": { "type": "object", "description": "Information related to disk encryption.", "title": "Disk Encryption", "x-displayname": "Disk Encryption.", "x-ves-proto-message": "ves.io.schema.views.AWSDiskEncryption", "properties": { "kms_key_id": { "type": "string", "description": "AWS KMS Key to be used to encrypt the disk attached to the VM.", "title": "KMS Key ID", "x-displayname": "KMS Key ID.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "AWS KMS Key to be used to encrypt the disk attached to the VM.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSDiskEncryption", "required_fields": [ "kms_key_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"kms_key_id\": \"value\"\n}", "example_yaml": "kms_key_id: value" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSSubnetIdsType": { "type": "object", "description": "AWS Subnet IDs used by F5 Distributed Cloud site.", "title": "AWS Subnets Ids", "x-displayname": "AWS Subnets IDs.", "x-ves-proto-message": "ves.io.schema.views.AWSSubnetIdsType", "properties": { "az_name": { "type": "string", "description": "AWS availability zone, must be consistent with the selected AWS region.", "title": "AZ Name", "x-displayname": "AZ Name", "x-ves-example": "Us-west-2a.", "x-f5xc-example": "us-west-2a", "x-f5xc-description-short": "AWS availability zone, must be consistent with the selected AWS region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSSubnetInfoType" } ], "x-f5xc-description-short": "Configuration parameter for inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_subnet_id": { "type": "string", "description": "Inside subnet ID used by F5 Distributed Cloud site.", "title": "Inside Subnet ID", "x-displayname": "Inside Subnet ID.", "x-ves-example": "Subnet-12345678901234567.", "x-f5xc-example": "subnet-12345678901234567", "x-f5xc-description-short": "Inside subnet ID used by F5 Distributed Cloud site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "outside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSSubnetInfoType" } ], "x-f5xc-description-short": "Configuration parameter for outside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_subnet_id": { "type": "string", "description": "Outside subnet ID used by F5 Distributed Cloud site.", "title": "Outside Subnet ID", "x-displayname": "Outside Subnet ID.", "x-ves-example": "Subnet-12345678901234567.", "x-f5xc-example": "subnet-12345678901234567", "x-f5xc-description-short": "Outside subnet ID used by F5 Distributed Cloud site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "workload_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSSubnetInfoType" } ], "x-f5xc-description-short": "Configuration parameter for workload subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "workload_subnet_id": { "type": "string", "description": "Workload subnet ID used by F5 Distributed Cloud site.", "title": "Workload Subnet ID", "x-displayname": "Workload Subnet ID.", "x-ves-example": "Subnet-12345678901234567.", "x-f5xc-example": "subnet-12345678901234567", "x-f5xc-description-short": "Workload subnet ID used by F5 Distributed Cloud site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "AWS Subnet IDs used by F5 Distributed Cloud site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSSubnetIdsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSSubnetInfoType": { "type": "object", "description": "AWS Subnets Info Type.", "title": "AWS Subnets Info Type", "x-displayname": "AWS Subnets Info Type.", "x-ves-proto-message": "ves.io.schema.views.AWSSubnetInfoType", "properties": { "az_name": { "type": "string", "description": "AWS availability zone, must be consistent with the selected AWS region.", "title": "AZ Name", "x-displayname": "AZ Name", "x-ves-example": "Us-west-2a.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^([a-z]{2})-?(gov-)?([a-z0-9]{4,20})-([a-z0-9]{2})$" }, "x-f5xc-example": "us-west-2a", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^([a-z]{2})-?(gov-)?([a-z0-9]{4,20})-([a-z0-9]{2})$" }, "x-f5xc-description-short": "AWS availability zone, must be consistent with the selected AWS region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^([a-z]{2})-?(gov-)?([a-z0-9]{4,20})-([a-z0-9]{2})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "id": { "type": "string", "description": "Subnet ID", "title": "Subnet ID", "maxLength": 64, "x-displayname": "Subnet ID", "x-ves-example": "Subnet-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "subnet-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ipv4_prefix": { "type": "string", "description": "Subnet CIDR block. It has to be private address space.", "title": "Subnet CIDR block", "x-displayname": "Subnet CIDR block.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "8" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "8" }, "x-f5xc-description-short": "Subnet CIDR block. It has to be private address space.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSSubnetInfoType", "required_fields": [ "az_name", "ipv4_prefix" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_name\": \"us-west-2a\",\n \"ipv4_prefix\": \"192.0.2.0/24\"\n}", "example_yaml": "az_name: us-west-2a\nipv4_prefix: 192.0.2.0/24" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSVPCParamsType": { "type": "object", "description": "Parameters to create new AWS VPC.", "title": "AWS VPC Parameters", "x-displayname": "AWS VPC Parameters.", "x-ves-displayorder": "7,3,6", "x-ves-oneof-field-name_choice": "[\"autogenerate\",\"name_tag\"]", "x-ves-proto-message": "ves.io.schema.views.AWSVPCParamsType", "properties": { "autogenerate": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for autogenerate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "name_tag" ] }, "name_tag": { "type": "string", "description": "Exclusive with [autogenerate]\nSpecify the VPC Name.", "title": "name_tag", "maxLength": 64, "x-displayname": "Choose VPC Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Exclusive with [autogenerate] Specify the VPC Name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "autogenerate" ] }, "primary_ipv4": { "type": "string", "description": "IPv4 CIDR block for this VPC. It has to be private address space.\nThe Primary IPv4 block cannot be modified. All subnets prefixes in this VPC must be part of this CIDR block.", "title": "Primary IPv4 CIDR block", "x-displayname": "Primary IPv4 CIDR block.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "16" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "16" }, "x-f5xc-description-short": "IPv4 CIDR block for this VPC. It has to be private address space.", "x-f5xc-description-medium": "IPv4 CIDR block for this VPC. It has to be private address space. The Primary IPv4 block cannot be modified. All subnets prefixes in this VPC must be part of this CIDR block.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSVPCParamsType", "required_fields": [ "primary_ipv4" ], "mutually_exclusive_groups": [], "example_json": "{\n \"primary_ipv4\": \"192.0.2.0/24\"\n}", "example_yaml": "primary_ipv4: 192.0.2.0/24" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSVPCTwoInterfaceNodeType": { "type": "object", "description": "Parameters for creating two interface Node in one AZ.", "title": "Two Interface Node", "x-displayname": "Two Interface Node.", "x-ves-displayorder": "1,7,3,5", "x-ves-oneof-field-choice": "[\"inside_subnet\",\"reserved_inside_subnet\"]", "x-ves-proto-message": "ves.io.schema.views.AWSVPCTwoInterfaceNodeType", "properties": { "aws_az_name": { "type": "string", "description": "AWS availability zone, must be consistent with the selected AWS region.", "title": "AWS AZ", "x-displayname": "AWS AZ Name.", "x-ves-example": "Us-west-2a.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-west-2a", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "AWS availability zone, must be consistent with the selected AWS region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetType" } ], "x-f5xc-description-short": "Configuration parameter for inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "reserved_inside_subnet" ] }, "outside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetType" } ], "x-f5xc-description-short": "Configuration parameter for outside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reserved_inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for reserved inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_subnet" ] }, "workload_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetType" } ], "x-f5xc-description-short": "Configuration parameter for workload subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating two interface Node in one AZ.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSVPCTwoInterfaceNodeType", "required_fields": [ "aws_az_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_az_name\": \"us-west-2a\"\n}", "example_yaml": "aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAllowedVIPPorts": { "type": "object", "description": "This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP LB configured on the F5XC Site.", "title": "Allowed VIP Ports", "x-displayname": "Allowed VIP Ports.", "x-ves-oneof-field-port_choice": "[\"custom_ports\",\"disable_allowed_vip_port\",\"use_http_https_port\",\"use_http_port\",\"use_https_port\"]", "x-ves-proto-message": "ves.io.schema.views.AllowedVIPPorts", "properties": { "custom_ports": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_allowed_vip_port", "use_http_https_port", "use_http_port", "use_https_port" ] }, "disable_allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_ports", "use_http_https_port", "use_http_port", "use_https_port" ] }, "use_http_https_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_ports", "disable_allowed_vip_port", "use_http_port", "use_https_port" ] }, "use_http_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_ports", "disable_allowed_vip_port", "use_http_https_port", "use_https_port" ] }, "use_https_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_ports", "disable_allowed_vip_port", "use_http_https_port", "use_http_port" ] } }, "x-f5xc-description-short": "Defines the TCP port(s) which will be opened on the cloud loadbalancer.", "x-f5xc-description-medium": "Defines the TCP port(s) which will be opened on the cloud loadbalancer. Such that the client can use the cloud VIP IP and port combination to reach TCP/HTTP LB configured on the F5XC Site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAllowedVIPPorts", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsCloudLinkADNType": { "type": "object", "title": "CloudLink ADN Network Config", "x-displayname": "CloudLink ADN Network Config.", "x-ves-proto-message": "ves.io.schema.views.CloudLinkADNType", "properties": { "cloudlink_network_name": { "type": "string", "description": "Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support.", "title": "Private ADN Network", "maxLength": 64, "x-displayname": "Private ADN Network.", "x-ves-example": "Private-cloud-ntw.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "private-cloud-ntw", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network.", "x-f5xc-description-medium": "Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsCloudLinkADNType", "required_fields": [ "cloudlink_network_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cloudlink_network_name\": \"private-cloud-ntw\"\n}", "example_yaml": "cloudlink_network_name: private-cloud-ntw" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud link is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsCloudSubnetParamType": { "type": "object", "description": "Parameters for creating a new cloud subnet.", "title": "Cloud Subnet Param", "x-displayname": "New Cloud Subnet Parameters.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.CloudSubnetParamType", "properties": { "ipv4": { "type": "string", "description": "IPv4 subnet prefix for this subnet.", "title": "IPv4 Subnet", "x-displayname": "IPv4 Subnet.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28" }, "format": "ipv4", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "ipv4", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating a new cloud subnet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsCloudSubnetParamType", "required_fields": [ "ipv4" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ipv4\": \"192.0.2.0/24\"\n}", "example_yaml": "ipv4: 192.0.2.0/24" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsCloudSubnetType": { "type": "object", "description": "Parameters for AWS subnet.", "title": "Cloud Subnet", "x-displayname": "AWS Subnet.", "x-ves-oneof-field-choice": "[\"existing_subnet_id\",\"subnet_param\"]", "x-ves-proto-message": "ves.io.schema.views.CloudSubnetType", "properties": { "existing_subnet_id": { "type": "string", "description": "Exclusive with [subnet_param]\nInformation about existing subnet ID.", "title": "Existing Subnet ID", "maxLength": 64, "x-displayname": "Existing Subnet ID.", "x-ves-example": "Subnet-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "subnet-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-description-short": "Exclusive with [subnet_param] Information about existing subnet ID.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "subnet_param" ] }, "subnet_param": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetParamType" } ], "x-f5xc-description-short": "Configuration parameter for subnet param.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_subnet_id" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsCloudSubnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsConfigValidationState": { "type": "string", "description": "The state of Site Config Validation\n\n- VALIDATION_STATE_NONE: None\n\nConfig validation state is none\n- VALIDATION_IN_PROGRESS: In Progress\n\nConfig validation state is In Progress\n- VALIDATION_FAILED: Failed\n\nConfig validation state is Failed\n- VALIDATION_SUCCEEDED: Succeeded\n\nConfig validation state is Succeeded.", "title": "Config Validation State", "enum": [ "VALIDATION_STATE_NONE", "VALIDATION_IN_PROGRESS", "VALIDATION_FAILED", "VALIDATION_SUCCEEDED" ], "default": "VALIDATION_STATE_NONE", "x-displayname": "Site Config Validation State.", "x-ves-proto-enum": "ves.io.schema.views.ConfigValidationState", "x-f5xc-description-short": "The state of Site Config Validation - VALIDATION_STATE_NONE: None Config validation state is none - VALIDATION_IN_PROGRESS: In Progress Config...", "x-f5xc-description-medium": "The state of Site Config Validation - VALIDATION_STATE_NONE: None Config validation state is none - VALIDATION_IN_PROGRESS: In Progress Config validation state is In Progress - VALIDATION_FAILED: Failed Config validation state is Failed - VALIDATION_SUCCEEDED: Succeeded Config validation state...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsConfigValidationState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VALIDATION_STATE_NONE\"", "example_yaml": "VALIDATION_STATE_NONE\n..." }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsCustomDNS": { "type": "object", "description": "Custom DNS is the configured for specify CE site.", "title": "Custom DNS", "x-displayname": "Custom DNS.", "x-ves-proto-message": "ves.io.schema.views.CustomDNS", "properties": { "inside_nameserver": { "type": "string", "description": "Optional DNS server IP to be used for name resolution in inside network.", "title": "inside_nameserver", "x-displayname": "DNS Server for Inside Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional DNS server IP to be used for name resolution in inside network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_nameserver": { "type": "string", "description": "Optional DNS server IP to be used for name resolution in outside network.", "title": "outside_nameserver", "x-displayname": "DNS Server for Outside Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional DNS server IP to be used for name resolution in outside network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Custom DNS is the configured for specify CE site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsCustomDNS", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsCustomPorts": { "type": "object", "description": "List of Custom port.", "title": "Custom Ports", "x-displayname": "Custom Ports.", "x-ves-proto-message": "ves.io.schema.views.CustomPorts", "properties": { "port_ranges": { "type": "string", "description": "Port Ranges.", "title": "Port Ranges", "minLength": 1, "maxLength": 512, "x-displayname": "Port Ranges.", "x-ves-example": "80, 8080-8085.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.port_range_list": "true" }, "x-f5xc-example": "80, 8080-8085", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.port_range_list": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsCustomPorts", "required_fields": [ "port_ranges" ], "mutually_exclusive_groups": [], "example_json": "{\n \"port_ranges\": \"80, 8080-8085\"\n}", "example_yaml": "port_ranges: 80, 8080-8085" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsDirectConnectConfigType": { "type": "object", "description": "Direct Connect Configuration.", "title": "DirectConnectConfigType", "x-displayname": "Direct Connect Configuration.", "x-ves-oneof-field-asn_choice": "[\"auto_asn\",\"custom_asn\"]", "x-ves-oneof-field-vif_choice": "[\"hosted_vifs\",\"standard_vifs\"]", "x-ves-proto-message": "ves.io.schema.views.DirectConnectConfigType", "properties": { "auto_asn": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_asn" ] }, "custom_asn": { "type": "integer", "description": "Exclusive with [auto_asn]\nCustom Autonomous System Number.", "title": "Custom ASN", "format": "int64", "x-displayname": "Custom ASN.", "x-ves-example": "64512", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-example": "64512", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-description-short": "Exclusive with [auto_asn] Custom Autonomous System Number.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auto_asn" ] }, "hosted_vifs": { "allOf": [ { "$ref": "#/components/schemas/viewsHostedVIFConfigType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "standard_vifs" ] }, "standard_vifs": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for standard vifs.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hosted_vifs" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsDirectConnectConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsDirectConnectInfo": { "type": "object", "description": "DirectConnect Info.", "title": "DirectConnect Info", "x-displayname": "DirectConnect Info.", "x-ves-proto-message": "ves.io.schema.views.DirectConnectInfo", "properties": { "asn": { "type": "integer", "description": "The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration.", "title": "AWS Side ASN", "format": "int64", "x-displayname": "AWS Side ASN.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "4294967294" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "4294967294" }, "x-f5xc-description-short": "The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 4294967294, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "direct_connect_gateway_id": { "type": "string", "description": "DirectConnect Gateway ID.", "title": "DirectConnect Gateway ID", "x-displayname": "DirectConnect Gateway ID.", "x-ves-example": "F2a50c04-xxxx-yyyy-zzzz-00000000a043.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "f2a50c04-xxxx-yyyy-zzzz-00000000a043", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vgw_id": { "type": "string", "description": "Virtual Private Gateway ID.", "title": "Virtual Private Gateway ID", "x-displayname": "Virtual Private Gateway ID.", "x-ves-example": "Vgw-12345678.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vgw-12345678", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsDirectConnectInfo", "required_fields": [ "asn", "direct_connect_gateway_id", "vgw_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"asn\": 1,\n \"direct_connect_gateway_id\": \"f2a50c04-xxxx-yyyy-zzzz-00000000a043\",\n \"vgw_id\": \"vgw-12345678\"\n}", "example_yaml": "asn: 1\ndirect_connect_gateway_id: f2a50c04-xxxx-yyyy-zzzz-00000000a043\nvgw_id: vgw-12345678" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsExistingTGWType": { "type": "object", "description": "Information needed for existing TGW.", "title": "Existing TGW Type", "x-displayname": "Existing TGW Type.", "x-ves-proto-message": "ves.io.schema.views.ExistingTGWType", "properties": { "tgw_asn": { "type": "integer", "description": "TGW ASN.", "title": "TGW ASN", "format": "int64", "x-displayname": "Enter TGW ASN.", "x-ves-example": "64500", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "64500", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_id": { "type": "string", "description": "Existing TGW ID.", "title": "Existing TGW ID", "maxLength": 64, "x-displayname": "Existing TGW ID.", "x-ves-example": "Tgw-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "tgw-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "volterra_site_asn": { "type": "integer", "description": "F5XC Site ASN.", "title": "F5XC Site ASN", "format": "int64", "x-displayname": "Enter F5XC Site ASN.", "x-ves-example": "64501", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "64501", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsExistingTGWType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGlobalConnectorType": { "type": "object", "description": "Global network reference for direct connection.", "title": "Global Network", "x-displayname": "Global Network.", "x-ves-proto-message": "ves.io.schema.views.GlobalConnectorType", "properties": { "global_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_network", "field_path": "global_vn", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Global network reference for direct connection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGlobalConnectorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGlobalNetworkConnectionListType": { "type": "object", "description": "List of global network connections.", "title": "Global Network Connection List", "x-displayname": "Global Network Connection List.", "x-ves-proto-message": "ves.io.schema.views.GlobalNetworkConnectionListType", "properties": { "global_network_connections": { "type": "array", "description": "Global network connections.", "title": "Global Network Connections", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionType" }, "x-displayname": "Global Network Connections.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGlobalNetworkConnectionListType", "required_fields": [ "global_network_connections" ], "mutually_exclusive_groups": [], "example_json": "{\n \"global_network_connections\": [\n {}\n ]\n}", "example_yaml": "global_network_connections:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Global network spans across tenants at platform level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "viewsGlobalNetworkConnectionType": { "type": "object", "description": "Global network connection.", "title": "Global Network Connection", "x-displayname": "Global Network Connection.", "x-ves-oneof-field-connection_choice": "[\"sli_to_global_dr\",\"slo_to_global_dr\"]", "x-ves-oneof-field-forward_proxy_choice": "[]", "x-ves-proto-message": "ves.io.schema.views.GlobalNetworkConnectionType", "properties": { "sli_to_global_dr": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalConnectorType" } ], "x-f5xc-description-short": "Configuration parameter for sli to global dr.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "slo_to_global_dr" ] }, "slo_to_global_dr": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalConnectorType" } ], "x-f5xc-description-short": "Configuration parameter for slo to global dr.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sli_to_global_dr" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGlobalNetworkConnectionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Global network spans across tenants at platform level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "viewsHostedVIFConfigType": { "type": "object", "description": "AWS Direct Connect Hosted VIF Configuration.", "title": "AWS Direct Connect Hosted VIF Config", "x-displayname": "AWS Direct Connect Hosted VIF Config.", "x-ves-oneof-field-connectivity_options": "[\"site_registration_over_direct_connect\",\"site_registration_over_internet\"]", "x-ves-proto-message": "ves.io.schema.views.HostedVIFConfigType", "properties": { "site_registration_over_direct_connect": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudLinkADNType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_registration_over_internet" ] }, "site_registration_over_internet": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_registration_over_direct_connect" ] }, "vif_list": { "type": "array", "description": "List of Hosted VIF Config.", "title": "List of Hosted VIF Config", "maxItems": 30, "items": { "$ref": "#/components/schemas/viewsVifRegionConfig" }, "x-displayname": "List of Hosted VIF Config.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 30, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-example": "value", "x-f5xc-description-short": "AWS Direct Connect Hosted VIF Configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsHostedVIFConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsKubernetesUpgradeDrain": { "type": "object", "description": "Specify how worker nodes within a site will be upgraded.", "title": "Node by Node Upgrade", "x-displayname": "Node by Node Upgrade.", "x-ves-displayorder": "1", "x-ves-oneof-field-kubernetes_upgrade_drain_enable_choice": "[\"disable_upgrade_drain\",\"enable_upgrade_drain\"]", "x-ves-proto-message": "ves.io.schema.views.KubernetesUpgradeDrain", "properties": { "disable_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_upgrade_drain" ] }, "enable_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrainConfig" } ], "x-f5xc-description-short": "Configuration parameter for enable upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_upgrade_drain" ] } }, "x-f5xc-description-short": "Specify how worker nodes within a site will be upgraded.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsKubernetesUpgradeDrain", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsKubernetesUpgradeDrainConfig": { "type": "object", "description": "Specify batch upgrade settings for worker nodes within a site.", "title": "Enable Node by Node Upgrade", "x-displayname": "Enable Node by Node Upgrade.", "x-ves-oneof-field-drain_max_unavailable_choice": "[\"drain_max_unavailable_node_count\", \"drain_max_unavailable_node_percentage\"]", "x-ves-oneof-field-vega_upgrade_mode_toggle_choice": "[\"disable_vega_upgrade_mode\",\"enable_vega_upgrade_mode\"]", "x-ves-proto-message": "ves.io.schema.views.KubernetesUpgradeDrainConfig", "properties": { "disable_vega_upgrade_mode": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable vega upgrade mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_vega_upgrade_mode" ] }, "drain_max_unavailable_node_count": { "type": "integer", "description": "Exclusive with []", "title": "Node Batch Size Count", "format": "int64", "x-displayname": "Node Batch Size Count.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "5000" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "5000" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 5000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "drain_max_unavailable_node_percentage" ] }, "drain_node_timeout": { "type": "integer", "description": "Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes.\n(Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).", "title": "Upgrade Wait Time", "format": "int64", "x-displayname": "Upgrade Wait Time.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "900" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "900" }, "x-f5xc-description-short": "Seconds to wait before initiating upgrade on the next set of nodes.", "x-f5xc-description-medium": "Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is...", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 900, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "enable_vega_upgrade_mode": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable vega upgrade mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_vega_upgrade_mode" ] }, "drain_max_unavailable_node_percentage": { "type": "integer", "format": "int64", "description": "Maximum percentage of nodes unavailable during upgrade draining.", "x-f5xc-conflicts-with": [ "drain_max_unavailable_node_count" ] } }, "x-f5xc-description-short": "Specify batch upgrade settings for worker nodes within a site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsKubernetesUpgradeDrainConfig", "required_fields": [ "drain_node_timeout" ], "mutually_exclusive_groups": [], "example_json": "{\n \"drain_node_timeout\": 0\n}", "example_yaml": "drain_node_timeout: 0" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsL3PerformanceEnhancementType": { "type": "object", "description": "L3 enhanced performance mode OPTIONS.", "title": "L3 Mode Enhanced Performance options", "x-displayname": "L3 Mode Enhanced Performance.", "x-ves-displayorder": "1", "x-ves-oneof-field-perf_mode_choice": "[\"jumbo\",\"no_jumbo\"]", "x-ves-proto-message": "ves.io.schema.views.L3PerformanceEnhancementType", "properties": { "jumbo": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_jumbo" ] }, "no_jumbo": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "jumbo" ] } }, "x-required": true, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsL3PerformanceEnhancementType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsL7PerformanceEnhancementType": { "type": "object", "description": "L7 enhanced performance mode OPTIONS.", "title": "L7 Mode Enhanced Performance options", "x-displayname": "L7 Mode Enhanced Performance.", "x-ves-oneof-field-perf_mode_choice": "[\"jumbo_disabled\",\"jumbo_enabled\"]", "x-ves-proto-message": "ves.io.schema.views.L7PerformanceEnhancementType", "properties": { "jumbo_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "jumbo_enabled" ] }, "jumbo_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "jumbo_disabled" ] } }, "x-required": true, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsL7PerformanceEnhancementType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsOfflineSurvivabilityModeType": { "type": "object", "description": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.", "title": "Offline Survivability Mode", "x-displayname": "Offline Survivability Mode.", "x-ves-oneof-field-offline_survivability_mode_choice": "[\"enable_offline_survivability_mode\",\"no_offline_survivability_mode\"]", "x-ves-proto-message": "ves.io.schema.views.OfflineSurvivabilityModeType", "properties": { "enable_offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_offline_survivability_mode" ] }, "no_offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_offline_survivability_mode" ] } }, "x-f5xc-description-short": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional...", "x-f5xc-description-medium": "Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC). When this feature is enabled, a site can continue to function as is with existing configuration for upto 7...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsOfflineSurvivabilityModeType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsOperatingSystemType": { "type": "object", "description": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.", "title": "Operating System Version", "x-displayname": "Operating System Version.", "x-ves-displayorder": "1", "x-ves-oneof-field-operating_system_version_choice": "[\"default_os_version\",\"operating_system_version\"]", "x-ves-proto-message": "ves.io.schema.views.OperatingSystemType", "properties": { "default_os_version": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "operating_system_version" ] }, "operating_system_version": { "type": "string", "description": "Exclusive with [default_os_version]\nSpecify a OS version to be used e.g. 9.2024.6.", "title": "Operating System Version", "maxLength": 20, "x-displayname": "Operating System Version.", "x-ves-example": "9.2024.6", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "20" }, "x-f5xc-example": "9.2024.6", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "20" }, "x-f5xc-description-short": "Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 20, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_os_version" ] } }, "x-f5xc-description-short": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.", "x-f5xc-description-medium": "Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used. Refer to release notes to find required released OS versions.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsOperatingSystemType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsPerformanceEnhancementModeType": { "type": "object", "description": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.", "title": "Performance Enhancement Choice", "x-displayname": "Performance Enhancement Mode.", "x-ves-displayorder": "1", "x-ves-oneof-field-perf_mode_choice": "[\"perf_mode_l3_enhanced\",\"perf_mode_l7_enhanced\"]", "x-ves-proto-message": "ves.io.schema.views.PerformanceEnhancementModeType", "properties": { "perf_mode_l3_enhanced": { "allOf": [ { "$ref": "#/components/schemas/viewsL3PerformanceEnhancementType" } ], "x-f5xc-description-short": "Configuration parameter for perf mode l3 enhanced.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "perf_mode_l7_enhanced" ] }, "perf_mode_l7_enhanced": { "allOf": [ { "$ref": "#/components/schemas/viewsL7PerformanceEnhancementType" } ], "x-f5xc-description-short": "Configuration parameter for perf mode l7 enhanced.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "perf_mode_l3_enhanced" ] } }, "x-required": true, "x-f5xc-description-short": "Optimize the site for L3 or L7 traffic processing. L7 optimized is the default.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsPerformanceEnhancementModeType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsPrivateConnectConfigType": { "type": "object", "description": "Private Connect Configuration.", "title": "PrivateConnectConfigType", "x-displayname": "Private Connect Configuration.", "x-ves-oneof-field-network_options": "[\"inside\",\"outside\"]", "x-ves-proto-message": "ves.io.schema.views.PrivateConnectConfigType", "properties": { "cloud_link": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_link", "field_path": "cloud_link", "gated_by": null, "required": false, "cardinality": "single" } ] }, "inside": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside" ] }, "outside": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsPrivateConnectConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSecurityGroupType": { "type": "object", "description": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC.", "title": "Security Group Parameters", "x-displayname": "Security Group IDs.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.SecurityGroupType", "properties": { "inside_security_group_id": { "type": "string", "description": "Security Group ID to be attached to SLI(Site Local Inside) Interface.", "title": "Inside Security Group ID", "maxLength": 20, "x-displayname": "Inside Security Group ID.", "x-ves-example": "Sg-0db952838ba829943.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "20", "ves.io.schema.rules.string.pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$" }, "x-f5xc-example": "sg-0db952838ba829943", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "20", "ves.io.schema.rules.string.pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$" }, "x-f5xc-description-short": "Security Group ID to be attached to SLI(Site Local Inside) Interface.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 20, "pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "outside_security_group_id": { "type": "string", "description": "Security Group ID to be attached to SLO(Site Local Outside) Interface.", "title": "Outside Security Group ID", "maxLength": 20, "x-displayname": "Outside Security Group ID.", "x-ves-example": "Sg-0db952838ba829943.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "20", "ves.io.schema.rules.string.pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$" }, "x-f5xc-example": "sg-0db952838ba829943", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "20", "ves.io.schema.rules.string.pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$" }, "x-f5xc-description-short": "Security Group ID to be attached to SLO(Site Local Outside) Interface.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 20, "pattern": "^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface.", "x-f5xc-description-medium": "Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSecurityGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteError": { "type": "object", "description": "Site Error.", "title": "Site Error", "x-displayname": "Site Error.", "x-ves-proto-message": "ves.io.schema.views.SiteError", "properties": { "error_description": { "type": "string", "description": "Error Description.", "title": "Error Description", "x-displayname": "Error Description.", "x-ves-example": "Invalid VPC ID.", "x-f5xc-example": "invalid VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_details": { "type": "string", "description": "Error details contains error message from cloud provider.", "title": "Error Details", "x-displayname": "Error Details.", "x-ves-example": "VPC VPC-1233548 NotExistent.", "x-f5xc-example": "VPC vpc-1233548 NotExistent", "x-f5xc-description-short": "Error details contains error message from cloud provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "suggested_action": { "type": "string", "description": "Suggested Action.", "title": "Suggested Action", "x-displayname": "Suggested Action.", "x-ves-example": "Update VPC ID.", "x-f5xc-example": "update VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteError", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteStaticRoutesListType": { "type": "object", "description": "List of static routes.", "title": "Static Route List Type", "x-displayname": "Static Route List Type.", "x-ves-proto-message": "ves.io.schema.views.SiteStaticRoutesListType", "properties": { "static_route_list": { "type": "array", "description": "List of Static routes.", "title": "List of Static Routes", "minItems": 1, "maxItems": 64, "items": { "$ref": "#/components/schemas/viewsSiteStaticRoutesType" }, "x-displayname": "List of Static Routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteStaticRoutesListType", "required_fields": [ "static_route_list" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_route_list\": [\n {}\n ]\n}", "example_yaml": "static_route_list:\n- {}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteStaticRoutesType": { "type": "object", "description": "Different ways to configure static routes.", "title": "Site Static Route Config Modes", "x-displayname": "Site Static Route Config Modes.", "x-ves-oneof-field-config_mode_choice": "[\"custom_static_route\",\"simple_static_route\"]", "x-ves-proto-message": "ves.io.schema.views.SiteStaticRoutesType", "properties": { "custom_static_route": { "allOf": [ { "$ref": "#/components/schemas/schemaStaticRouteType" } ], "x-f5xc-description-short": "Configuration parameter for custom static route.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "simple_static_route" ] }, "simple_static_route": { "type": "string", "description": "Exclusive with [custom_static_route]\nUse simple static route for prefix pointing to single interface in the network.", "title": "Simple Static Route", "x-displayname": "Simple Static Route.", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4_prefix": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.string.ipv4_prefix": "true" }, "x-f5xc-description-short": "Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.", "x-f5xc-description-medium": "Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_static_route" ] } }, "x-f5xc-description-short": "Different ways to configure static routes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteStaticRoutesType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsTGWAssignedASNType": { "type": "object", "description": "Information needed when ASNs are assigned by the user.", "title": "TGW Assigned ASN Type", "x-displayname": "TGW Assigned ASN Type.", "x-ves-proto-message": "ves.io.schema.views.TGWAssignedASNType", "properties": { "tgw_asn": { "type": "integer", "description": "TGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.", "title": "TGW ASN", "format": "int64", "x-displayname": "Enter TGW ASN.", "x-ves-example": "64512", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "64512", "ves.io.schema.rules.uint32.lte": "65534" }, "x-f5xc-example": "64512", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "64512", "ves.io.schema.rules.uint32.lte": "65534" }, "x-f5xc-description-short": "TGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65534, "minimum": 64513, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_site_asn": { "type": "integer", "description": "F5XC Site ASN.", "title": "F5XC Site ASN", "format": "int64", "x-displayname": "Enter F5XC Site ASN.", "x-ves-example": "64500", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "64500", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information needed when ASNs are assigned by the user.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsTGWAssignedASNType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsTGWParamsType": { "type": "object", "title": "TGWParamsType", "x-displayname": "TGWParamsType.", "x-ves-oneof-field-asn_choice": "[\"system_generated\",\"user_assigned\"]", "x-ves-proto-message": "ves.io.schema.views.TGWParamsType", "properties": { "system_generated": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for system generated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "user_assigned" ] }, "user_assigned": { "allOf": [ { "$ref": "#/components/schemas/viewsTGWAssignedASNType" } ], "x-f5xc-description-short": "Configuration parameter for user assigned.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "system_generated" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsTGWParamsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsValidateConfigRequest": { "type": "object", "description": "Request to validate AWS VPC site configuration.", "title": "Request to validate AWS VPC site configuration", "x-displayname": "Request to validate AWS VPC site configuration.", "x-ves-proto-message": "ves.io.schema.views.ValidateConfigRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-VPC-site-1.", "x-f5xc-example": "aws-vpc-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to validate AWS VPC site configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsValidateConfigRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsValidateConfigResponse": { "type": "object", "title": "Response to validate AWS VPC site configuration", "x-displayname": "Response to validate AWS VPC site configuration.", "x-ves-proto-message": "ves.io.schema.views.ValidateConfigResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsValidateConfigResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsVifRegionConfig": { "type": "object", "description": "AWS Direct Connect Hosted VIF Config Per Region Object.", "title": "HostedVIFRegionObject", "x-displayname": "Hosted VIF Config Per Region Object.", "x-ves-displayorder": "5,2", "x-ves-oneof-field-vif_region_choice": "[\"other_region\",\"same_as_site_region\"]", "x-ves-proto-message": "ves.io.schema.views.VifRegionConfig", "properties": { "other_region": { "type": "string", "description": "Exclusive with [same_as_site_region]\nOther Region.", "title": "Other Region", "x-displayname": "Other Region.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-northeast-1\\\",\\\"ap-northeast-2\\\",\\\"ap-south-1\\\",\\\"ap-southeast-1\\\",\\\"ap-southeast-2\\\",\\\"ap-southeast-3\\\",\\\"ca-central-1\\\",\\\"eu-central-1\\\",\\\"eu-north-1\\\",\\\"eu-south-1\\\",\\\"eu-west-1\\\",\\\"eu-west-2\\\",\\\"eu-west-3\\\",\\\"me-south-1\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-1\\\",\\\"us-west-2\\\"]" }, "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-northeast-1\\\",\\\"ap-northeast-2\\\",\\\"ap-south-1\\\",\\\"ap-southeast-1\\\",\\\"ap-southeast-2\\\",\\\"ap-southeast-3\\\",\\\"ca-central-1\\\",\\\"eu-central-1\\\",\\\"eu-north-1\\\",\\\"eu-south-1\\\",\\\"eu-west-1\\\",\\\"eu-west-2\\\",\\\"eu-west-3\\\",\\\"me-south-1\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-1\\\",\\\"us-west-2\\\"]" }, "x-f5xc-description-short": "Exclusive with [same_as_site_region] Other Region.", "maxLength": 1024, "enum": [ "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-west-1", "us-west-2" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "same_as_site_region" ] }, "same_as_site_region": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "other_region" ] }, "vif_id": { "type": "string", "description": "AWS Direct Connect VIF ID that needs to be connected to the site.", "title": "VIF ID", "x-displayname": "VIF ID", "x-ves-example": "Dxvif-fgwtckim.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(dxvif-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "dxvif-fgwtckim", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^(dxvif-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-description-short": "AWS Direct Connect VIF ID that needs to be connected to the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^(dxvif-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-example": "value", "x-f5xc-description-short": "AWS Direct Connect Hosted VIF Config Per Region Object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsVifRegionConfig", "required_fields": [ "vif_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"vif_id\": \"dxvif-fgwtckim\"\n}", "example_yaml": "vif_id: dxvif-fgwtckim" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsVolterraSoftwareType": { "type": "object", "description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.", "title": "F5XC Software Version", "x-displayname": "F5XC Software Version.", "x-ves-displayorder": "1", "x-ves-oneof-field-volterra_sw_version_choice": "[\"default_sw_version\",\"volterra_software_version\"]", "x-ves-proto-message": "ves.io.schema.views.VolterraSoftwareType", "properties": { "default_sw_version": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "volterra_software_version" ] }, "volterra_software_version": { "type": "string", "description": "Exclusive with [default_sw_version]\nSpecify a F5XC Software Version to be used e.g. Crt-20210329-1002.", "title": "F5XC Software Version", "maxLength": 20, "x-displayname": "F5XC Software Version.", "x-ves-example": "Crt-20210329-1002.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "20" }, "x-f5xc-example": "crt-20210329-1002", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "20" }, "x-f5xc-description-short": "Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g.", "x-f5xc-description-medium": "Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 20, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sw_version" ] } }, "x-f5xc-description-short": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.", "x-f5xc-description-medium": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used. Refer to release notes to find required released SW versions.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsVolterraSoftwareType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_tgw_siteAWSTGWResourceShareType": { "type": "object", "description": "AWS Resource Share Status Type.", "title": "AWS Resource Share Status Type", "x-displayname": "AWS Resource Share Status.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.AWSTGWResourceShareType", "properties": { "allow_external_principles": { "type": "boolean", "description": "Manage Sharing Outside AWS Organization.", "title": "Allow External Principles", "format": "boolean", "x-displayname": "Allow External Principles.", "x-f5xc-description-short": "Manage Sharing Outside AWS Organization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Attachment Deployment Status.", "title": "Attachment Deployment Status", "x-displayname": "Attachment Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "owner_account_id": { "type": "string", "description": "Resource Share Owner Account ID.", "title": "Resource Share Owner Account ID", "x-displayname": "Resource Share Owner Account ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "receiver_account_id": { "type": "array", "description": "Resource Share Acceptor Account ID.", "title": "Resource Share Acceptor Account ID", "items": { "type": "string" }, "x-displayname": "Resource Share Acceptor Account ID.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_share_arn": { "type": "string", "description": "Resource Share ARN.", "title": "Resource Share ARN", "x-displayname": "Resource Share ARN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_share_name": { "type": "string", "description": "Resource Share Name.", "title": "Resource Share Name", "x-displayname": "Resource Share Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Resource Share State.", "title": "Resource Share State", "x-displayname": "Resource Share State.", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tags": { "type": "object", "description": "Resource Share Tags.", "title": "Resource Share Tags", "x-displayname": "Resource Share Tags.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_tgw_siteAWSTGWResourceShareType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_tgw_siteAWSTGWStatusType": { "type": "object", "description": "AWS Transit Gateway Status Type.", "title": "AWS Transit Gateway Status Type", "x-displayname": "AWS TGW Status.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.AWSTGWStatusType", "properties": { "status_msg": { "type": "string", "description": "X-displayName \"TGW Deployment Status\"\nTGW Deployment Status.", "title": "TGW Deployment Status", "x-f5xc-description-short": "X-displayName \"TGW Deployment Status\" TGW Deployment Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "TGW Tags", "title": "TGW Tags", "x-displayname": "TGW Tags", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_amazon_asn": { "type": "string", "description": "AWS Side ASN of TGW.", "title": "AWS Side ASN of TGW", "format": "int64", "x-displayname": "AWS Side ASN of TGW.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_arn": { "type": "string", "description": "TGW ARN", "title": "TGW ARN", "x-displayname": "TGW ARN", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_cidrs": { "type": "array", "description": "X-displayName \"TGW CIDRs\"\nTGW CIDRs.", "title": "TGW CIDRs", "items": { "type": "string" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_id": { "type": "string", "description": "TGW ID", "title": "TGW ID", "x-displayname": "TGW ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tgw_owner_account": { "type": "string", "description": "TGW Owner Account.", "title": "TGW Owner", "x-displayname": "TGW Owner Account.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_region": { "type": "string", "description": "TGW Region.", "title": "TGW Region", "x-displayname": "TGW Region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_state": { "type": "string", "description": "TGW State", "title": "TGW State", "x-displayname": "TGW State", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_tgw_siteAWSTGWStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_tgw_siteActiveServicePoliciesType": { "type": "object", "description": "Active service policies for the east-west proxy.", "title": "Active Service Policies", "x-displayname": "Active Service Policies.", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ActiveServicePoliciesType", "properties": { "service_policies": { "type": "array", "description": "A list of references to service_policy objects.", "title": "service_policies", "maxItems": 32, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Service Policies.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of references to service_policy objects.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Active service policies for the east-west proxy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_tgw_siteActiveServicePoliciesType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_tgw_siteCreateSpecType": { "type": "object", "description": "Shape of the AWS TGW site specification.", "title": "CreateSpecType", "x-displayname": "Create AWS TGW site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-direct_connect_choice": "[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.CreateSpecType", "properties": { "aws_parameters": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteServicesVPCType" } ], "x-f5xc-description-short": "Configuration parameter for aws parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "direct_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_enabled", "private_connectivity" ] }, "direct_connect_enabled": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "private_connectivity" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "direct_connect_enabled" ] }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-displayname": "AWS Tags", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_security": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteSecurityConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vn_config": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the AWS TGW site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_tgw_siteCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_tgw_siteGetSpecType": { "type": "object", "description": "Shape of the AWS TGW site specification.", "title": "GetSpecType", "x-displayname": "GET AWS TGW site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-direct_connect_choice": "[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.GetSpecType", "properties": { "aws_parameters": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteServicesVPCType" } ], "x-f5xc-description-short": "Configuration parameter for aws parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "direct_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_enabled", "private_connectivity" ] }, "direct_connect_enabled": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "private_connectivity" ] }, "direct_connect_info": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectInfo" } ], "x-f5xc-description-short": "Configuration parameter for direct connect info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_description": { "type": "string", "description": "Description of error on site.", "x-displayname": "Error Description.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "direct_connect_enabled" ] }, "site_errors": { "type": "array", "description": "Errors on site including suggested action.", "items": { "$ref": "#/components/schemas/viewsSiteError" }, "x-displayname": "Site Errors.", "x-ves-example": "Site Errors.", "x-f5xc-example": "Site Errors", "x-f5xc-description-short": "Errors on site including suggested action.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "suggested_action": { "type": "string", "description": "Suggested action for customer on error.", "x-displayname": "Suggested Action.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-displayname": "AWS Tags", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_info": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteAWSTGWInfoConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_security": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteSecurityConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteTunnelType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validation_state": { "allOf": [ { "$ref": "#/components/schemas/viewsConfigValidationState" } ], "x-f5xc-description-short": "Configuration parameter for validation state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_params_per_az": { "type": "array", "description": "VIP Parameters Per AZ.", "items": { "$ref": "#/components/schemas/sitePublishVIPParamsPerAz__ves_io_schema_views_aws_tgw_site" }, "x-displayname": "VIP Params Per AZ.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.num_items": "0,1,2,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.num_items": "0,1,2,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vn_config": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the AWS TGW site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_tgw_siteGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_tgw_siteReplaceSpecType": { "type": "object", "description": "Shape of the AWS TGW site replace specification.", "title": "ReplaceSpecType", "x-displayname": "Replace AWS TGW site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-direct_connect_choice": "[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-proto-message": "ves.io.schema.views.aws_tgw_site.ReplaceSpecType", "properties": { "aws_parameters": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteServicesVPCReplaceType" } ], "x-f5xc-description-short": "Configuration parameter for aws parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "direct_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_enabled", "private_connectivity" ] }, "direct_connect_enabled": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "private_connectivity" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "direct_connect_enabled" ] }, "tgw_security": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteSecurityConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vn_config": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/aws_tgw_siteVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the AWS TGW site replace specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_tgw_siteReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCIngressEgressGwReplaceType": { "type": "object", "description": "Two interface AWS ingress/egress site.", "title": "AWS Ingress Egress Gateway", "x-displayname": "AWS Ingress/Egress Gateway.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCIngressEgressGwReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allowed_vip_port_sli": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCTwoInterfaceNodeType" }, "x-displayname": "Ingress/Egress Gateway (two Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCIngressEgressGwReplaceType", "required_fields": [ "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ]\n}", "example_yaml": "az_nodes:\n- aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCIngressEgressGwType": { "type": "object", "description": "Two interface AWS ingress/egress site.", "title": "AWS Ingress Egress Gateway", "x-displayname": "AWS Ingress/Egress Gateway.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCIngressEgressGwType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allowed_vip_port_sli": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_certified_hw": { "type": "string", "description": "Name for AWS certified hardware.", "title": "AWS Certified Hardware", "maxLength": 64, "x-displayname": "AWS Certified Hardware.", "x-ves-example": "AWS-byol-multi-NIC-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"aws-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "aws-byol-multi-nic-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"aws-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "aws-byol-multi-nic-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCTwoInterfaceNodeType" }, "x-displayname": "Ingress/Egress Gateway (two Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCIngressEgressGwType", "required_fields": [ "aws_certified_hw", "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_certified_hw\": \"aws-byol-multi-nic-voltmesh\",\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ]\n}", "example_yaml": "aws_certified_hw: aws-byol-multi-nic-voltmesh\naz_nodes:\n- aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCIngressGwReplaceType": { "type": "object", "description": "Single interface AWS ingress site.", "title": "AWS Ingress Gateway", "x-displayname": "AWS Ingress Gateway.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCIngressGwReplaceType", "properties": { "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCOneInterfaceNodeType" }, "x-displayname": "Ingress Gateway (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCIngressGwReplaceType", "required_fields": [ "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ]\n}", "example_yaml": "az_nodes:\n- aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCIngressGwType": { "type": "object", "description": "Single interface AWS ingress site.", "title": "AWS Ingress Gateway", "x-displayname": "AWS Ingress Gateway.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCIngressGwType", "properties": { "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_certified_hw": { "type": "string", "description": "Name for AWS certified hardware.", "title": "AWS Certified Hardware", "maxLength": 64, "x-displayname": "AWS Certified Hardware.", "x-ves-example": "AWS-byol-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"aws-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "aws-byol-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"aws-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "aws-byol-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCOneInterfaceNodeType" }, "x-displayname": "Ingress Gateway (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCIngressGwType", "required_fields": [ "aws_certified_hw", "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_certified_hw\": \"aws-byol-voltmesh\",\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ]\n}", "example_yaml": "aws_certified_hw: aws-byol-voltmesh\naz_nodes:\n- aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCSiteInfoType": { "type": "object", "description": "AWS VPC Site information like.", "title": "AWS VPC Site Information Config", "x-displayname": "AWS VPC Site Information Config.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCSiteInfoType", "properties": { "private_ips": { "type": "array", "description": "AWS Private IPs used by the nodes.", "title": "AWS Node Private IPs", "items": { "type": "string" }, "x-displayname": "AWS Node Private IPs.", "x-ves-example": "192.0.2.246, 192.0.2.204, 192.0.2.170.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.246, 192.0.2.204, 192.0.2.170", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "public_ips": { "type": "array", "description": "AWS Elastic IPs used by the nodes.", "title": "AWS Node Elastic IPs", "items": { "type": "string" }, "x-displayname": "AWS Node Elastic IPs.", "x-ves-example": "192.0.2.242, 192.0.2.31, 192.0.2.63.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.242, 192.0.2.31, 192.0.2.63", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "subnet_ids": { "type": "array", "description": "AWS Subnet Info where the F5XC site is deployed.", "title": "AWS Subnet Info", "items": { "$ref": "#/components/schemas/viewsAWSSubnetIdsType" }, "x-displayname": "AWS Subnet Info.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3" }, "x-f5xc-description-short": "AWS Subnet Info where the F5XC site is deployed.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vpc_id": { "type": "string", "description": "VPC ID where the F5 Distributed Cloud site exists.", "title": "VPC ID", "x-displayname": "VPC ID", "x-ves-example": "VPC-12345678.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$|^$" }, "x-f5xc-example": "vpc-12345678", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$|^$" }, "x-f5xc-description-short": "VPC ID where the F5 Distributed Cloud site exists.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$|^$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vpc_name": { "type": "string", "description": "VPC Name where the F5 Distributed Cloud site exists.", "title": "VPC Name", "x-displayname": "VPC Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "VPC Name where the F5 Distributed Cloud site exists.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCSiteInfoType", "required_fields": [ "private_ips", "public_ips", "subnet_ids" ], "mutually_exclusive_groups": [], "example_json": "{\n \"private_ips\": [\n \"value\"\n ],\n \"public_ips\": [\n \"value\"\n ],\n \"subnet_ids\": [\n {}\n ]\n}", "example_yaml": "private_ips:\n- value\npublic_ips:\n- value\nsubnet_ids:\n- {}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCVoltstackClusterReplaceType": { "type": "object", "description": "App Stack cluster of single interface AWS nodes.", "title": "AWS App Stack Cluster", "x-displayname": "AWS App Stack Cluster.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCVoltstackClusterReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCOneInterfaceNodeType" }, "x-displayname": "App Stack Cluster (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "App Stack cluster of single interface AWS nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCVoltstackClusterReplaceType", "required_fields": [ "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ]\n}", "example_yaml": "az_nodes:\n- aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteAWSVPCVoltstackClusterType": { "type": "object", "description": "App Stack cluster of single interface AWS nodes.", "title": "AWS App Stack Cluster", "x-displayname": "AWS App Stack Cluster.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-oneof-field-storage_class_choice": "[\"default_storage\",\"storage_class_list\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.AWSVPCVoltstackClusterType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "allowed_vip_port": { "allOf": [ { "$ref": "#/components/schemas/viewsAllowedVIPPorts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_certified_hw": { "type": "string", "description": "Name for AWS certified hardware.", "title": "AWS Certified Hardware", "maxLength": 64, "x-displayname": "AWS Certified Hardware.", "x-ves-example": "AWS-byol-multi-NIC-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"aws-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "aws-byol-multi-nic-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"aws-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "aws-byol-voltstack-combo" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAWSVPCOneInterfaceNodeType" }, "x-displayname": "App Stack Cluster (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "default_storage": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_class_list" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] }, "storage_class_list": { "allOf": [ { "$ref": "#/components/schemas/viewsStorageClassListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage" ] } }, "x-f5xc-description-short": "App Stack cluster of single interface AWS nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteAWSVPCVoltstackClusterType", "required_fields": [ "aws_certified_hw", "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_certified_hw\": \"aws-byol-multi-nic-voltmesh\",\n \"az_nodes\": [\n {\n \"aws_az_name\": \"us-west-2a\"\n }\n ]\n}", "example_yaml": "aws_certified_hw: aws-byol-multi-nic-voltmesh\naz_nodes:\n- aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of aws_vpc_site", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_vpc_siteCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_vpc_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a aws_vpc_site", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read aws_vpc_site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_vpc_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/aws_vpc_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of aws_vpc_site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/aws_vpc_siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteListResponseItem": { "type": "object", "description": "By default a summary of aws_vpc_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of aws_vpc_site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this aws_vpc_site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this aws_vpc_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this aws_vpc_site.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this aws_vpc_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates aws_vpc_site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates aws_vpc_site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_vpc_siteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this aws_vpc_site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this aws_vpc_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this aws_vpc_site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/aws_vpc_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this aws_vpc_site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of aws_vpc_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of aws_vpc_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a aws_vpc_site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsaws_vpc_siteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteSetCloudSiteInfoRequest": { "type": "object", "description": "Request to configure Cloud Site Information.", "title": "Request to configure Cloud Site Information", "x-displayname": "Request to configure Cloud Site Information.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetCloudSiteInfoRequest", "properties": { "aws_vpc_info": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCSiteInfoType" } ], "x-f5xc-description-short": "Configuration parameter for aws vpc info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "direct_connect_info": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectInfo" } ], "x-f5xc-description-short": "Configuration parameter for direct connect info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-VPC-site-1.", "x-f5xc-example": "aws-vpc-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to configure Cloud Site Information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteSetCloudSiteInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteSetCloudSiteInfoResponse": { "type": "object", "description": "Response to configure configure Cloud Site Information.", "title": "Response to configure Cloud Site Information", "x-displayname": "Response to configure Cloud Site Information.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetCloudSiteInfoResponse", "x-f5xc-description-short": "Response to configure configure Cloud Site Information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteSetCloudSiteInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteSetVIPInfoRequest": { "type": "object", "description": "Request to configure AWS VPC Site VIP information.", "title": "Request to configure AWS VPC Site VIP information", "x-displayname": "Request to configure AWS VPC Site VIP information.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetVIPInfoRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-VPC-site-1.", "x-f5xc-example": "aws-vpc-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "vip_params_per_az": { "type": "array", "description": "VIP Parameters per AZ.", "title": "VIP Params Per AZ", "items": { "$ref": "#/components/schemas/sitePublishVIPParamsPerAz__ves_io_schema_views_aws_vpc_site" }, "x-displayname": "VIP Params Per AZ.", "x-ves-example": "Master-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.num_items": "1,2,3" }, "x-f5xc-example": "master-0", "x-validation-rules": { "ves.io.schema.rules.repeated.num_items": "1,2,3" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to configure AWS VPC Site VIP information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteSetVIPInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteSetVIPInfoResponse": { "type": "object", "title": "Response to configure AWS VPC Site VIP Information", "x-displayname": "Response to configure AWS VPC Site VIP Information.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetVIPInfoResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteSetVIPInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteSetVPCK8SHostnamesRequest": { "type": "object", "description": "Request to configure VPC K8s node hostname set.", "title": "Request to configure VPC k8s node hostname set", "x-displayname": "Request to configure VPC K8s node hostname set.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetVPCK8SHostnamesRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "AWS-VPC-site-1.", "x-f5xc-example": "aws-vpc-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "node_names": { "type": "array", "description": "Hostname of K8s nodes for definition of Mayastore pools.", "title": "Hostname of K8S nodes", "items": { "type": "string" }, "x-displayname": "Hostname of K8s nodes.", "x-ves-example": "Master-0", "x-f5xc-example": "master-0", "x-f5xc-description-short": "Hostname of K8s nodes for definition of Mayastore pools.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to configure VPC K8s node hostname set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteSetVPCK8SHostnamesRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteSetVPCK8SHostnamesResponse": { "type": "object", "title": "Response to configure VPC k8s node hostname set", "x-displayname": "Response to configure VPC K8s node hostname set.", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.SetVPCK8SHostnamesResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteSetVPCK8SHostnamesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "aws_vpc_siteStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersDeploymentStatusType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "AWS VPC view object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for aws_vpc_siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePublishVIPParamsPerAz__ves_io_schema_views_aws_vpc_site": { "type": "object", "description": "X-displayName: \"Publish VIP Params Per AZ\"\nPer AZ parameters needed to publish VIP for public cloud sites.", "title": "Publish VIP Params Per AZ", "properties": { "az_name": { "type": "string", "description": "X-displayName: \"AZ Name\"\nName of the Availability zone.", "title": "AZ Name", "x-f5xc-example": "us-east-2a", "x-f5xc-description-short": "X-displayName: \"AZ Name\" Name of the Availability zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip": { "type": "array", "description": "X-displayName: \"Inside VIP(s)\"\nList of Inside VIPs for an AZ.", "title": "Inside VIP(s)", "items": { "type": "string" }, "x-f5xc-example": "192.0.2.102", "x-f5xc-description-short": "X-displayName: \"Inside VIP(s)\" List of Inside VIPs for an AZ.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip_cname": { "type": "string", "description": "X-displayName: \"Inside VIP CNAME\"\nCNAME value for the inside VIP,\nThese are usually public cloud generated CNAME.", "title": "Inside VIP CNAME", "x-f5xc-example": "test.56670-387196482.useast2.F5 XC", "x-f5xc-description-short": "X-displayName: \"Inside VIP CNAME\" CNAME value for the inside VIP, These are usually public cloud generated CNAME.", "x-f5xc-description-medium": "X-displayName: \"Inside VIP CNAME\" CNAME value for the inside VIP, These are usually public cloud generated CNAME.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip_v6": { "type": "array", "description": "X-displayName: \"Inside IPv6 VIP(s)\"\nOptional list of Inside IPv6 VIPs for an AZ.", "title": "Inside IPv6 VIP(s)", "items": { "type": "string" }, "x-f5xc-example": "2001::1", "x-f5xc-description-short": "X-displayName: \"Inside IPv6 VIP(s)\" Optional list of Inside IPv6 VIPs for an AZ.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip": { "type": "array", "description": "X-displayName: \"Outside VIP(s)\"\nx-required\nList of Outside VIPs for an AZ.", "title": "Outside VIP(s)", "items": { "type": "string" }, "x-f5xc-example": "192.0.2.102", "x-f5xc-description-short": "X-displayName: \"Outside VIP(s)\" x-required List of Outside VIPs for an AZ.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip_cname": { "type": "string", "description": "X-displayName: \"Outside VIP CNAME\"\nCNAME value for the outside VIP\nThese are usually public cloud generated CNAME.", "title": "Outside VIP CNAME", "x-f5xc-example": "test.56670-387196482.useast2.F5 XC", "x-f5xc-description-short": "X-displayName: \"Outside VIP CNAME\" CNAME value for the outside VIP These are usually public cloud generated CNAME.", "x-f5xc-description-medium": "X-displayName: \"Outside VIP CNAME\" CNAME value for the outside VIP These are usually public cloud generated CNAME.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip_v6": { "type": "array", "description": "X-displayName: \"Outside IPv6 VIP(s)\"\nOptional list of Outside IPv6 VIPs for an AZ.", "title": "Outside IPv6 VIP(s)", "items": { "type": "string" }, "x-f5xc-example": "2001::1", "x-f5xc-description-short": "X-displayName: \"Outside IPv6 VIP(s)\" Optional list of Outside IPv6 VIPs for an AZ.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "X-displayName: \"Publish VIP Params Per AZ\" Per AZ parameters needed to publish VIP for public cloud sites.", "x-f5xc-description-medium": "X-displayName: \"Publish VIP Params Per AZ\" Per AZ parameters needed to publish VIP for public cloud sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePublishVIPParamsPerAz", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSNATGatewaychoiceType": { "type": "object", "description": "With this option, egress site traffic will be routed through an Network Address Translation(NAT) Gateway.", "title": "AWS NAT Gateway choice", "x-displayname": "AWS NAT Gateway choice.", "x-ves-oneof-field-choice": "[\"nat_gw_id\"]", "x-ves-proto-message": "ves.io.schema.views.AWSNATGatewaychoiceType", "properties": { "nat_gw_id": { "type": "string", "description": "Exclusive with []", "title": "AWS existing NAT Gateway ID", "maxLength": 21, "x-displayname": "Existing NAT Gateway ID.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "21", "ves.io.schema.rules.string.pattern": "^(nat-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "21", "ves.io.schema.rules.string.pattern": "^(nat-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 21, "pattern": "^(nat-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "With this option, egress site traffic will be routed through an Network Address Translation(NAT) Gateway.", "x-f5xc-description-medium": "With this option, egress site traffic will be routed through an Network Address Translation(NAT) Gateway.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSNATGatewaychoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSVPCOneInterfaceNodeType": { "type": "object", "description": "Parameters for creating Single interface Node in one AZ.", "title": "Single Interface Node", "x-displayname": "Single Interface Node.", "x-ves-displayorder": "1,3,2", "x-ves-proto-message": "ves.io.schema.views.AWSVPCOneInterfaceNodeType", "properties": { "aws_az_name": { "type": "string", "description": "AWS availability zone, must be consistent with the selected AWS region.", "title": "AWS AZ", "x-displayname": "AWS AZ Name.", "x-ves-example": "Us-west-2a.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-west-2a", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "AWS availability zone, must be consistent with the selected AWS region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetType" } ], "x-f5xc-description-short": "Configuration parameter for local subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating Single interface Node in one AZ.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSVPCOneInterfaceNodeType", "required_fields": [ "aws_az_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_az_name\": \"us-west-2a\"\n}", "example_yaml": "aws_az_name: us-west-2a" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSVPCchoiceType": { "type": "object", "description": "This defines choice about AWS VPC for a view.", "title": "AWS VPC choice", "x-displayname": "AWS VPC choice.", "x-ves-oneof-field-choice": "[\"new_vpc\",\"vpc_id\"]", "x-ves-proto-message": "ves.io.schema.views.AWSVPCchoiceType", "properties": { "new_vpc": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVPCParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vpc_id" ] }, "vpc_id": { "type": "string", "description": "Exclusive with [new_vpc]\nInformation about existing VPC ID.", "title": "Existing VPC", "maxLength": 64, "x-displayname": "Existing VPC ID.", "x-ves-example": "VPC-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vpc-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-description-short": "Exclusive with [new_vpc] Information about existing VPC ID.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "new_vpc" ] } }, "x-f5xc-description-short": "Defines choice about AWS VPC for a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSVPCchoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAWSVirtualPrivateGatewaychoiceType": { "type": "object", "description": "With this option, egress site traffic will be routed through an Virtual Private Gateway.", "title": "AWS Virtual Private Gateway choice", "x-displayname": "AWS Virtual Private Gateway choice.", "x-ves-oneof-field-choice": "[\"vgw_id\"]", "x-ves-proto-message": "ves.io.schema.views.AWSVirtualPrivateGatewaychoiceType", "properties": { "vgw_id": { "type": "string", "description": "Exclusive with []", "title": "AWS existing Virtual Private Gateway ID", "maxLength": 21, "x-displayname": "Existing Virtual Private Gateway ID.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "21", "ves.io.schema.rules.string.pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "21", "ves.io.schema.rules.string.pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 21, "pattern": "^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "With this option, egress site traffic will be routed through an Virtual Private Gateway.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAWSVirtualPrivateGatewaychoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsStorageClassListType": { "type": "object", "description": "Add additional custom storage classes in Kubernetes for this site.", "title": "Custom Storage Class List", "x-displayname": "Custom Storage Class List.", "x-ves-proto-message": "ves.io.schema.views.StorageClassListType", "properties": { "storage_classes": { "type": "array", "description": "List of custom storage classes.", "title": "List of Storage Classes", "maxItems": 4, "items": { "$ref": "#/components/schemas/viewsStorageClassType" }, "x-displayname": "List of Storage Classes.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Add additional custom storage classes in Kubernetes for this site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsStorageClassListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsStorageClassType": { "type": "object", "description": "Configuration of custom storage class.", "title": "Custom Storage Class", "x-displayname": "Custom Storage Class.", "x-ves-proto-message": "ves.io.schema.views.StorageClassType", "properties": { "default_storage_class": { "type": "boolean", "description": "Make this storage class default storage class for the K8s cluster.", "title": "Default Storage Class", "format": "boolean", "x-displayname": "Default Storage Class.", "x-f5xc-description-short": "Make this storage class default storage class for the K8s cluster.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_class_name": { "type": "string", "description": "Name of the storage class as it will appear in K8s.", "title": "Storage Class Name", "x-displayname": "Storage Class Name.", "x-ves-example": "Premium", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "premium", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name of the storage class as it will appear in K8s.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsStorageClassType", "required_fields": [ "storage_class_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"storage_class_name\": \"premium\"\n}", "example_yaml": "storage_class_name: premium" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_vpc_siteCreateSpecType": { "type": "object", "description": "Shape of the AWS VPC site specification.", "title": "CreateSpecType", "x-displayname": "Create AWS VPC site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"aws_cred\"]", "x-ves-oneof-field-direct_connect_choice": "[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]", "x-ves-oneof-field-egress_gateway_choice": "[\"egress_gateway_default\",\"egress_nat_gw\",\"egress_virtual_private_gateway\"]", "x-ves-oneof-field-encryption_choice": "[\"disable_encryption\",\"enable_encryption\"]", "x-ves-oneof-field-internet_vip_choice": "[\"disable_internet_vip\",\"enable_internet_vip\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-routing_type": "[\"f5_orchestrated_routing\",\"manual_routing\"]", "x-ves-oneof-field-security_group_choice": "[\"custom_security_group\",\"f5xc_security_group\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_gw\",\"voltstack_cluster\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.CreateSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "aws_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "aws_region": { "type": "string", "description": "Name for AWS Region.", "x-displayname": "AWS Region.", "x-ves-example": "Us-east-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-east-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_security_group": { "allOf": [ { "$ref": "#/components/schemas/viewsSecurityGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5xc_security_group" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "direct_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_enabled", "private_connectivity" ] }, "direct_connect_enabled": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "private_connectivity" ] }, "disable_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_encryption" ] }, "disable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_internet_vip" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "2048" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "2048" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 2048, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "egress_gateway_default": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for egress gateway default.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_nat_gw", "egress_virtual_private_gateway" ] }, "egress_nat_gw": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSNATGatewaychoiceType" } ], "x-f5xc-description-short": "Configuration parameter for egress nat gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_gateway_default", "egress_virtual_private_gateway" ] }, "egress_virtual_private_gateway": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVirtualPrivateGatewaychoiceType" } ], "x-f5xc-description-short": "Configuration parameter for egress virtual private gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_gateway_default", "egress_nat_gw" ] }, "enable_encryption": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSDiskEncryption" } ], "x-f5xc-description-short": "Configuration parameter for enable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_encryption" ] }, "enable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_internet_vip" ] }, "f5_orchestrated_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "manual_routing" ] }, "f5xc_security_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_security_group" ] }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCIngressEgressGwType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_gw", "voltstack_cluster" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCIngressGwType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "voltstack_cluster" ] }, "instance_type": { "type": "string", "description": "Select Instance size based on performance needed.", "maxLength": 64, "x-displayname": "AWS Instance Type for Node.", "x-ves-example": "a1.xlarge", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "a1.xlarge", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "manual_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_orchestrated_routing" ] }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "direct_connect_enabled" ] }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-displayname": "AWS Tags", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCVoltstackClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw" ] }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVPCchoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the AWS VPC site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_vpc_siteCreateSpecType", "required_fields": [ "aws_region", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_region\": \"us-east-1\",\n \"instance_type\": \"a1.xlarge\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "aws_region: us-east-1\ninstance_type: a1.xlarge\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_vpc_siteGetSpecType": { "type": "object", "description": "Shape of the AWS VPC site specification.", "title": "GetSpecType", "x-displayname": "GET AWS VPC site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"aws_cred\"]", "x-ves-oneof-field-direct_connect_choice": "[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]", "x-ves-oneof-field-egress_gateway_choice": "[\"egress_gateway_default\",\"egress_nat_gw\",\"egress_virtual_private_gateway\"]", "x-ves-oneof-field-encryption_choice": "[\"disable_encryption\",\"enable_encryption\"]", "x-ves-oneof-field-internet_vip_choice": "[\"disable_internet_vip\",\"enable_internet_vip\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-routing_type": "[\"f5_orchestrated_routing\",\"manual_routing\"]", "x-ves-oneof-field-security_group_choice": "[\"custom_security_group\",\"f5xc_security_group\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_gw\",\"voltstack_cluster\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.GetSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "aws_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "aws_region": { "type": "string", "description": "Name for AWS Region.", "x-displayname": "AWS Region.", "x-ves-example": "Us-east-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-east-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "cloud_site_info": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCSiteInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_security_group": { "allOf": [ { "$ref": "#/components/schemas/viewsSecurityGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5xc_security_group" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "direct_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_enabled", "private_connectivity" ] }, "direct_connect_enabled": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "private_connectivity" ] }, "direct_connect_info": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectInfo" } ], "x-f5xc-description-short": "Configuration parameter for direct connect info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disable_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_encryption" ] }, "disable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_internet_vip" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "2048" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "2048" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 2048, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "egress_gateway_default": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for egress gateway default.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_nat_gw", "egress_virtual_private_gateway" ] }, "egress_nat_gw": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSNATGatewaychoiceType" } ], "x-f5xc-description-short": "Configuration parameter for egress nat gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_gateway_default", "egress_virtual_private_gateway" ] }, "egress_virtual_private_gateway": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVirtualPrivateGatewaychoiceType" } ], "x-f5xc-description-short": "Configuration parameter for egress virtual private gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_gateway_default", "egress_nat_gw" ] }, "enable_encryption": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSDiskEncryption" } ], "x-f5xc-description-short": "Configuration parameter for enable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_encryption" ] }, "enable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_internet_vip" ] }, "error_description": { "type": "string", "description": "Description of error on site.", "x-displayname": "Error Description.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "f5_orchestrated_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "manual_routing" ] }, "f5xc_security_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_security_group" ] }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCIngressEgressGwType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_gw", "voltstack_cluster" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCIngressGwType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "voltstack_cluster" ] }, "instance_type": { "type": "string", "description": "Select Instance size based on performance needed.", "maxLength": 64, "x-displayname": "AWS Instance Type for Node.", "x-ves-example": "a1.xlarge", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "a1.xlarge", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "manual_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_orchestrated_routing" ] }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "direct_connect_enabled" ] }, "site_errors": { "type": "array", "description": "Errors on site including suggested action.", "items": { "$ref": "#/components/schemas/viewsSiteError" }, "x-displayname": "Site Errors.", "x-ves-example": "Site Errors.", "x-f5xc-example": "Site Errors", "x-f5xc-description-short": "Errors on site including suggested action.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "suggested_action": { "type": "string", "description": "Suggested action for customer on error.", "x-displayname": "Suggested Action.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "AWS Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-displayname": "AWS Tags", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "validation_state": { "allOf": [ { "$ref": "#/components/schemas/viewsConfigValidationState" } ], "x-f5xc-description-short": "Configuration parameter for validation state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCVoltstackClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw" ] }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVPCchoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the AWS VPC site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_vpc_siteGetSpecType", "required_fields": [ "aws_region", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_region\": \"us-east-1\",\n \"instance_type\": \"a1.xlarge\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "aws_region: us-east-1\ninstance_type: a1.xlarge\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsaws_vpc_siteReplaceSpecType": { "type": "object", "description": "Shape of the AWS VPC site replace specification.", "title": "ReplaceSpecType", "x-displayname": "Replace AWS VPC site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"aws_cred\"]", "x-ves-oneof-field-direct_connect_choice": "[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]", "x-ves-oneof-field-egress_gateway_choice": "[\"egress_gateway_default\",\"egress_nat_gw\",\"egress_virtual_private_gateway\"]", "x-ves-oneof-field-internet_vip_choice": "[\"disable_internet_vip\",\"enable_internet_vip\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-security_group_choice": "[\"custom_security_group\",\"f5xc_security_group\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_gw\",\"voltstack_cluster\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.aws_vpc_site.ReplaceSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "aws_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "aws_region": { "type": "string", "description": "Name for AWS Region.", "x-displayname": "AWS Region.", "x-ves-example": "Us-east-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-east-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_security_group": { "allOf": [ { "$ref": "#/components/schemas/viewsSecurityGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5xc_security_group" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "direct_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_enabled", "private_connectivity" ] }, "direct_connect_enabled": { "allOf": [ { "$ref": "#/components/schemas/viewsDirectConnectConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "private_connectivity" ] }, "disable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_internet_vip" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "2048" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "2048" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 2048, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "egress_gateway_default": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for egress gateway default.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_nat_gw", "egress_virtual_private_gateway" ] }, "egress_nat_gw": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSNATGatewaychoiceType" } ], "x-f5xc-description-short": "Configuration parameter for egress nat gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_gateway_default", "egress_virtual_private_gateway" ] }, "egress_virtual_private_gateway": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVirtualPrivateGatewaychoiceType" } ], "x-f5xc-description-short": "Configuration parameter for egress virtual private gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "egress_gateway_default", "egress_nat_gw" ] }, "enable_internet_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_internet_vip" ] }, "f5xc_security_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_security_group" ] }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCIngressEgressGwReplaceType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_gw", "voltstack_cluster" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCIngressGwReplaceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "voltstack_cluster" ] }, "instance_type": { "type": "string", "description": "Select Instance size based on performance needed.", "maxLength": 64, "x-displayname": "AWS Instance Type for Node.", "x-ves-example": "a1.xlarge", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "a1.xlarge", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "direct_connect_disabled", "direct_connect_enabled" ] }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/aws_vpc_siteAWSVPCVoltstackClusterReplaceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw" ] }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/viewsAWSVPCchoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the AWS VPC site replace specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsaws_vpc_siteReplaceSpecType", "required_fields": [ "aws_region", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_region\": \"us-east-1\",\n \"instance_type\": \"a1.xlarge\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "aws_region: us-east-1\ninstance_type: a1.xlarge\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "bgpAggregationIPv4": { "type": "object", "description": "Aggregation in BGP occurs only when more specific routes exist in the routing table and applies to outbound advertisements.", "title": "AggregationIPv4", "x-displayname": "Aggregation.", "x-ves-proto-message": "ves.io.schema.bgp.AggregationIPv4", "properties": { "ip_prefix": { "type": "string", "description": "Specify IPv4 subnet for aggregation.", "title": "ip_prefix", "x-displayname": "IP Prefix", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4_prefix": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv4_prefix": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "options": { "type": "array", "description": "Configuration parameter for options", "title": "options", "items": { "$ref": "#/components/schemas/bgpAggregationOption" }, "x-displayname": "Aggregation OPTIONS.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Aggregation in BGP occurs only when more specific routes exist in the routing table and applies to outbound advertisements.", "x-f5xc-description-medium": "Aggregation in BGP occurs only when more specific routes exist in the routing table and applies to outbound advertisements.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpAggregationIPv4", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpAggregationOption": { "type": "object", "description": "Aggregation OPTIONS for BGP routes.", "title": "AggregationOption", "x-displayname": "Aggregation OPTIONS.", "x-ves-oneof-field-aggregation_choice": "[\"summary_only\"]", "x-ves-proto-message": "ves.io.schema.bgp.AggregationOption", "properties": { "summary_only": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for summary only.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpAggregationOption", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpBFD": { "type": "object", "description": "BFD parameters.", "title": "BFD", "x-displayname": "BFD", "x-ves-proto-message": "ves.io.schema.bgp.BFD", "properties": { "multiplier": { "type": "integer", "description": "Specify Number of missed packets to bring session down\"", "title": "Multiplier", "format": "int64", "x-displayname": "Multiplier.", "x-ves-example": "3", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "2", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "3", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "2", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Specify Number of missed packets to bring session down\".", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 2, "maximum": 255, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "receive_interval_milliseconds": { "type": "integer", "description": "BFD receive interval timer, in milliseconds.", "title": "Receive Interval in milliseconds", "format": "int64", "x-displayname": "Minimum Receive Interval.", "x-ves-example": "3000", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "300", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-example": "3000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "300", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-description-short": "BFD receive interval timer, in milliseconds.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 300, "maximum": 60000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "transmit_interval_milliseconds": { "type": "integer", "description": "BFD transmit interval timer, in milliseconds.", "title": "Transmit Interval in milliseconds", "format": "int64", "x-displayname": "Transmit Interval.", "x-ves-example": "3000", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "300", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-example": "3000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "300", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-description-short": "BFD transmit interval timer, in milliseconds.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 300, "maximum": 60000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpBFD", "required_fields": [ "multiplier", "receive_interval_milliseconds", "transmit_interval_milliseconds" ], "mutually_exclusive_groups": [], "example_json": "{\n \"multiplier\": 2,\n \"receive_interval_milliseconds\": 300,\n \"transmit_interval_milliseconds\": 300\n}", "example_yaml": "multiplier: 2\nreceive_interval_milliseconds: 300\ntransmit_interval_milliseconds: 300" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpBgpRoutePolicies": { "type": "object", "description": "List of rules which can be applied on all or particular nodes.", "title": "BGP Routing policies", "x-displayname": "BGP Routing Policy.", "x-ves-proto-message": "ves.io.schema.bgp.BgpRoutePolicies", "properties": { "route_policy": { "type": "array", "description": "Route policy to be applied.", "title": "route_policy", "maxItems": 4, "items": { "$ref": "#/components/schemas/bgpBgpRoutePolicy" }, "x-displayname": "BGP Routing policy.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of rules which can be applied on all or particular nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpBgpRoutePolicies", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpBgpRoutePolicy": { "type": "object", "description": "List of filter rules which can be applied on all or particular nodes.", "title": "BGP Route policy", "x-displayname": "BGP Routing Policy.", "x-ves-displayorder": "7,4,1", "x-ves-oneof-field-direction": "[\"inbound\",\"outbound\"]", "x-ves-oneof-field-node_choice": "[\"all_nodes\",\"node_name\"]", "x-ves-proto-message": "ves.io.schema.bgp.BgpRoutePolicy", "properties": { "all_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "node_name" ] }, "inbound": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outbound" ] }, "node_name": { "allOf": [ { "$ref": "#/components/schemas/bgpNodes" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_nodes" ] }, "object_refs": { "type": "array", "description": "Select route policy to apply.", "title": "Policy to apply", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "BGP routing policy.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "outbound": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inbound" ] } }, "x-f5xc-description-short": "List of filter rules which can be applied on all or particular nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpBgpRoutePolicy", "required_fields": [ "object_refs" ], "mutually_exclusive_groups": [], "example_json": "{\n \"object_refs\": [\n {}\n ]\n}", "example_yaml": "object_refs:\n- {}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpFamilyInet": { "type": "object", "description": "Parameters for inet family.", "title": "FamilyInet", "x-displayname": "BGP Family Inet.", "x-ves-oneof-field-enable_choice": "[\"disable\",\"enable\"]", "x-ves-proto-message": "ves.io.schema.bgp.FamilyInet", "properties": { "disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable" ] }, "enable": { "allOf": [ { "$ref": "#/components/schemas/bgpUnicastIPv4" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpFamilyInet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpInterfaceList": { "type": "object", "description": "List of network interfaces.", "title": "InterfaceList", "x-displayname": "Interface List.", "x-ves-proto-message": "ves.io.schema.bgp.InterfaceList", "properties": { "interfaces": { "type": "array", "description": "List of network interfaces.", "title": "interface_list", "minItems": 1, "maxItems": 16, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Interface List.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpInterfaceList", "required_fields": [ "interfaces" ], "mutually_exclusive_groups": [], "example_json": "{\n \"interfaces\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "interfaces:\n- name: contacts-route" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpNodes": { "type": "object", "description": "List of nodes on which BGP routing policy has to be applied.", "title": "Nodes", "x-displayname": "Nodes", "x-ves-proto-message": "ves.io.schema.bgp.Nodes", "properties": { "node": { "type": "array", "description": "Select BGP Session on which policy will be applied.", "title": "Node", "items": { "type": "string" }, "x-displayname": "Node of choice.", "x-f5xc-description-short": "Select BGP Session on which policy will be applied.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of nodes on which BGP routing policy has to be applied.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpNodes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpPeer": { "type": "object", "description": "BGP Peer parameters.", "title": "Peer", "x-displayname": "BGP Peer", "x-ves-displayorder": "1,2,5", "x-ves-oneof-field-bfd_choice": "[\"bfd_disabled\",\"bfd_enabled\"]", "x-ves-oneof-field-enable_choice": "[\"disable\",\"routing_policies\"]", "x-ves-oneof-field-passive_choice": "[\"passive_mode_disabled\",\"passive_mode_enabled\"]", "x-ves-oneof-field-type_choice": "[\"external\"]", "x-ves-proto-message": "ves.io.schema.bgp.Peer", "properties": { "bfd_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bfd_enabled" ] }, "bfd_enabled": { "allOf": [ { "$ref": "#/components/schemas/bgpBFD" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bfd_disabled" ] }, "disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "routing_policies" ] }, "external": { "allOf": [ { "$ref": "#/components/schemas/bgpPeerExternal" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "label": { "type": "string", "description": "Specify whether this peer should be.", "title": "label", "x-displayname": "Label", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "labeling", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "passive_mode_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "passive_mode_enabled" ] }, "passive_mode_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "passive_mode_disabled" ] }, "routing_policies": { "allOf": [ { "$ref": "#/components/schemas/bgpBgpRoutePolicies" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpPeer", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpPeerExternal": { "type": "object", "description": "External BGP Peer parameters.", "title": "PeerExternal", "x-displayname": "External BGP Peer.", "x-ves-displayorder": "1,2,29,10,11,12,20,25", "x-ves-oneof-field-address_choice": "[\"address\",\"default_gateway\",\"disable\",\"external_connector\",\"from_site\",\"subnet_begin_offset\",\"subnet_end_offset\"]", "x-ves-oneof-field-address_choice_v6": "[\"address_ipv6\",\"default_gateway_v6\",\"disable_v6\",\"from_site_v6\",\"subnet_begin_offset_v6\",\"subnet_end_offset_v6\"]", "x-ves-oneof-field-auth_choice": "[\"md5_auth_key\",\"no_authentication\"]", "x-ves-oneof-field-interface_choice": "[\"interface\",\"interface_list\"]", "x-ves-proto-message": "ves.io.schema.bgp.PeerExternal", "properties": { "address": { "type": "string", "description": "Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset]\nSpecify IPv4 peer address.", "title": "address", "x-displayname": "Peer Address.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset] Specify IPv4 peer address.", "x-f5xc-description-medium": "Exclusive with [default_gateway disable external_connector from_site subnet_begin_offset subnet_end_offset] Specify IPv4 peer address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_gateway", "disable", "external_connector", "from_site", "subnet_begin_offset", "subnet_end_offset" ] }, "address_ipv6": { "type": "string", "description": "Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6]\nSpecify peer IPv6 address.", "title": "address_ipv6", "x-displayname": "Peer IPv6 Address.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6] Specify peer IPv6 address.", "x-f5xc-description-medium": "Exclusive with [default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6 subnet_end_offset_v6] Specify peer IPv6 address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_gateway_v6", "disable_v6", "from_site_v6", "subnet_begin_offset_v6", "subnet_end_offset_v6" ] }, "asn": { "type": "integer", "description": "Autonomous System Number for BGP peer.", "title": "ASN", "format": "int64", "x-displayname": "ASN", "x-ves-example": "64512", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-example": "64512", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "default_gateway": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address", "disable", "external_connector", "from_site", "subnet_begin_offset", "subnet_end_offset" ] }, "default_gateway_v6": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default gateway v6.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address_ipv6", "disable_v6", "from_site_v6", "subnet_begin_offset_v6", "subnet_end_offset_v6" ] }, "disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address", "default_gateway", "external_connector", "from_site", "subnet_begin_offset", "subnet_end_offset" ] }, "disable_v6": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address_ipv6", "default_gateway_v6", "from_site_v6", "subnet_begin_offset_v6", "subnet_end_offset_v6" ] }, "external_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for external connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address", "default_gateway", "disable", "from_site", "subnet_begin_offset", "subnet_end_offset" ] }, "family_inet": { "allOf": [ { "$ref": "#/components/schemas/bgpFamilyInet" } ], "x-f5xc-description-short": "Configuration parameter for family inet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "from_site": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address", "default_gateway", "disable", "external_connector", "subnet_begin_offset", "subnet_end_offset" ] }, "from_site_v6": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address_ipv6", "default_gateway_v6", "disable_v6", "subnet_begin_offset_v6", "subnet_end_offset_v6" ] }, "interface": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "interface_list" ], "x-f5xc-references": [ { "resource_kind": "network_interface", "field_path": "interface", "gated_by": { "choice": "interface_choice" }, "required": false, "cardinality": "single" } ] }, "interface_list": { "allOf": [ { "$ref": "#/components/schemas/bgpInterfaceList" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "interface" ] }, "md5_auth_key": { "type": "string", "description": "Exclusive with [no_authentication]\nMD5 key for protecting BGP Sessions (RFC 2385)", "title": "md5_auth_key", "x-displayname": "MD5 Authentication Key.", "x-f5xc-description-short": "Exclusive with [no_authentication] MD5 key for protecting BGP Sessions (RFC 2385).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_authentication" ] }, "no_authentication": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no authentication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "md5_auth_key" ] }, "port": { "type": "integer", "description": "Peer TCP port number.", "title": "Peer Port", "format": "int64", "x-displayname": "Peer Port", "x-ves-example": "179", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "179", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "subnet_begin_offset": { "type": "integer", "description": "Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset]\nCalculate peer address using offset from the beginning of the subnet.", "title": "subnet_begin_offset", "format": "int64", "x-displayname": "Offset From Beginning Of Subnet.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset] Calculate peer address using offset from the...", "x-f5xc-description-medium": "Exclusive with [address default_gateway disable external_connector from_site subnet_end_offset] Calculate peer address using offset from the beginning of the subnet.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address", "default_gateway", "disable", "external_connector", "from_site", "subnet_end_offset" ] }, "subnet_begin_offset_v6": { "type": "integer", "description": "Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6]\nCalculate peer address using offset from the beginning of the subnet.", "title": "subnet_begin_offset_v6", "format": "int64", "x-displayname": "Offset From Beginning Of Subnet.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6] Calculate peer address using offset from the...", "x-f5xc-description-medium": "Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_end_offset_v6] Calculate peer address using offset from the beginning of the subnet.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address_ipv6", "default_gateway_v6", "disable_v6", "from_site_v6", "subnet_end_offset_v6" ] }, "subnet_end_offset": { "type": "integer", "description": "Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset]\nCalculate peer address using offset from the end of the subnet.", "title": "subnet_end_offset", "format": "int64", "x-displayname": "Offset From End Of Subnet.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset] Calculate peer address using offset from the end...", "x-f5xc-description-medium": "Exclusive with [address default_gateway disable external_connector from_site subnet_begin_offset] Calculate peer address using offset from the end of the subnet.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address", "default_gateway", "disable", "external_connector", "from_site", "subnet_begin_offset" ] }, "subnet_end_offset_v6": { "type": "integer", "description": "Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6]\nCalculate peer address using offset from the end of the subnet.", "title": "subnet_end_offset_v6", "format": "int64", "x-displayname": "Offset From End Of Subnet.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6] Calculate peer address using offset from the end...", "x-f5xc-description-medium": "Exclusive with [address_ipv6 default_gateway_v6 disable_v6 from_site_v6 subnet_begin_offset_v6] Calculate peer address using offset from the end of the subnet.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "address_ipv6", "default_gateway_v6", "disable_v6", "from_site_v6", "subnet_begin_offset_v6" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpPeerExternal", "required_fields": [ "asn", "port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"asn\": 1,\n \"port\": 1\n}", "example_yaml": "asn: 1\nport: 1" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpUnicastIPv4": { "type": "object", "description": "IPv4 Unicast.", "title": "UnicastIPv4", "x-displayname": "Unicast IPv4.", "x-ves-proto-message": "ves.io.schema.bgp.UnicastIPv4", "properties": { "aggregation": { "type": "array", "description": "BGP aggregation prefixes are shared among all peers, aggregation configured under any peer will take effect on all peers. Aggregation in BGP occurs only when more specific routes exist in the routing table and applies to outbound advertisements.", "title": "aggregation", "items": { "$ref": "#/components/schemas/bgpAggregationIPv4" }, "x-displayname": "Aggregation.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "BGP aggregation prefixes are shared among all peers, aggregation configured under any peer will take effect on all peers.", "x-f5xc-description-medium": "BGP aggregation prefixes are shared among all peers, aggregation configured under any peer will take effect on all peers. Aggregation in BGP occurs only when more specific routes exist in the routing table and applies to outbound advertisements.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpUnicastIPv4", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "fleetBGPConfiguration": { "type": "object", "description": "BGP configuration parameters.", "title": "BGP Configuration", "x-displayname": "BGP Configuration.", "x-ves-proto-message": "ves.io.schema.fleet.BGPConfiguration", "properties": { "asn": { "type": "integer", "description": "Autonomous System Number.", "title": "ASN", "format": "int64", "x-displayname": "ASN", "x-ves-example": "64512", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-example": "64512", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "peers": { "type": "array", "description": "BGP parameters for peer.", "title": "BGP Peers", "maxItems": 8, "items": { "$ref": "#/components/schemas/bgpPeer" }, "x-displayname": "Peers", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetBGPConfiguration", "required_fields": [ "asn" ], "mutually_exclusive_groups": [], "example_json": "{\n \"asn\": 1\n}", "example_yaml": "asn: 1" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetBondLacpType": { "type": "object", "description": "LACP parameters for the bond device.", "title": "LACP parameters", "x-displayname": "LACP parameters.", "x-ves-proto-message": "ves.io.schema.fleet.BondLacpType", "properties": { "rate": { "type": "integer", "description": "Interval in seconds to transmit LACP packets.", "title": "Interval", "format": "int64", "x-displayname": "LACP Packet Interval.", "x-ves-example": "30", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "30" }, "x-f5xc-example": "30", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "30" }, "x-f5xc-description-short": "Interval in seconds to transmit LACP packets.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 30, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetBondLacpType", "required_fields": [ "rate" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rate\": 1\n}", "example_yaml": "rate: 1" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetDeviceNetappBackendOntapSanChapType": { "type": "object", "description": "Device NetApp Backend ONTAP SAN CHAP configuration OPTIONS for enabled CHAP.", "title": "Device NetApp Backend ONTAP SAN CHAP configuration", "x-displayname": "Device NetApp Backend ONTAP SAN CHAP Configuration.", "x-ves-proto-message": "ves.io.schema.fleet.DeviceNetappBackendOntapSanChapType", "properties": { "chap_initiator_secret": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "chap_target_initiator_secret": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "chap_target_username": { "type": "string", "description": "Target username. Required if useCHAP=true.", "title": "CHAP Target Username", "minLength": 1, "maxLength": 256, "x-displayname": "CHAP Target Username.", "x-ves-example": "Bob", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "bob", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Target username. Required if useCHAP=true.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "chap_username": { "type": "string", "description": "Inbound username. Required if useCHAP=true.", "title": "CHAP Username", "minLength": 1, "maxLength": 256, "x-displayname": "CHAP Username.", "x-ves-example": "Alice", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "alice", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Inbound username. Required if useCHAP=true.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Device NetApp Backend ONTAP SAN CHAP configuration OPTIONS for enabled CHAP.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetDeviceNetappBackendOntapSanChapType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFlashArrayEndpoint": { "type": "object", "description": "For FlashArrays you must set the \"mgmt_endpoint\" and \"api_token\"", "title": "Flash Array Endpoint", "x-displayname": "Flash Array Endpoint.", "x-ves-oneof-field-mgmt_endpoint": "[\"mgmt_dns_name\",\"mgmt_ip\"]", "x-ves-proto-message": "ves.io.schema.fleet.FlashArrayEndpoint", "properties": { "api_token": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The labels are optional, and can be any key-value pair for use with the PSO \"fleet\" provisioner.", "title": "Labels", "x-displayname": "Labels", "x-ves-example": "{\"rack\": \"22\"}", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "\"{\"rack\"\"22\"}\"", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Specifies labels optional, and can be any key-value pair for use with the PSO \"fleet\" provisioner.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mgmt_dns_name": { "type": "string", "description": "Exclusive with [mgmt_ip]\nManagement Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "dns_name", "maxLength": 256, "x-displayname": "Management Endpoint Name.", "x-ves-example": "storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [mgmt_ip] Management Endpoint's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [mgmt_ip] Management Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mgmt_ip" ] }, "mgmt_ip": { "type": "string", "description": "Exclusive with [mgmt_dns_name]\nManagement Endpoint is reachable at the given IP address.", "title": "Management Endpoint IP Address", "x-displayname": "Management Endpoint IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mgmt_dns_name" ] } }, "x-f5xc-description-short": "For FlashArrays you must set the \"mgmt_endpoint\" and \"api_token\".", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFlashArrayEndpoint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFlashArrayType": { "type": "object", "description": "Specify what storage flash arrays should be managed the plugin.", "title": "Flash Arrays", "x-displayname": "Flash Arrays.", "x-ves-proto-message": "ves.io.schema.fleet.FlashArrayType", "properties": { "default_fs_opt": { "type": "string", "description": "Block volume default mkfs OPTIONS. Not recommended to change!", "title": "Default Filesystem Options", "minLength": 1, "maxLength": 128, "x-displayname": "Default Filesystem OPTIONS.", "x-ves-example": "-q", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "-q", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Block volume default mkfs OPTIONS. Not recommended to change!", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_fs_type": { "type": "string", "description": "Block volume default filesystem type. Not recommended to change!", "title": "Default Filesystem Type", "x-displayname": "Default Filesystem Type.", "x-ves-example": "Xfs", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"xfs\\\",\\\"ext4\\\"]" }, "x-f5xc-example": "xfs", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"xfs\\\",\\\"ext4\\\"]" }, "x-f5xc-description-short": "Block volume default filesystem type. Not recommended to change!", "maxLength": 1024, "enum": [ "xfs", "ext4" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "default_mount_opts": { "type": "array", "description": "Block volume default filesystem mount OPTIONS. Not recommended to change!", "title": "Default Mount Options", "maxItems": 4, "items": { "type": "string" }, "x-displayname": "Default Mount OPTIONS.", "x-ves-example": "[- discart]", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[- discart]", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Block volume default filesystem mount OPTIONS. Not recommended to change!", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disable_preempt_attachments": { "type": "boolean", "description": "Enable/Disable attachment preemption!", "title": "Disable Preempt Attachments", "format": "boolean", "x-displayname": "Disable Preempt Attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flash_arrays": { "type": "array", "description": "For FlashArrays you must set the \"mgmt_endpoint\" and \"api_token\"", "title": "Flash Arrays", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/fleetFlashArrayEndpoint" }, "x-displayname": "Flash Arrays.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "For FlashArrays you must set the \"mgmt_endpoint\" and \"api_token\".", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "iscsi_login_timeout": { "type": "integer", "description": "ISCSI login timeout in seconds. Not recommended to change!", "title": "iSCSI Login Timeout", "format": "int32", "x-displayname": "ISCSI Login Timeout.", "x-ves-example": "20", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-example": "20", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-description-short": "ISCSI login timeout in seconds. Not recommended to change!", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 100, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "san_type": { "type": "string", "description": "Block volume access protocol, either ISCSI or FC.", "title": "SAN Type", "x-displayname": "SAN Type", "x-ves-example": "ISCSI", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ISCSI\\\",\\\"FC\\\"]" }, "x-f5xc-example": "ISCSI", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ISCSI\\\",\\\"FC\\\"]" }, "x-f5xc-description-short": "Block volume access protocol, either ISCSI or FC.", "maxLength": 1024, "enum": [ "ISCSI", "FC" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Specify what storage flash arrays should be managed the plugin.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFlashArrayType", "required_fields": [ "default_fs_type", "flash_arrays", "iscsi_login_timeout", "san_type" ], "mutually_exclusive_groups": [], "example_json": "{\n \"default_fs_type\": \"xfs\",\n \"flash_arrays\": [\n {}\n ],\n \"iscsi_login_timeout\": 1,\n \"san_type\": \"ISCSI\"\n}", "example_yaml": "default_fs_type: xfs\nflash_arrays:\n- {}\niscsi_login_timeout: 1\nsan_type: ISCSI" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFlashBladeEndpoint": { "type": "object", "description": "For FlashBlades you must set the \"mgmt_endpoint\", \"api_token\" and nfs_endpoint.", "title": "Flash Blade Endpoint", "x-displayname": "Flash Blade Endpoint.", "x-ves-oneof-field-mgmt_endpoint": "[\"mgmt_dns_name\",\"mgmt_ip\"]", "x-ves-oneof-field-nfs_endpoint": "[\"nfs_endpoint_dns_name\",\"nfs_endpoint_ip\"]", "x-ves-proto-message": "ves.io.schema.fleet.FlashBladeEndpoint", "properties": { "api_token": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The labels are optional, and can be any key-value pair for use with the PSO \"fleet\" provisioner.", "title": "Labels", "x-displayname": "Labels", "x-ves-example": "{\"rack\": \"22\"}", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "\"{\"rack\"\"22\"}\"", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Specifies labels optional, and can be any key-value pair for use with the PSO \"fleet\" provisioner.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mgmt_dns_name": { "type": "string", "description": "Exclusive with [mgmt_ip]\nManagement Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "dns_name", "maxLength": 256, "x-displayname": "Management Endpoint Name.", "x-ves-example": "storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [mgmt_ip] Management Endpoint's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [mgmt_ip] Management Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mgmt_ip" ] }, "mgmt_ip": { "type": "string", "description": "Exclusive with [mgmt_dns_name]\nManagement Endpoint is reachable at the given IP address.", "title": "Management Endpoint IP Address", "x-displayname": "Management Endpoint IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [mgmt_dns_name] Management Endpoint is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mgmt_dns_name" ] }, "nfs_endpoint_dns_name": { "type": "string", "description": "Exclusive with [nfs_endpoint_ip]\nEndpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "NFS DNS Name", "maxLength": 256, "x-displayname": "NFS DNS Name.", "x-ves-example": "nfs.storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "nfs.storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [nfs_endpoint_ip] Endpoint's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [nfs_endpoint_ip] Endpoint's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nfs_endpoint_ip" ] }, "nfs_endpoint_ip": { "type": "string", "description": "Exclusive with [nfs_endpoint_dns_name]\nEndpoint is reachable at the given IP address.", "title": "NFS IP Address", "x-displayname": "NFS IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [nfs_endpoint_dns_name] Endpoint is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "nfs_endpoint_dns_name" ] } }, "x-f5xc-description-short": "For FlashBlades you must set the \"mgmt_endpoint\", \"api_token\" and nfs_endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFlashBladeEndpoint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFlashBladeType": { "type": "object", "description": "Specify what storage flash blades should be managed the plugin.", "title": "Flash Blades", "x-displayname": "Flash Blades.", "x-ves-proto-message": "ves.io.schema.fleet.FlashBladeType", "properties": { "enable_snapshot_directory": { "type": "boolean", "description": "Enable/Disable FlashBlade snapshots.", "title": "Enable Snapshot Directory", "format": "boolean", "x-displayname": "Enable Snapshot Directory.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "export_rules": { "type": "string", "description": "NFS Export rules.", "title": "NFS Export Rules", "minLength": 1, "maxLength": 250, "x-displayname": "NFS Export Rules.", "x-ves-example": "*(rw,no_root_squash)", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "250", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "*(rw,no_root_squash)", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "250", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 250, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flash_blades": { "type": "array", "description": "For FlashBlades you must set the \"mgmt_endpoint\", \"api_token\" and nfs_endpoint.", "title": "Flash Blades", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/fleetFlashBladeEndpoint" }, "x-displayname": "Flash Blades.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "For FlashBlades you must set the \"mgmt_endpoint\", \"api_token\" and nfs_endpoint.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Specify what storage flash blades should be managed the plugin.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFlashBladeType", "required_fields": [ "flash_blades" ], "mutually_exclusive_groups": [], "example_json": "{\n \"flash_blades\": [\n {}\n ]\n}", "example_yaml": "flash_blades:\n- {}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFleetBondDeviceType": { "type": "object", "description": "Bond devices configuration for fleet.", "title": "Bond Device", "x-displayname": "Bond Device.", "x-ves-oneof-field-lacp_choice": "[\"active_backup\",\"lacp\"]", "x-ves-proto-message": "ves.io.schema.fleet.FleetBondDeviceType", "properties": { "active_backup": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for active backup.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "lacp" ] }, "devices": { "type": "array", "description": "Ethernet devices that will make up this bond.", "title": "Member Ethernet Devices", "minItems": 1, "maxItems": 8, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "Member Ethernet Devices.", "x-ves-example": "Eth0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "64", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "eth0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "64", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Ethernet devices that will make up this bond.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "lacp": { "allOf": [ { "$ref": "#/components/schemas/fleetBondLacpType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_backup" ] }, "link_polling_interval": { "type": "integer", "description": "Link polling interval in milliseconds.", "title": "Link Polling Interval", "format": "int64", "x-displayname": "Link Polling Interval.", "x-ves-example": "1000", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "500", "ves.io.schema.rules.uint32.lte": "5000" }, "x-f5xc-example": "1000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "500", "ves.io.schema.rules.uint32.lte": "5000" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 500, "maximum": 5000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "link_up_delay": { "type": "integer", "description": "Milliseconds wait before link is declared up.", "title": "Link Up Delay", "format": "int64", "x-displayname": "Link Up Delay.", "x-ves-example": "200", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "1000" }, "x-f5xc-example": "200", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "1000" }, "x-f5xc-description-short": "Milliseconds wait before link is declared up.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 1000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "Name for the Bond. Ex 'bond0'", "title": "Bond Device", "maxLength": 64, "x-displayname": "Bond Device Name.", "x-ves-example": "Bond0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "bond0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFleetBondDeviceType", "required_fields": [ "devices", "link_polling_interval", "link_up_delay", "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"devices\": [\n \"value\"\n ],\n \"link_polling_interval\": 500,\n \"link_up_delay\": 0,\n \"name\": \"bond0\"\n}", "example_yaml": "devices:\n- value\nlink_polling_interval: 500\nlink_up_delay: 0\nname: bond0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFleetBondDevicesListType": { "type": "object", "description": "List of bond devices for this fleet.", "title": "Bond Devices List", "x-displayname": "Bond Devices List.", "x-ves-proto-message": "ves.io.schema.fleet.FleetBondDevicesListType", "properties": { "bond_devices": { "type": "array", "description": "List of bond devices.", "title": "Bond Devices List", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/fleetFleetBondDeviceType" }, "x-displayname": "Bond Devices.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFleetBondDevicesListType", "required_fields": [ "bond_devices" ], "mutually_exclusive_groups": [], "example_json": "{\n \"bond_devices\": [\n {\n \"devices\": [\n \"value\"\n ],\n \"link_polling_interval\": 500,\n \"link_up_delay\": 0,\n \"name\": \"bond0\"\n }\n ]\n}", "example_yaml": "bond_devices:\n- devices:\n - value\n link_polling_interval: 500\n link_up_delay: 0\n name: bond0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFleetStorageClassListType": { "type": "object", "description": "Add additional custom storage classes in Kubernetes for this fleet.", "title": "Custom Storage Class List", "x-displayname": "Custom Storage Class List.", "x-ves-proto-message": "ves.io.schema.fleet.FleetStorageClassListType", "properties": { "storage_classes": { "type": "array", "description": "List of custom storage classes.", "title": "List of Storage Classes", "maxItems": 4, "items": { "$ref": "#/components/schemas/fleetFleetStorageClassType" }, "x-displayname": "List of Storage Classes.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Add additional custom storage classes in Kubernetes for this fleet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFleetStorageClassListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFleetStorageClassType": { "type": "object", "description": "Configuration of custom storage class.", "title": "Custom Storage Class", "x-displayname": "Custom Storage Class.", "x-ves-oneof-field-device_choice": "[\"custom_storage\",\"hpe_storage\",\"netapp_trident\",\"pure_service_orchestrator\"]", "x-ves-proto-message": "ves.io.schema.fleet.FleetStorageClassType", "properties": { "advanced_storage_parameters": { "type": "object", "description": "Map of parameter name and string value.", "title": "Advanced Parameters", "x-displayname": "Advanced Parameters.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allow_volume_expansion": { "type": "boolean", "description": "Allow volume expansion.", "title": "Allow Volume Expansion", "format": "boolean", "x-displayname": "Allow Volume Expansion.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_storage": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageClassCustomType" } ], "x-f5xc-description-short": "Configuration parameter for custom storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hpe_storage", "netapp_trident", "pure_service_orchestrator" ] }, "default_storage_class": { "type": "boolean", "description": "Make this storage class default storage class for the K8s cluster.", "title": "Default Storage Class", "format": "boolean", "x-displayname": "Default Storage Class.", "x-f5xc-description-short": "Make this storage class default storage class for the K8s cluster.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Description for this storage class.", "title": "Storage Class Description", "maxLength": 256, "x-displayname": "Storage Class Description.", "x-ves-example": "Volume from example fast storage.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "Volume from example fast storage", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "hpe_storage": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageClassHpeStorageType" } ], "x-f5xc-description-short": "Configuration parameter for hpe storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage", "netapp_trident", "pure_service_orchestrator" ] }, "netapp_trident": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageClassNetappTridentType" } ], "x-f5xc-description-short": "Configuration parameter for netapp trident.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage", "hpe_storage", "pure_service_orchestrator" ] }, "pure_service_orchestrator": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageClassPureServiceOrchestratorType" } ], "x-f5xc-description-short": "Configuration parameter for pure service orchestrator.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage", "hpe_storage", "netapp_trident" ] }, "reclaim_policy": { "type": "string", "description": "Reclaim Policy.", "title": "Reclaim Policy", "maxLength": 16, "x-displayname": "Reclaim Policy.", "x-ves-example": "DELETE", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "Delete", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_class_name": { "type": "string", "description": "Name of the storage class as it will appear in K8s.", "title": "Storage Class Name", "x-displayname": "Storage Class Name.", "x-ves-example": "Premium", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "premium", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name of the storage class as it will appear in K8s.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "storage_device": { "type": "string", "description": "Storage device that this class will use. The Device name defined at previous step.", "title": "Storage Device", "minLength": 1, "maxLength": 64, "x-displayname": "Storage Device.", "x-ves-example": "DellEMC-isilon_F800-0.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "DellEMC-isilon_F800-0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Storage device that this class will use. The Device name defined at previous step.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "byteLength": { "max": 64, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFleetStorageClassType", "required_fields": [ "storage_class_name", "storage_device" ], "mutually_exclusive_groups": [], "example_json": "{\n \"storage_class_name\": \"premium\",\n \"storage_device\": \"DellEMC-isilon_F800-0\"\n}", "example_yaml": "storage_class_name: premium\nstorage_device: DellEMC-isilon_F800-0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFleetStorageDeviceListType": { "type": "object", "description": "Add additional custom storage classes in Kubernetes for this fleet.", "title": "Custom Storage Device List", "x-displayname": "Custom Storage Device List.", "x-ves-proto-message": "ves.io.schema.fleet.FleetStorageDeviceListType", "properties": { "storage_devices": { "type": "array", "description": "List of custom storage devices.", "title": "List of Storage Devices", "maxItems": 4, "items": { "$ref": "#/components/schemas/fleetFleetStorageDeviceType" }, "x-displayname": "List of Storage Devices.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Add additional custom storage classes in Kubernetes for this fleet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFleetStorageDeviceListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetFleetStorageDeviceType": { "type": "object", "description": "Configuration of storage device.", "title": "Storage Device", "x-displayname": "Storage Device.", "x-ves-oneof-field-device_choice": "[\"custom_storage\",\"hpe_storage\",\"netapp_trident\",\"pure_service_orchestrator\"]", "x-ves-proto-message": "ves.io.schema.fleet.FleetStorageDeviceType", "properties": { "advanced_advanced_parameters": { "type": "object", "description": "Map of parameter name and string value.", "title": "Advanced Parameters", "x-displayname": "Advanced Parameters.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_storage": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for custom storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hpe_storage", "netapp_trident", "pure_service_orchestrator" ] }, "hpe_storage": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageDeviceHpeStorageType" } ], "x-f5xc-description-short": "Configuration parameter for hpe storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage", "netapp_trident", "pure_service_orchestrator" ] }, "netapp_trident": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageDeviceNetappTridentType" } ], "x-f5xc-description-short": "Configuration parameter for netapp trident.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage", "hpe_storage", "pure_service_orchestrator" ] }, "pure_service_orchestrator": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageDevicePureStorageServiceOrchestratorType" } ], "x-f5xc-description-short": "Configuration parameter for pure service orchestrator.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage", "hpe_storage", "netapp_trident" ] }, "storage_device": { "type": "string", "description": "Storage device and device unit.", "title": "Storage Device", "maxLength": 64, "x-displayname": "Storage Device.", "x-ves-example": "DellEMC-isilon-F800-0.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "DellEMC-isilon-F800-0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetFleetStorageDeviceType", "required_fields": [ "storage_device" ], "mutually_exclusive_groups": [], "example_json": "{\n \"storage_device\": \"DellEMC-isilon-F800-0\"\n}", "example_yaml": "storage_device: DellEMC-isilon-F800-0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetLocalControlPlaneType": { "type": "object", "description": "Enable local control plane for L3VPN, SRV6, EVPN etc.", "title": "Local Control Plane", "x-displayname": "Local Control Plane.", "x-ves-oneof-field-network_choice": "[\"inside_vn\",\"outside_vn\"]", "x-ves-proto-message": "ves.io.schema.fleet.LocalControlPlaneType", "properties": { "bgp_config": { "allOf": [ { "$ref": "#/components/schemas/fleetBGPConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vn": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_vn" ] }, "outside_vn": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_vn" ] } }, "x-f5xc-description-short": "Enable local control plane for L3VPN, SRV6, EVPN etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetLocalControlPlaneType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetOntapVirtualStoragePoolType": { "type": "object", "description": "ONTAP Virtual Storage Pool definition.", "title": "Backend ONTAP Virtual Storage Pool", "x-displayname": "Backend ONTAP Virtual Storage Pool.", "x-ves-proto-message": "ves.io.schema.fleet.OntapVirtualStoragePoolType", "properties": { "labels": { "type": "object", "description": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.", "title": "Storage Pool Labels", "x-displayname": "Storage Pool Labels.", "x-ves-example": "{\"department\":\"finance\", \"creditpoints\":\"6000\"}", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "\"{\"department\":\"finance\", \"creditpoints\":\"6000\"}\"", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.", "x-f5xc-description-medium": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class label match selection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volume_defaults": { "allOf": [ { "$ref": "#/components/schemas/fleetOntapVolumeDefaults" } ], "x-f5xc-description-short": "Configuration parameter for volume defaults.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "zone": { "type": "string", "description": "Virtual Storage Pool zone definition.", "title": "Pool Zone", "x-displayname": "Virtual Pool Zone.", "x-ves-example": "Us_east_1b.", "x-f5xc-example": "us_east_1b", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetOntapVirtualStoragePoolType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetOntapVolumeDefaults": { "type": "object", "description": "It controls how each volume is provisioned by default using these OPTIONS in a special section of the configuration.", "title": "Backend OnTap Volume Defaults", "x-displayname": "Backend OnTap Volume Defaults.", "x-ves-oneof-field-qos_policy_choice": "[\"adaptive_qos_policy\",\"no_qos\",\"qos_policy\"]", "x-ves-proto-message": "ves.io.schema.fleet.OntapVolumeDefaults", "properties": { "adaptive_qos_policy": { "type": "string", "description": "Exclusive with [no_qos qos_policy]\nEnter Adaptive QoS Policy Name.", "title": "Storage Server IP address", "minLength": 1, "maxLength": 128, "x-displayname": "Adaptive QoS Policy name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_qos", "qos_policy" ] }, "encryption": { "type": "boolean", "description": "Enable NetApp volume encryption.", "title": "Enable Encryption", "format": "boolean", "x-displayname": "Enable Encryption.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "export_policy": { "type": "string", "description": "Export policy to use.", "title": "Export Policy", "x-displayname": "Export Policy.", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Policy configuration for this feature.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_qos": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adaptive_qos_policy", "qos_policy" ] }, "qos_policy": { "type": "string", "description": "Exclusive with [adaptive_qos_policy no_qos]\nEnter QoS Policy Name.", "title": "QoS Policy Name", "minLength": 1, "maxLength": 128, "x-displayname": "QoS Policy Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adaptive_qos_policy", "no_qos" ] }, "security_style": { "type": "string", "description": "Security style for new volumes.", "title": "Security Style", "x-displayname": "Security Style.", "x-ves-example": "Unix", "x-f5xc-example": "unix", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "snapshot_dir": { "type": "boolean", "description": "Access to the .snapshot directory.", "title": "Access to Snapshot Directory", "format": "boolean", "x-displayname": "Access to Snapshot Directory.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "snapshot_policy": { "type": "string", "description": "Snapshot policy to use.", "title": "Snapshot Policy", "x-displayname": "Snapshot Policy.", "x-ves-example": "None", "x-f5xc-example": "none", "x-f5xc-description-short": "Policy configuration for this feature.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "snapshot_reserve": { "type": "string", "description": "Percentage of volume reserved for snapshots. \"0\" if snapshot policy is \"none\", else \"\"", "title": "Snapshot Rerserved", "x-displayname": "Snapshot Reserved.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Percentage of volume reserved for snapshots. \"0\" if snapshot policy is \"none\", else \"\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "space_reserve": { "type": "string", "description": "Space reservation mode; “none” (thin) or “volume” (thick)", "title": "Space Reservation Mode", "x-displayname": "Space Reservation Mode.", "x-ves-example": "Thick", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"none\\\",\\\"thick\\\"]" }, "x-f5xc-example": "thick", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"none\\\",\\\"thick\\\"]" }, "x-f5xc-description-short": "Space reservation mode; “none” (thin) or “volume” (thick).", "maxLength": 1024, "enum": [ "none", "thick" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "split_on_clone": { "type": "boolean", "description": "Split a clone from its parent upon creation.", "title": "Split on Clone", "format": "boolean", "x-displayname": "Split on Clone.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "Split a clone from its parent upon creation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tiering_policy": { "type": "string", "description": "Tiering policy to use. \"none\" is default.", "title": "Tiering Policy", "x-displayname": "Tiering Policy.", "x-ves-example": "Snapshot-only.", "x-f5xc-example": "snapshot-only", "x-f5xc-description-short": "Policy configuration for this feature.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unix_permissions": { "type": "integer", "description": "Unix permission mode for new volumes. All allowed 777.", "title": "Unix Mode Permissions", "format": "int32", "x-displayname": "Unix Mode Permissions.", "x-ves-example": "777", "x-f5xc-example": "777", "x-f5xc-description-short": "Unix permission mode for new volumes. All allowed 777.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "It controls how each volume is provisioned by default using these OPTIONS in a special section of the configuration.", "x-f5xc-description-medium": "It controls how each volume is provisioned by default using these OPTIONS in a special section of the configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetOntapVolumeDefaults", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetPsoArrayConfiguration": { "type": "object", "description": "Device configuration for PSO Arrays.", "title": "Arrays Configuration", "x-displayname": "Arrays Configuration.", "x-ves-proto-message": "ves.io.schema.fleet.PsoArrayConfiguration", "properties": { "flash_array": { "allOf": [ { "$ref": "#/components/schemas/fleetFlashArrayType" } ], "x-f5xc-description-short": "Configuration parameter for flash array.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flash_blade": { "allOf": [ { "$ref": "#/components/schemas/fleetFlashBladeType" } ], "x-f5xc-description-short": "Configuration parameter for flash blade.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetPsoArrayConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetSriovInterface": { "type": "object", "description": "Single Root I/O Virtualization interfaces configured explicitly\nBy default no SR-IOV interface is assigned to the fleet.", "title": "SriovInterface specifies the configuration for SR-IOV interfaces and how many virtual functions it has", "x-displayname": "SR-IOV Interfaces.", "x-ves-proto-message": "ves.io.schema.fleet.SriovInterface", "properties": { "interface_name": { "type": "string", "description": "Name of SR-IOV physical interface.", "title": "interface_name", "x-displayname": "Name of physical interface.", "x-ves-example": "Eth0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "eth0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "number_of_vfio_vfs": { "type": "integer", "description": "Number of virtual functions reserved for VNFs and DPDK-based CNFs.", "title": "number_of_vfio_vfs", "format": "int64", "x-displayname": "Number of virtual functions reserved for vfio.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Number of virtual functions reserved for VNFs and DPDK-based CNFs.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "number_of_vfs": { "type": "integer", "description": "Total number of virtual functions.", "title": "number_of_vfs", "format": "int64", "x-displayname": "Total number of virtual functions.", "x-ves-example": "3", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "3", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.", "x-f5xc-description-medium": "Single Root I/O Virtualization interfaces configured explicitly By default no SR-IOV interface is assigned to the fleet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetSriovInterface", "required_fields": [ "interface_name", "number_of_vfs" ], "mutually_exclusive_groups": [], "example_json": "{\n \"interface_name\": \"eth0\",\n \"number_of_vfs\": 0\n}", "example_yaml": "interface_name: eth0\nnumber_of_vfs: 0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetSriovInterfacesListType": { "type": "object", "description": "List of all custom SR-IOV interfaces configuration.", "title": "Custom SR-IOV interfaces Configuration List", "x-displayname": "Custom SR-IOV interfaces Configuration List.", "x-ves-proto-message": "ves.io.schema.fleet.SriovInterfacesListType", "properties": { "sriov_interface": { "type": "array", "description": "Use custom SR-IOV interfaces Configuration.", "title": "Custom SR-IOV interfaces Configuration", "items": { "$ref": "#/components/schemas/fleetSriovInterface" }, "x-displayname": "Custom SR-IOV interfaces Configuration.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Use custom SR-IOV interfaces Configuration.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of all custom SR-IOV interfaces configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetSriovInterfacesListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageClassCustomType": { "type": "object", "description": "Custom Storage Class allows to insert Kubernetes storageclass definition which will be applied into given site.", "title": "Custom StorageClass", "x-displayname": "Custom StorageClass.", "x-ves-proto-message": "ves.io.schema.fleet.StorageClassCustomType", "properties": { "yaml": { "type": "string", "description": "K8s YAML for StorageClass.", "title": "Storage Class YAML", "maxLength": 4096, "x-displayname": "Storage Class YAML.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "minLength": 1, "formatDescription": "Valid parseable YAML", "validation": { "customRule": "Must be valid YAML" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "format": "uri" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Custom Storage Class allows to insert Kubernetes storageclass definition which will be applied into given site.", "x-f5xc-description-medium": "Custom Storage Class allows to insert Kubernetes storageclass definition which will be applied into given site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageClassCustomType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageClassHpeStorageType": { "type": "object", "description": "Storage class Device configuration for HPE Storage.", "title": "HPE Storage", "x-displayname": "HPE Storage.", "x-ves-proto-message": "ves.io.schema.fleet.StorageClassHpeStorageType", "properties": { "allow_mutations": { "type": "string", "description": "Mutation can override specified parameters.", "title": "allowMutations", "maxLength": 256, "x-displayname": "AllowMutations.", "x-ves-example": "Description,limitIops.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "description,limitIops", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Mutation can override specified parameters.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allow_overrides": { "type": "string", "description": "PVC can override specified parameters.", "title": "allowOverrides", "maxLength": 256, "x-displayname": "AllowOverrides.", "x-ves-example": "Description,limitIops.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "description,limitIops", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dedupe_enabled": { "type": "boolean", "description": "Indicates that the volume should enable deduplication.", "title": "dedupeEnabled", "format": "boolean", "x-displayname": "DedupeEnabled.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Indicates that the volume should enable deduplication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The SecretName parameter is used to identify name of secret to identify backend storage's auth information.", "title": "Description", "maxLength": 512, "x-displayname": "Description.", "x-ves-example": "Volume created by using a default Secret with the HPE CSI Driver for Kubernetes.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "Volume created by using a default Secret with the HPE CSI Driver for Kubernetes", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "The SecretName parameter is used to identify name of secret to identify backend storage's auth information.", "x-f5xc-description-medium": "The SecretName parameter is used to identify name of secret to identify backend storage's auth information.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "destroy_on_delete": { "type": "boolean", "description": "Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.", "title": "destroyOnDelete", "format": "boolean", "x-displayname": "DestroyOnDelete.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.", "x-f5xc-description-medium": "Indicates the backing Nimble volume (including snapshots) should be destroyed when the PVC is deleted.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "encrypted": { "type": "boolean", "description": "Indicates that the volume should be encrypted.", "title": "encrypted", "format": "boolean", "x-displayname": "Encrypted", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "Indicates that the volume should be encrypted.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "folder": { "type": "string", "description": "The name of the folder in which to place the volume.", "title": "folder", "maxLength": 128, "x-displayname": "Folder", "x-ves-example": "Default", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "The name of the folder in which to place the volume.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit_iops": { "type": "string", "description": "The IOPS limit of the volume.", "title": "limitIops", "format": "int64", "x-displayname": "LimitIops", "x-ves-example": "-1", "x-f5xc-example": "-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit_mbps": { "type": "string", "description": "The IOPS limit of the volume.", "title": "limitMbps", "format": "int64", "x-displayname": "LimitMbps", "x-ves-example": "-1", "x-f5xc-example": "-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_policy": { "type": "string", "description": "The name of the performance policy to assign to the volume.", "title": "performancePolicy", "maxLength": 128, "x-displayname": "PerformancePolicy.", "x-ves-example": "Default", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool": { "type": "string", "description": "The name of the pool in which to place the volume.", "title": "pool", "maxLength": 128, "x-displayname": "Pool", "x-ves-example": "Default", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "The name of the pool in which to place the volume.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protection_template": { "type": "string", "description": "The name of the performance policy to assign to the volume.", "title": "protectionTemplate", "maxLength": 128, "x-displayname": "ProtectionTemplate.", "x-ves-example": "Retain-30Daily.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "Retain-30Daily", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "The name of the performance policy to assign to the volume.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secret_name": { "type": "string", "description": "The SecretName parameter is used to identify name of secret to identify backend storage's auth information.", "title": "Secret Name", "maxLength": 256, "x-displayname": "Secret Name.", "x-ves-example": "Hpe-backend.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "The SecretName parameter is used to identify name of secret to identify backend storage's auth information.", "x-f5xc-description-medium": "The SecretName parameter is used to identify name of secret to identify backend storage's auth information.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secret_namespace": { "type": "string", "description": "The SecretNamespace parameter is used to identify name of namespace where secret resides.", "title": "Secret Namespace", "maxLength": 256, "x-displayname": "Secret Namespace.", "x-ves-example": "Hpe-storage.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "The SecretNamespace parameter is used to identify name of namespace where secret resides.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_on_detach": { "type": "boolean", "description": "Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.", "title": "syncOnDetach", "format": "boolean", "x-displayname": "SyncOnDetach.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.", "x-f5xc-description-medium": "Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "thick": { "type": "boolean", "description": "Indicates that the volume should be thick provisioned.", "title": "thick", "format": "boolean", "x-displayname": "Thick", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "Indicates that the volume should be thick provisioned.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Storage class Device configuration for HPE Storage.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageClassHpeStorageType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageClassNetappTridentType": { "type": "object", "description": "Storage class Device configuration for NetApp Trident.", "title": "NetApp Trident Storage", "x-displayname": "NetApp Trident Storage.", "x-ves-proto-message": "ves.io.schema.fleet.StorageClassNetappTridentType", "properties": { "selector": { "type": "object", "description": "Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume.\nThe volume will have the aspects defined in the chosen virtual pool.", "title": "Selector", "x-displayname": "Selector", "x-ves-example": "Protection=silver; creditpoints=20000.", "x-f5xc-example": "protection=silver; creditpoints=20000", "x-f5xc-description-short": "Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume.", "x-f5xc-description-medium": "Using the Selector field, each StorageClass calls out which virtual pool(s) may be used to host a volume. The volume will have the aspects defined in the chosen virtual pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_pools": { "type": "string", "description": "The storagePools parameter is used to further restrict the set of pools that match any specified attributes.", "title": "Storage Pools", "maxLength": 512, "x-displayname": "Storage Pools.", "x-ves-example": "Backend-name1:.*;backend-name2:storagePoolListName.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "backend-name1:.*;backend-name2:storagePoolListName", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "The storagePools parameter is used to further restrict the set of pools that match any specified attributes.", "x-f5xc-description-medium": "The storagePools parameter is used to further restrict the set of pools that match any specified attributes.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Storage class Device configuration for NetApp Trident.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageClassNetappTridentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageClassPureServiceOrchestratorType": { "type": "object", "description": "Storage class Device configuration for Pure Service Orchestrator.", "title": "Pure Storage Service Orchestrator", "x-displayname": "Pure Storage Service Orchestrator.", "x-ves-proto-message": "ves.io.schema.fleet.StorageClassPureServiceOrchestratorType", "properties": { "backend": { "type": "string", "description": "Defines type of Pure storage backend block or file.\nThe volume will have the aspects defined in the chosen virtual pool.", "title": "Backend", "x-displayname": "Backend", "x-ves-example": "Block", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"block\\\",\\\"file\\\"]" }, "x-f5xc-example": "block", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"block\\\",\\\"file\\\"]" }, "x-f5xc-description-short": "Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.", "x-f5xc-description-medium": "Defines type of Pure storage backend block or file. The volume will have the aspects defined in the chosen virtual pool.", "maxLength": 1024, "enum": [ "block", "file" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bandwidth_limit": { "type": "string", "description": "It must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes must be multiple of 512) or number with a single character unit symbol.\nValid unit symbols are K, M, G, representing KiB, MiB, and GiB.", "title": "Bandwidth Limit", "maxLength": 12, "x-displayname": "Bandwidth Limit.", "x-ves-example": "1G", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "12" }, "x-f5xc-example": "1G", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "12" }, "x-f5xc-description-short": "It must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes must be multiple of 512) or number with a single character unit symbol.", "x-f5xc-description-medium": "It must be between 1 MB/s and 512 GB/s. Enter the size as a number (bytes must be multiple of 512) or number with a single character unit symbol. Valid unit symbols are K, M, G, representing KiB, MiB, and GiB.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 12, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iops_limit": { "type": "integer", "description": "Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.", "title": "IOPS Limit", "format": "int64", "x-displayname": "IOPS Limit.", "x-ves-example": "3000", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,100-100000000" }, "x-f5xc-example": "3000", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,100-100000000" }, "x-f5xc-description-short": "Enable IOPS limitation. It must be between 100 and 100 million.", "x-f5xc-description-medium": "Enable IOPS limitation. It must be between 100 and 100 million. If value is 0, IOPS limit is not defined.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 100000000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Storage class Device configuration for Pure Service Orchestrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageClassPureServiceOrchestratorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageDeviceHpeStorageType": { "type": "object", "description": "Device configuration for HPE Storage.", "title": "HPE Storage", "x-displayname": "HPE Storage.", "x-ves-proto-message": "ves.io.schema.fleet.StorageDeviceHpeStorageType", "properties": { "api_server_port": { "type": "integer", "description": "Enter Storage Server Port.", "title": "Storage server Port", "format": "int64", "x-displayname": "Storage server Port.", "x-ves-example": "8080", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "iscsi_chap_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for iscsi chap password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iscsi_chap_user": { "type": "string", "description": "Chap Username to connect to the HPE storage.", "title": "iscsi chapUser", "maxLength": 256, "x-displayname": "Iscsi chapUser.", "x-ves-example": "Admin", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "admin", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Chap Username to connect to the HPE storage.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_server_ip_address": { "type": "string", "description": "Enter storage server IP address.", "title": "Storage Server IP address", "x-displayname": "Storage Server IP address.", "x-ves-example": "192.0.2.108.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.108", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_server_name": { "type": "string", "description": "Enter storage server Name.", "title": "Storage Server Name", "x-displayname": "Storage Server Name.", "x-ves-example": "Hpe-backend.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "hpe-backend", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "username": { "type": "string", "description": "Username to connect to the HPE storage management IP.", "title": "Username", "minLength": 1, "maxLength": 256, "x-displayname": "Username", "x-ves-example": "Admin", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "admin", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Username to connect to the HPE storage management IP.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageDeviceHpeStorageType", "required_fields": [ "api_server_port", "username" ], "mutually_exclusive_groups": [], "example_json": "{\n \"api_server_port\": 1,\n \"username\": \"admin\"\n}", "example_yaml": "api_server_port: 1\nusername: admin" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageDeviceNetappBackendOntapNasType": { "type": "object", "description": "Configuration of storage backend for NetApp ONTAP NAS.", "title": "Storage Backend NetApp ONTAP NAS", "x-displayname": "Storage Backend NetApp ONTAP NAS.", "x-ves-oneof-field-data_lif": "[\"data_lif_dns_name\",\"data_lif_ip\"]", "x-ves-oneof-field-management_lif": "[\"management_lif_dns_name\",\"management_lif_ip\"]", "x-ves-proto-message": "ves.io.schema.fleet.StorageDeviceNetappBackendOntapNasType", "properties": { "auto_export_cidrs": { "allOf": [ { "$ref": "#/components/schemas/viewsPrefixStringListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "auto_export_policy": { "type": "boolean", "description": "Enable automatic export policy creation and updating.", "title": "Auto Export Policy", "format": "boolean", "x-displayname": "Auto Export Policy.", "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "backend_name": { "type": "string", "description": "Configuration of Backend Name. Driver is name + \"_\" + dataLIF.", "title": "Storage Backend Name", "minLength": 1, "maxLength": 50, "x-displayname": "Storage Backend Name.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "50", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "50", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Configuration of Backend Name. Driver is name + \"_\" + dataLIF.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 50, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_certificate": { "type": "string", "description": "Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.", "title": "Client Certificate", "maxLength": 8192, "x-displayname": "Client Certificate.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-description-short": "Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_private_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data_lif_dns_name": { "type": "string", "description": "Exclusive with [data_lif_ip]\nBackend Data LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "Backend Data LIF Name", "maxLength": 256, "x-displayname": "Backend Data LIF Name.", "x-ves-example": "storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [data_lif_ip] Backend Data LIF IP Address's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [data_lif_ip] Backend Data LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_lif_ip" ] }, "data_lif_ip": { "type": "string", "description": "Exclusive with [data_lif_dns_name]\nBackend Data LIF IP Address is reachable at the given IP address.", "title": "Backend Data LIF IP Address", "x-displayname": "Backend Data LIF IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.", "x-f5xc-description-medium": "Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_lif_dns_name" ] }, "labels": { "type": "object", "description": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.", "title": "Backend Labels", "x-displayname": "Backend Labels.", "x-ves-example": "{\"store\":\"nas_store\"}", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "\"{\"store\":\"nas_store\"}\"", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit_aggregate_usage": { "type": "string", "description": "Fail provisioning if usage is above this percentage. Not enforced by default.", "title": "Limit Aggregate Usage", "x-displayname": "Limit Aggregate Usage.", "x-ves-example": "80%", "x-f5xc-example": "80%", "x-f5xc-description-short": "Fail provisioning if usage is above this percentage. Not enforced by default.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit_volume_size": { "type": "string", "description": "Fail provisioning if requested volume size is above this value. Not enforced by default.", "title": "Limit Volume Size", "x-displayname": "Limit Volume Size.", "x-ves-example": "50Gi", "x-f5xc-example": "50Gi", "x-f5xc-description-short": "Fail provisioning if requested volume size is above this value. Not enforced by default.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "management_lif_dns_name": { "type": "string", "description": "Exclusive with [management_lif_ip]\nBackend Management LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "Backend Management LIF Name", "maxLength": 256, "x-displayname": "Backend Management LIF Name.", "x-ves-example": "storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [management_lif_ip] Backend Management LIF IP Address's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [management_lif_ip] Backend Management LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "management_lif_ip" ] }, "management_lif_ip": { "type": "string", "description": "Exclusive with [management_lif_dns_name]\nBackend Management LIF IP Address is reachable at the given IP address.", "title": "Backend Management LIF IP Address", "x-displayname": "Backend Management LIF IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.", "x-f5xc-description-medium": "Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "management_lif_dns_name" ] }, "nfs_mount_options": { "type": "string", "description": "Comma-separated list of NFS mount OPTIONS. Not enforced by default.", "title": "NFS Mount Options", "x-displayname": "NFS Mount OPTIONS.", "x-ves-example": "Nfsvers=4", "x-f5xc-example": "nfsvers=4", "x-f5xc-description-short": "Comma-separated list of NFS mount OPTIONS. Not enforced by default.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "string", "description": "Virtual Pool Region.", "title": "Backend Region", "x-displayname": "Backend Region.", "x-ves-example": "Us_east_1b.", "x-f5xc-example": "us_east_1b", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage": { "type": "array", "description": "List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.", "title": "Virtual Storage Pools", "maxItems": 8, "items": { "$ref": "#/components/schemas/fleetOntapVirtualStoragePoolType" }, "x-displayname": "Virtual Storage Pools.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.", "x-f5xc-description-medium": "List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_driver_name": { "type": "string", "description": "Configuration of Backend Name.", "title": "Storage Backend Driver", "x-displayname": "Storage Backend Driver.", "x-ves-example": "Ontap-nas", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ontap-nas\\\",\\\"ontap-nas-economy\\\",\\\"ontap-nas-flexgroup\\\"]" }, "x-f5xc-example": "ontap-nas", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ontap-nas\\\",\\\"ontap-nas-economy\\\",\\\"ontap-nas-flexgroup\\\"]" }, "maxLength": 1024, "enum": [ "ontap-nas", "ontap-nas-economy", "ontap-nas-flexgroup" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "storage_prefix": { "type": "string", "description": "Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.", "title": "Storage Prefix", "x-displayname": "Storage Prefix.", "x-ves-example": "Trident", "x-f5xc-example": "trident", "x-f5xc-description-short": "Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "svm": { "type": "string", "description": "Storage virtual machine to use. Derived if an SVM managementLIF is specified.", "title": "Backend SVM", "minLength": 1, "maxLength": 256, "x-displayname": "Backend SVM.", "x-ves-example": "Trident_svm.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "trident_svm", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Storage virtual machine to use. Derived if an SVM managementLIF is specified.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_ca_certificate": { "type": "string", "description": "Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..", "title": "Trusted CA Certificate", "maxLength": 8192, "x-displayname": "Trusted CA Certificate.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-description-short": "Please Enter Base64-encoded value of trusted CA certificate. Optional.", "x-f5xc-description-medium": "Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "username": { "type": "string", "description": "Username to connect to the cluster/SVM.", "title": "Username", "minLength": 1, "maxLength": 256, "x-displayname": "Username", "x-ves-example": "Cluster-admin.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "cluster-admin", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "volume_defaults": { "allOf": [ { "$ref": "#/components/schemas/fleetOntapVolumeDefaults" } ], "x-f5xc-description-short": "Configuration parameter for volume defaults.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Configuration of storage backend for NetApp ONTAP NAS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageDeviceNetappBackendOntapNasType", "required_fields": [ "storage_driver_name", "username" ], "mutually_exclusive_groups": [], "example_json": "{\n \"storage_driver_name\": \"ontap-nas\",\n \"username\": \"cluster-admin\"\n}", "example_yaml": "storage_driver_name: ontap-nas\nusername: cluster-admin" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageDeviceNetappBackendOntapSanType": { "type": "object", "description": "Configuration of storage backend for NetApp ONTAP SAN.", "title": "Storage Backend NetApp ONTAP SAN", "x-displayname": "Storage Backend NetApp ONTAP SAN.", "x-ves-oneof-field-chap_choice": "[\"no_chap\",\"use_chap\"]", "x-ves-oneof-field-data_lif": "[\"data_lif_dns_name\",\"data_lif_ip\"]", "x-ves-oneof-field-management_lif": "[\"management_lif_dns_name\",\"management_lif_ip\"]", "x-ves-proto-message": "ves.io.schema.fleet.StorageDeviceNetappBackendOntapSanType", "properties": { "client_certificate": { "type": "string", "description": "Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.", "title": "Client Certificate", "maxLength": 8192, "x-displayname": "Client Certificate.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-description-short": "Please Enter Base64-encoded value of client certificate. Used for certificate-based auth.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "client_private_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data_lif_dns_name": { "type": "string", "description": "Exclusive with [data_lif_ip]\nBackend Data LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "Backend Data LIF Name", "maxLength": 256, "x-displayname": "Backend Data LIF Name.", "x-ves-example": "storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [data_lif_ip] Backend Data LIF IP Address's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [data_lif_ip] Backend Data LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_lif_ip" ] }, "data_lif_ip": { "type": "string", "description": "Exclusive with [data_lif_dns_name]\nBackend Data LIF IP Address is reachable at the given IP address.", "title": "Backend Data LIF IP Address", "x-displayname": "Backend Data LIF IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.", "x-f5xc-description-medium": "Exclusive with [data_lif_dns_name] Backend Data LIF IP Address is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_lif_dns_name" ] }, "igroup_name": { "type": "string", "description": "Name of the igroup for SAN volumes to use.", "title": "iGroup Name", "minLength": 1, "maxLength": 256, "x-displayname": "IGroup Name.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Name of the igroup for SAN volumes to use.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.", "title": "Backend Labels", "x-displayname": "Backend Labels.", "x-ves-example": "{\"store\":\"nas_store\"}", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "\"{\"store\":\"nas_store\"}\"", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "128", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "List of labels for Storage Device used in NetApp ONTAP. It is used for storage class selection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit_aggregate_usage": { "type": "integer", "description": "Fail provisioning if usage is above this percentage. Not enforced by default.", "title": "Limit Aggregate Usage", "format": "int64", "x-displayname": "Limit Aggregate Usage.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-description-short": "Fail provisioning if usage is above this percentage. Not enforced by default.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 100, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit_volume_size": { "type": "integer", "description": "Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.", "title": "Limit Volume Size", "format": "int32", "x-displayname": "Limit Volume Size.", "x-ves-example": "50", "x-f5xc-example": "50", "x-f5xc-description-short": "Fail provisioning if requested volume size in GBi is above this value. Not enforced by default.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "management_lif_dns_name": { "type": "string", "description": "Exclusive with [management_lif_ip]\nBackend Management LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "title": "Backend Management LIF Name", "maxLength": 256, "x-displayname": "Backend Management LIF Name.", "x-ves-example": "storage.local.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "storage.local", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [management_lif_ip] Backend Management LIF IP Address's IP address is discovered using DNS name resolution.", "x-f5xc-description-medium": "Exclusive with [management_lif_ip] Backend Management LIF IP Address's IP address is discovered using DNS name resolution. The name given here is fully qualified domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "management_lif_ip" ] }, "management_lif_ip": { "type": "string", "description": "Exclusive with [management_lif_dns_name]\nBackend Management LIF IP Address is reachable at the given IP address.", "title": "Backend Management LIF IP Address", "x-displayname": "Backend Management LIF IP Address.", "x-ves-example": "192.0.2.103.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.103", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.", "x-f5xc-description-medium": "Exclusive with [management_lif_dns_name] Backend Management LIF IP Address is reachable at the given IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "management_lif_dns_name" ] }, "no_chap": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_chap" ] }, "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "string", "description": "Virtual Pool Region.", "title": "Backend Region", "x-displayname": "Backend Region.", "x-ves-example": "Us_east_1b.", "x-f5xc-example": "us_east_1b", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage": { "type": "array", "description": "List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.", "title": "Virtual Storage Pools", "maxItems": 8, "items": { "$ref": "#/components/schemas/fleetOntapVirtualStoragePoolType" }, "x-displayname": "Virtual Storage Pools.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.", "x-f5xc-description-medium": "List of Virtual Storage Pool definitions which are referred back by Storage Class label match selection.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_driver_name": { "type": "string", "description": "Configuration of Backend Name.", "title": "Storage Backend Driver", "x-displayname": "Storage Backend Driver.", "x-ves-example": "Ontap-nas", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ontap-san\\\",\\\"ontap-san-economy\\\",\\\"ontap-nas-flexgroup\\\"]" }, "x-f5xc-example": "ontap-nas", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ontap-san\\\",\\\"ontap-san-economy\\\",\\\"ontap-nas-flexgroup\\\"]" }, "maxLength": 1024, "enum": [ "ontap-san", "ontap-san-economy", "ontap-nas-flexgroup" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "storage_prefix": { "type": "string", "description": "Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.", "title": "Storage Prefix", "minLength": 1, "maxLength": 80, "x-displayname": "Storage Prefix.", "x-ves-example": "Trident", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "80", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "trident", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "80", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Prefix used when provisioning new volumes in the SVM. Once set this cannot be updated.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 80, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "svm": { "type": "string", "description": "Storage virtual machine to use. Derived if an SVM managementLIF is specified.", "title": "Backend SVM", "minLength": 1, "maxLength": 256, "x-displayname": "Backend SVM.", "x-ves-example": "Trident_svm.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "trident_svm", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Storage virtual machine to use. Derived if an SVM managementLIF is specified.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_ca_certificate": { "type": "string", "description": "Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..", "title": "Trusted CA Certificate", "maxLength": 8192, "x-displayname": "Trusted CA Certificate.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-description-short": "Please Enter Base64-encoded value of trusted CA certificate. Optional.", "x-f5xc-description-medium": "Please Enter Base64-encoded value of trusted CA certificate. Optional. Used for certificate-based auth..", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_chap": { "allOf": [ { "$ref": "#/components/schemas/fleetDeviceNetappBackendOntapSanChapType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_chap" ] }, "username": { "type": "string", "description": "Username to connect to the cluster/SVM.", "title": "Username", "minLength": 1, "maxLength": 256, "x-displayname": "Username", "x-ves-example": "Cluster-admin.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "cluster-admin", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "volume_defaults": { "allOf": [ { "$ref": "#/components/schemas/fleetOntapVolumeDefaults" } ], "x-f5xc-description-short": "Configuration parameter for volume defaults.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Configuration of storage backend for NetApp ONTAP SAN.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageDeviceNetappBackendOntapSanType", "required_fields": [ "storage_driver_name", "username" ], "mutually_exclusive_groups": [], "example_json": "{\n \"storage_driver_name\": \"ontap-nas\",\n \"username\": \"cluster-admin\"\n}", "example_yaml": "storage_driver_name: ontap-nas\nusername: cluster-admin" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageDeviceNetappTridentType": { "type": "object", "description": "Device configuration for NetApp Trident Storage.", "title": "NetApp Trident", "x-displayname": "NetApp Trident.", "x-ves-oneof-field-backend_choice": "[\"netapp_backend_ontap_nas\",\"netapp_backend_ontap_san\"]", "x-ves-proto-message": "ves.io.schema.fleet.StorageDeviceNetappTridentType", "properties": { "netapp_backend_ontap_nas": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageDeviceNetappBackendOntapNasType" } ], "x-f5xc-description-short": "Configuration parameter for netapp backend ontap nas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "netapp_backend_ontap_san" ] }, "netapp_backend_ontap_san": { "allOf": [ { "$ref": "#/components/schemas/fleetStorageDeviceNetappBackendOntapSanType" } ], "x-f5xc-description-short": "Configuration parameter for netapp backend ontap san.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "netapp_backend_ontap_nas" ] } }, "x-f5xc-description-short": "Device configuration for NetApp Trident Storage.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageDeviceNetappTridentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetStorageDevicePureStorageServiceOrchestratorType": { "type": "object", "description": "Device configuration for Pure Storage Service Orchestrator.", "title": "Pure Storage Service Orchestrator", "x-displayname": "Pure Storage Service Orchestrator.", "x-ves-proto-message": "ves.io.schema.fleet.StorageDevicePureStorageServiceOrchestratorType", "properties": { "arrays": { "allOf": [ { "$ref": "#/components/schemas/fleetPsoArrayConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cluster_id": { "type": "string", "description": "ClusterID is added as a prefix for all volumes created by this PSO installation.\nClusterID is also used to identify the volumes used by the datastore, pso-db.\nClusterID MUST BE UNIQUE for multiple K8s clusters running on top of the same storage arrays.\nCharacters allowed: alphanumeric and underscores.", "title": "Cluster ID", "minLength": 1, "maxLength": 22, "x-displayname": "Cluster ID.", "x-ves-example": "Cluster1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "22", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.pattern": "^[a-z0-9_]*$" }, "x-f5xc-example": "cluster1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "22", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.pattern": "^[a-z0-9_]*$" }, "x-f5xc-description-short": "ClusterID is added as a prefix for all volumes created by this PSO installation.", "x-f5xc-description-medium": "ClusterID is added as a prefix for all volumes created by this PSO installation. ClusterID is also used to identify the volumes used by the datastore, pso-db. ClusterID MUST BE UNIQUE for multiple K8s clusters running on top of the same storage arrays.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 22, "pattern": "^[a-z0-9_]*$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "enable_storage_topology": { "type": "boolean", "description": "This option is to enable/disable the csi topology feature for pso-csi.", "title": "Enable Storage Topology", "format": "boolean", "x-displayname": "Enable Storage Topology.", "x-f5xc-description-short": "Option is to enable/disable the csi topology feature for pso-csi.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_strict_topology": { "type": "boolean", "description": "This option is to enable/disable the strict csi topology feature for pso-csi.", "title": "Enable Strict Topology", "format": "boolean", "x-displayname": "Enable Strict Topology.", "x-f5xc-description-short": "Option is to enable/disable the strict csi topology feature for pso-csi.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Device configuration for Pure Storage Service Orchestrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetStorageDevicePureStorageServiceOrchestratorType", "required_fields": [ "cluster_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cluster_id\": \"cluster1\"\n}", "example_yaml": "cluster_id: cluster1" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetVGPUConfiguration": { "type": "object", "description": "Licensing configuration for NVIDIA vGPU.", "title": "vGPU Configuration", "x-displayname": "VGPU Configuration.", "x-ves-proto-message": "ves.io.schema.fleet.VGPUConfiguration", "properties": { "feature_type": { "allOf": [ { "$ref": "#/components/schemas/fleetVGPUFeatureType" } ], "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "server_address": { "type": "string", "description": "Set License Server Address.", "title": "License Server Address", "x-displayname": "License Server Address.", "x-ves-example": "gridlicense1.example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname_or_ip": "true" }, "x-f5xc-example": "gridlicense1.example.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname_or_ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "server_port": { "type": "integer", "description": "Set License Server port number.", "title": "License Server Port Number", "format": "int64", "x-displayname": "License Server Port Number.", "x-ves-example": "7070", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "7070", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Licensing configuration for NVIDIA vGPU.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetVGPUConfiguration", "required_fields": [ "server_port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"server_port\": 1\n}", "example_yaml": "server_port: 1" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetVGPUFeatureType": { "type": "string", "description": "Set feature to be enabled\n\nOperate with a degraded vGPU performance\nEnable NVIDIA vGPU\nEnable NVIDIA RTX Virtual Workstation\nEnable NVIDIA Virtual Compute Server.", "title": "vGPU Feature Type", "enum": [ "UNLICENSED", "VGPU", "VWS", "VCS" ], "default": "UNLICENSED", "x-displayname": "Feature Type.", "x-ves-proto-enum": "ves.io.schema.fleet.VGPUFeatureType", "x-f5xc-description-short": "Set feature to be enabled Operate with a degraded vGPU performance Enable NVIDIA vGPU Enable NVIDIA RTX Virtual Workstation Enable NVIDIA Virtual...", "x-f5xc-description-medium": "Set feature to be enabled Operate with a degraded vGPU performance Enable NVIDIA vGPU Enable NVIDIA RTX Virtual Workstation Enable NVIDIA Virtual Compute Server.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetVGPUFeatureType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNLICENSED\"", "example_yaml": "UNLICENSED\n..." }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "fleetVMConfiguration": { "type": "object", "description": "VMs support configuration.", "title": "VM Configuration", "x-displayname": "VM Configuration.", "x-ves-proto-message": "ves.io.schema.fleet.VMConfiguration", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for fleetVMConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Fleet management is platform-level orchestration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "network_firewallActiveEnhancedFirewallPoliciesType": { "type": "object", "description": "List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all OPTIONS available under firewall policies\nwith an additional option for service insertion.", "title": "Active Enhanced Firewall Policies Type", "x-displayname": "Active Enhanced Network Policies Type.", "x-ves-proto-message": "ves.io.schema.network_firewall.ActiveEnhancedFirewallPoliciesType", "properties": { "enhanced_firewall_policies": { "type": "array", "description": "Ordered List of Enhanced Firewall Policies active.", "title": "Enhanced Firewall Policy", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Enhanced Firewall Policy.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "Ordered List of Enhanced Firewall Policies active.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List of Enhanced Firewall Policies These policies use session-based rules and provide all OPTIONS available under firewall policies with an...", "x-f5xc-description-medium": "List of Enhanced Firewall Policies These policies use session-based rules and provide all OPTIONS available under firewall policies with an additional option for service insertion.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_firewallActiveEnhancedFirewallPoliciesType", "required_fields": [ "enhanced_firewall_policies" ], "mutually_exclusive_groups": [], "example_json": "{\n \"enhanced_firewall_policies\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "enhanced_firewall_policies:\n- name: contacts-route" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network firewall is platform-level security" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "network_firewallActiveForwardProxyPoliciesType": { "type": "object", "description": "Ordered List of Forward Proxy Policies active.", "title": "Active Forward Proxy Policies Type", "x-displayname": "Active Forward Proxy Policies Type.", "x-ves-proto-message": "ves.io.schema.network_firewall.ActiveForwardProxyPoliciesType", "properties": { "forward_proxy_policies": { "type": "array", "description": "Ordered List of Forward Proxy Policies active.", "title": "Forward Proxy Policies", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Forward Proxy Policies.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "Ordered List of Forward Proxy Policies active.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Ordered List of Forward Proxy Policies active.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_firewallActiveForwardProxyPoliciesType", "required_fields": [ "forward_proxy_policies" ], "mutually_exclusive_groups": [], "example_json": "{\n \"forward_proxy_policies\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "forward_proxy_policies:\n- name: contacts-route" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network firewall is platform-level security" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPIPV6NetworkType": { "type": "object", "description": "DHCP IPv6 network type configuration.", "title": "DHCPIPV6NetworkType", "x-displayname": "DHCPIPV6NetworkType.", "x-ves-displayorder": "1,5,4", "x-ves-oneof-field-network_prefix_choice": "[\"network_prefix\"]", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPIPV6NetworkType", "properties": { "network_prefix": { "type": "string", "description": "Exclusive with []\nNetwork Prefix to be used for IPv6 address auto configuration.", "title": "Network Prefix", "x-displayname": "Network Prefix.", "x-ves-example": "2001::0/64.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6_prefix": "true" }, "x-f5xc-example": "2001::0/64", "x-validation-rules": { "ves.io.schema.rules.string.ipv6_prefix": "true" }, "x-f5xc-description-short": "Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool_settings": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPPoolSettingType" } ], "x-f5xc-description-short": "Configuration parameter for pool settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pools": { "type": "array", "description": "List of non overlapping IP address ranges.", "title": "DHCP pools", "maxItems": 16, "items": { "$ref": "#/components/schemas/network_interfaceDHCPIPV6PoolType" }, "x-displayname": "DHCP Pools.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of non overlapping IP address ranges.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "minItems": 1, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPIPV6NetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPIPV6PoolType": { "type": "object", "description": "DHCP IPv6 pool is a range of IP addresses (start IP and end IP).", "title": "DHCP IPV6 Range", "x-displayname": "DHCP IPv6 Range.", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPIPV6PoolType", "properties": { "end_ip": { "type": "string", "description": "Ending IPv6 address of the pool range.\nIn case of address allocator, offset is derived based on network prefix.", "title": "End IP", "x-displayname": "Ending IPv6.", "x-ves-example": "2001::200", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "2001::200", "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.", "x-f5xc-description-medium": "Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_ip": { "type": "string", "description": "Starting IPv6 address of the pool range.\nIn case of address allocator, offset is derived based on network prefix.\n2001::1 with prefix length of 64, start offset is 5.", "title": "Start IPV6", "x-displayname": "Starting IPv6.", "x-ves-example": "2001::1", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "2001::1", "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Starting IPv6 address of the pool range.", "x-f5xc-description-medium": "Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DHCP IPv6 pool is a range of IP addresses (start IP and end IP).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPIPV6PoolType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPIPV6StatefulServer": { "type": "object", "title": "DHCPIPV6StatefulServer", "x-displayname": "DHCPIPV6 Stateful Server.", "x-ves-oneof-field-interfaces_addressing_choice": "[\"automatic_from_end\",\"automatic_from_start\",\"interface_ip_map\"]", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPIPV6StatefulServer", "properties": { "automatic_from_end": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for automatic from end.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "automatic_from_start", "interface_ip_map" ] }, "automatic_from_start": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for automatic from start.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "automatic_from_end", "interface_ip_map" ] }, "dhcp_networks": { "type": "array", "description": "List of networks from which DHCP server can allocate IP addresses.", "title": "DHCP IPV6 Networks", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/network_interfaceDHCPIPV6NetworkType" }, "x-displayname": "DHCP IPv6 Networks.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of networks from which DHCP server can allocate IP addresses.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 1, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "fixed_ip_map": { "type": "object", "description": "Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address\nAssign fixed IPv6 addresses based on the MAC Address of the DHCP Client.", "title": "Fixed IPV6 Assignments", "x-displayname": "Fixed MAC Address to IPv6 Assignments.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.mac": "true", "ves.io.schema.rules.map.max_pairs": "128", "ves.io.schema.rules.map.unique_values": "true", "ves.io.schema.rules.map.values.string.ipv6": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.mac": "true", "ves.io.schema.rules.map.max_pairs": "128", "ves.io.schema.rules.map.unique_values": "true", "ves.io.schema.rules.map.values.string.ipv6": "true" }, "x-f5xc-description-short": "Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.", "x-f5xc-description-medium": "Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_ip_map": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPInterfaceIPV6Type" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "automatic_from_end", "automatic_from_start" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPIPV6StatefulServer", "required_fields": [ "dhcp_networks" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dhcp_networks\": [\n {}\n ]\n}", "example_yaml": "dhcp_networks:\n- {}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPInterfaceIPType": { "type": "object", "description": "Specify static IPv4 addresses per node.", "title": "Interface IPv4 Assignments", "x-displayname": "Interface IPv4 Assignments.", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPInterfaceIPType", "properties": { "interface_ip_map": { "type": "object", "description": "Specify static IPv4 addresses per site:node.", "title": "Site:Node to IP mapping", "x-displayname": "Site:Node to IPv4 Address Mapping.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.ipv4": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.ipv4": "true" }, "x-f5xc-description-short": "Specify static IPv4 addresses per site:node.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPInterfaceIPType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPInterfaceIPV6Type": { "type": "object", "description": "Map of Interface IPv6 assignments per node.", "title": "Interface IPV6 Assignments", "x-displayname": "Interface IPv6 Assignments.", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPInterfaceIPV6Type", "properties": { "interface_ip_map": { "type": "object", "description": "Map of Site:Node to IPv6 address.", "title": "Site:Node to IPV6 mapping", "x-displayname": "Site:Node to IPv6 Mapping.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.ipv6": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "64", "ves.io.schema.rules.map.values.string.ipv6": "true" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Map of Interface IPv6 assignments per node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPInterfaceIPV6Type", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPNetworkType": { "type": "object", "description": "DHCP network configuration.", "title": "DHCP Network", "x-displayname": "DHCP Network.", "x-ves-displayorder": "1,12,4,5,9", "x-ves-oneof-field-dns_choice": "[\"dns_address\",\"same_as_dgw\"]", "x-ves-oneof-field-gateway_choice": "[\"dgw_address\",\"first_address\",\"last_address\"]", "x-ves-oneof-field-network_prefix_choice": "[\"network_prefix\"]", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPNetworkType", "properties": { "dgw_address": { "type": "string", "description": "Exclusive with [first_address last_address]\nEnter a IPv4 address from the network prefix to be used as the default gateway.", "title": "Configured Address", "x-displayname": "Static IPv4 Configuration.", "x-ves-example": "192.0.2.2", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.2", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.", "x-f5xc-description-medium": "Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "first_address", "last_address" ] }, "dns_address": { "type": "string", "description": "Exclusive with [same_as_dgw]\nEnter a IPv4 address from the network prefix to be used as the DNS server.", "title": "Configured Address", "x-displayname": "Static IPv4 Configuration.", "x-ves-example": "192.0.2.193.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.193", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.", "x-f5xc-description-medium": "Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "same_as_dgw" ] }, "first_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dgw_address", "last_address" ] }, "last_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dgw_address", "first_address" ] }, "network_prefix": { "type": "string", "description": "Exclusive with []\nSet the network prefix for the site. Ex: 192.0.2.0/24.", "title": "Network Prefix", "x-displayname": "Network Prefix.", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4_prefix": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.string.ipv4_prefix": "true" }, "x-f5xc-description-short": "Exclusive with [] Set the network prefix for the site. Ex: 192.0.2.0/24.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool_settings": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPPoolSettingType" } ], "x-f5xc-description-short": "Configuration parameter for pool settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pools": { "type": "array", "description": "List of non overlapping IP address ranges.", "title": "DHCP pools", "maxItems": 16, "items": { "$ref": "#/components/schemas/network_interfaceDHCPPoolType" }, "x-displayname": "DHCP Pools.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of non overlapping IP address ranges.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "minItems": 1, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "same_as_dgw": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for same as dgw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dns_address" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPPoolSettingType": { "type": "string", "description": "Identifies the how to pick the network for Interface.\n\nAddress ranges in DHCP pool list are used for IP Address allocation\nAddress ranges in DHCP pool list are excluded from IP Address allocation.", "title": "DHCP POOL SETTING", "enum": [ "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS" ], "default": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "x-displayname": "Interface Network Type.", "x-ves-proto-enum": "ves.io.schema.network_interface.DHCPPoolSettingType", "x-f5xc-description-short": "Identifies the how to pick the network for Interface.", "x-f5xc-description-medium": "Identifies the how to pick the network for Interface. Address ranges in DHCP pool list are used for IP Address allocation Address ranges in DHCP pool list are excluded from IP Address allocation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPPoolSettingType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS\"", "example_yaml": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS\n..." }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPPoolType": { "type": "object", "description": "DHCP pool is a range of IP addresses (start IP and end IP).", "title": "DHCP IP Range", "x-displayname": "DHCP IP Range.", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPPoolType", "properties": { "end_ip": { "type": "string", "description": "Ending IP of the pool range.\nIn case of address allocator, offset is derived based on network prefix.\n192.0.2.39 with prefix length of 24, end offset is 192.0.2.186.", "title": "End IP", "x-displayname": "Ending IP", "x-ves-example": "192.0.2.39.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.39", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-medium": "Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 192.0.2.39 with prefix length of 24, end offset is 192.0.2.186.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_ip": { "type": "string", "description": "Starting IP of the pool range.\nIn case of address allocator, offset is derived based on network prefix.\n192.0.2.173 with prefix length of 24, start offset is 192.0.2.96.", "title": "Start IP", "x-displayname": "Starting IP.", "x-ves-example": "192.0.2.173.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.173", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-medium": "Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 192.0.2.173 with prefix length of 24, start offset is 192.0.2.96.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "exclude": { "type": "boolean", "description": "Exclude this address range from DHCP allocation." } }, "x-f5xc-description-short": "DHCP pool is a range of IP addresses (start IP and end IP).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPPoolType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDHCPServerParametersType": { "type": "object", "title": "DHCPServerParametersType", "x-displayname": "DHCPServerParametersType.", "x-ves-oneof-field-interfaces_addressing_choice": "[\"automatic_from_end\",\"automatic_from_start\",\"interface_ip_map\"]", "x-ves-proto-message": "ves.io.schema.network_interface.DHCPServerParametersType", "properties": { "automatic_from_end": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for automatic from end.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "automatic_from_start", "interface_ip_map" ] }, "automatic_from_start": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for automatic from start.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "automatic_from_end", "interface_ip_map" ] }, "dhcp_networks": { "type": "array", "description": "List of networks from which DHCP Server can allocate IPv4 Addresses.", "title": "DHCP Networks", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/network_interfaceDHCPNetworkType" }, "x-displayname": "DHCP Networks.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of networks from which DHCP Server can allocate IPv4 Addresses.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 1, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "fixed_ip_map": { "type": "object", "description": "Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.", "title": "Fixed IP Assignments", "x-displayname": "Fixed MAC Address to IPv4 Assignments.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.mac": "true", "ves.io.schema.rules.map.max_pairs": "128", "ves.io.schema.rules.map.unique_values": "true", "ves.io.schema.rules.map.values.string.ipv4": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.mac": "true", "ves.io.schema.rules.map.max_pairs": "128", "ves.io.schema.rules.map.unique_values": "true", "ves.io.schema.rules.map.values.string.ipv4": "true" }, "x-f5xc-description-short": "Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_ip_map": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPInterfaceIPType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "automatic_from_end", "automatic_from_start" ] }, "dhcp_option82_tag": { "type": "string", "description": "DHCP option 82 tag." } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDHCPServerParametersType", "required_fields": [ "dhcp_networks" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dhcp_networks\": [\n {}\n ]\n}", "example_yaml": "dhcp_networks:\n- {}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDedicatedInterfaceType": { "type": "object", "description": "Dedicated Interface Configuration.", "title": "Dedicated Interface", "x-displayname": "Dedicated Interface.", "x-ves-oneof-field-monitoring_choice": "[\"monitor\",\"monitor_disabled\"]", "x-ves-oneof-field-node_choice": "[\"cluster\",\"node\"]", "x-ves-oneof-field-primary_choice": "[\"is_primary\",\"not_primary\"]", "x-ves-proto-message": "ves.io.schema.network_interface.DedicatedInterfaceType", "properties": { "cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "production-cluster", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "node" ] }, "device": { "type": "string", "description": "Name of the device for which interface is configured. Use wwan0 for 4G/LTE.", "title": "Device", "minLength": 1, "maxLength": 64, "x-displayname": "Interface Device.", "x-ves-example": "Eth0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "eth0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Name of the device for which interface is configured. Use wwan0 for 4G/LTE.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "is_primary": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "not_primary" ] }, "monitor": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceLinkQualityMonitorConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monitor_disabled" ] }, "monitor_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monitor" ] }, "mtu": { "type": "integer", "description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.", "title": "Maximum Packet Size (MTU)", "format": "int64", "x-displayname": "Maximum Packet Size (MTU)", "x-ves-example": "1450", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-example": "1450", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-description-short": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-description-medium": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16384, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "type": "string", "description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node of the site.", "title": "Node", "minLength": 1, "maxLength": 64, "x-displayname": "Specific Node.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Exclusive with [cluster] Configuration will apply to a device on the given node of the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster" ] }, "not_primary": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for not primary.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "is_primary" ] }, "priority": { "type": "integer", "description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.", "title": "Priority", "format": "int64", "x-displayname": "Priority", "x-ves-example": "42", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "42", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.", "x-f5xc-description-medium": "Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDedicatedInterfaceType", "required_fields": [ "device" ], "mutually_exclusive_groups": [], "example_json": "{\n \"device\": \"eth0\"\n}", "example_yaml": "device: eth0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceDedicatedManagementInterfaceType": { "type": "object", "description": "Dedicated Interface Configuration.", "title": "Dedicated Management Interface", "x-displayname": "Dedicated Management Interface.", "x-ves-oneof-field-node_choice": "[\"cluster\",\"node\"]", "x-ves-proto-message": "ves.io.schema.network_interface.DedicatedManagementInterfaceType", "properties": { "cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "production-cluster", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "node" ] }, "device": { "type": "string", "description": "Name of the device for which interface is configured.", "title": "Device", "minLength": 1, "maxLength": 64, "x-displayname": "Interface Device.", "x-ves-example": "Eth0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "eth0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Name of the device for which interface is configured.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "mtu": { "type": "integer", "description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.", "title": "Maximum Packet Size (MTU)", "format": "int64", "x-displayname": "Maximum Packet Size (MTU)", "x-ves-example": "1450", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-example": "1450", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-description-short": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-description-medium": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16384, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "type": "string", "description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node of the site.", "title": "Node", "minLength": 1, "maxLength": 64, "x-displayname": "Specific Node.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Exclusive with [cluster] Configuration will apply to a device on the given node of the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceDedicatedManagementInterfaceType", "required_fields": [ "device" ], "mutually_exclusive_groups": [], "example_json": "{\n \"device\": \"eth0\"\n}", "example_yaml": "device: eth0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceEthernetInterfaceType": { "type": "object", "description": "Ethernet Interface Configuration.", "title": "Ethernet Interface", "x-displayname": "Ethernet Interface.", "x-ves-oneof-field-address_choice": "[\"dhcp_client\",\"dhcp_server\",\"static_ip\"]", "x-ves-oneof-field-ipv6_address_choice": "[\"ipv6_auto_config\",\"no_ipv6_address\",\"static_ipv6_address\"]", "x-ves-oneof-field-monitoring_choice": "[\"monitor\",\"monitor_disabled\"]", "x-ves-oneof-field-network_choice": "[\"segment_network\",\"site_local_inside_network\",\"site_local_network\",\"storage_network\"]", "x-ves-oneof-field-node_choice": "[\"cluster\",\"node\"]", "x-ves-oneof-field-primary_choice": "[\"is_primary\",\"not_primary\"]", "x-ves-oneof-field-vlan_choice": "[\"untagged\",\"vlan_id\"]", "x-ves-proto-message": "ves.io.schema.network_interface.EthernetInterfaceType", "properties": { "cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "production-cluster", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "node" ] }, "device": { "type": "string", "description": "Interface configuration for the ethernet device.", "title": "Device", "minLength": 1, "maxLength": 64, "x-displayname": "Ethernet Device.", "x-ves-example": "Eth0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "eth0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Interface configuration for the ethernet device.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dhcp_client": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dhcp_server", "static_ip" ] }, "dhcp_server": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPServerParametersType" } ], "x-f5xc-description-short": "Configuration parameter for dhcp server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dhcp_client", "static_ip" ] }, "ipv6_auto_config": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceIPV6AutoConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_ipv6_address", "static_ipv6_address" ] }, "is_primary": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "not_primary" ] }, "monitor": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceLinkQualityMonitorConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monitor_disabled" ] }, "monitor_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monitor" ] }, "mtu": { "type": "integer", "description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.", "title": "Maximum Packet Size (MTU)", "format": "int64", "x-displayname": "Maximum Packet Size (MTU)", "x-ves-example": "1450", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-example": "1450", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-description-short": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-description-medium": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16384, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_ipv6_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv6_auto_config", "static_ipv6_address" ] }, "node": { "type": "string", "description": "Exclusive with [cluster]\nConfiguration will apply to a device on the given node.", "title": "Node", "minLength": 1, "maxLength": 64, "x-displayname": "Specific Node.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Exclusive with [cluster] Configuration will apply to a device on the given node.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster" ] }, "not_primary": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for not primary.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "is_primary" ] }, "priority": { "type": "integer", "description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.", "title": "Priority", "format": "int64", "x-displayname": "Priority", "x-ves-example": "42", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "42", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.", "x-f5xc-description-medium": "Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_local_inside_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "segment_network", "site_local_network", "storage_network" ] }, "site_local_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "segment_network", "site_local_inside_network", "storage_network" ] }, "static_ip": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIPParametersType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dhcp_client", "dhcp_server" ] }, "static_ipv6_address": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIPParametersType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv6_auto_config", "no_ipv6_address" ] }, "storage_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for storage network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "segment_network", "site_local_inside_network", "site_local_network" ] }, "untagged": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vlan_id" ] }, "vlan_id": { "type": "integer", "description": "Exclusive with [untagged]\nConfigure a VLAN tagged ethernet interface.", "title": "VLAN Id", "format": "int64", "x-displayname": "VLAN ID", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "4095" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-description-short": "Exclusive with [untagged] Configure a VLAN tagged ethernet interface.", "minimum": 1, "maximum": 4095, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 4095, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "untagged" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceEthernetInterfaceType", "required_fields": [ "device" ], "mutually_exclusive_groups": [], "example_json": "{\n \"device\": \"eth0\"\n}", "example_yaml": "device: eth0" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceIPV6AutoConfigRouterType": { "type": "object", "title": "IPV6AutoConfigRouterType", "x-displayname": "IPV6AutoConfigRouterType.", "x-ves-oneof-field-address_choice": "[\"network_prefix\",\"stateful\"]", "x-ves-proto-message": "ves.io.schema.network_interface.IPV6AutoConfigRouterType", "properties": { "dns_config": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceIPV6DnsConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_prefix": { "type": "string", "description": "Exclusive with [stateful]\nNetwork prefix that is used as Prefix information\nAllowed only /64 prefix length as per RFC 4862.", "title": "Prefix Info", "x-displayname": "Network Prefix.", "x-ves-example": "2001::0/64.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6_prefix": "true", "ves.io.schema.rules.string.pattern": ".*::/64$" }, "x-f5xc-example": "2001::0/64", "x-validation-rules": { "ves.io.schema.rules.string.ipv6_prefix": "true", "ves.io.schema.rules.string.pattern": ".*::/64$" }, "x-f5xc-description-short": "Exclusive with [stateful] Network prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.", "x-f5xc-description-medium": "Exclusive with [stateful] Network prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": ".*::/64$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "stateful" ] }, "stateful": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPIPV6StatefulServer" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "network_prefix" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceIPV6AutoConfigRouterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceIPV6AutoConfigType": { "type": "object", "title": "IPV6AutoConfigType", "x-displayname": "IPV6AutoConfigType.", "x-ves-oneof-field-autoconfig_choice": "[\"host\",\"router\"]", "x-ves-proto-message": "ves.io.schema.network_interface.IPV6AutoConfigType", "properties": { "host": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "api.example.com", "x-f5xc-description-short": "Hostname or IP address of the target server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "router" ] }, "router": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceIPV6AutoConfigRouterType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "host" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceIPV6AutoConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceIPV6DnsConfig": { "type": "object", "title": "IPV6DnsConfig", "x-displayname": "IPV6DnsConfig.", "x-ves-oneof-field-dns_choice": "[\"configured_list\",\"local_dns\"]", "x-ves-proto-message": "ves.io.schema.network_interface.IPV6DnsConfig", "properties": { "configured_list": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceIPV6DnsList" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "local_dns" ] }, "local_dns": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceIPV6LocalDnsAddress" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "configured_list" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceIPV6DnsConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceIPV6DnsList": { "type": "object", "title": "IPV6DnsList", "x-displayname": "IPV6DnsList.", "x-ves-proto-message": "ves.io.schema.network_interface.IPV6DnsList", "properties": { "dns_list": { "type": "array", "description": "List of IPv6 Addresses acting as DNS servers.", "title": "Dns List", "minItems": 1, "maxItems": 4, "items": { "type": "string" }, "x-displayname": "DNS List", "x-ves-example": "2001::11", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "2001::11", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "List of IPv6 Addresses acting as DNS servers.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceIPV6DnsList", "required_fields": [ "dns_list" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dns_list\": [\n \"value\"\n ]\n}", "example_yaml": "dns_list:\n- value" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceIPV6LocalDnsAddress": { "type": "object", "title": "IPV6LocalDnsAddress", "x-displayname": "IPV6LocalDnsAddress.", "x-ves-oneof-field-local_dns_choice": "[\"configured_address\",\"first_address\",\"last_address\"]", "x-ves-proto-message": "ves.io.schema.network_interface.IPV6LocalDnsAddress", "properties": { "configured_address": { "type": "string", "description": "Exclusive with [first_address last_address]\nConfigured address from the network prefix is chosen as DNS server.", "title": "Configured Address", "x-displayname": "Configured Address.", "x-ves-example": "2001::10", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "2001::10", "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.", "x-f5xc-description-medium": "Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "first_address", "last_address" ] }, "first_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "configured_address", "last_address" ] }, "last_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "configured_address", "first_address" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceIPV6LocalDnsAddress", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceLinkQualityMonitorConfig": { "type": "object", "description": "Link Quality Monitoring configuration for a network interface.", "title": "Link Quality Monitoring Configuration", "x-displayname": "Link Quality Monitoring Configuration.", "x-ves-proto-message": "ves.io.schema.network_interface.LinkQualityMonitorConfig", "x-f5xc-description-short": "Link Quality Monitoring configuration for a network interface.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceLinkQualityMonitorConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceStaticIPParametersType": { "type": "object", "description": "Configure Static IP parameters.", "title": "Static IP Parameters", "x-displayname": "Static IP Parameters.", "x-ves-oneof-field-network_prefix_choice": "[\"cluster_static_ip\",\"node_static_ip\"]", "x-ves-proto-message": "ves.io.schema.network_interface.StaticIPParametersType", "properties": { "cluster_static_ip": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIpParametersClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "node_static_ip" ] }, "node_static_ip": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIpParametersNodeType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster_static_ip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceStaticIPParametersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceStaticIpParametersClusterType": { "type": "object", "description": "Configure Static IP parameters for cluster.", "title": "Static IP Parameters", "x-displayname": "Cluster: Static IP Parameters.", "x-ves-proto-message": "ves.io.schema.network_interface.StaticIpParametersClusterType", "properties": { "interface_ip_map": { "type": "object", "description": "Map of Node to Static IP configuration value, Key:Node, Value:IP Address.", "title": "Site:Node to IP mapping", "x-displayname": "Node to IP Mapping.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "128" }, "additionalProperties": { "type": "string" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "128", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "128" }, "x-f5xc-description-short": "Map of Node to Static IP configuration value, Key:Node, Value:IP Address.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Configure Static IP parameters for cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceStaticIpParametersClusterType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceStaticIpParametersNodeType": { "type": "object", "description": "Configure Static IP parameters for a node.", "title": "Static IP Parameters", "x-displayname": "Node: Static IP Parameters.", "x-ves-proto-message": "ves.io.schema.network_interface.StaticIpParametersNodeType", "properties": { "default_gw": { "type": "string", "description": "IP address of the default gateway.", "title": "Default Gateway", "x-displayname": "Default Gateway.", "x-ves-example": "192.0.2.13.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.13", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_address": { "type": "string", "description": "IP address of the interface and prefix length.", "title": "Default Gateway", "x-displayname": "IP address/Prefix Length.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip_prefix": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip_prefix": "true" }, "x-f5xc-description-short": "IP address of the interface and prefix length.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "cidr", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dns_server": { "type": "string", "description": "DNS server address for the static interface configuration." } }, "x-f5xc-description-short": "Configure Static IP parameters for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceStaticIpParametersNodeType", "required_fields": [ "ip_address" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_address\": \"192.0.2.0/24\"\n}", "example_yaml": "ip_address: 192.0.2.0/24" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "network_interfaceTunnelInterfaceType": { "type": "object", "description": "Tunnel Interface Configuration.", "title": "Tunnel Interface", "x-displayname": "Tunnel Interface.", "x-ves-oneof-field-network_choice": "[\"site_local_inside_network\",\"site_local_network\"]", "x-ves-oneof-field-node_choice": "[\"node\"]", "x-ves-proto-message": "ves.io.schema.network_interface.TunnelInterfaceType", "properties": { "mtu": { "type": "integer", "description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.", "title": "Maximum Packet Size (MTU)", "format": "int64", "x-displayname": "Maximum Packet Size (MTU)", "x-ves-example": "1450", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-example": "1450", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-description-short": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-description-medium": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16384, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "type": "string", "description": "Exclusive with []\nConfiguration will apply to a given device on the given node.", "title": "Node", "minLength": 1, "maxLength": 64, "x-displayname": "Specific Node.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Exclusive with [] Configuration will apply to a given device on the given node.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "priority": { "type": "integer", "description": "Priority of the network interface when multiple network interfaces are present in outside network\nGreater the value, higher the priority.", "title": "Priority", "format": "int64", "x-displayname": "Priority", "x-ves-example": "42", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "42", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.", "x-f5xc-description-medium": "Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_local_inside_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_local_network" ] }, "site_local_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_local_inside_network" ] }, "static_ip": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIPParametersType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "tunnel", "field_path": "tunnel", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for network_interfaceTunnelInterfaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Network interface configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemaMessageMetaType": { "type": "object", "description": "MessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.", "title": "MessageMetaType", "x-displayname": "Message Metadata.", "x-ves-proto-message": "ves.io.schema.MessageMetaType", "properties": { "description": { "type": "string", "description": "Human readable description.", "title": "description", "maxLength": 256, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "This is the name of the message.\nThe value of name has to follow DNS-1035 format.", "title": "name", "minLength": 1, "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.", "x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaMessageMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaNodeInterfaceInfo": { "type": "object", "description": "On a multinode site, this list holds the nodes and corresponding tunnel transport interface.", "title": "NodeInterfaceInfo", "x-displayname": "NodeInterfaceInfo.", "x-ves-proto-message": "ves.io.schema.NodeInterfaceInfo", "properties": { "interface": { "type": "array", "description": "Interface reference on this node.", "title": "Interface", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Interface", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "type": "string", "description": "Node name on this site.", "title": "Node", "x-displayname": "Node", "x-ves-example": "Master-0", "x-f5xc-example": "master-0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "On a multinode site, this list holds the nodes and corresponding tunnel transport interface.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaNodeInterfaceInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaNodeInterfaceType": { "type": "object", "description": "On multinode site, this type holds the information about per node interfaces.", "title": "NodeInterfaceType", "x-displayname": "NodeInterfaceType.", "x-ves-proto-message": "ves.io.schema.NodeInterfaceType", "properties": { "list": { "type": "array", "description": "On a multinode site, this list holds the nodes and corresponding networking_interface.", "title": "NodeInterfaceInfo", "maxItems": 8, "items": { "$ref": "#/components/schemas/schemaNodeInterfaceInfo" }, "x-displayname": "Node Interface Info.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "On a multinode site, this list holds the nodes and corresponding networking_interface.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "On multinode site, this type holds the information about per node interfaces.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaNodeInterfaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaVipVrrpType": { "type": "string", "description": "VRRP advertisement mode for VIP\n\nInvalid VRRP mode.", "title": "VipVrrpType", "enum": [ "VIP_VRRP_INVALID", "VIP_VRRP_ENABLE", "VIP_VRRP_DISABLE" ], "default": "VIP_VRRP_INVALID", "x-displayname": "VRRP Virtual-IP.", "x-ves-proto-enum": "ves.io.schema.VipVrrpType", "x-f5xc-description-short": "VRRP advertisement mode for VIP Invalid VRRP mode.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaVipVrrpType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VIP_VRRP_INVALID\"", "example_yaml": "VIP_VRRP_INVALID\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaviewsGlobalNetworkConnectionListType": { "type": "object", "description": "List of global network connections.", "title": "Global Network Connection List", "x-displayname": "Global Network Connection List.", "x-ves-proto-message": "ves.io.schema.views.GlobalNetworkConnectionListType", "properties": { "global_network_connections": { "type": "array", "description": "Global network connections.", "title": "Global Network Connections", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/schemaviewsGlobalNetworkConnectionType" }, "x-displayname": "Global Network Connections.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsGlobalNetworkConnectionListType", "required_fields": [ "global_network_connections" ], "mutually_exclusive_groups": [], "example_json": "{\n \"global_network_connections\": [\n {}\n ]\n}", "example_yaml": "global_network_connections:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaviewsGlobalNetworkConnectionType": { "type": "object", "description": "Global network connection.", "title": "Global Network Connection", "x-displayname": "Global Network Connection.", "x-ves-oneof-field-connection_choice": "[\"sli_to_global_dr\",\"slo_to_global_dr\"]", "x-ves-oneof-field-forward_proxy_choice": "[]", "x-ves-proto-message": "ves.io.schema.views.GlobalNetworkConnectionType", "properties": { "sli_to_global_dr": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalConnectorType" } ], "x-f5xc-description-short": "Configuration parameter for sli to global dr.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "slo_to_global_dr" ] }, "slo_to_global_dr": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalConnectorType" } ], "x-f5xc-description-short": "Configuration parameter for slo to global dr.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sli_to_global_dr" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsGlobalNetworkConnectionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsMasterNode": { "type": "object", "description": "Master Node is the configuration of the master node.", "title": "Master Node", "x-displayname": "Master Node.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.MasterNode", "properties": { "name": { "type": "string", "description": "Names of master node.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Master-0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "master-0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "public_ip": { "type": "string", "description": "IP Address of the master node. This IP will be used when other sites connect\nvia Site Mesh Group.", "title": "Public IP", "x-displayname": "Public IP", "x-ves-example": "192.0.2.102.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.102", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Master Node is the configuration of the master node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsMasterNode", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"master-0\"\n}", "example_yaml": "name: master-0" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsPrefixStringListType": { "type": "object", "description": "List of IPv4 prefixes that represent an endpoint.", "title": "ipv4 prefix list", "x-displayname": "IPv4 Prefix List.", "x-ves-proto-message": "ves.io.schema.views.PrefixStringListType", "properties": { "prefixes": { "type": "array", "description": "List of IPv4 prefixes that represent an endpoint.", "title": "ipv4 prefix list", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "IPv4 Prefix List.", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of IPv4 prefixes that represent an endpoint.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-example": "192.0.2.0/24", "x-f5xc-description-short": "List of IPv4 prefixes that represent an endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsPrefixStringListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsvoltstack_siteCreateSpecType": { "type": "object", "description": "Shape of the App Stack site specification.", "title": "CreateSpecType", "x-displayname": "Create App Stack site.", "x-ves-oneof-field-blocked_services_choice": "[\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-bond_choice": "[\"bond_device_list\",\"no_bond_devices\"]", "x-ves-oneof-field-gpu_choice": "[\"disable_gpu\",\"enable_gpu\",\"enable_vgpu\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-local_control_plane_choice": "[\"local_control_plane\",\"no_local_control_plane\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_cfg_choice": "[\"custom_network_config\",\"default_network_config\"]", "x-ves-oneof-field-sriov_interface_choice": "[\"default_sriov_interface\",\"sriov_interfaces\"]", "x-ves-oneof-field-storage_cfg_choice": "[\"custom_storage_config\",\"default_storage_config\"]", "x-ves-oneof-field-usb_policy_choice": "[\"allow_all_usb\",\"deny_all_usb\",\"usb_policy\"]", "x-ves-oneof-field-vm_choice": "[\"disable_vm\",\"enable_vm\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.CreateSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allow_all_usb": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for allow all usb.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "deny_all_usb", "usb_policy" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_blocked_services" ] }, "bond_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDevicesListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_bond_devices" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_network_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVssNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_network_config" ] }, "custom_storage_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVssStorageConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage_config" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "default_network_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_network_config" ] }, "default_sriov_interface": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default sriov interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sriov_interfaces" ] }, "default_storage_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage_config" ] }, "deny_all_usb": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for deny all usb.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_all_usb", "usb_policy" ] }, "disable_gpu": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable gpu.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_gpu", "enable_vgpu" ] }, "disable_vm": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_vm" ] }, "enable_gpu": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_gpu", "enable_vgpu" ] }, "enable_vgpu": { "allOf": [ { "$ref": "#/components/schemas/fleetVGPUConfiguration" } ], "x-f5xc-description-short": "Configuration parameter for enable vgpu.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_gpu", "enable_gpu" ] }, "enable_vm": { "allOf": [ { "$ref": "#/components/schemas/fleetVMConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_vm" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_control_plane": { "allOf": [ { "$ref": "#/components/schemas/fleetLocalControlPlaneType" } ], "x-f5xc-description-short": "Configuration parameter for local control plane.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_local_control_plane" ] }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "master_node_configuration": { "type": "array", "description": "Configuration of master nodes.", "maxItems": 3, "items": { "$ref": "#/components/schemas/viewsMasterNode" }, "x-displayname": "Master Nodes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_bond_devices": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no bond devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_device_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_local_control_plane": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no local control plane.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "local_control_plane" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sriov_interfaces": { "allOf": [ { "$ref": "#/components/schemas/fleetSriovInterfacesListType" } ], "x-f5xc-description-short": "Configuration parameter for sriov interfaces.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sriov_interface" ] }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "usb_policy": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_all_usb", "deny_all_usb" ], "x-f5xc-references": [ { "resource_kind": "usb_policy", "field_path": "usb_policy", "gated_by": { "choice": "usb_policy_choice" }, "required": false, "cardinality": "single" } ] }, "volterra_certified_hw": { "type": "string", "description": "Name for generic server certified hardware to form this App Stack site.", "minLength": 1, "x-displayname": "Generic Server Certified Hardware.", "x-ves-example": "Isv-8000-series-voltstack-combo.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "isv-8000-series-voltstack-combo", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name for generic server certified hardware to form this App Stack site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "worker_nodes": { "type": "array", "description": "Names of worker nodes.", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "Worker Nodes.", "x-ves-example": "Worker-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "worker-0", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the App Stack site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsvoltstack_siteCreateSpecType", "required_fields": [ "master_node_configuration", "volterra_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"master_node_configuration\": [\n {\n \"name\": \"master-0\"\n }\n ],\n \"volterra_certified_hw\": \"isv-8000-series-voltstack-combo\"\n}", "example_yaml": "master_node_configuration:\n- name: master-0\nvolterra_certified_hw: isv-8000-series-voltstack-combo" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsvoltstack_siteGetSpecType": { "type": "object", "description": "Shape of the App Stack site specification.", "title": "GetSpecType", "x-displayname": "GET App Stack site.", "x-ves-oneof-field-blocked_services_choice": "[\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-bond_choice": "[\"bond_device_list\",\"no_bond_devices\"]", "x-ves-oneof-field-gpu_choice": "[\"disable_gpu\",\"enable_gpu\",\"enable_vgpu\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-local_control_plane_choice": "[\"local_control_plane\",\"no_local_control_plane\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_cfg_choice": "[\"custom_network_config\",\"default_network_config\"]", "x-ves-oneof-field-sriov_interface_choice": "[\"default_sriov_interface\",\"sriov_interfaces\"]", "x-ves-oneof-field-storage_cfg_choice": "[\"custom_storage_config\",\"default_storage_config\"]", "x-ves-oneof-field-usb_policy_choice": "[\"allow_all_usb\",\"deny_all_usb\",\"usb_policy\"]", "x-ves-oneof-field-vm_choice": "[\"disable_vm\",\"enable_vm\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.GetSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allow_all_usb": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for allow all usb.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "deny_all_usb", "usb_policy" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_blocked_services" ] }, "bond_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDevicesListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_bond_devices" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_network_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVssNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_network_config" ] }, "custom_storage_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVssStorageConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage_config" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "default_network_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_network_config" ] }, "default_sriov_interface": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default sriov interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sriov_interfaces" ] }, "default_storage_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage_config" ] }, "deny_all_usb": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for deny all usb.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_all_usb", "usb_policy" ] }, "disable_gpu": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable gpu.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_gpu", "enable_vgpu" ] }, "disable_vm": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_vm" ] }, "enable_gpu": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_gpu", "enable_vgpu" ] }, "enable_vgpu": { "allOf": [ { "$ref": "#/components/schemas/fleetVGPUConfiguration" } ], "x-f5xc-description-short": "Configuration parameter for enable vgpu.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_gpu", "enable_gpu" ] }, "enable_vm": { "allOf": [ { "$ref": "#/components/schemas/fleetVMConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_vm" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_control_plane": { "allOf": [ { "$ref": "#/components/schemas/fleetLocalControlPlaneType" } ], "x-f5xc-description-short": "Configuration parameter for local control plane.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_local_control_plane" ] }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "master_node_configuration": { "type": "array", "description": "Configuration of master nodes.", "maxItems": 3, "items": { "$ref": "#/components/schemas/viewsMasterNode" }, "x-displayname": "Master Nodes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_bond_devices": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no bond devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_device_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_local_control_plane": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no local control plane.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "local_control_plane" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operating_system_version": { "type": "string", "description": "Desired Operating System version that should be installed on the site.", "maxLength": 256, "x-displayname": "Operating System Version.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Desired Operating System version that should be installed on the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sriov_interfaces": { "allOf": [ { "$ref": "#/components/schemas/fleetSriovInterfacesListType" } ], "x-f5xc-description-short": "Configuration parameter for sriov interfaces.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sriov_interface" ] }, "usb_policy": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_all_usb", "deny_all_usb" ], "x-f5xc-references": [ { "resource_kind": "usb_policy", "field_path": "usb_policy", "gated_by": { "choice": "usb_policy_choice" }, "required": false, "cardinality": "single" } ] }, "volterra_certified_hw": { "type": "string", "description": "Name for generic server certified hardware to form this App Stack site.", "minLength": 1, "x-displayname": "Generic Server Certified Hardware.", "x-ves-example": "Isv-8000-series-voltstack-combo.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "isv-8000-series-voltstack-combo", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name for generic server certified hardware to form this App Stack site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "volterra_software_version": { "type": "string", "description": "Desired F5 Distributed Cloud software version that should be installed on the site.", "maxLength": 256, "x-displayname": "Software Version.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Desired F5 Distributed Cloud software version that should be installed on the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "worker_nodes": { "type": "array", "description": "Names of worker nodes.", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "Worker Nodes.", "x-ves-example": "Worker-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "worker-0", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the App Stack site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsvoltstack_siteGetSpecType", "required_fields": [ "master_node_configuration", "volterra_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"master_node_configuration\": [\n {\n \"name\": \"master-0\"\n }\n ],\n \"volterra_certified_hw\": \"isv-8000-series-voltstack-combo\"\n}", "example_yaml": "master_node_configuration:\n- name: master-0\nvolterra_certified_hw: isv-8000-series-voltstack-combo" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsvoltstack_siteReplaceSpecType": { "type": "object", "description": "Shape of the App Stack site replace specification.", "title": "ReplaceSpecType", "x-displayname": "Replace App Stack site.", "x-ves-oneof-field-blocked_services_choice": "[\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-bond_choice": "[\"bond_device_list\",\"no_bond_devices\"]", "x-ves-oneof-field-gpu_choice": "[\"disable_gpu\",\"enable_gpu\",\"enable_vgpu\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-local_control_plane_choice": "[\"local_control_plane\",\"no_local_control_plane\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_cfg_choice": "[\"custom_network_config\",\"default_network_config\"]", "x-ves-oneof-field-sriov_interface_choice": "[\"default_sriov_interface\",\"sriov_interfaces\"]", "x-ves-oneof-field-storage_cfg_choice": "[\"custom_storage_config\",\"default_storage_config\"]", "x-ves-oneof-field-usb_policy_choice": "[\"allow_all_usb\",\"deny_all_usb\",\"usb_policy\"]", "x-ves-oneof-field-vm_choice": "[\"disable_vm\",\"enable_vm\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.ReplaceSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allow_all_usb": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for allow all usb.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "deny_all_usb", "usb_policy" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_blocked_services" ] }, "bond_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDevicesListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_bond_devices" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_network_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVssNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_network_config" ] }, "custom_storage_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVssStorageConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage_config" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "default_network_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_network_config" ] }, "default_sriov_interface": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default sriov interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sriov_interfaces" ] }, "default_storage_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_storage_config" ] }, "deny_all_usb": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for deny all usb.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_all_usb", "usb_policy" ] }, "disable_gpu": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable gpu.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_gpu", "enable_vgpu" ] }, "disable_vm": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_vm" ] }, "enable_gpu": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_gpu", "enable_vgpu" ] }, "enable_vgpu": { "allOf": [ { "$ref": "#/components/schemas/fleetVGPUConfiguration" } ], "x-f5xc-description-short": "Configuration parameter for enable vgpu.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_gpu", "enable_gpu" ] }, "enable_vm": { "allOf": [ { "$ref": "#/components/schemas/fleetVMConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_vm" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_control_plane": { "allOf": [ { "$ref": "#/components/schemas/fleetLocalControlPlaneType" } ], "x-f5xc-description-short": "Configuration parameter for local control plane.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_local_control_plane" ] }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "master_node_configuration": { "type": "array", "description": "Configuration of master nodes.", "maxItems": 3, "items": { "$ref": "#/components/schemas/viewsMasterNode" }, "x-displayname": "Master Nodes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_bond_devices": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no bond devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_device_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_local_control_plane": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no local control plane.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "local_control_plane" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sriov_interfaces": { "allOf": [ { "$ref": "#/components/schemas/fleetSriovInterfacesListType" } ], "x-f5xc-description-short": "Configuration parameter for sriov interfaces.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sriov_interface" ] }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "usb_policy": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_all_usb", "deny_all_usb" ], "x-f5xc-references": [ { "resource_kind": "usb_policy", "field_path": "usb_policy", "gated_by": { "choice": "usb_policy_choice" }, "required": false, "cardinality": "single" } ] }, "volterra_certified_hw": { "type": "string", "description": "Name for generic server certified hardware to form this App Stack site.", "minLength": 1, "x-displayname": "Generic Server Certified Hardware.", "x-ves-example": "Isv-8000-series-voltstack-combo.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "isv-8000-series-voltstack-combo", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name for generic server certified hardware to form this App Stack site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "worker_nodes": { "type": "array", "description": "Names of worker nodes.", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "Worker Nodes.", "x-ves-example": "Worker-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "worker-0", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the App Stack site replace specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsvoltstack_siteReplaceSpecType", "required_fields": [ "master_node_configuration", "volterra_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"master_node_configuration\": [\n {\n \"name\": \"master-0\"\n }\n ],\n \"volterra_certified_hw\": \"isv-8000-series-voltstack-combo\"\n}", "example_yaml": "master_node_configuration:\n- name: master-0\nvolterra_certified_hw: isv-8000-series-voltstack-combo" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "virtual_networkStaticRouteViewType": { "type": "object", "description": "Defines a static route, configuring a list of prefixes and a next-hop to be used for them.", "title": "Static Route", "x-displayname": "Static Route.", "x-ves-oneof-field-next_hop_choice": "[\"default_gateway\",\"ip_address\",\"node_interface\"]", "x-ves-proto-message": "ves.io.schema.virtual_network.StaticRouteViewType", "properties": { "attrs": { "type": "array", "description": "List of attributes that control forwarding, dynamic routing and control plane (host) reachability.", "title": "Attributes", "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaRouteAttrType" }, "x-displayname": "Attributes.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of attributes that control forwarding, dynamic routing and control plane (host) reachability.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_gateway": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_address", "node_interface" ] }, "ip_address": { "type": "string", "description": "Exclusive with [default_gateway node_interface]\nTraffic matching the IP prefixes is sent to this IP Address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.", "x-f5xc-description-medium": "Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ipv4", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_gateway", "node_interface" ] }, "ip_prefixes": { "type": "array", "description": "List of route prefixes that have common next hop and attributes.", "title": "IP Prefixes", "minItems": 1, "maxItems": 256, "items": { "type": "string" }, "x-displayname": "IP Prefixes.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of route prefixes that have common next hop and attributes.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 256, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "node_interface": { "allOf": [ { "$ref": "#/components/schemas/schemaNodeInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for node interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_gateway", "ip_address" ] } }, "x-f5xc-description-short": "Defines a static route, configuring a list of prefixes and a next-hop to be used for them.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_networkStaticRouteViewType", "required_fields": [ "ip_prefixes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_prefixes\": [\n \"value\"\n ]\n}", "example_yaml": "ip_prefixes:\n- value" }, "x-f5xc-cli-domain": "network", "x-f5xc-required-oneof-groups": { "next_hop_choice": [ "default_gateway", "ip_address", "node_interface" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual network is platform-level infrastructure" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "virtual_networkStaticV6RouteViewType": { "type": "object", "description": "Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.", "title": "Static IPv6 Route", "x-displayname": "Static IPv6 Route.", "x-ves-oneof-field-next_hop_choice": "[\"default_gateway\",\"ip_address\",\"node_interface\"]", "x-ves-proto-message": "ves.io.schema.virtual_network.StaticV6RouteViewType", "properties": { "attrs": { "type": "array", "description": "List of attributes that control forwarding, dynamic routing and control plane (host) reachability.", "title": "Attributes", "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaRouteAttrType" }, "x-displayname": "Attributes.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of attributes that control forwarding, dynamic routing and control plane (host) reachability.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_gateway": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_address", "node_interface" ] }, "ip_address": { "type": "string", "description": "Exclusive with [default_gateway node_interface]\nTraffic matching the IP prefixes is sent to this IP Address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.", "x-f5xc-description-medium": "Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ipv6", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_gateway", "node_interface" ] }, "ip_prefixes": { "type": "array", "description": "List of IPv6 route prefixes that have common next hop and attributes.", "title": "IPv6 Prefixes", "minItems": 1, "maxItems": 256, "items": { "type": "string" }, "x-displayname": "IPv6 Prefixes.", "x-ves-example": "2001::/92", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv6_prefix": "true", "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "2001::/92", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv6_prefix": "true", "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of IPv6 route prefixes that have common next hop and attributes.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 256, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "node_interface": { "allOf": [ { "$ref": "#/components/schemas/schemaNodeInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for node interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_gateway", "ip_address" ] } }, "x-f5xc-description-short": "Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.", "x-f5xc-description-medium": "Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_networkStaticV6RouteViewType", "required_fields": [ "ip_prefixes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_prefixes\": [\n \"value\"\n ]\n}", "example_yaml": "ip_prefixes:\n- value" }, "x-f5xc-cli-domain": "network", "x-f5xc-required-oneof-groups": { "next_hop_choice": [ "default_gateway", "ip_address", "node_interface" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual network is platform-level infrastructure" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "virtual_networkStaticV6RoutesListType": { "type": "object", "description": "List of IPv6 static routes.", "title": "Static IPv6 Routes List", "x-displayname": "Static IPv6 Routes List.", "x-ves-proto-message": "ves.io.schema.virtual_network.StaticV6RoutesListType", "properties": { "static_routes": { "type": "array", "description": "List of IPv6 static routes.", "title": "static_routes", "minItems": 1, "maxItems": 16, "items": { "$ref": "#/components/schemas/virtual_networkStaticV6RouteViewType" }, "x-displayname": "Static IPv6 Routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_networkStaticV6RoutesListType", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n {\n \"ip_prefixes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "static_routes:\n- ip_prefixes:\n - value" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual network is platform-level infrastructure" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "voltstack_siteCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of voltstack_site", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsvoltstack_siteCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsvoltstack_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a voltstack_site", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read voltstack_site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsvoltstack_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/voltstack_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteInterface": { "type": "object", "description": "Interface definition.", "title": "Interface", "x-displayname": "Interface", "x-ves-oneof-field-dc_cluster_group_connectivity_interface_choice": "[\"dc_cluster_group_connectivity_interface_disabled\",\"dc_cluster_group_connectivity_interface_enabled\"]", "x-ves-oneof-field-interface_choice": "[\"dedicated_interface\",\"dedicated_management_interface\",\"ethernet_interface\",\"tunnel_interface\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.Interface", "properties": { "dc_cluster_group_connectivity_interface_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_connectivity_interface_enabled" ] }, "dc_cluster_group_connectivity_interface_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_connectivity_interface_disabled" ] }, "dedicated_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDedicatedInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for dedicated interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_management_interface", "ethernet_interface", "tunnel_interface" ] }, "dedicated_management_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDedicatedManagementInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for dedicated management interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_interface", "ethernet_interface", "tunnel_interface" ] }, "description": { "type": "string", "description": "Description for this Interface.", "title": "Interface Description", "maxLength": 256, "x-displayname": "Interface Description.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ethernet_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceEthernetInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for ethernet interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_interface", "dedicated_management_interface", "tunnel_interface" ] }, "labels": { "type": "object", "description": "Add Labels for this Interface, these labels can be used in firewall policy.", "title": "Interface labels", "x-displayname": "Interface Labels.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add Labels for this Interface, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceTunnelInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for tunnel interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_interface", "dedicated_management_interface", "ethernet_interface" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteInterface", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteInterfaceListType": { "type": "object", "description": "Configure network interfaces for this App Stack site.", "title": "List of Interfaces", "x-displayname": "List of Interface.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.InterfaceListType", "properties": { "interfaces": { "type": "array", "description": "Configure network interfaces for this App Stack site.", "title": "List of Interfaces", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/voltstack_siteInterface" }, "x-displayname": "List of Interface.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Configure network interfaces for this App Stack site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Configure network interfaces for this App Stack site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteInterfaceListType", "required_fields": [ "interfaces" ], "mutually_exclusive_groups": [], "example_json": "{\n \"interfaces\": [\n {}\n ]\n}", "example_yaml": "interfaces:\n- {}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of voltstack_site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/voltstack_siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteListResponseItem": { "type": "object", "description": "By default a summary of customer_edge_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of voltstack_site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this customer_edge_site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this customer_edge_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this customer_edge_site.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this customer_edge_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates customer_edge_site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates customer_edge_site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewsvoltstack_siteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this customer_edge_site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this customer_edge_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this customer_edge_site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/voltstack_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this customer_edge_site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this customer_edge_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of customer_edge_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of customer_edge_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a voltstack_site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsvoltstack_siteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteSliVnConfiguration": { "type": "object", "description": "Site local inside network configuration.", "title": "SLI Virtual Network Configuration", "x-displayname": "Site Local Inside Network Configuration.", "x-ves-oneof-field-static_route_choice": "[\"no_static_routes\",\"static_routes\"]", "x-ves-oneof-field-static_v6_route_choice": "[\"no_v6_static_routes\",\"static_v6_routes\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.SliVnConfiguration", "properties": { "no_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_routes" ] }, "no_v6_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no v6 static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_v6_routes" ] }, "static_routes": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_routes" ] }, "static_v6_routes": { "allOf": [ { "$ref": "#/components/schemas/virtual_networkStaticV6RoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static v6 routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_v6_static_routes" ] } }, "x-f5xc-description-short": "Site local inside network configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteSliVnConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteStaticRoutesListType": { "type": "object", "description": "List of static routes.", "title": "Static Routes List", "x-displayname": "Static Routes List.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.StaticRoutesListType", "properties": { "static_routes": { "type": "array", "description": "List of static routes.", "title": "static_routes", "minItems": 1, "maxItems": 16, "items": { "$ref": "#/components/schemas/virtual_networkStaticRouteViewType" }, "x-displayname": "Static Routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteStaticRoutesListType", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n {\n \"ip_prefixes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "static_routes:\n- ip_prefixes:\n - value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "F5XC App Stack site object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-description-short": "F5XC App Stack site object direct reference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteStorageInterfaceListType": { "type": "object", "description": "Configure storage interfaces for this App Stack site.", "title": "List of Interfaces", "x-displayname": "List of Interface.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.StorageInterfaceListType", "properties": { "storage_interfaces": { "type": "array", "description": "Configure storage interfaces for this App Stack site.", "title": "List of Interfaces", "minItems": 1, "maxItems": 256, "items": { "$ref": "#/components/schemas/voltstack_siteStorageInterfaceType" }, "x-displayname": "List of Interface.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Configure storage interfaces for this App Stack site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 256, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Configure storage interfaces for this App Stack site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteStorageInterfaceListType", "required_fields": [ "storage_interfaces" ], "mutually_exclusive_groups": [], "example_json": "{\n \"storage_interfaces\": [\n {}\n ]\n}", "example_yaml": "storage_interfaces:\n- {}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteStorageInterfaceType": { "type": "object", "description": "Configure storage interface for this App Stack site.", "title": "Storage Interfaces", "x-displayname": "Storage Interface.", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.StorageInterfaceType", "properties": { "description": { "type": "string", "description": "Description for this Interface.", "title": "Interface Description", "maxLength": 256, "x-displayname": "Interface Description.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "labels": { "type": "object", "description": "Add Labels for this Interface, these labels can be used in firewall policy.", "title": "Interface labels", "x-displayname": "Interface Labels.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add Labels for this Interface, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceEthernetInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for storage interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Configure storage interface for this App Stack site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteStorageInterfaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteVnConfiguration": { "type": "object", "description": "Site local network configuration.", "title": "Virtual Network Configuration", "x-displayname": "Site Local Network Configuration.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-static_route_choice": "[\"no_static_routes\",\"static_routes\"]", "x-ves-oneof-field-static_v6_route_choice": "[\"no_static_v6_routes\",\"static_v6_routes\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.VnConfiguration", "properties": { "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "labels": { "type": "object", "description": "Add Labels for this network, these labels can be used in firewall policy.", "title": "Network labels", "x-displayname": "Network Labels.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add Labels for this network, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_routes" ] }, "no_static_v6_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static v6 routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_v6_routes" ] }, "static_routes": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_routes" ] }, "static_v6_routes": { "allOf": [ { "$ref": "#/components/schemas/virtual_networkStaticV6RoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static v6 routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_v6_routes" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteVnConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteVssNetworkConfiguration": { "type": "object", "title": "VssNetworkConfiguration", "x-displayname": "VssNetworkConfiguration.", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-interface_choice": "[\"default_interface_config\",\"interface_list\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"site_to_site_tunnel_ip\",\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-oneof-field-sli_choice": "[\"default_sli_config\",\"sli_config\"]", "x-ves-oneof-field-slo_choice": "[\"default_config\",\"slo_config\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.VssNetworkConfiguration", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "bgp_peer_address": { "type": "string", "description": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured\nto fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.", "title": "bgp_peer_address", "x-displayname": "BGP Peer Address.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object.", "x-f5xc-description-medium": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_router_id": { "type": "string", "description": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to\nfetch BGP router ID from site object.", "title": "bgp_router_id", "x-displayname": "BGP Router ID.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.", "x-f5xc-description-medium": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "default_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "slo_config" ] }, "default_interface_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "interface_list" ] }, "default_sli_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sli_config" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "interface_list": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteInterfaceListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_interface_config" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "outside_nameserver": { "type": "string", "description": "Optional DNS server V4 IP to be used for name resolution in local network.", "title": "outside_nameserver", "x-displayname": "DNS V4 Server for Local Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional DNS server V4 IP to be used for name resolution in local network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip": { "type": "string", "description": "Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.", "title": "Common V4 VIP", "x-displayname": "Common V4 VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional common virtual V4 IP across all nodes to be used as automatic VIP for site local network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_to_site_tunnel_ip": { "type": "string", "description": "Exclusive with [sm_connection_public_ip sm_connection_pvt_ip]\nSite Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for\ncreating IPsec between two sites which are part of the site mesh group.", "title": "Site Mesh Group Connection Via Virtual Ip", "x-displayname": "Site Mesh Group Connection Via Virtual IP.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Exclusive with [sm_connection_public_ip sm_connection_pvt_ip] Site Mesh Group Connection Via Virtual IP.", "x-f5xc-description-medium": "Exclusive with [sm_connection_public_ip sm_connection_pvt_ip] Site Mesh Group Connection Via Virtual IP. This option will use the Virtual IP provided for creating IPsec between two sites which are part of the site mesh group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip", "sm_connection_pvt_ip" ] }, "sli_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteSliVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sli_config" ] }, "slo_config": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_config" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_to_site_tunnel_ip", "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_to_site_tunnel_ip", "sm_connection_public_ip" ] }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "title": "tunnel_dead_timeout", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_vrrp_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaVipVrrpType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteVssNetworkConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "voltstack_siteVssStorageConfiguration": { "type": "object", "title": "VssStorageConfiguration", "x-displayname": "VssStorageConfiguration.", "x-ves-oneof-field-static_route_choice": "[\"no_static_routes\",\"static_routes\"]", "x-ves-oneof-field-storage_class_choice": "[\"default_storage_class\",\"storage_class_list\"]", "x-ves-oneof-field-storage_device_choice": "[\"no_storage_device\",\"storage_device_list\"]", "x-ves-oneof-field-storage_interface_choice": "[\"no_storage_interfaces\",\"storage_interface_list\"]", "x-ves-proto-message": "ves.io.schema.views.voltstack_site.VssStorageConfiguration", "properties": { "default_storage_class": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default storage class.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_class_list" ] }, "no_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_routes" ] }, "no_storage_device": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no storage device.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_device_list" ] }, "no_storage_interfaces": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no storage interfaces.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_interface_list" ] }, "static_routes": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_routes" ] }, "storage_class_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetStorageClassListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage_class" ] }, "storage_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetStorageDeviceListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_storage_device" ] }, "storage_interface_list": { "allOf": [ { "$ref": "#/components/schemas/voltstack_siteStorageInterfaceListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_storage_interfaces" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for voltstack_siteVssStorageConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Voltstack site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureDiskEncryption": { "type": "object", "description": "Information related to disk encryption.", "title": "Disk Encryption", "x-displayname": "Disk Encryption.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureDiskEncryption", "properties": { "disk_encryption_set_id": { "type": "string", "description": "Azure Disk Encryption Set to be used to encrypt the disk attached to the VM.", "title": "Disk Encryption Set", "x-displayname": "Disk Encryption Set.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Azure Disk Encryption Set to be used to encrypt the disk attached to the VM.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_group": { "type": "string", "description": "The resource group in which the Disk Encryption Set is present.", "title": "Resource group", "minLength": 1, "maxLength": 64, "x-displayname": "Disk Encryption Set Resource Group.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "The resource group in which the Disk Encryption Set is present.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureDiskEncryption", "required_fields": [ "disk_encryption_set_id", "resource_group" ], "mutually_exclusive_groups": [], "example_json": "{\n \"disk_encryption_set_id\": \"value\",\n \"resource_group\": \"value\"\n}", "example_yaml": "disk_encryption_set_id: value\nresource_group: value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureHubVnetType": { "type": "object", "description": "Hub VNet type.", "title": "Azure Hub VNet Type", "x-displayname": "Hub VNet type.", "x-ves-oneof-field-express_route_choice": "[\"express_route_disabled\",\"express_route_enabled\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureHubVnetType", "properties": { "express_route_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "express_route_enabled" ] }, "express_route_enabled": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteExpressRouteConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "express_route_disabled" ] }, "spoke_vnets": { "type": "array", "description": "Spoke VNet Peering.", "title": "Spoke VNet Peering", "maxItems": 100, "items": { "$ref": "#/components/schemas/azure_vnet_siteVnetPeeringType" }, "x-displayname": "Spoke VNet Peering (Legacy)", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 100, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureHubVnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressEgressGwARReplaceType": { "type": "object", "description": "Two interface Azure ingress/egress site for Alternate Region.", "title": "Azure Ingress Egress Gateway for Alternate Region", "x-displayname": "Azure Ingress/Egress Gateway for Alternate Region.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-hub_choice": "[\"hub\",\"not_hub\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressEgressGwARReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureHubVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "not_hub" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetTwoInterfaceNodeARType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not_hub": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hub" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "Two interface Azure ingress/egress site for Alternate Region.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressEgressGwARReplaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressEgressGwARType": { "type": "object", "description": "Two interface Azure ingress/egress site on Alternate Region with no support for zones.", "title": "Azure Ingress Egress Gateway on Alternate Region", "x-displayname": "Azure Ingress/Egress Gateway on Alternate Region.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-hub_choice": "[\"hub\",\"not_hub\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressEgressGwARType", "properties": { "accelerated_networking": { "allOf": [ { "$ref": "#/components/schemas/viewsAcceleratedNetworkingType" } ], "x-f5xc-description-short": "Configuration parameter for accelerated networking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "azure_certified_hw": { "type": "string", "description": "Name for Azure certified hardware.", "title": "Azure Certified Hardware", "maxLength": 64, "x-displayname": "Azure Certified Hardware.", "x-ves-example": "Azure-byol-multi-NIC-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "azure-byol-multi-nic-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "azure-byol-multi-nic-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureHubVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "not_hub" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetTwoInterfaceNodeARType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not_hub": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hub" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "Two interface Azure ingress/egress site on Alternate Region with no support for zones.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressEgressGwARType", "required_fields": [ "azure_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"azure_certified_hw\": \"azure-byol-multi-nic-voltmesh\"\n}", "example_yaml": "azure_certified_hw: azure-byol-multi-nic-voltmesh" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressEgressGwReplaceType": { "type": "object", "description": "Two interface Azure ingress/egress site.", "title": "Azure Ingress Egress Gateway", "x-displayname": "Azure Ingress/Egress Gateway.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-hub_choice": "[\"hub\",\"not_hub\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressEgressGwReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAzureVnetTwoInterfaceNodeType" }, "x-displayname": "Ingress/Egress Gateway (two Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureHubVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "not_hub" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "not_hub": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hub" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "Two interface Azure ingress/egress site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressEgressGwReplaceType", "required_fields": [ "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"azure_az\": \"1\"\n }\n ]\n}", "example_yaml": "az_nodes:\n- azure_az: '1'" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressEgressGwType": { "type": "object", "description": "Two interface Azure ingress/egress site.", "title": "Azure Ingress Egress Gateway on Recommended Region", "x-displayname": "Azure Ingress/Egress Gateway on Recommended Region.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-hub_choice": "[\"hub\",\"not_hub\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressEgressGwType", "properties": { "accelerated_networking": { "allOf": [ { "$ref": "#/components/schemas/viewsAcceleratedNetworkingType" } ], "x-f5xc-description-short": "Configuration parameter for accelerated networking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAzureVnetTwoInterfaceNodeType" }, "x-displayname": "Ingress/Egress Gateway (two Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "azure_certified_hw": { "type": "string", "description": "Name for Azure certified hardware.", "title": "Azure Certified Hardware", "maxLength": 64, "x-displayname": "Azure Certified Hardware.", "x-ves-example": "Azure-byol-multi-NIC-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "azure-byol-multi-nic-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "azure-byol-multi-nic-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "hub": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureHubVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "not_hub" ] }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "not_hub": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hub" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "Two interface Azure ingress/egress site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressEgressGwType", "required_fields": [ "az_nodes", "azure_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"azure_az\": \"1\"\n }\n ],\n \"azure_certified_hw\": \"azure-byol-multi-nic-voltmesh\"\n}", "example_yaml": "az_nodes:\n- azure_az: '1'\nazure_certified_hw: azure-byol-multi-nic-voltmesh" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressGwARReplaceType": { "type": "object", "description": "Single interface Azure ingress site for Alternate Region.", "title": "Azure Ingress Gateway for Alternate Region", "x-displayname": "Azure Ingress Gateway for Alternate Region.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressGwARReplaceType", "properties": { "node": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeARType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Single interface Azure ingress site for Alternate Region.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressGwARReplaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressGwARType": { "type": "object", "description": "Single interface Azure ingress site.", "title": "Azure Ingress Gateway on Alternate Region", "x-displayname": "Azure Ingress Gateway on Alternate Region.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressGwARType", "properties": { "accelerated_networking": { "allOf": [ { "$ref": "#/components/schemas/viewsAcceleratedNetworkingType" } ], "x-f5xc-description-short": "Configuration parameter for accelerated networking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "azure_certified_hw": { "type": "string", "description": "Name for Azure certified hardware.", "title": "Azure Certified Hardware", "maxLength": 64, "x-displayname": "Azure Certified Hardware.", "x-ves-example": "Azure-byol-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "azure-byol-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "azure-byol-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "node": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeARType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressGwARType", "required_fields": [ "azure_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"azure_certified_hw\": \"azure-byol-voltmesh\"\n}", "example_yaml": "azure_certified_hw: azure-byol-voltmesh" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressGwReplaceType": { "type": "object", "description": "Single interface Azure ingress site.", "title": "Azure Ingress Gateway", "x-displayname": "Azure Ingress Gateway.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressGwReplaceType", "properties": { "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeType" }, "x-displayname": "Ingress Gateway (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressGwReplaceType", "required_fields": [ "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"azure_az\": \"1\"\n }\n ]\n}", "example_yaml": "az_nodes:\n- azure_az: '1'" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetIngressGwType": { "type": "object", "description": "Single interface Azure ingress site on on Recommended Region.", "title": "Azure Ingress Gateway on Recommended Region", "x-displayname": "Azure Ingress Gateway on Recommended Region.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetIngressGwType", "properties": { "accelerated_networking": { "allOf": [ { "$ref": "#/components/schemas/viewsAcceleratedNetworkingType" } ], "x-f5xc-description-short": "Configuration parameter for accelerated networking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": null, "x-f5xc-server-default": true }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeType" }, "x-displayname": "Ingress Gateway (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "azure_certified_hw": { "type": "string", "description": "Name for Azure certified hardware.", "title": "Azure Certified Hardware", "maxLength": 64, "x-displayname": "Azure Certified Hardware.", "x-ves-example": "Azure-byol-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "azure-byol-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "azure-byol-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": null, "x-f5xc-server-default": true } }, "x-f5xc-description-short": "Single interface Azure ingress site on on Recommended Region.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetIngressGwType", "required_fields": [ "az_nodes", "azure_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"azure_az\": \"1\"\n }\n ],\n \"azure_certified_hw\": \"azure-byol-voltmesh\"\n}", "example_yaml": "az_nodes:\n- azure_az: '1'\nazure_certified_hw: azure-byol-voltmesh" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetSiteInfoType": { "type": "object", "description": "Azure VNet Site information like.", "title": "Azure VNet Site Information Config", "x-displayname": "Azure VNet Site Information Config.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetSiteInfoType", "properties": { "express_route_info": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteExpressRouteInfo" } ], "x-f5xc-description-short": "Configuration parameter for express route info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_info": { "type": "array", "description": "Azure Node Name.", "title": "Azure Node Name", "items": { "$ref": "#/components/schemas/azure_vnet_siteNodeInstanceNameType" }, "x-displayname": "Azure Node Name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_ips": { "type": "array", "description": "Azure VM Private IPs used by the nodes.", "title": "Azure VM Private IPs", "items": { "type": "string" }, "x-displayname": "Azure VM Private IPs.", "x-ves-example": "192.0.2.246, 192.0.2.204, 192.0.2.170.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.246, 192.0.2.204, 192.0.2.170", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "public_ips": { "type": "array", "description": "Azure VM Public IPs used by the nodes.", "title": "Azure VM Public IPs", "items": { "type": "string" }, "x-displayname": "Azure VM Public IPs.", "x-ves-example": "192.0.2.242, 192.0.2.31, 192.0.2.63.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.242, 192.0.2.31, 192.0.2.63", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spoke_vnet_prefix_info": { "type": "array", "description": "Azure Spoke VNet Prefix Information.", "title": "Azure Spoke VNet Prefix Information", "maxItems": 500, "items": { "$ref": "#/components/schemas/azure_vnet_siteVnetIpPrefixesType" }, "x-displayname": "Azure Spoke VNet Prefix Information.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "500" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "500" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 500, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteVNETInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetSiteInfoType", "required_fields": [ "private_ips", "public_ips" ], "mutually_exclusive_groups": [], "example_json": "{\n \"private_ips\": [\n \"value\"\n ],\n \"public_ips\": [\n \"value\"\n ]\n}", "example_yaml": "private_ips:\n- value\npublic_ips:\n- value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetVoltstackClusterARReplaceType": { "type": "object", "description": "App Stack cluster of single interface Azure nodes.", "title": "Azure App Stack Cluster for Alternate Region", "x-displayname": "Azure App Stack Cluster for Alternate Region.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetVoltstackClusterARReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeARType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "App Stack cluster of single interface Azure nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetVoltstackClusterARReplaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetVoltstackClusterARType": { "type": "object", "description": "App Stack Cluster of single interface Azure nodes.", "title": "Azure App Stack Cluster on Alternate Region", "x-displayname": "Azure App Stack Cluster on Alternate Region.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-oneof-field-storage_class_choice": "[\"default_storage\",\"storage_class_list\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetVoltstackClusterARType", "properties": { "accelerated_networking": { "allOf": [ { "$ref": "#/components/schemas/viewsAcceleratedNetworkingType" } ], "x-f5xc-description-short": "Configuration parameter for accelerated networking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "azure_certified_hw": { "type": "string", "description": "Name for Azure certified hardware.", "title": "Azure Certified Hardware", "maxLength": 64, "x-displayname": "Azure Certified Hardware.", "x-ves-example": "Azure-byol-voltstack-combo.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "azure-byol-voltstack-combo", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "azure-byol-voltstack-combo" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "default_storage": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_class_list" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeARType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] }, "storage_class_list": { "allOf": [ { "$ref": "#/components/schemas/viewsStorageClassListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage" ] } }, "x-f5xc-description-short": "App Stack Cluster of single interface Azure nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetVoltstackClusterARType", "required_fields": [ "azure_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"azure_certified_hw\": \"azure-byol-voltstack-combo\"\n}", "example_yaml": "azure_certified_hw: azure-byol-voltstack-combo" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetVoltstackClusterReplaceType": { "type": "object", "description": "App Stack cluster of single interface Azure nodes.", "title": "Azure App Stack Cluster", "x-displayname": "Azure App Stack Cluster.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetVoltstackClusterReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeType" }, "x-displayname": "App Stack Cluster (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "App Stack cluster of single interface Azure nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetVoltstackClusterReplaceType", "required_fields": [ "az_nodes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"azure_az\": \"1\"\n }\n ]\n}", "example_yaml": "az_nodes:\n- azure_az: '1'" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteAzureVnetVoltstackClusterType": { "type": "object", "description": "App Stack Cluster of single interface Azure nodes.", "title": "Azure App Stack Cluster on Recommended Region", "x-displayname": "Azure App Stack Cluster on Recommended Region.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-oneof-field-storage_class_choice": "[\"default_storage\",\"storage_class_list\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.AzureVnetVoltstackClusterType", "properties": { "accelerated_networking": { "allOf": [ { "$ref": "#/components/schemas/viewsAcceleratedNetworkingType" } ], "x-f5xc-description-short": "Configuration parameter for accelerated networking.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "az_nodes": { "type": "array", "description": "Only Single AZ or Three AZ(s) nodes are supported currently.", "title": "Nodes", "items": { "$ref": "#/components/schemas/viewsAzureVnetOneInterfaceNodeType" }, "x-displayname": "App Stack Cluster (One Interface) Nodes in AZ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-description-short": "Only Single AZ or Three AZ(s) nodes are supported currently.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "azure_certified_hw": { "type": "string", "description": "Name for Azure certified hardware.", "title": "Azure Certified Hardware", "maxLength": 64, "x-displayname": "Azure Certified Hardware.", "x-ves-example": "Azure-byol-voltstack-combo.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "azure-byol-voltstack-combo", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"azure-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "azure-byol-voltstack-combo" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "default_storage": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_class_list" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] }, "storage_class_list": { "allOf": [ { "$ref": "#/components/schemas/viewsStorageClassListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage" ] } }, "x-f5xc-description-short": "App Stack Cluster of single interface Azure nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteAzureVnetVoltstackClusterType", "required_fields": [ "az_nodes", "azure_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"az_nodes\": [\n {\n \"azure_az\": \"1\"\n }\n ],\n \"azure_certified_hw\": \"azure-byol-voltstack-combo\"\n}", "example_yaml": "az_nodes:\n- azure_az: '1'\nazure_certified_hw: azure-byol-voltstack-combo" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of azure_vnet_site", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsazure_vnet_siteCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Azure Virtual Network CE site for deploying F5 XC nodes in Azure", "required_fields": [ "metadata.name", "metadata.namespace", "spec.azure_region", "spec.resource_group", "spec.azure_cred", "spec.vnet", "spec.ssh_key" ], "mutually_exclusive_groups": [ { "name": "vnet_choice", "fields": [ "spec.vnet.new_vnet", "spec.vnet.existing_vnet" ], "reason": "Create new VNet or use existing" }, { "name": "deployment", "fields": [ "spec.ingress_gw", "spec.ingress_egress_gw", "spec.voltstack_cluster" ], "reason": "Choose site deployment type (REQUIRED)" } ], "example_yaml": "metadata:\n name: example-azure-site\n namespace: system\nspec:\n azure_region: eastus2\n machine_type: Standard_D4s_v4\n resource_group: example-resource-group\n azure_cred:\n name: example-azure-cred\n namespace: system\n vnet:\n new_vnet:\n name: example-vnet\n primary_ipv4: \"10.0.0.0/16\"\n ingress_gw:\n azure_certified_hw: azure-byol-voltmesh\n az_nodes:\n - azure_az: \"1\"\n local_subnet:\n subnet_param:\n ipv4: \"10.0.1.0/24\"\n ssh_key: \"ssh-rsa AAAA... user@host\"\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-azure-site\",\n \"namespace\": \"system\"\n },\n \"spec\": {\n \"azure_region\": \"eastus2\",\n \"machine_type\": \"Standard_D4s_v4\",\n \"resource_group\": \"example-resource-group\",\n \"azure_cred\": {\"name\": \"example-azure-cred\", \"namespace\": \"system\"},\n \"vnet\": {\"new_vnet\": {\"name\": \"example-vnet\", \"primary_ipv4\": \"10.0.0.0/16\"}},\n \"ingress_gw\": {\n \"azure_certified_hw\": \"azure-byol-voltmesh\",\n \"az_nodes\": [{\"azure_az\": \"1\", \"local_subnet\": {\"subnet_param\": {\"ipv4\": \"10.0.1.0/24\"}}}]\n },\n \"ssh_key\": \"ssh-rsa AAAA... user@host\"\n }\n}\n" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsazure_vnet_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a azure_vnet_site", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteExpressRouteConfigType": { "type": "object", "description": "Express Route Configuration.", "title": "Express Route Configuration", "x-displayname": "Express Route Configuration.", "x-ves-oneof-field-asn_choice": "[\"auto_asn\",\"custom_asn\"]", "x-ves-oneof-field-connectivity_options": "[\"site_registration_over_express_route\",\"site_registration_over_internet\"]", "x-ves-oneof-field-sku_choice": "[\"sku_ergw1az\",\"sku_ergw2az\",\"sku_high_perf\",\"sku_standard\"]", "x-ves-oneof-field-spoke_vnet_routes": "[\"advertise_to_route_server\",\"do_not_advertise_to_route_server\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ExpressRouteConfigType", "properties": { "advertise_to_route_server": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for advertise to route server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "do_not_advertise_to_route_server" ] }, "auto_asn": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_asn" ] }, "connections": { "type": "array", "description": "Add the ExpressRoute Circuit Connections to this site.", "title": "Connections", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/azure_vnet_siteExpressRouteConnectionType" }, "x-displayname": "Connections.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "Add the ExpressRoute Circuit Connections to this site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "custom_asn": { "type": "integer", "description": "Exclusive with [auto_asn]\nSet custom ASN for F5XC Site.", "title": "Custom ASN", "format": "int64", "x-displayname": "Custom ASN.", "x-ves-example": "64512", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "1", "ves.io.schema.rules.uint32.lte": "65535", "ves.io.schema.rules.uint32.not_in_ranges": "65515,65517,65518,65519,65520,8074,8075,12076,23456" }, "x-f5xc-example": "64512", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "1", "ves.io.schema.rules.uint32.lte": "65535", "ves.io.schema.rules.uint32.not_in_ranges": "65515,65517,65518,65519,65520,8074,8075,12076,23456" }, "x-f5xc-description-short": "Exclusive with [auto_asn] Set custom ASN for F5XC Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "minimum": 2, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auto_asn" ] }, "do_not_advertise_to_route_server": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for do not advertise to route server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_to_route_server" ] }, "gateway_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceWithAutoType" } ], "x-f5xc-description-short": "Configuration parameter for gateway subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_server_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceWithAutoType" } ], "x-f5xc-description-short": "Configuration parameter for route server subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_registration_over_express_route": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudLinkADNType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_registration_over_internet" ] }, "site_registration_over_internet": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_registration_over_express_route" ] }, "sku_ergw1az": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for sku ergw1az.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sku_ergw2az", "sku_high_perf", "sku_standard" ] }, "sku_ergw2az": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for sku ergw2az.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sku_ergw1az", "sku_high_perf", "sku_standard" ] }, "sku_high_perf": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for sku high perf.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sku_ergw1az", "sku_ergw2az", "sku_standard" ] }, "sku_standard": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for sku standard.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sku_ergw1az", "sku_ergw2az", "sku_high_perf" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteExpressRouteConfigType", "required_fields": [ "connections" ], "mutually_exclusive_groups": [], "example_json": "{\n \"connections\": [\n {}\n ]\n}", "example_yaml": "connections:\n- {}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteExpressRouteConnectionType": { "type": "object", "description": "Express Route Connection Configuration.", "title": "Express Route Connection Configuration", "x-displayname": "Express Route Connection Configuration.", "x-ves-displayorder": "3", "x-ves-oneof-field-subscription_choice": "[\"circuit_id\",\"other_subscription\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ExpressRouteConnectionType", "properties": { "circuit_id": { "type": "string", "description": "Exclusive with [other_subscription]\nExpressRoute Circuit is in same subscription as the site.", "title": "Circuit in Same subscription", "maxLength": 512, "x-displayname": "Circuit in same subscription.", "x-ves-example": "/subscriptions/00000000-0000-4000-8000-d3bc6a2935db/resourceGroups/ExpressRouteResourceGroup/providers/microsoft.network/expressRouteCircuits/MyCircuit.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "/subscriptions/00000000-0000-4000-8000-d3bc6a2935db/resourceGroups/ExpressRouteResourceGroup/providers/microsoft.network/expressRouteCircuits/MyCircuit", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Exclusive with [other_subscription] ExpressRoute Circuit is in same subscription as the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "other_subscription" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "other_subscription": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteExpressRouteOtherSubscriptionConnection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "circuit_id" ] }, "weight": { "type": "integer", "description": "The weight (or priority) for the routes received from this connection. The default value is 10.", "title": "Routing Weight", "format": "int64", "x-displayname": "Routing Weight.", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "The weight (or priority) for the routes received from this connection. The default value is 10.", "x-f5xc-constraints": { "constraintType": "number", "category": "load-balancing", "minimum": 0, "maximum": 100, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteExpressRouteConnectionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteExpressRouteInfo": { "type": "object", "description": "Express Route Info.", "title": "Express Route Info", "x-displayname": "Express Route Info.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ExpressRouteInfo", "properties": { "route_server_asn": { "type": "integer", "description": "Route Server ASN.", "title": "Route Server ASN", "format": "int64", "x-displayname": "Route Server ASN.", "x-ves-example": "65441", "x-f5xc-example": "65441", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_server_ips": { "type": "array", "description": "Route Server IPs.", "title": "Route Server IPs", "items": { "type": "string" }, "x-displayname": "Route Server IPs.", "x-ves-example": "192.0.2.246.", "x-f5xc-example": "192.0.2.246", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteExpressRouteInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteExpressRouteOtherSubscriptionConnection": { "type": "object", "description": "Express Route Circuit Config From Other Subscription.", "title": "Express Route Circuit Config From Other Subscription", "x-displayname": "Express Route Circuit Config From Other Subscription.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ExpressRouteOtherSubscriptionConnection", "properties": { "authorized_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for authorized key.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "circuit_id": { "type": "string", "description": "Circuit ID.", "title": "Circuit ID", "maxLength": 512, "x-displayname": "Circuit ID.", "x-ves-example": "/subscriptions/00000000-0000-4000-8000-d3bc6a2935db/resourceGroups/ExpressRouteResourceGroup/providers/microsoft.network/expressRouteCircuits/MyCircuit.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "/subscriptions/00000000-0000-4000-8000-d3bc6a2935db/resourceGroups/ExpressRouteResourceGroup/providers/microsoft.network/expressRouteCircuits/MyCircuit", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Express Route Circuit Config From Other Subscription.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteExpressRouteOtherSubscriptionConnection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read azure_vnet_site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsazure_vnet_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/azure_vnet_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of azure_vnet_site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/azure_vnet_siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteListResponseItem": { "type": "object", "description": "By default a summary of azure_vnet_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of azure_vnet_site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this azure_vnet_site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this azure_vnet_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this azure_vnet_site.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this azure_vnet_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates azure_vnet_site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates azure_vnet_site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewsazure_vnet_siteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this azure_vnet_site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this azure_vnet_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this azure_vnet_site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/azure_vnet_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this azure_vnet_site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of azure_vnet_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of azure_vnet_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteNodeInstanceNameType": { "type": "object", "description": "Node Instance Name.", "title": "Node Instance Name", "x-displayname": "Node Instance Name.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.NodeInstanceNameType", "properties": { "node_id": { "type": "string", "description": "Node ID Information.", "title": "Node ID", "minLength": 1, "maxLength": 64, "x-displayname": "Node ID", "x-ves-example": "VES-node-ID-xxxxxx.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ves-node-id-xxxxxx", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "node_instance_name": { "type": "string", "description": "Node Instance Name used by dataplane.", "title": "Node Instance Name", "minLength": 1, "maxLength": 64, "x-displayname": "Node Instance Name.", "x-ves-example": "IP-1-2-3-4-site1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ip-1-2-3-4-site1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteNodeInstanceNameType", "required_fields": [ "node_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"node_id\": \"ves-node-id-xxxxxx\"\n}", "example_yaml": "node_id: ves-node-id-xxxxxx" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a azure_vnet_site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsazure_vnet_siteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Azure Virtual Network CE site for deploying F5 XC nodes in Azure", "required_fields": [], "mutually_exclusive_groups": [ { "name": "vnet_choice", "fields": [ "spec.vnet.new_vnet", "spec.vnet.existing_vnet" ], "reason": "Create new VNet or use existing" }, { "name": "deployment", "fields": [ "spec.ingress_gw", "spec.ingress_egress_gw", "spec.voltstack_cluster" ], "reason": "Choose site deployment type (REQUIRED)" } ], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteSetCloudSiteInfoRequest": { "type": "object", "description": "Request to configure Cloud Site Information.", "title": "Request to configure Cloud Site Information", "x-displayname": "Request to configure Cloud Site Information.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.SetCloudSiteInfoRequest", "properties": { "azure_vnet_info": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetSiteInfoType" } ], "x-f5xc-description-short": "Configuration parameter for azure vnet info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "VNet-site-1.", "x-f5xc-example": "vnet-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to configure Cloud Site Information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteSetCloudSiteInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteSetCloudSiteInfoResponse": { "type": "object", "description": "Response to configure configure Cloud Site Information.", "title": "Response to configure Cloud Site Information", "x-displayname": "Response to configure Cloud Site Information.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.SetCloudSiteInfoResponse", "x-f5xc-description-short": "Response to configure configure Cloud Site Information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteSetCloudSiteInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteSetVIPInfoRequest": { "type": "object", "description": "Request to configure Azure VNet Site VIP information.", "title": "Request to configure Azure VNet Site VIP information", "x-displayname": "Request to configure Azure VNet Site VIP information.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.SetVIPInfoRequest", "properties": { "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "VNet-site-1.", "x-f5xc-example": "vnet-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "vip_params_per_az": { "type": "array", "description": "VIP Parameters per AZ.", "title": "VIP Params Per AZ", "items": { "$ref": "#/components/schemas/sitePublishVIPParamsPerAz__ves_io_schema_views_aws_vpc_site" }, "x-displayname": "VIP Params Per AZ.", "x-ves-example": "Master-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.num_items": "1,2,3" }, "x-f5xc-example": "master-0", "x-validation-rules": { "ves.io.schema.rules.repeated.num_items": "1,2,3" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to configure Azure VNet Site VIP information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteSetVIPInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteSetVIPInfoResponse": { "type": "object", "title": "Response to configure Azure VNet Site VIP Information", "x-displayname": "Response to configure Azure VNet Site VIP Information.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.SetVIPInfoResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteSetVIPInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersDeploymentStatusType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Azure VNet view object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-description-short": "Azure VNet view object direct reference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet_attachment": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureAttachmentsListStatusType" } ], "x-f5xc-description-short": "Configuration parameter for vnet attachment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteVNETInfoType": { "type": "object", "description": "Azure VNet Info Type.", "title": "VNET Info Type", "x-displayname": "Azure VNet Info type.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.VNETInfoType", "properties": { "resource_id": { "type": "string", "description": "VNet Resource ID.", "title": "VNET Resource ID", "x-displayname": "VNet Resource ID.", "x-ves-example": "/subscriptions/00000000-0000-4000-8000-af885e126181/resourceGroups/ks-Azure-VNet-3/providers/microsoft.network/virtualNetworks/VES-VNet-auto-ks-Azure-VNet-3-585b7768d9.", "x-f5xc-example": "/subscriptions/00000000-0000-4000-8000-af885e126181/resourceGroups/ks-azure-vnet-3/providers/microsoft.network/virtualNetworks/ves-vnet-auto-ks-azure-vnet-3-585b7768d9", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vnet_name": { "type": "string", "description": "VNet Name", "title": "VNET Name", "x-displayname": "VNet Name", "x-ves-example": "VES-VNet-auto-ks-Azure-VNet-3-585b7768d9.", "x-f5xc-example": "ves-vnet-auto-ks-azure-vnet-3-585b7768d9", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteVNETInfoType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteVnetIpPrefixesType": { "type": "object", "description": "Azure VNet IP prefixes Info.", "title": "Azure VNet IP prefixes Info", "x-displayname": "Azure VNet IP prefixes Info.", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.VnetIpPrefixesType", "properties": { "prefixes": { "type": "array", "description": "An unordered list of IP prefixes.", "title": "VNet prefixes", "minItems": 1, "maxItems": 1024, "items": { "type": "string" }, "x-displayname": "VNet Prefixes.", "x-ves-example": "['192.0.2.0/24', '192.0.2.0/24', '192.0.2.0/24']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "1024", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['192.0.2.0/24', '192.0.2.0/24', '192.0.2.0/24']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "1024", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 1024, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteVnetIpPrefixesType", "required_fields": [ "prefixes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"prefixes\": [\n \"value\"\n ]\n}", "example_yaml": "prefixes:\n- value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "azure_vnet_siteVnetPeeringType": { "type": "object", "description": "VNet peering to Azure VNet site.", "title": "VNet Peering", "x-displayname": "VNet Peering.", "x-ves-oneof-field-routing_choice": "[\"auto\",\"manual\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.VnetPeeringType", "properties": { "auto": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "manual" ] }, "labels": { "type": "object", "description": "Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy\nThese labels used must be from known key and label defined in shared namespace.", "title": "Labels For VNet's Peering", "x-displayname": "Labels For VNets Peering.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy These labels used must be from known key...", "x-f5xc-description-medium": "Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy These labels used must be from known key and label defined in shared namespace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manual": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auto" ] }, "vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for azure_vnet_siteVnetPeeringType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureAttachmentsListStatusType": { "type": "object", "description": "Azure VEspokeNT Attachment List Status Type.", "title": "Azure spoke Attachment List Status Type", "x-displayname": "Azure spoke Attachment List Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureAttachmentsListStatusType", "properties": { "attachment_status": { "type": "array", "description": "Azure spoke Attachment Status Type.", "title": "Azure spoke Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAzureAttachmentsStatusType" }, "x-displayname": "Azure spoke Attachment Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Azure VEspokeNT Attachment List Status Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureAttachmentsListStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureAttachmentsStatusType": { "type": "object", "description": "Azure Attachment Status Type.", "title": "Azure Attachment Status Type", "x-displayname": "Azure Attachment Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureAttachmentsStatusType", "properties": { "deployment_status": { "type": "string", "description": "Attachment Deployment Status.", "title": "Attachment Deployment Status", "x-displayname": "Attachment Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_owner_subscriptionid": { "type": "string", "description": "Hub Owner Subscription.", "title": "Hub Owner subscription", "x-displayname": "Hub Owner Subscription.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_vnet_name": { "type": "string", "description": "Hub VNet Name.", "title": "Hub VNET Name", "x-displayname": "Hub VNet Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_vnet_resource_group": { "type": "string", "description": "Hub VNet Resource Group.", "title": "Hub VNET Resource Group", "x-displayname": "Hub VNet Resource Group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "installed_routes": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureRouteTableWithStaticRouteListType" } ], "x-f5xc-description-short": "Configuration parameter for installed routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering_state": { "type": "string", "description": "Hub VNet Peering state.", "title": "Hub VNET Peering state", "x-displayname": "Hub VNet Peering state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering_sync_level": { "type": "string", "description": "Hub VNet peering sync level.", "title": "Hub VNET peering sync level", "x-displayname": "Hub VNet peering sync level.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "provisioning_state": { "type": "string", "description": "Hub VNet Provisioning state.", "title": "Hub VNET Provisioning state", "x-displayname": "Hub VNet Provisioning state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spoke_subscription_id": { "type": "string", "description": "VNet Subscription.", "title": "VNET subscription", "x-displayname": "VNet Subscription.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "spoke_vnet_id": { "type": "string", "description": "Spoke VNet ID.", "title": "Spoke VNET ID", "x-displayname": "Spoke VNet ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "subnets": { "type": "array", "description": "Network Interfaces created along with the attachment.", "title": "Subnets", "items": { "$ref": "#/components/schemas/cloud_connectSubnetStatusType" }, "x-displayname": "Network Interfaces.", "x-f5xc-description-short": "Network Interfaces created along with the attachment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet_attachment_id": { "type": "string", "description": "VNet Attachment ID.", "title": "VNET Attachment ID", "x-displayname": "VNet Attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vnet_cidr": { "type": "string", "description": "VNet CIDR", "title": "VNET CIDR", "x-displayname": "VNet CIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureAttachmentsStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureRouteTableWithStaticRoute": { "type": "object", "description": "Azure Route Table with Static Route.", "title": "Azure Route Table", "x-displayname": "Azure Route Table with Static Route.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureRouteTableWithStaticRoute", "properties": { "route_table_id": { "type": "string", "description": "Route table ID in the format //", "title": "Route table ID", "maxLength": 256, "x-displayname": "Route table ID.", "x-ves-example": "/rg-1/rtb-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.pattern": "^\\\\/[-\\\\w\\\\._\\\\(\\\\)]+\\\\/[a-zA-Z0-9][a-zA-Z0-9-._]+[a-zA-Z0-9_]$" }, "x-f5xc-example": "/rg-1/rtb-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.pattern": "^\\\\/[-\\\\w\\\\._\\\\(\\\\)]+\\\\/[a-zA-Z0-9][a-zA-Z0-9-._]+[a-zA-Z0-9_]$" }, "x-f5xc-description-short": "Route table ID in the format //.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "pattern": "^\\\\/[-\\\\w\\\\._\\\\(\\\\)]+\\\\/[a-zA-Z0-9][a-zA-Z0-9-._]+[a-zA-Z0-9_]$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "static_routes": { "type": "array", "description": "List of Static Routes.", "title": "static_routes", "minItems": 1, "maxItems": 50, "items": { "type": "string" }, "x-displayname": "Static Routes.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 50, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureRouteTableWithStaticRoute", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n \"value\"\n ]\n}", "example_yaml": "static_routes:\n- value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureRouteTableWithStaticRouteListType": { "type": "object", "description": "List Azure Route Table with Static Route.", "title": "List Azure Route Table with Static Route", "x-displayname": "List Azure Route Table with Static Route.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureRouteTableWithStaticRouteListType", "properties": { "route_tables": { "type": "array", "description": "Route Tables with static routes.", "title": "List of route tables with static routes", "minItems": 1, "maxItems": 200, "items": { "$ref": "#/components/schemas/cloud_connectAzureRouteTableWithStaticRoute" }, "x-displayname": "List of route tables with static routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "200", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "200", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 200, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List Azure Route Table with Static Route.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureRouteTableWithStaticRouteListType", "required_fields": [ "route_tables" ], "mutually_exclusive_groups": [], "example_json": "{\n \"route_tables\": [\n {\n \"static_routes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "route_tables:\n- static_routes:\n - value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAcceleratedNetworkingType": { "type": "object", "description": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen.", "title": "Accelerated Networking Type", "x-displayname": "Accelerated Networking Type.", "x-ves-oneof-field-accelerated_networking": "[\"disable\",\"enable\"]", "x-ves-proto-message": "ves.io.schema.views.AcceleratedNetworkingType", "properties": { "disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable" ] }, "enable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable" ] } }, "x-required": true, "x-f5xc-description-short": "Accelerated Networking to reduce Latency, When Mode is toggled, traffic disruption will be seen.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAcceleratedNetworkingType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureSpecialSubnetType": { "type": "object", "description": "Parameters for Azure special subnet which name is reserved. (i.e GatewaySubnet or RouteServerSubnet)", "title": "Azure Cloud Special Subnet", "x-displayname": "Azure Cloud Special Subnet.", "x-ves-oneof-field-resource_group_choice": "[\"subnet_resource_grp\",\"vnet_resource_group\"]", "x-ves-proto-message": "ves.io.schema.views.AzureSpecialSubnetType", "properties": { "subnet_resource_grp": { "type": "string", "description": "Exclusive with [vnet_resource_group]\nSpecify name of Resource Group.", "title": "subnet_resource_grp", "maxLength": 64, "x-displayname": "Resource Group Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [vnet_resource_group] Specify name of Resource Group.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vnet_resource_group" ] }, "vnet_resource_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for vnet resource group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "subnet_resource_grp" ] } }, "x-f5xc-description-short": "Parameters for Azure special subnet which name is reserved. (i.e GatewaySubnet or RouteServerSubnet).", "x-f5xc-description-medium": "Parameters for Azure special subnet which name is reserved. (i.e GatewaySubnet or RouteServerSubnet).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureSpecialSubnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureSubnetChoiceType": { "type": "object", "description": "Parameters for Azure subnet.", "title": "Azure Cloud Subnet", "x-displayname": "Azure Subnet.", "x-ves-oneof-field-choice": "[\"subnet\",\"subnet_param\"]", "x-ves-proto-message": "ves.io.schema.views.AzureSubnetChoiceType", "properties": { "subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetType" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-description-short": "Subnet specification for network segmentation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "subnet_param" ] }, "subnet_param": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetParamType" } ], "x-f5xc-description-short": "Configuration parameter for subnet param.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "subnet" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureSubnetChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureSubnetChoiceWithAutoType": { "type": "object", "description": "Parameters for Azure subnet.", "title": "Azure Cloud Subnet", "x-displayname": "Azure Subnet.", "x-ves-oneof-field-choice": "[\"auto\",\"subnet\",\"subnet_param\"]", "x-ves-proto-message": "ves.io.schema.views.AzureSubnetChoiceWithAutoType", "properties": { "auto": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "subnet", "subnet_param" ] }, "subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSpecialSubnetType" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-description-short": "Subnet specification for network segmentation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auto", "subnet_param" ] }, "subnet_param": { "allOf": [ { "$ref": "#/components/schemas/viewsCloudSubnetParamType" } ], "x-f5xc-description-short": "Configuration parameter for subnet param.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auto", "subnet" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureSubnetChoiceWithAutoType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureSubnetType": { "type": "object", "description": "Parameters for Azure subnet.", "title": "Azure Cloud Subnet", "x-displayname": "Azure Subnet.", "x-ves-displayorder": "3,1", "x-ves-oneof-field-resource_group_choice": "[\"subnet_resource_grp\",\"vnet_resource_group\"]", "x-ves-proto-message": "ves.io.schema.views.AzureSubnetType", "properties": { "subnet_name": { "type": "string", "description": "Name of existing subnet.", "title": "Existing Subnet Name", "maxLength": 64, "x-displayname": "Subnet Name.", "x-ves-example": "MySubnet", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "MySubnet", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "subnet_resource_grp": { "type": "string", "description": "Exclusive with [vnet_resource_group]\nSpecify name of Resource Group.", "title": "subnet_resource_grp", "maxLength": 64, "x-displayname": "Resource Group Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [vnet_resource_group] Specify name of Resource Group.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vnet_resource_group" ] }, "vnet_resource_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for vnet resource group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "subnet_resource_grp" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureSubnetType", "required_fields": [ "subnet_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"subnet_name\": \"MySubnet\"\n}", "example_yaml": "subnet_name: MySubnet" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetChoiceType": { "type": "object", "description": "This defines choice about Azure VNet for a view.", "title": "Azure Vnet choice", "x-displayname": "Azure VNet choice.", "x-ves-oneof-field-choice": "[\"existing_vnet\",\"new_vnet\"]", "x-ves-proto-message": "ves.io.schema.views.AzureVnetChoiceType", "properties": { "existing_vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetType" } ], "x-f5xc-description-short": "Configuration parameter for existing vnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "new_vnet" ] }, "new_vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_vnet" ] } }, "x-f5xc-description-short": "Defines choice about Azure VNet for a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetOneInterfaceNodeARType": { "type": "object", "description": "Parameters for creating Single interface Node for Alternate Region.", "title": "Single Interface Node for Alternate Region", "x-displayname": "Single Interface Node for Alternate Region.", "x-ves-displayorder": "1,2,3,4", "x-ves-proto-message": "ves.io.schema.views.AzureVnetOneInterfaceNodeARType", "properties": { "fault_domain": { "type": "integer", "description": "Namuber of fault domains to be used while creating the availability set.", "title": "Number of fault domains", "format": "int64", "x-displayname": "Number of fault domains.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "3" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "3" }, "x-f5xc-description-short": "Namuber of fault domains to be used while creating the availability set.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 3, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for local subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main nodes.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "update_domain": { "type": "integer", "description": "Namuber of update domains to be used while creating the availability set.", "title": "Number of update domains", "format": "int64", "x-displayname": "Number of update domains.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "20" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "20" }, "x-f5xc-description-short": "Namuber of update domains to be used while creating the availability set.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 20, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating Single interface Node for Alternate Region.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetOneInterfaceNodeARType", "required_fields": [ "fault_domain", "node_number", "update_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fault_domain\": 1,\n \"node_number\": 0,\n \"update_domain\": 1\n}", "example_yaml": "fault_domain: 1\nnode_number: 0\nupdate_domain: 1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetOneInterfaceNodeType": { "type": "object", "description": "Parameters for creating Single interface Node in one AZ.", "title": "Single Interface Node", "x-displayname": "Single Interface Node.", "x-ves-displayorder": "1,4,2", "x-ves-proto-message": "ves.io.schema.views.AzureVnetOneInterfaceNodeType", "properties": { "azure_az": { "type": "string", "description": "A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input.", "title": "Azure AZ", "x-displayname": "Azure Availability Zone.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"1\\\",\\\"2\\\",\\\"3\\\"]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"1\\\",\\\"2\\\",\\\"3\\\"]" }, "x-f5xc-description-short": "Zone depicting a grouping of datacenters within an Azure region. Expecting numeric input.", "maxLength": 1024, "enum": [ "1", "2", "3" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for local subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating Single interface Node in one AZ.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetOneInterfaceNodeType", "required_fields": [ "azure_az" ], "mutually_exclusive_groups": [], "example_json": "{\n \"azure_az\": \"1\"\n}", "example_yaml": "azure_az: '1'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetParamsType": { "type": "object", "description": "Parameters to create a new Azure VNet.", "title": "Azure Vnet Parameters", "x-displayname": "Azure VNet Parameters.", "x-ves-displayorder": "3,2", "x-ves-oneof-field-name_choice": "[\"autogenerate\",\"name\"]", "x-ves-proto-message": "ves.io.schema.views.AzureVnetParamsType", "properties": { "autogenerate": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for autogenerate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "name" ] }, "name": { "type": "string", "description": "Exclusive with [autogenerate]\nSpecify the VNet Name.", "title": "name", "minLength": 1, "maxLength": 64, "x-displayname": "Choose VNet Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Exclusive with [autogenerate] Specify the VNet Name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "x-f5xc-conflicts-with": [ "autogenerate" ] }, "primary_ipv4": { "type": "string", "description": "IPv4 CIDR block for this VNet. It has to be private address space.", "title": "IPv4 CIDR block", "x-displayname": "IPv4 CIDR block.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "8" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "8" }, "x-f5xc-description-short": "IPv4 CIDR block for this VNet. It has to be private address space.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetParamsType", "required_fields": [ "primary_ipv4" ], "mutually_exclusive_groups": [], "example_json": "{\n \"primary_ipv4\": \"192.0.2.0/24\"\n}", "example_yaml": "primary_ipv4: 192.0.2.0/24" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetTwoInterfaceNodeARType": { "type": "object", "description": "Parameters for creating two interface Node in one AZ.", "title": "Two Interface Node", "x-displayname": "Two Interface Node.", "x-ves-displayorder": "1,2,3,4,5", "x-ves-proto-message": "ves.io.schema.views.AzureVnetTwoInterfaceNodeARType", "properties": { "fault_domain": { "type": "integer", "description": "Namuber of fault domains to be used while creating the availability set.", "title": "Number of fault domains", "format": "int64", "x-displayname": "Number of fault domains.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "3" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "3" }, "x-f5xc-description-short": "Namuber of fault domains to be used while creating the availability set.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 3, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main nodes.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "outside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for outside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "update_domain": { "type": "integer", "description": "Namuber of update domains to be used while creating the availability set.", "title": "Number of update domains", "format": "int64", "x-displayname": "Number of update domains.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "20" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "20" }, "x-f5xc-description-short": "Namuber of update domains to be used while creating the availability set.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 20, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating two interface Node in one AZ.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetTwoInterfaceNodeARType", "required_fields": [ "fault_domain", "node_number", "update_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fault_domain\": 1,\n \"node_number\": 0,\n \"update_domain\": 1\n}", "example_yaml": "fault_domain: 1\nnode_number: 0\nupdate_domain: 1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetTwoInterfaceNodeType": { "type": "object", "description": "Parameters for creating two interface Node in one AZ.", "title": "Two Interface Node", "x-displayname": "Two Interface Node.", "x-ves-displayorder": "1,2,5,3", "x-ves-proto-message": "ves.io.schema.views.AzureVnetTwoInterfaceNodeType", "properties": { "azure_az": { "type": "string", "description": "A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input.", "title": "Azure AZ", "x-displayname": "Azure Availability Zone.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"1\\\",\\\"2\\\",\\\"3\\\"]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"1\\\",\\\"2\\\",\\\"3\\\"]" }, "x-f5xc-description-short": "Zone depicting a grouping of datacenters within an Azure region. Expecting numeric input.", "maxLength": 1024, "enum": [ "1", "2", "3" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for outside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Parameters for creating two interface Node in one AZ.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetTwoInterfaceNodeType", "required_fields": [ "azure_az" ], "mutually_exclusive_groups": [], "example_json": "{\n \"azure_az\": \"1\"\n}", "example_yaml": "azure_az: '1'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAzureVnetType": { "type": "object", "description": "Resource group and name of existing Azure VNet.", "title": "Azure Existing Vnet Type", "x-displayname": "Azure Existing VNet Type.", "x-ves-oneof-field-routing_type": "[\"f5_orchestrated_routing\",\"manual_routing\"]", "x-ves-proto-message": "ves.io.schema.views.AzureVnetType", "properties": { "f5_orchestrated_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "manual_routing" ] }, "manual_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_orchestrated_routing" ] }, "resource_group": { "type": "string", "description": "Resource group of existing VNet.", "title": "Existing Vnet Resource Group", "minLength": 1, "maxLength": 64, "x-displayname": "Existing VNet Resource Group.", "x-ves-example": "MyResourceGroup.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "MyResourceGroup", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "vnet_name": { "type": "string", "description": "Name of existing VNet.", "title": "Existing Vnet Name", "minLength": 1, "maxLength": 64, "x-displayname": "Existing VNet Name.", "x-ves-example": "MyVnet", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "MyVnet", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Resource group and name of existing Azure VNet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAzureVnetType", "required_fields": [ "resource_group", "vnet_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"resource_group\": \"MyResourceGroup\",\n \"vnet_name\": \"MyVnet\"\n}", "example_yaml": "resource_group: MyResourceGroup\nvnet_name: MyVnet" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsazure_vnet_siteCreateSpecType": { "type": "object", "description": "Shape of the Azure VNet site specification.", "title": "CreateSpecType", "x-displayname": "Create Azure VNet site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"azure_cred\"]", "x-ves-oneof-field-encryption_choice": "[\"disable_encryption\",\"enable_encryption\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-region_choice": "[\"alternate_region\",\"azure_region\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_egress_gw_ar\",\"ingress_gw\",\"ingress_gw_ar\",\"voltstack_cluster\",\"voltstack_cluster_ar\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.CreateSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "alternate_region": { "type": "string", "description": "Exclusive with [azure_region]\nName of the Azure region which does not support availability zones.", "maxLength": 64, "x-displayname": "Alternate Azure Region Name.", "x-ves-example": "Northcentralus.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "northcentralus", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [azure_region] Name of the Azure region which does not support availability zones.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_region" ] }, "azure_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "azure_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "azure_region": { "type": "string", "description": "Exclusive with [alternate_region]\nName of the Azure region which supports availability zones.", "maxLength": 64, "x-displayname": "Recommended Azure Region Name.", "x-ves-example": "Eastus", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "eastus", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [alternate_region] Name of the Azure region which supports availability zones.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alternate_region" ] }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "disable_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_encryption" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 4095, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": 0, "x-f5xc-server-default": true }, "enable_encryption": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureDiskEncryption" } ], "x-f5xc-description-short": "Configuration parameter for enable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_encryption" ] }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressEgressGwType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ] }, "ingress_egress_gw_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressEgressGwARType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw ar.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressGwType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ], "x-f5xc-requires": [ { "field": "azure_certified_hw", "required": true, "reason": "ingress_gw requires azure_certified_hw string (e.g. 'azure-byol-voltmesh')" }, { "field": "az_nodes", "required": true, "reason": "ingress_gw requires at least one az_nodes entry", "min_items": 1 }, { "field": "az_nodes.azure_az", "required": true, "reason": "Each az_node requires azure_az (AZ number string: '1', '2', '3')" }, { "field": "az_nodes.local_subnet", "required": true, "reason": "Each az_node requires local_subnet.subnet_param.ipv4 (CIDR)" } ] }, "ingress_gw_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressGwARType" } ], "x-f5xc-description-short": "Configuration parameter for ingress gw ar.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "voltstack_cluster", "voltstack_cluster_ar" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "machine_type": { "type": "string", "description": "Select Instance size based on performance needed.\nThe default setting for Accelerated Networking is enabled, thus make sure\nyou select a Virtual Machine that supports accelerated networking or\ndisable the setting under, Select Ingress Gateway or Ingress/Egress Gateway\n> advanced OPTIONS.", "maxLength": 64, "x-displayname": "Azure Machine Type for Node.", "x-ves-example": "Standard_D4s_v4.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "Standard_D4s_v4", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-description-medium": "Select Instance size based on performance needed. The default setting for Accelerated Networking is enabled, thus make sure you select a Virtual Machine that supports accelerated networking or disable the setting under, Select Ingress Gateway or Ingress/Egress Gateway > advanced OPTIONS.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "default": "", "x-f5xc-server-default": true }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_group": { "type": "string", "description": "Azure resource group for resources that will be created.", "minLength": 1, "maxLength": 64, "x-displayname": "Resource Group.", "x-ves-example": "Example-resources.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resources", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Azure resource group for resources that will be created.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Azure Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in Azure console.", "x-displayname": "Azure Tags.", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "Azure Tags is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "Azure Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in Azure console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-requires": [ { "field": "new_vnet.name", "required": true, "reason": "new_vnet requires name" }, { "field": "new_vnet.primary_ipv4", "required": true, "reason": "new_vnet requires primary_ipv4 CIDR (e.g. '10.0.0.0/16')" } ] }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetVoltstackClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster_ar" ] }, "voltstack_cluster_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetVoltstackClusterARType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster" ] } }, "x-f5xc-description-short": "Shape of the Azure VNet site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsazure_vnet_siteCreateSpecType", "required_fields": [ "machine_type", "resource_group", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"machine_type\": \"Standard_D4s_v4\",\n \"resource_group\": \"example-resources\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "machine_type: Standard_D4s_v4\nresource_group: example-resources\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-recommended-oneof-variant": { "deployment": "ingress_gw", "vnet_choice": "new_vnet", "worker_nodes_choice": "no_worker_nodes", "allowed_services_choice": "block_all_services", "logs_streaming_choice": "logs_streaming_disabled" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsazure_vnet_siteGetSpecType": { "type": "object", "description": "Shape of the Azure VNet site specification.", "title": "GetSpecType", "x-displayname": "GET Azure VNet site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"azure_cred\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-region_choice": "[\"alternate_region\",\"azure_region\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_egress_gw_ar\",\"ingress_gw\",\"ingress_gw_ar\",\"voltstack_cluster\",\"voltstack_cluster_ar\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.GetSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "alternate_region": { "type": "string", "description": "Exclusive with [azure_region]\nName of the Azure region which does not support availability zones.", "maxLength": 64, "x-displayname": "Alternate Azure Region Name.", "x-ves-example": "Northcentralus.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "northcentralus", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [azure_region] Name of the Azure region which does not support availability zones.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_region" ] }, "azure_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "azure_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "azure_region": { "type": "string", "description": "Exclusive with [alternate_region]\nName of the Azure region which supports availability zones.", "maxLength": 64, "x-displayname": "Recommended Azure Region Name.", "x-ves-example": "Eastus", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "eastus", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [alternate_region] Name of the Azure region which supports availability zones.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alternate_region" ] }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "cloud_site_info": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetSiteInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 4095, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": 0, "x-f5xc-server-default": true }, "error_description": { "type": "string", "description": "Description of error on site.", "x-displayname": "Error Description.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressEgressGwType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ] }, "ingress_egress_gw_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressEgressGwARType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw ar.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressGwType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ], "x-f5xc-requires": [ { "field": "azure_certified_hw", "required": true, "reason": "ingress_gw requires azure_certified_hw string (e.g. 'azure-byol-voltmesh')" }, { "field": "az_nodes", "required": true, "reason": "ingress_gw requires at least one az_nodes entry", "min_items": 1 }, { "field": "az_nodes.azure_az", "required": true, "reason": "Each az_node requires azure_az (AZ number string: '1', '2', '3')" }, { "field": "az_nodes.local_subnet", "required": true, "reason": "Each az_node requires local_subnet.subnet_param.ipv4 (CIDR)" } ] }, "ingress_gw_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressGwARType" } ], "x-f5xc-description-short": "Configuration parameter for ingress gw ar.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "voltstack_cluster", "voltstack_cluster_ar" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "machine_type": { "type": "string", "description": "Select Instance size based on performance needed.\nThe default setting for Accelerated Networking is enabled, thus make sure\nyou select a Virtual Machine that supports accelerated networking or\ndisable the setting under, Select Ingress Gateway or Ingress/Egress Gateway\n> advanced OPTIONS.", "maxLength": 64, "x-displayname": "Azure Machine Type for Node.", "x-ves-example": "Standard_D4s_v4.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "Standard_D4s_v4", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-description-medium": "Select Instance size based on performance needed. The default setting for Accelerated Networking is enabled, thus make sure you select a Virtual Machine that supports accelerated networking or disable the setting under, Select Ingress Gateway or Ingress/Egress Gateway > advanced OPTIONS.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "default": "", "x-f5xc-server-default": true }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_group": { "type": "string", "description": "Azure resource group for resources that will be created.", "minLength": 1, "maxLength": 64, "x-displayname": "Resource Group.", "x-ves-example": "Example-resources.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resources", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Azure resource group for resources that will be created.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "site_errors": { "type": "array", "description": "Errors on site including suggested action.", "items": { "$ref": "#/components/schemas/viewsSiteError" }, "x-displayname": "Site Errors.", "x-ves-example": "Site Errors.", "x-f5xc-example": "Site Errors", "x-f5xc-description-short": "Errors on site including suggested action.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "suggested_action": { "type": "string", "description": "Suggested action for customer on error.", "x-displayname": "Suggested Action.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Azure Tags is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in Azure console.", "x-displayname": "Azure Tags.", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "Azure Tags is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "Azure Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in Azure console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "validation_state": { "allOf": [ { "$ref": "#/components/schemas/viewsConfigValidationState" } ], "x-f5xc-description-short": "Configuration parameter for validation state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-requires": [ { "field": "new_vnet.name", "required": true, "reason": "new_vnet requires name" }, { "field": "new_vnet.primary_ipv4", "required": true, "reason": "new_vnet requires primary_ipv4 CIDR (e.g. '10.0.0.0/16')" } ] }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetVoltstackClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster_ar" ] }, "voltstack_cluster_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetVoltstackClusterARType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster" ] } }, "x-f5xc-description-short": "Shape of the Azure VNet site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsazure_vnet_siteGetSpecType", "required_fields": [ "machine_type", "resource_group", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"machine_type\": \"Standard_D4s_v4\",\n \"resource_group\": \"example-resources\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "machine_type: Standard_D4s_v4\nresource_group: example-resources\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-recommended-oneof-variant": { "deployment": "ingress_gw", "vnet_choice": "new_vnet", "worker_nodes_choice": "no_worker_nodes", "allowed_services_choice": "block_all_services", "logs_streaming_choice": "logs_streaming_disabled" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsazure_vnet_siteReplaceSpecType": { "type": "object", "description": "Shape of the Azure VNet site replace specification.", "title": "ReplaceSpecType", "x-displayname": "Replace Azure VNet site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"azure_cred\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-region_choice": "[\"alternate_region\",\"azure_region\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_egress_gw_ar\",\"ingress_gw\",\"ingress_gw_ar\",\"voltstack_cluster\",\"voltstack_cluster_ar\"]", "x-ves-oneof-field-worker_nodes": "[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]", "x-ves-proto-message": "ves.io.schema.views.azure_vnet_site.ReplaceSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "alternate_region": { "type": "string", "description": "Exclusive with [azure_region]\nName of the Azure region which does not support availability zones.", "maxLength": 64, "x-displayname": "Alternate Azure Region Name.", "x-ves-example": "Northcentralus.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "northcentralus", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [azure_region] Name of the Azure region which does not support availability zones.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_region" ] }, "azure_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "azure_cred", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "azure_region": { "type": "string", "description": "Exclusive with [alternate_region]\nName of the Azure region which supports availability zones.", "maxLength": 64, "x-displayname": "Recommended Azure Region Name.", "x-ves-example": "Eastus", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "eastus", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Exclusive with [alternate_region] Name of the Azure region which supports availability zones.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alternate_region" ] }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 4095, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": 0, "x-f5xc-server-default": true }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressEgressGwReplaceType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ] }, "ingress_egress_gw_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressEgressGwARReplaceType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw ar.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressGwReplaceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw_ar", "voltstack_cluster", "voltstack_cluster_ar" ], "x-f5xc-requires": [ { "field": "azure_certified_hw", "required": true, "reason": "ingress_gw requires azure_certified_hw string (e.g. 'azure-byol-voltmesh')" }, { "field": "az_nodes", "required": true, "reason": "ingress_gw requires at least one az_nodes entry", "min_items": 1 }, { "field": "az_nodes.azure_az", "required": true, "reason": "Each az_node requires azure_az (AZ number string: '1', '2', '3')" }, { "field": "az_nodes.local_subnet", "required": true, "reason": "Each az_node requires local_subnet.subnet_param.ipv4 (CIDR)" } ] }, "ingress_gw_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetIngressGwARReplaceType" } ], "x-f5xc-description-short": "Configuration parameter for ingress gw ar.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "voltstack_cluster", "voltstack_cluster_ar" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "machine_type": { "type": "string", "description": "Select Instance size based on performance needed.\nThe default setting for Accelerated Networking is enabled, thus make sure\nyou select a Virtual Machine that supports accelerated networking or\ndisable the setting under, Select Ingress Gateway or Ingress/Egress Gateway\n> advanced OPTIONS.", "maxLength": 64, "x-displayname": "Azure Machine Type for Node.", "x-ves-example": "Standard_D4s_v4.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "Standard_D4s_v4", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-description-medium": "Select Instance size based on performance needed. The default setting for Accelerated Networking is enabled, thus make sure you select a Virtual Machine that supports accelerated networking or disable the setting under, Select Ingress Gateway or Ingress/Egress Gateway > advanced OPTIONS.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "default": "", "x-f5xc-server-default": true }, "no_worker_nodes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no worker nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "nodes_per_az", "total_nodes" ] }, "nodes_per_az": { "type": "integer", "description": "Exclusive with [no_worker_nodes total_nodes]\nDesired Worker Nodes Per AZ. Max limit is up to 21.", "format": "int64", "x-displayname": "Desired Worker Nodes Per AZ.", "x-ves-example": "2", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "21" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 21, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "total_nodes" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_group": { "type": "string", "description": "Azure resource group for resources that will be created.", "minLength": 1, "maxLength": 64, "x-displayname": "Resource Group.", "x-ves-example": "Example-resources.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resources", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Azure resource group for resources that will be created.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "total_nodes": { "type": "integer", "description": "Exclusive with [no_worker_nodes nodes_per_az]\nTotal number of worker nodes to be deployed across all AZ's used in the Site.", "format": "int64", "x-displayname": "Total Number of Worker Nodes for a Site.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "61" }, "x-f5xc-description-short": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-description-medium": "Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ's used in the Site.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 61, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_worker_nodes", "nodes_per_az" ] }, "vnet": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-requires": [ { "field": "new_vnet.name", "required": true, "reason": "new_vnet requires name" }, { "field": "new_vnet.primary_ipv4", "required": true, "reason": "new_vnet requires primary_ipv4 CIDR (e.g. '10.0.0.0/16')" } ] }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetVoltstackClusterReplaceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster_ar" ] }, "voltstack_cluster_ar": { "allOf": [ { "$ref": "#/components/schemas/azure_vnet_siteAzureVnetVoltstackClusterARReplaceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_egress_gw_ar", "ingress_gw", "ingress_gw_ar", "voltstack_cluster" ] } }, "x-f5xc-description-short": "Shape of the Azure VNet site replace specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsazure_vnet_siteReplaceSpecType", "required_fields": [ "machine_type", "resource_group", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"machine_type\": \"Standard_D4s_v4\",\n \"resource_group\": \"example-resources\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "machine_type: Standard_D4s_v4\nresource_group: example-resources\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-recommended-oneof-variant": { "deployment": "ingress_gw", "vnet_choice": "new_vnet", "worker_nodes_choice": "no_worker_nodes", "allowed_services_choice": "block_all_services", "logs_streaming_choice": "logs_streaming_disabled" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of gcp_vpc_site", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsgcp_vpc_siteCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsgcp_vpc_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a gcp_vpc_site", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPDiskEncryption": { "type": "object", "description": "Information related to disk encryption.", "title": "Disk Encryption", "x-displayname": "Disk Encryption.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPDiskEncryption", "properties": { "kms_key_resource_id": { "type": "string", "description": "GCP KMS Key to be used to encrypt the disk attached to the VM.", "title": "KMS Key Resource ID", "x-displayname": "KMS Key Resource ID.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "GCP KMS Key to be used to encrypt the disk attached to the VM.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "kms_key_ring_id": { "type": "string", "description": "Key ring in which the CMK to be used to encrypt is present.", "title": "KMS Key Ring ID", "x-displayname": "KMS Key Ring ID.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Key ring in which the CMK to be used to encrypt is present.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPDiskEncryption", "required_fields": [ "kms_key_resource_id", "kms_key_ring_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"kms_key_resource_id\": \"value\",\n \"kms_key_ring_id\": \"value\"\n}", "example_yaml": "kms_key_resource_id: value\nkms_key_ring_id: value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCIngressEgressGwReplaceType": { "type": "object", "description": "Two interface GCP ingress/egress site.", "title": "GCP Ingress Egress Gateway", "x-displayname": "GCP Ingress/Egress Gateway.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCIngressEgressGwReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "gcp_zone_names": { "type": "array", "description": "X-required\nList of zones when instances will be created, needs to match with region selected.", "title": "GCP zones", "maxItems": 3, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "GCP zone names.", "x-ves-example": "Us-west1-a, us-west1-b, us-west1-c.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1-a, us-west1-b, us-west1-c", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "X-required List of zones when instances will be created, needs to match with region selected.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "inside_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for inside network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main nodes.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for outside network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "outside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for outside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCIngressEgressGwReplaceType", "required_fields": [ "gcp_zone_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_zone_names\": [\n \"value\"\n ]\n}", "example_yaml": "gcp_zone_names:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCIngressEgressGwType": { "type": "object", "description": "Two interface GCP ingress/egress site.", "title": "GCP Ingress Egress Gateway", "x-displayname": "GCP Ingress/Egress Gateway.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-inside_static_route_choice": "[\"inside_static_routes\",\"no_inside_static_routes\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCIngressEgressGwType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "dc_cluster_group_inside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_outside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_inside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_outside_vn": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_outside_vn", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "gcp_certified_hw": { "type": "string", "description": "Name for GCP certified hardware.", "title": "GCP Certified Hardware", "maxLength": 64, "x-displayname": "GCP Certified Hardware.", "x-ves-example": "GCP-byol-multi-NIC-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"gcp-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "gcp-byol-multi-nic-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"gcp-byol-multi-nic-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "gcp-byol-multi-nic-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "gcp_zone_names": { "type": "array", "description": "X-required\nList of zones when instances will be created, needs to match with region selected.", "title": "GCP zones", "maxItems": 3, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "GCP zone names.", "x-ves-example": "Us-west1-a, us-west1-b, us-west1-c.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1-a, us-west1-b, us-west1-c", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "X-required List of zones when instances will be created, needs to match with region selected.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "inside_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for inside network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_inside_static_routes" ] }, "inside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for inside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_inside_vn", "dc_cluster_group_outside_vn" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_inside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no inside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_static_routes" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main nodes.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for outside network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "outside_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for outside subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCIngressEgressGwType", "required_fields": [ "gcp_certified_hw", "gcp_zone_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_certified_hw\": \"gcp-byol-multi-nic-voltmesh\",\n \"gcp_zone_names\": [\n \"value\"\n ]\n}", "example_yaml": "gcp_certified_hw: gcp-byol-multi-nic-voltmesh\ngcp_zone_names:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCIngressGwReplaceType": { "type": "object", "description": "Single interface GCP ingress site.", "title": "GCP Ingress Gateway", "x-displayname": "GCP Ingress Gateway.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCIngressGwReplaceType", "properties": { "gcp_zone_names": { "type": "array", "description": "X-required\nList of zones when instances will be created, needs to match with region selected.", "title": "GCP zones", "maxItems": 3, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "GCP zone names.", "x-ves-example": "Us-west1-a, us-west1-b, us-west1-c.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1-a, us-west1-b, us-west1-c", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "X-required List of zones when instances will be created, needs to match with region selected.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "local_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for local network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for local subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main nodes.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCIngressGwReplaceType", "required_fields": [ "gcp_zone_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_zone_names\": [\n \"value\"\n ]\n}", "example_yaml": "gcp_zone_names:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCIngressGwType": { "type": "object", "description": "Single interface GCP ingress site.", "title": "GCP Ingress Gateway", "x-displayname": "GCP Ingress Gateway.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCIngressGwType", "properties": { "gcp_certified_hw": { "type": "string", "description": "Name for GCP certified hardware.", "title": "GCP Certified Hardware", "maxLength": 64, "x-displayname": "GCP Certified Hardware.", "x-ves-example": "GCP-byol-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"gcp-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "gcp-byol-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"gcp-byol-voltmesh\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "gcp-byol-voltmesh" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "gcp_zone_names": { "type": "array", "description": "X-required\nList of zones when instances will be created, needs to match with region selected.", "title": "GCP zones", "maxItems": 3, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "GCP zone names.", "x-ves-example": "Us-west1-a, us-west1-b, us-west1-c.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1-a, us-west1-b, us-west1-c", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "X-required List of zones when instances will be created, needs to match with region selected.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "local_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for local network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for local subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main nodes.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCIngressGwType", "required_fields": [ "gcp_certified_hw", "gcp_zone_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_certified_hw\": \"gcp-byol-voltmesh\",\n \"gcp_zone_names\": [\n \"value\"\n ]\n}", "example_yaml": "gcp_certified_hw: gcp-byol-voltmesh\ngcp_zone_names:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCSiteInfoType": { "type": "object", "description": "GCP VPC Site information like.", "title": "GCP VPC Site Information Config", "x-displayname": "GCP VPC Site Information Config.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCSiteInfoType", "properties": { "private_ips": { "type": "array", "description": "GCP Private IPs used by the nodes.", "title": "GCP Node Private IPs", "items": { "type": "string" }, "x-displayname": "GCP Node Private IPs.", "x-ves-example": "192.0.2.246, 192.0.2.204, 192.0.2.170.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.246, 192.0.2.204, 192.0.2.170", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "public_ips": { "type": "array", "description": "GCP Node Public IPs used by the nodes.", "title": "GCP Node Public IPs", "items": { "type": "string" }, "x-displayname": "GCP Node Public IPs.", "x-ves-example": "192.0.2.242, 192.0.2.31, 192.0.2.63.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.242, 192.0.2.31, 192.0.2.63", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.num_items": "0,1,3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCSiteInfoType", "required_fields": [ "private_ips", "public_ips" ], "mutually_exclusive_groups": [], "example_json": "{\n \"private_ips\": [\n \"value\"\n ],\n \"public_ips\": [\n \"value\"\n ]\n}", "example_yaml": "private_ips:\n- value\npublic_ips:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCVoltstackClusterReplaceType": { "type": "object", "description": "App Stack cluster of single interface GCP nodes.", "title": "GCP App Stack Cluster", "x-displayname": "GCP App Stack Cluster.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCVoltstackClusterReplaceType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "gcp_zone_names": { "type": "array", "description": "X-required\nList of zones when instances will be created, needs to match with region selected.", "title": "GCP zones", "maxItems": 3, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "GCP zone names.", "x-ves-example": "Us-west1-a, us-west1-b, us-west1-c.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1-a, us-west1-b, us-west1-c", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "X-required List of zones when instances will be created, needs to match with region selected.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main Nodes.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "site_local_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "App Stack cluster of single interface GCP nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCVoltstackClusterReplaceType", "required_fields": [ "gcp_zone_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_zone_names\": [\n \"value\"\n ]\n}", "example_yaml": "gcp_zone_names:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGCPVPCVoltstackClusterType": { "type": "object", "description": "App Stack cluster of single interface GCP site.", "title": "GCP App Stack Cluster", "x-displayname": "GCP App Stack Cluster.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-k8s_cluster_choice": "[\"k8s_cluster\",\"no_k8s_cluster\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-outside_static_route_choice": "[\"no_outside_static_routes\",\"outside_static_routes\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-oneof-field-storage_class_choice": "[\"default_storage\",\"storage_class_list\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GCPVPCVoltstackClusterType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "default_storage": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default storage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "storage_class_list" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "gcp_certified_hw": { "type": "string", "description": "Name for GCP certified hardware.", "title": "GCP Certified Hardware", "maxLength": 64, "x-displayname": "GCP Certified Hardware.", "x-ves-example": "GCP-byol-voltstack-combo.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"gcp-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "gcp-byol-voltstack-combo", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"gcp-byol-voltstack-combo\\\"]", "ves.io.schema.rules.string.max_len": "64" }, "enum": [ "gcp-byol-voltstack-combo" ], "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "gcp_zone_names": { "type": "array", "description": "X-required\nList of zones when instances will be created, needs to match with region selected.", "title": "GCP zones", "maxItems": 3, "items": { "type": "string", "maxLength": 64 }, "x-displayname": "GCP zone names.", "x-ves-example": "Us-west1-a, us-west1-b, us-west1-c.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1-a, us-west1-b, us-west1-c", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "X-required List of zones when instances will be created, needs to match with region selected.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_k8s_cluster" ], "x-f5xc-references": [ { "resource_kind": "k8s_cluster", "field_path": "k8s_cluster", "gated_by": { "choice": "k8s_cluster_choice" }, "required": false, "cardinality": "single" } ] }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_k8s_cluster": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "no_outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_static_routes" ] }, "node_number": { "type": "integer", "description": "Number of main nodes to create, either 1 or 3.", "title": "Number of main nodes", "format": "int64", "x-displayname": "Number of main Nodes.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.uint32.in": "[1,3]" }, "x-f5xc-description-short": "Number of main nodes to create, either 1 or 3.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_static_routes": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for outside static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_outside_static_routes" ] }, "site_local_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_local_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCSubnetChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] }, "storage_class_list": { "allOf": [ { "$ref": "#/components/schemas/viewsStorageClassListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_storage" ] } }, "x-f5xc-description-short": "App Stack cluster of single interface GCP site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGCPVPCVoltstackClusterType", "required_fields": [ "gcp_certified_hw", "gcp_zone_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_certified_hw\": \"gcp-byol-voltstack-combo\",\n \"gcp_zone_names\": [\n \"value\"\n ]\n}", "example_yaml": "gcp_certified_hw: gcp-byol-voltstack-combo\ngcp_zone_names:\n- value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read gcp_vpc_site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsgcp_vpc_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/gcp_vpc_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of gcp_vpc_site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/gcp_vpc_siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteListResponseItem": { "type": "object", "description": "By default a summary of gcp_vpc_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of gcp_vpc_site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this gcp_vpc_site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this gcp_vpc_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this gcp_vpc_site.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this gcp_vpc_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates gcp_vpc_site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates gcp_vpc_site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewsgcp_vpc_siteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this gcp_vpc_site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this gcp_vpc_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this gcp_vpc_site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/gcp_vpc_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this gcp_vpc_site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of gcp_vpc_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of gcp_vpc_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a gcp_vpc_site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewsgcp_vpc_siteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteSetCloudSiteInfoRequest": { "type": "object", "description": "Request to configure Cloud Site Information.", "title": "Request to configure Cloud Site Information", "x-displayname": "Request to configure Cloud Site Information.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.SetCloudSiteInfoRequest", "properties": { "aws_vpc_info": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCSiteInfoType" } ], "x-f5xc-description-short": "Configuration parameter for aws vpc info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the object to be configured.", "title": "Name", "x-displayname": "Name", "x-ves-example": "GCP-VPC-site-1.", "x-f5xc-example": "gcp-vpc-site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace for the object to be configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "x-f5xc-description-short": "Namespace for the object to be configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to configure Cloud Site Information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteSetCloudSiteInfoRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteSetCloudSiteInfoResponse": { "type": "object", "description": "Response to configure configure Cloud Site Information.", "title": "Response to configure Cloud Site Information", "x-displayname": "Response to configure Cloud Site Information.", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.SetCloudSiteInfoResponse", "x-f5xc-description-short": "Response to configure configure Cloud Site Information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteSetCloudSiteInfoResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "gcp_vpc_siteStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersDeploymentStatusType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "GCP VPC view object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gcp_vpc_siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPSubnetParamsType": { "type": "object", "description": "Parameters for GCP subnet.", "title": "GCP subnet parameters Type", "x-displayname": "GCP subnet parameters Type.", "x-ves-proto-message": "ves.io.schema.views.GCPSubnetParamsType", "properties": { "primary_ipv4": { "type": "string", "description": "IPv4 prefix for this Subnet. It has to be private address space.", "title": "IPv4 CIDR block", "x-displayname": "IPv4 Subnet Prefix.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "8" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.max_ip_prefix_length": "28", "ves.io.schema.rules.string.min_ip_prefix_length": "8" }, "x-f5xc-description-short": "IPv4 prefix for this Subnet. It has to be private address space.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "subnet_name": { "type": "string", "description": "Name of new VPC Subnet, will be autogenerated if empty.", "title": "GCP VPC Subnet Name", "maxLength": 64, "x-displayname": "VPC Subnet Name.", "x-ves-example": "Subnet1-in-network1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "subnet1-in-network1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Name of new VPC Subnet, will be autogenerated if empty.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPSubnetParamsType", "required_fields": [ "primary_ipv4" ], "mutually_exclusive_groups": [], "example_json": "{\n \"primary_ipv4\": \"192.0.2.0/24\"\n}", "example_yaml": "primary_ipv4: 192.0.2.0/24" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPSubnetType": { "type": "object", "description": "Name of existing GCP subnet.", "title": "GCP existing subnet Type", "x-displayname": "GCP existing subnet Type.", "x-ves-proto-message": "ves.io.schema.views.GCPSubnetType", "properties": { "subnet_name": { "type": "string", "description": "Name of your subnet in VPC network.", "title": "GCP VPC Subnet Name", "minLength": 1, "maxLength": 64, "x-displayname": "VPC Subnet Name.", "x-ves-example": "Subnet1-in-network1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "subnet1-in-network1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPSubnetType", "required_fields": [ "subnet_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"subnet_name\": \"subnet1-in-network1\"\n}", "example_yaml": "subnet_name: subnet1-in-network1" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPVPCNetworkAutogenerateParamsType": { "type": "object", "description": "Create a new GCP VPC Network with autogenerated name.", "title": "GCP VPC Network Parameters Autogenerate", "x-displayname": "GCP VPC Network Autogenerated Parameters.", "x-ves-displayorder": "1", "x-ves-proto-message": "ves.io.schema.views.GCPVPCNetworkAutogenerateParamsType", "x-f5xc-description-short": "Create a new GCP VPC Network with autogenerated name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPVPCNetworkAutogenerateParamsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPVPCNetworkChoiceType": { "type": "object", "description": "This defines choice about GCP VPC network for a view.", "title": "GCP VPC network choice", "x-displayname": "GCP VPC network choice.", "x-ves-oneof-field-choice": "[\"existing_network\",\"new_network\",\"new_network_autogenerate\"]", "x-ves-proto-message": "ves.io.schema.views.GCPVPCNetworkChoiceType", "properties": { "existing_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkType" } ], "x-f5xc-description-short": "Configuration parameter for existing network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "new_network", "new_network_autogenerate" ] }, "new_network": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkParamsType" } ], "x-f5xc-description-short": "Configuration parameter for new network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_network", "new_network_autogenerate" ] }, "new_network_autogenerate": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPVPCNetworkAutogenerateParamsType" } ], "x-f5xc-description-short": "Configuration parameter for new network autogenerate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_network", "new_network" ] } }, "x-f5xc-description-short": "Defines choice about GCP VPC network for a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPVPCNetworkChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPVPCNetworkParamsType": { "type": "object", "description": "Parameters to create a new GCP VPC Network.", "title": "GCP VPC Network Parameters", "x-displayname": "GCP VPC Network Manual Parameters.", "x-ves-displayorder": "1", "x-ves-proto-message": "ves.io.schema.views.GCPVPCNetworkParamsType", "properties": { "name": { "type": "string", "description": "Name for your GCP VPC Network.", "title": "GCP VPC Network Name", "minLength": 1, "maxLength": 64, "x-displayname": "GCP VPC Network Name.", "x-ves-example": "Network1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "network1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Parameters to create a new GCP VPC Network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPVPCNetworkParamsType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"network1\"\n}", "example_yaml": "name: network1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPVPCNetworkType": { "type": "object", "description": "Name of existing VPC network.", "title": "GCP existing VPC network Type", "x-displayname": "GCP existing VPC network Type.", "x-ves-oneof-field-routing_type": "[]", "x-ves-proto-message": "ves.io.schema.views.GCPVPCNetworkType", "properties": { "name": { "type": "string", "description": "Name for your GCP VPC Network.", "title": "GCP VPC Network Name", "minLength": 1, "maxLength": 64, "x-displayname": "GCP VPC Network Name.", "x-ves-example": "Network1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "network1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPVPCNetworkType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"network1\"\n}", "example_yaml": "name: network1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsGCPVPCSubnetChoiceType": { "type": "object", "description": "This defines choice about GCP VPC network for a view.", "title": "GCP VPC network choice", "x-displayname": "GCP VPC network choice.", "x-ves-oneof-field-choice": "[\"existing_subnet\",\"new_subnet\"]", "x-ves-proto-message": "ves.io.schema.views.GCPVPCSubnetChoiceType", "properties": { "existing_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPSubnetType" } ], "x-f5xc-description-short": "Configuration parameter for existing subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "new_subnet" ] }, "new_subnet": { "allOf": [ { "$ref": "#/components/schemas/viewsGCPSubnetParamsType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "existing_subnet" ] } }, "x-f5xc-description-short": "Defines choice about GCP VPC network for a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsGCPVPCSubnetChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsgcp_vpc_siteCreateSpecType": { "type": "object", "description": "Shape of the GCP VPC site specification.", "title": "CreateSpecType", "x-displayname": "Create GCP VPC site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"cloud_credentials\"]", "x-ves-oneof-field-encryption_choice": "[\"disable_encryption\",\"enable_encryption\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-private_connectivity_choice": "[\"private_connect_disabled\",\"private_connectivity\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_gw\",\"voltstack_cluster\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.CreateSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "cloud_credentials": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for cloud credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cloud_credentials", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "disable_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_encryption" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 64000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_encryption": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPDiskEncryption" } ], "x-f5xc-description-short": "Configuration parameter for enable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_encryption" ] }, "gcp_labels": { "type": "object", "description": "GCP Label is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in GCP console.", "x-displayname": "GCP Labels.", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "GCP Label is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "GCP Label is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in GCP console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp_region": { "type": "string", "description": "Name for GCP Region.", "maxLength": 64, "x-displayname": "GCP Region.", "x-ves-example": "Us-west1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCIngressEgressGwType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_gw", "voltstack_cluster" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCIngressGwType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "voltstack_cluster" ] }, "instance_type": { "type": "string", "description": "Select Instance size based on performance needed.", "maxLength": 64, "x-displayname": "GCP Instance Type for Node.", "x-ves-example": "N1-standard-4.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "n1-standard-4", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "private_connectivity" ] }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "private_connect_disabled" ] }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCVoltstackClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw" ] } }, "x-f5xc-description-short": "Shape of the GCP VPC site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsgcp_vpc_siteCreateSpecType", "required_fields": [ "gcp_region", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_region\": \"us-west1\",\n \"instance_type\": \"n1-standard-4\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "gcp_region: us-west1\ninstance_type: n1-standard-4\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsgcp_vpc_siteGetSpecType": { "type": "object", "description": "Shape of the GCP VPC site specification.", "title": "GetSpecType", "x-displayname": "GET GCP VPC site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"cloud_credentials\"]", "x-ves-oneof-field-encryption_choice": "[\"disable_encryption\",\"enable_encryption\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-private_connectivity_choice": "[\"private_connect_disabled\",\"private_connectivity\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_gw\",\"voltstack_cluster\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.GetSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "cloud_credentials": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for cloud credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cloud_credentials", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "cloud_site_info": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCSiteInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "disable_encryption": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_encryption" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 64000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_encryption": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPDiskEncryption" } ], "x-f5xc-description-short": "Configuration parameter for enable encryption.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_encryption" ] }, "error_description": { "type": "string", "description": "Description of error on site.", "x-displayname": "Error Description.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp_labels": { "type": "object", "description": "GCP Label is a label consisting of a user-defined key and value.\nIt helps to manage, identify, organize, search for, and filter resources in GCP console.", "x-displayname": "GCP Labels.", "x-ves-example": "Dev: staging.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "devstaging", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "40", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-description-short": "GCP Label is a label consisting of a user-defined key and value.", "x-f5xc-description-medium": "GCP Label is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in GCP console.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp_region": { "type": "string", "description": "Name for GCP Region.", "maxLength": 64, "x-displayname": "GCP Region.", "x-ves-example": "Us-west1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCIngressEgressGwType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_gw", "voltstack_cluster" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCIngressGwType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "voltstack_cluster" ] }, "instance_type": { "type": "string", "description": "Select Instance size based on performance needed.", "maxLength": 64, "x-displayname": "GCP Instance Type for Node.", "x-ves-example": "N1-standard-4.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "n1-standard-4", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "private_connectivity" ] }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "private_connect_disabled" ] }, "site_errors": { "type": "array", "description": "Errors on site including suggested action.", "items": { "$ref": "#/components/schemas/viewsSiteError" }, "x-displayname": "Site Errors.", "x-ves-example": "Site Errors.", "x-f5xc-example": "Site Errors", "x-f5xc-description-short": "Errors on site including suggested action.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "suggested_action": { "type": "string", "description": "Suggested action for customer on error.", "x-displayname": "Suggested Action.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "validation_state": { "allOf": [ { "$ref": "#/components/schemas/viewsConfigValidationState" } ], "x-f5xc-description-short": "Configuration parameter for validation state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCVoltstackClusterType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw" ] } }, "x-f5xc-description-short": "Shape of the GCP VPC site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsgcp_vpc_siteGetSpecType", "required_fields": [ "gcp_region", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_region\": \"us-west1\",\n \"instance_type\": \"n1-standard-4\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "gcp_region: us-west1\ninstance_type: n1-standard-4\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsgcp_vpc_siteReplaceSpecType": { "type": "object", "description": "Shape of the GCP VPC site replace specification.", "title": "ReplaceSpecType", "x-displayname": "Replace GCP VPC site.", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-deployment": "[\"cloud_credentials\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-private_connectivity_choice": "[\"private_connect_disabled\",\"private_connectivity\"]", "x-ves-oneof-field-site_type": "[\"ingress_egress_gw\",\"ingress_gw\",\"voltstack_cluster\"]", "x-ves-proto-message": "ves.io.schema.views.gcp_vpc_site.ReplaceSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services", "default_blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "default_blocked_services" ] }, "cloud_credentials": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for cloud credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cloud_credentials", "gated_by": { "choice": "deployment" }, "required": false, "cardinality": "single" } ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/viewsCustomDNS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services", "blocked_services" ] }, "disk_size": { "type": "integer", "description": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "format": "int64", "x-displayname": "Cloud Disk Size.", "x-ves-example": "80", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "64000" }, "x-f5xc-description-short": "Disk size to be used for this instance in GiB. 80 is 80 GiB.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 64000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp_region": { "type": "string", "description": "Name for GCP Region.", "maxLength": 64, "x-displayname": "GCP Region.", "x-ves-example": "Us-west1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "us-west1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ingress_egress_gw": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCIngressEgressGwReplaceType" } ], "x-f5xc-description-short": "Configuration parameter for ingress egress gw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_gw", "voltstack_cluster" ] }, "ingress_gw": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCIngressGwReplaceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "voltstack_cluster" ] }, "instance_type": { "type": "string", "description": "Select Instance size based on performance needed.", "maxLength": 64, "x-displayname": "GCP Instance Type for Node.", "x-ves-example": "N1-standard-4.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "n1-standard-4", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Select Instance size based on performance needed.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connect_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "private_connectivity" ] }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectConfigType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "private_connect_disabled" ] }, "ssh_key": { "type": "string", "description": "Public SSH key for accessing the site.", "minLength": 1, "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "8192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "voltstack_cluster": { "allOf": [ { "$ref": "#/components/schemas/gcp_vpc_siteGCPVPCVoltstackClusterReplaceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ingress_egress_gw", "ingress_gw" ] } }, "x-f5xc-description-short": "Shape of the GCP VPC site replace specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsgcp_vpc_siteReplaceSpecType", "required_fields": [ "gcp_region", "instance_type", "ssh_key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"gcp_region\": \"us-west1\",\n \"instance_type\": \"n1-standard-4\",\n \"ssh_key\": \"ssh-rsa AAAAB...\"\n}", "example_yaml": "gcp_region: us-west1\ninstance_type: n1-standard-4\nssh_key: ssh-rsa AAAAB..." }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of securemesh_site", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_siteCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a securemesh_site", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read securemesh_site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_siteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/securemesh_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteInterface": { "type": "object", "description": "Interface definition.", "title": "Interface", "x-displayname": "Interface", "x-ves-oneof-field-dc_cluster_group_connectivity_interface_choice": "[\"dc_cluster_group_connectivity_interface_disabled\",\"dc_cluster_group_connectivity_interface_enabled\"]", "x-ves-oneof-field-interface_choice": "[\"dedicated_interface\",\"dedicated_management_interface\",\"ethernet_interface\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.Interface", "properties": { "dc_cluster_group_connectivity_interface_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_connectivity_interface_enabled" ] }, "dc_cluster_group_connectivity_interface_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_connectivity_interface_disabled" ] }, "dedicated_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDedicatedInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for dedicated interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_management_interface", "ethernet_interface" ] }, "dedicated_management_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDedicatedManagementInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for dedicated management interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_interface", "ethernet_interface" ] }, "description": { "type": "string", "description": "Description for this Interface.", "title": "Interface Description", "maxLength": 256, "x-displayname": "Interface Description.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ethernet_interface": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceEthernetInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for ethernet interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dedicated_interface", "dedicated_management_interface" ] }, "labels": { "type": "object", "description": "Add Labels for this Interface, these labels can be used in firewall policy.", "title": "Interface labels", "x-displayname": "Interface Labels.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Add Labels for this Interface, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteInterface", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteInterfaceListType": { "type": "object", "description": "Configure network interfaces for this Secure Mesh site.", "title": "List of Interfaces", "x-displayname": "List of Interface.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.InterfaceListType", "properties": { "interfaces": { "type": "array", "description": "Configure network interfaces for this Secure Mesh site.", "title": "List of Interfaces", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/securemesh_siteInterface" }, "x-displayname": "List of Interface.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Configure network interfaces for this Secure Mesh site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Configure network interfaces for this Secure Mesh site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteInterfaceListType", "required_fields": [ "interfaces" ], "mutually_exclusive_groups": [], "example_json": "{\n \"interfaces\": [\n {}\n ]\n}", "example_yaml": "interfaces:\n- {}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of securemesh_site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/securemesh_siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteListResponseItem": { "type": "object", "description": "By default a summary of securemesh_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of securemesh_site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this securemesh_site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this securemesh_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this securemesh_site.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this securemesh_site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates securemesh_site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates securemesh_site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_siteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this securemesh_site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this securemesh_site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this securemesh_site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/securemesh_siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this securemesh_site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of securemesh_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of securemesh_site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a securemesh_site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_siteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteSmsNetworkConfiguration": { "type": "object", "title": "SmsNetworkConfiguration", "x-displayname": "SmsNetworkConfiguration.", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]", "x-ves-oneof-field-global_network_choice": "[\"global_network_list\",\"no_global_network\"]", "x-ves-oneof-field-interface_choice": "[\"default_interface_config\",\"interface_list\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]", "x-ves-oneof-field-site_mesh_group_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-oneof-field-sli_choice": "[\"default_sli_config\",\"sli_config\"]", "x-ves-oneof-field-slo_choice": "[\"default_config\",\"slo_config\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.SmsNetworkConfiguration", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_network_policies", "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "forward_proxy_allow_all", "no_forward_proxy" ] }, "active_network_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveNetworkPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active network policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "no_network_policy" ] }, "default_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "slo_config" ] }, "default_interface_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "interface_list" ] }, "default_sli_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sli_config" ] }, "forward_proxy_allow_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for forward proxy allow all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "no_forward_proxy" ] }, "global_network_list": { "allOf": [ { "$ref": "#/components/schemas/viewsGlobalNetworkConnectionListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_network" ] }, "interface_list": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteInterfaceListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_interface_config" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies", "forward_proxy_allow_all" ] }, "no_global_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "global_network_list" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies", "active_network_policies" ] }, "sli_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sli_config" ] }, "slo_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteVnConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_config" ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "title": "tunnel_dead_timeout", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_vrrp_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaVipVrrpType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteSmsNetworkConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteStaticRoutesListType": { "type": "object", "description": "List of static routes.", "title": "Static Routes List", "x-displayname": "Static Routes List.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.StaticRoutesListType", "properties": { "static_routes": { "type": "array", "description": "List of static routes.", "title": "static_routes", "minItems": 1, "maxItems": 16, "items": { "$ref": "#/components/schemas/virtual_networkStaticRouteViewType" }, "x-displayname": "Static Routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteStaticRoutesListType", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n {\n \"ip_prefixes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "static_routes:\n- ip_prefixes:\n - value" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "F5XC Secure Mesh site object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-description-short": "F5XC Secure Mesh site object direct reference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_siteVnConfiguration": { "type": "object", "description": "Site local network configuration.", "title": "Virtual Network Configuration", "x-displayname": "Site Local Network Configuration.", "x-ves-oneof-field-dc_cluster_group_choice": "[\"dc_cluster_group\",\"no_dc_cluster_group\"]", "x-ves-oneof-field-static_route_choice": "[\"no_static_routes\",\"static_routes\"]", "x-ves-oneof-field-static_v6_route_choice": "[\"no_v6_static_routes\",\"static_v6_routes\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.VnConfiguration", "properties": { "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_dc_cluster_group" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group", "gated_by": { "choice": "dc_cluster_group_choice" }, "required": false, "cardinality": "single" } ] }, "labels": { "type": "object", "description": "Add Labels for this network, these labels can be used in firewall policy.", "title": "Network labels", "x-displayname": "Network Labels.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Add Labels for this network, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nameserver": { "type": "string", "description": "Optional DNS V4 server IP to be used for name resolution.", "title": "nameserver", "x-displayname": "DNS V4 Server.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional DNS V4 server IP to be used for name resolution.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group" ] }, "no_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_routes" ] }, "no_v6_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no v6 static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_v6_routes" ] }, "static_routes": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteStaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_routes" ] }, "static_v6_routes": { "allOf": [ { "$ref": "#/components/schemas/virtual_networkStaticV6RoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static v6 routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_v6_static_routes" ] }, "vip": { "type": "string", "description": "Optional common virtual V4 IP across all nodes to be used as automatic VIP.", "title": "Common V4 VIP", "x-displayname": "Common V4 VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional common virtual V4 IP across all nodes to be used as automatic VIP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_siteVnConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_siteCreateSpecType": { "type": "object", "description": "Shape of the Secure Mesh site specification.", "title": "CreateSpecType", "x-displayname": "Create Secure Mesh site.", "x-ves-oneof-field-blocked_services_choice": "[\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-bond_choice": "[\"bond_device_list\",\"no_bond_devices\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_cfg_choice": "[\"custom_network_config\",\"default_network_config\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.CreateSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_blocked_services" ] }, "bond_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDevicesListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_bond_devices" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_network_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteSmsNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_network_config" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "default_network_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_network_config" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "master_node_configuration": { "type": "array", "description": "Configuration of master nodes.", "maxItems": 3, "items": { "$ref": "#/components/schemas/viewsMasterNode" }, "x-displayname": "Master Nodes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_bond_devices": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no bond devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_device_list" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_certified_hw": { "type": "string", "description": "Name for generic server certified hardware to form this Secure Mesh site.", "minLength": 1, "x-displayname": "Generic Server Certified Hardware.", "x-ves-example": "Isv-8000-series-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "isv-8000-series-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name for generic server certified hardware to form this Secure Mesh site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "worker_nodes": { "type": "array", "description": "Names of worker nodes.", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "Worker Nodes.", "x-ves-example": "Worker-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "worker-0", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the Secure Mesh site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_siteCreateSpecType", "required_fields": [ "master_node_configuration", "volterra_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"master_node_configuration\": [\n {\n \"name\": \"master-0\"\n }\n ],\n \"volterra_certified_hw\": \"isv-8000-series-voltmesh\"\n}", "example_yaml": "master_node_configuration:\n- name: master-0\nvolterra_certified_hw: isv-8000-series-voltmesh" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_siteGetSpecType": { "type": "object", "description": "Shape of the Secure Mesh site specification.", "title": "GetSpecType", "x-displayname": "GET Secure Mesh site.", "x-ves-oneof-field-blocked_services_choice": "[\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-bond_choice": "[\"bond_device_list\",\"no_bond_devices\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_cfg_choice": "[\"custom_network_config\",\"default_network_config\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.GetSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_blocked_services" ] }, "bond_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDevicesListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_bond_devices" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_network_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteSmsNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_network_config" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "default_network_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_network_config" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "master_node_configuration": { "type": "array", "description": "Configuration of master nodes.", "maxItems": 3, "items": { "$ref": "#/components/schemas/viewsMasterNode" }, "x-displayname": "Master Nodes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_bond_devices": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no bond devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_device_list" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operating_system_version": { "type": "string", "description": "Desired Operating System version that should be installed on the site.", "maxLength": 256, "x-displayname": "Operating System Version.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Desired Operating System version that should be installed on the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_certified_hw": { "type": "string", "description": "Name for generic server certified hardware to form this Secure Mesh site.", "minLength": 1, "x-displayname": "Generic Server Certified Hardware.", "x-ves-example": "Isv-8000-series-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "isv-8000-series-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name for generic server certified hardware to form this Secure Mesh site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "volterra_software_version": { "type": "string", "description": "Desired F5 Distributed Cloud software version that should be installed on the site.", "maxLength": 256, "x-displayname": "Software Version.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Desired F5 Distributed Cloud software version that should be installed on the site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "worker_nodes": { "type": "array", "description": "Names of worker nodes.", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "Worker Nodes.", "x-ves-example": "Worker-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "worker-0", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the Secure Mesh site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_siteGetSpecType", "required_fields": [ "master_node_configuration", "volterra_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"master_node_configuration\": [\n {\n \"name\": \"master-0\"\n }\n ],\n \"volterra_certified_hw\": \"isv-8000-series-voltmesh\"\n}", "example_yaml": "master_node_configuration:\n- name: master-0\nvolterra_certified_hw: isv-8000-series-voltmesh" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_siteReplaceSpecType": { "type": "object", "description": "Shape of the Secure Mesh site specification.", "title": "ReplaceSpecType", "x-displayname": "Replace Secure Mesh site.", "x-ves-oneof-field-blocked_services_choice": "[\"blocked_services\",\"default_blocked_services\"]", "x-ves-oneof-field-bond_choice": "[\"bond_device_list\",\"no_bond_devices\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_cfg_choice": "[\"custom_network_config\",\"default_network_config\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site.ReplaceSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_blocked_services" ] }, "bond_device_list": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDevicesListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_bond_devices" ] }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "custom_network_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_siteSmsNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_network_config" ] }, "default_blocked_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "default_network_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_network_config" ] }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ], "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": { "choice": "logs_receiver_choice" }, "required": false, "cardinality": "single" } ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver" ] }, "master_node_configuration": { "type": "array", "description": "Configuration of master nodes.", "maxItems": 3, "items": { "$ref": "#/components/schemas/viewsMasterNode" }, "x-displayname": "Master Nodes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.num_items": "1,3" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_bond_devices": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no bond devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_device_list" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_certified_hw": { "type": "string", "description": "Name for generic server certified hardware to form this Secure Mesh site.", "minLength": 1, "x-displayname": "Generic Server Certified Hardware.", "x-ves-example": "Isv-8000-series-voltmesh.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "isv-8000-series-voltmesh", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-description-short": "Name for generic server certified hardware to form this Secure Mesh site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "worker_nodes": { "type": "array", "description": "Names of worker nodes.", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "Worker Nodes.", "x-ves-example": "Worker-0", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "worker-0", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the Secure Mesh site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_siteReplaceSpecType", "required_fields": [ "master_node_configuration", "volterra_certified_hw" ], "mutually_exclusive_groups": [], "example_json": "{\n \"master_node_configuration\": [\n {\n \"name\": \"master-0\"\n }\n ],\n \"volterra_certified_hw\": \"isv-8000-series-voltmesh\"\n}", "example_yaml": "master_node_configuration:\n- name: master-0\nvolterra_certified_hw: isv-8000-series-voltmesh" }, "x-f5xc-cli-domain": "sites", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "SecureMesh site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaSiteToSiteTunnelType": { "type": "string", "description": "Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL.\nTunnel is of type IPsec\nTunnel is of type SSL.", "title": "Site to site tunnel type", "enum": [ "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL", "SITE_TO_SITE_TUNNEL_IPSEC", "SITE_TO_SITE_TUNNEL_SSL" ], "default": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL", "x-displayname": "Tunnel type.", "x-ves-proto-enum": "ves.io.schema.SiteToSiteTunnelType", "x-f5xc-description-short": "Tunnel encapsulation to be used between sites Tunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL.", "x-f5xc-description-medium": "Tunnel encapsulation to be used between sites Tunnel can operate in both IPsec and SSL, with IPsec being preferred over SSL. Tunnel is of type IPsec Tunnel is of type SSL.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSiteToSiteTunnelType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL\"", "example_yaml": "SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2AWSProviderType": { "type": "object", "description": "AWS Provider Type.", "title": "AWS Provider Type", "x-displayname": "AWS Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.AWSProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2AWSProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2AwsCloudResourceListType": { "type": "object", "description": "AWS Cloud Resources.", "title": "AWS Cloud Resource List Type", "x-displayname": "AWS Cloud Resources.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.AwsCloudResourceListType", "properties": { "aws_cloud_resources": { "type": "array", "description": "List of AWS Cloud Resource.", "title": "AWS Cloud Resource", "items": { "$ref": "#/components/schemas/securemesh_site_v2AwsCloudResourceType" }, "x-displayname": "AWS Cloud Resources.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2AwsCloudResourceListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2AwsCloudResourceType": { "type": "object", "description": "AWS Cloud Resource Type.", "title": "AWS Cloud Resource Type", "x-displayname": "AWS Cloud Resource.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.AwsCloudResourceType", "properties": { "resource_id": { "type": "array", "description": "Resource ID.", "title": "Resource Id", "items": { "type": "string" }, "x-displayname": "Resource ID.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_type": { "type": "string", "description": "Resource Type.", "title": "Resource Type", "x-displayname": "Resource Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2AwsCloudResourceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2AzureProviderType": { "type": "object", "description": "Azure Provider Type.", "title": "Azure Provider Type", "x-displayname": "Azure Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.AzureProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2AzureProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2BaremetalProviderType": { "type": "object", "description": "Baremetal Provider Type.", "title": "Baremetal Provider Type", "x-displayname": "Baremetal Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.BaremetalProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2BaremetalProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2CreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of securemesh_site_v2", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_site_v2CreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Secure Mesh Site v2 for multi-cloud CE deployments (Azure, AWS, GCP, bare-metal, etc.)", "required_fields": [ "metadata.name", "metadata.namespace" ], "mutually_exclusive_groups": [ { "name": "provider_choice", "fields": [ "spec.aws", "spec.azure", "spec.baremetal", "spec.equinix", "spec.gcp", "spec.kvm", "spec.nutanix", "spec.oci", "spec.openshift_virtualization", "spec.openstack", "spec.vmware" ], "required": true, "reason": "Choose exactly one cloud provider" }, { "name": "node_ha_choice", "fields": [ "spec.disable_ha", "spec.enable_ha" ], "reason": "HA enabled or disabled" }, { "name": "blocked_services_choice", "fields": [ "spec.block_all_services", "spec.blocked_services" ], "reason": "Block all or specific services" }, { "name": "network_policy_choice", "fields": [ "spec.active_enhanced_firewall_policies", "spec.no_network_policy" ], "reason": "Network policy or none" }, { "name": "forward_proxy_choice", "fields": [ "spec.active_forward_proxy_policies", "spec.no_forward_proxy" ], "reason": "Forward proxy or none" }, { "name": "enterprise_proxy_choice", "fields": [ "spec.custom_proxy", "spec.f5_proxy" ], "reason": "Proxy type" }, { "name": "proxy_bypass_choice", "fields": [ "spec.custom_proxy_bypass", "spec.no_proxy_bypass" ], "reason": "Proxy bypass or none" }, { "name": "logs_receiver_choice", "fields": [ "spec.log_receiver_with_net", "spec.logs_streaming_disabled" ], "reason": "Log receiver or disabled" }, { "name": "s2s_connectivity_sli_choice", "fields": [ "spec.dc_cluster_group_sli", "spec.no_s2s_connectivity_sli" ], "reason": "S2S connectivity SLI" }, { "name": "s2s_connectivity_slo_choice", "fields": [ "spec.dc_cluster_group_slo", "spec.no_s2s_connectivity_slo", "spec.site_mesh_group_on_slo" ], "reason": "S2S connectivity SLO" }, { "name": "url_categorization_choice", "fields": [ "spec.disable_url_categorization", "spec.enable_url_categorization" ], "reason": "URL categorization" }, { "name": "management_network_choice", "fields": [ "spec.disable_management_network", "spec.enable_management_network" ], "reason": "Management network" } ], "example_yaml": "metadata:\n name: example-smsv2\n namespace: system\nspec:\n azure:\n not_managed:\n node_list: []\n disable_ha: {}\n no_network_policy: {}\n no_forward_proxy: {}\n logs_streaming_disabled: {}\n block_all_services: {}\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-smsv2\",\n \"namespace\": \"system\"\n },\n \"spec\": {\n \"azure\": {\n \"not_managed\": {\n \"node_list\": []\n }\n },\n \"disable_ha\": {},\n \"no_network_policy\": {},\n \"no_forward_proxy\": {},\n \"logs_streaming_disabled\": {},\n \"block_all_services\": {}\n }\n}\n" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2CreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_site_v2GetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2CreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2CustomDNSSettings": { "type": "object", "description": "DNS Servers.", "title": "DNS Servers", "x-displayname": "DNS Servers.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CustomDNSSettings", "properties": { "dns_servers": { "type": "array", "description": "DNS Servers.", "title": "DNS Servers", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "DNS Servers.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2CustomDNSSettings", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2CustomNTPSettings": { "type": "object", "description": "NTP Servers.", "title": "NTP Servers", "x-displayname": "NTP Servers.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CustomNTPSettings", "properties": { "ntp_servers": { "type": "array", "description": "NTP Servers.", "title": "NTP Servers", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "NTP Servers.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2CustomNTPSettings", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2CustomProxy": { "type": "object", "description": "Custom Enterprise Proxy.", "title": "Custom Enterprise Proxy", "x-displayname": "Custom Enterprise Proxy.", "x-ves-oneof-field-use_for_re_tunnel_choice": "[\"disable_re_tunnel\",\"enable_re_tunnel\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CustomProxy", "properties": { "disable_re_tunnel": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable re tunnel.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_re_tunnel" ] }, "enable_re_tunnel": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable re tunnel.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_re_tunnel" ] }, "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "proxy_ip_address": { "type": "string", "description": "Specify the IPv4 Address of the internal Enterprise Proxy.", "title": "Proxy IPv4 Address", "x-displayname": "Proxy IPv4 Address.", "x-ves-example": "192.0.2.172.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.172", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Specify the IPv4 Address of the internal Enterprise Proxy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "proxy_port": { "type": "integer", "description": "Specify the Port of the internal Enterprise Proxy.", "title": "Proxy Port", "format": "int64", "x-displayname": "Proxy Port.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Specify the Port of the internal Enterprise Proxy.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "username": { "type": "string", "description": "If the internal Enterprise Proxy is using basic authentication, specify the username. This is an optional field.", "title": "Username", "x-displayname": "Username", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "If the internal Enterprise Proxy is using basic authentication, specify the username.", "x-f5xc-description-medium": "If the internal Enterprise Proxy is using basic authentication, specify the username. This is an optional field.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2CustomProxy", "required_fields": [ "proxy_ip_address", "proxy_port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"proxy_ip_address\": \"192.0.2.172\",\n \"proxy_port\": 0\n}", "example_yaml": "proxy_ip_address: 192.0.2.172\nproxy_port: 0" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2CustomProxyBypassSettings": { "type": "object", "description": "List of domains to bypass the proxy.", "title": "Proxy Bypass", "x-displayname": "Proxy Bypass.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CustomProxyBypassSettings", "properties": { "proxy_bypass": { "type": "array", "description": "List of domains to bypass the proxy.", "title": "Proxy Bypass", "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Proxy Bypass.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname_or_ip": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname_or_ip": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2CustomProxyBypassSettings", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2DNSNTPServerConfig": { "type": "object", "description": "Specify DNS and NTP servers that will be used by the nodes in this Customer Edge site.", "title": "DNS & NTP Servers", "x-displayname": "DNS & NTP Servers Settings.", "x-ves-oneof-field-dns_server_choice": "[\"custom_dns\",\"f5_dns_default\"]", "x-ves-oneof-field-ntp_server_choice": "[\"custom_ntp\",\"f5_ntp_default\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.DNSNTPServerConfig", "properties": { "custom_dns": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomDNSSettings" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_dns_default" ] }, "custom_ntp": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomNTPSettings" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_ntp_default" ] }, "f5_dns_default": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for f5 dns default.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_dns" ] }, "f5_ntp_default": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for f5 ntp default.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_ntp" ] } }, "x-f5xc-description-short": "Specify DNS and NTP servers that will be used by the nodes in this Customer Edge site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2DNSNTPServerConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2DeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a securemesh_site_v2", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2DeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2EquinixProviderType": { "type": "object", "description": "Equinix Provider Type.", "title": "Equinix Provider Type", "x-displayname": "Equinix Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.EquinixProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2EquinixProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2GCPProviderType": { "type": "object", "description": "GCP Provider Type.", "title": "GCP Provider Type", "x-displayname": "GCP Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.GCPProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2GCPProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2GetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read securemesh_site_v2", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2ReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_site_v2GetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/securemesh_site_v2StatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2GetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2Interface": { "type": "object", "description": "Interface definition.", "title": "Interface", "x-displayname": "Interface", "x-ves-oneof-field-address_choice": "[\"dhcp_client\", \"dhcp_server\", \"no_ipv4_address\", \"static_ip\"]", "x-ves-oneof-field-interface_choice": "[\"bond_interface\",\"ethernet_interface\",\"vlan_interface\"]", "x-ves-oneof-field-ipv6_address_choice": "[\"ipv6_auto_config\",\"no_ipv6_address\",\"static_ipv6_address\"]", "x-ves-oneof-field-monitoring_choice": "[\"monitor\",\"monitor_disabled\"]", "x-ves-oneof-field-site_to_site_connectivity_interface_choice": "[\"site_to_site_connectivity_interface_disabled\",\"site_to_site_connectivity_interface_enabled\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.Interface", "properties": { "bond_interface": { "allOf": [ { "$ref": "#/components/schemas/fleetFleetBondDeviceType" } ], "x-f5xc-description-short": "Configuration parameter for bond interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ethernet_interface", "vlan_interface" ] }, "description": { "type": "string", "description": "Description for this Interface.", "title": "Interface Description", "maxLength": 256, "x-displayname": "Interface Description.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "dhcp_client": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dhcp_server", "no_ipv4_address", "static_ip" ] }, "ethernet_interface": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_site_v2EthernetInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for ethernet interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_interface", "vlan_interface" ] }, "ipv6_auto_config": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceIPV6AutoConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_ipv6_address", "static_ipv6_address" ] }, "labels": { "type": "object", "description": "Add Labels for this Interface, these labels can be used in firewall policy.", "title": "Interface labels", "x-displayname": "Interface Labels.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Add Labels for this Interface, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "monitor": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceLinkQualityMonitorConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monitor_disabled" ] }, "monitor_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monitor" ] }, "mtu": { "type": "integer", "description": "Maximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, MTU must be between 512 and 16384.", "title": "Maximum Packet Size (MTU)", "format": "int64", "x-displayname": "Maximum Packet Size (MTU)", "x-ves-example": "1450", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-example": "1450", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,512-16384" }, "x-f5xc-description-short": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-description-medium": "Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 16384, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of this Interface.", "title": "Interface Name", "maxLength": 256, "x-displayname": "Interface Name.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "network_option": { "allOf": [ { "$ref": "#/components/schemas/viewsNetworkSelectType" } ], "x-f5xc-description-short": "Configuration parameter for network option.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_ipv4_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dhcp_client", "dhcp_server", "static_ip" ] }, "no_ipv6_address": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv6_auto_config", "static_ipv6_address" ] }, "priority": { "type": "integer", "description": "For a node, if multiple interfaces are configured in a VRF, interfaces with highest priority will be used as active\nand interfaces with lower priority will be used as backup.\nIf multiple interfaces have the same priority, ECMP will be used.\nGreater the value, higher the priority.", "title": "Priority", "format": "int64", "x-displayname": "Priority", "x-ves-example": "42", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "42", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "For a node, if multiple interfaces are configured in a VRF, interfaces with highest priority will be used as active and interfaces with lower...", "x-f5xc-description-medium": "For a node, if multiple interfaces are configured in a VRF, interfaces with highest priority will be used as active and interfaces with lower priority will be used as backup. If multiple interfaces have the same priority, ECMP will be used. Greater the value, higher the priority.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_to_site_connectivity_interface_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_to_site_connectivity_interface_enabled" ] }, "site_to_site_connectivity_interface_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_to_site_connectivity_interface_disabled" ] }, "static_ip": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIpParametersNodeType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dhcp_client", "dhcp_server", "no_ipv4_address" ] }, "static_ipv6_address": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceStaticIPParametersType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ipv6_auto_config", "no_ipv6_address" ] }, "vlan_interface": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2VlanInterfaceType" } ], "x-f5xc-description-short": "Configuration parameter for vlan interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bond_interface", "ethernet_interface" ] }, "dhcp_server": { "allOf": [ { "$ref": "#/components/schemas/network_interfaceDHCPServerParametersType" } ], "description": "DHCP server configuration for this interface.", "x-f5xc-conflicts-with": [ "dhcp_client", "no_ipv4_address", "static_ip" ] }, "is_management": { "type": "boolean", "readOnly": true }, "is_primary": { "type": "boolean", "readOnly": true } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2Interface", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2KVMProviderType": { "type": "object", "description": "KVM Provider Type.", "title": "KVM Provider Type", "x-displayname": "KVM Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.KVMProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2KVMProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2ListCloudResourceResponse": { "type": "object", "description": "List all cloud resources.", "title": "Cloud Resource Response", "x-displayname": "Cloud Resource Response.", "x-ves-oneof-field-cloud_resource_choice": "[\"aws_cloud_resources\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ListCloudResourceResponse", "properties": { "aws_cloud_resources": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AwsCloudResourceListType" } ], "x-f5xc-description-short": "Configuration parameter for aws cloud resources.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2ListCloudResourceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2ListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of securemesh_site_v2", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/securemesh_site_v2ListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2ListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2ListResponseItem": { "type": "object", "description": "By default a summary of securemesh_site_v2 is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of securemesh_site_v2", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this securemesh_site_v2.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this securemesh_site_v2.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this securemesh_site_v2.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this securemesh_site_v2.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates securemesh_site_v2 is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates securemesh_site_v2 is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_site_v2GetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this securemesh_site_v2.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this securemesh_site_v2.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this securemesh_site_v2.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/securemesh_site_v2StatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this securemesh_site_v2.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this securemesh_site_v2.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of securemesh_site_v2 is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of securemesh_site_v2 is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2ListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2LoadBalancingSettingsType": { "type": "object", "description": "This section contains settings on the site that relate to Load Balancing functionality.", "title": "Load Balancing Settings", "x-displayname": "Load Balancing Settings.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.LoadBalancingSettingsType", "properties": { "vip_vrrp_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaVipVrrpType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Section contains settings on the site that relate to Load Balancing functionality.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2LoadBalancingSettingsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2LocalVRFSettingType": { "type": "object", "description": "There can be two local VRFs on each site.\nThe Site Local Outside (SLO) local VRF is used to connect WAN side workloads to this site and to connect the site to F5 Distributed Cloud for management. All sites are required to have an SLO local VRF.\nThe Site Local Inside (SLI) local VRF is used to connect LAN side workloads to this site. SLI local VRF is optional.", "title": "Local VRF Settings", "x-displayname": "Local VRF Settings.", "x-ves-oneof-field-sli_choice": "[\"default_sli_config\",\"sli_config\"]", "x-ves-oneof-field-slo_choice": "[\"default_config\",\"slo_config\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.LocalVRFSettingType", "properties": { "default_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "slo_config" ] }, "default_sli_config": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sli_config" ] }, "sli_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2VirtualNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_sli_config" ] }, "slo_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2VirtualNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_config" ] } }, "x-f5xc-description-short": "There can be two local VRFs on each site.", "x-f5xc-description-medium": "There can be two local VRFs on each site. The Site Local Outside (SLO) local VRF is used to connect WAN side workloads to this site and to connect the site to F5 Distributed Cloud for management. All sites are required to have an SLO local VRF.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2LocalVRFSettingType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2LogReceiverWithNet": { "type": "object", "description": "Select log receiver for logs streaming with network option.", "title": "LogReceiverWithNet", "x-displayname": "Enable", "x-ves-oneof-field-network_choice": "[\"use_management_network\",\"use_slo_sli\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.LogReceiverWithNet", "properties": { "log_receiver": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for log receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "log_receiver", "field_path": "log_receiver", "gated_by": null, "required": false, "cardinality": "single" } ] }, "use_management_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use management network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_slo_sli" ] }, "use_slo_sli": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use slo sli.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_management_network" ] } }, "x-f5xc-description-short": "Select log receiver for logs streaming with network option.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2LogReceiverWithNet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2NodeList": { "type": "object", "description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.", "title": "NodeList", "x-displayname": "List of Nodes.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.NodeList", "properties": { "node_list": { "type": "array", "description": "This section will show nodes associated with this site. Note: For sites that are not orchestrated by F5XC, create nodes in the chosen provider.\nOnce a node is created and registers with the site, it will be shown in this section.", "title": "Nodes", "maxItems": 128, "items": { "$ref": "#/components/schemas/viewssecuremesh_site_v2Node" }, "x-displayname": "Nodes", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Section will show nodes associated with this site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Section will show nodes associated with this site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2NodeList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2NutanixProviderType": { "type": "object", "description": "Nutanix Provider Type.", "title": "Nutanix Provider Type", "x-displayname": "Nutanix Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.NutanixProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2NutanixProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2OCIProviderType": { "type": "object", "description": "OCI Provider Type.", "title": "OCI Provider Type", "x-displayname": "OCI Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.OCIProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2OCIProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2OpenShiftProviderType": { "type": "object", "description": "OpenShift Provider Type.", "title": "OpenShift Virtualization Provider Type", "x-displayname": "OpenShift Virtualization Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.OpenShiftProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2OpenShiftProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2OpenstackProviderType": { "type": "object", "description": "Openstack Provider Type.", "title": "Openstack Provider Type", "x-displayname": "Openstack Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.OpenstackProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2OpenstackProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2ReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a securemesh_site_v2", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/viewssecuremesh_site_v2ReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Secure Mesh Site v2 for multi-cloud CE deployments (Azure, AWS, GCP, bare-metal, etc.)", "required_fields": [], "mutually_exclusive_groups": [ { "name": "provider_choice", "fields": [ "spec.aws", "spec.azure", "spec.baremetal", "spec.equinix", "spec.gcp", "spec.kvm", "spec.nutanix", "spec.oci", "spec.openshift_virtualization", "spec.openstack", "spec.vmware" ], "required": true, "reason": "Choose exactly one cloud provider" }, { "name": "node_ha_choice", "fields": [ "spec.disable_ha", "spec.enable_ha" ], "reason": "HA enabled or disabled" }, { "name": "blocked_services_choice", "fields": [ "spec.block_all_services", "spec.blocked_services" ], "reason": "Block all or specific services" }, { "name": "network_policy_choice", "fields": [ "spec.active_enhanced_firewall_policies", "spec.no_network_policy" ], "reason": "Network policy or none" }, { "name": "forward_proxy_choice", "fields": [ "spec.active_forward_proxy_policies", "spec.no_forward_proxy" ], "reason": "Forward proxy or none" }, { "name": "enterprise_proxy_choice", "fields": [ "spec.custom_proxy", "spec.f5_proxy" ], "reason": "Proxy type" }, { "name": "proxy_bypass_choice", "fields": [ "spec.custom_proxy_bypass", "spec.no_proxy_bypass" ], "reason": "Proxy bypass or none" }, { "name": "logs_receiver_choice", "fields": [ "spec.log_receiver_with_net", "spec.logs_streaming_disabled" ], "reason": "Log receiver or disabled" }, { "name": "s2s_connectivity_sli_choice", "fields": [ "spec.dc_cluster_group_sli", "spec.no_s2s_connectivity_sli" ], "reason": "S2S connectivity SLI" }, { "name": "s2s_connectivity_slo_choice", "fields": [ "spec.dc_cluster_group_slo", "spec.no_s2s_connectivity_slo", "spec.site_mesh_group_on_slo" ], "reason": "S2S connectivity SLO" }, { "name": "url_categorization_choice", "fields": [ "spec.disable_url_categorization", "spec.enable_url_categorization" ], "reason": "URL categorization" }, { "name": "management_network_choice", "fields": [ "spec.disable_management_network", "spec.enable_management_network" ], "reason": "Management network" } ], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2ReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2ReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2SegmentNetworkConfiguration": { "type": "object", "description": "Segment Network Configuration.", "title": "Segment Network Configuration", "x-displayname": "Segment Network Configuration.", "x-ves-oneof-field-static_route_choice": "[\"no_static_routes\",\"static_routes\"]", "x-ves-oneof-field-static_v6_route_choice": "[\"no_v6_static_routes\",\"static_v6_routes\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.SegmentNetworkConfiguration", "properties": { "nameserver": { "type": "string", "description": "Optional IPv4 DNS server to be used for name resolution.", "title": "nameserver", "x-displayname": "IPv4 DNS Server.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional IPv4 DNS server to be used for name resolution.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_routes" ] }, "no_v6_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no v6 static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_v6_routes" ] }, "secondary_nameserver": { "type": "string", "description": "Optional Secondary IPv4 DNS server to be used for name resolution.", "title": "secondary_nameserver", "x-displayname": "Secondary IPv4 DNS Server.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional Secondary IPv4 DNS server to be used for name resolution.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "static_routes": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2StaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_routes" ] }, "static_v6_routes": { "allOf": [ { "$ref": "#/components/schemas/virtual_networkStaticV6RoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static v6 routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_v6_static_routes" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2SegmentNetworkConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2SegmentVRFSettingType": { "type": "object", "description": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid\nper Site that can be configured here.", "title": "Segment VRF Settings", "x-displayname": "Segment VRF Settings.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.SegmentVRFSettingType", "properties": { "segment_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SegmentNetworkConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaObjectRefType" } ], "x-f5xc-references": [ { "resource_kind": "segment", "field_path": "segment_network", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name.", "x-f5xc-description-medium": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid per Site that can be configured here.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2SegmentVRFSettingType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2SiteMeshGroupType": { "type": "object", "description": "Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used.", "title": "Site Mesh Group Type", "x-displayname": "Site Mesh Group Type.", "x-ves-oneof-field-site_mesh_group_choice": "[\"no_site_mesh_group\",\"site_mesh_group\"]", "x-ves-oneof-field-site_mesh_group_ip_choice": "[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.SiteMeshGroupType", "properties": { "no_site_mesh_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_mesh_group" ] }, "site_mesh_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_site_mesh_group" ], "x-f5xc-references": [ { "resource_kind": "site_mesh_group", "field_path": "site_mesh_group", "gated_by": { "choice": "site_mesh_group_choice" }, "required": false, "cardinality": "single" } ] }, "sm_connection_public_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_pvt_ip" ] }, "sm_connection_pvt_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sm_connection_public_ip" ] } }, "x-f5xc-description-short": "Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used.", "x-f5xc-description-medium": "Select how the site mesh group will be connected. By default, public IPs of the control nodes of the site will be used.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2SiteMeshGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2SoftwareSettingsType": { "type": "object", "description": "Select OS and Software version for the site. All nodes in the site will run the same OS and Software version. These settings cannot be changed after the site is created.", "title": "F5XC Software Settings", "x-displayname": "F5XC Software Settings.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.SoftwareSettingsType", "properties": { "os": { "allOf": [ { "$ref": "#/components/schemas/viewsOperatingSystemType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sw": { "allOf": [ { "$ref": "#/components/schemas/viewsVolterraSoftwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Select OS and Software version for the site. All nodes in the site will run the same OS and Software version.", "x-f5xc-description-medium": "Select OS and Software version for the site. All nodes in the site will run the same OS and Software version. These settings cannot be changed after the site is created.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2SoftwareSettingsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2StaticRoutesListType": { "type": "object", "title": "Static Routes List", "x-displayname": "Static Routes List.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.StaticRoutesListType", "properties": { "static_routes": { "type": "array", "description": "Configuration parameter for static routes", "title": "static_routes", "minItems": 1, "maxItems": 16, "items": { "$ref": "#/components/schemas/virtual_networkStaticRouteViewType" }, "x-displayname": "Static Routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2StaticRoutesListType", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n {\n \"ip_prefixes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "static_routes:\n- ip_prefixes:\n - value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2StatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions represent the normalized status values for configuration object.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "F5XC Secure Mesh Site object direct reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-description-short": "F5XC Secure Mesh Site object direct reference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2StatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2UpgradeSettingsType": { "type": "object", "description": "Specify how a site will be upgraded.", "title": "Upgrade Settings", "x-displayname": "Upgrade Settings.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.UpgradeSettingsType", "properties": { "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2UpgradeSettingsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2VMwareProviderType": { "type": "object", "description": "VMware Provider Type.", "title": "VMware Provider Type", "x-displayname": "VMware Provider Type.", "x-ves-oneof-field-orchestration_choice": "[\"not_managed\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.VMwareProviderType", "properties": { "not_managed": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NodeList" } ], "x-f5xc-description-short": "Configuration parameter for not managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2VMwareProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2VirtualNetworkConfiguration": { "type": "object", "description": "Site local network configuration.", "title": "Virtual Network Configuration", "x-displayname": "Site Local Network Configuration.", "x-ves-oneof-field-static_route_choice": "[\"no_static_routes\",\"static_routes\"]", "x-ves-oneof-field-static_v6_route_choice": "[\"no_v6_static_routes\",\"static_v6_routes\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.VirtualNetworkConfiguration", "properties": { "labels": { "type": "object", "description": "Add Labels for this network, these labels can be used in firewall policy.", "title": "Network labels", "x-displayname": "Network Labels.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "16", "ves.io.schema.rules.map.values.string.max_len": "64", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Add Labels for this network, these labels can be used in firewall policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nameserver": { "type": "string", "description": "Optional IPv4 DNS server to be used for name resolution.", "title": "nameserver", "x-displayname": "IPv4 DNS Server.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional IPv4 DNS server to be used for name resolution.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_routes" ] }, "no_v6_static_routes": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no v6 static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "static_v6_routes" ] }, "secondary_nameserver": { "type": "string", "description": "Optional Secondary IPv4 DNS server to be used for name resolution.", "title": "secondary_nameserver", "x-displayname": "Secondary IPv4 DNS Server.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional Secondary IPv4 DNS server to be used for name resolution.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "static_routes": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2StaticRoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_static_routes" ] }, "static_v6_routes": { "allOf": [ { "$ref": "#/components/schemas/virtual_networkStaticV6RoutesListType" } ], "x-f5xc-description-short": "Configuration parameter for static v6 routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_v6_static_routes" ] }, "vip": { "type": "string", "description": "Optional common virtual V4 IP across all nodes to be used as automatic VIP.", "title": "Common V4 VIP", "x-displayname": "Common V4 VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Optional common virtual V4 IP across all nodes to be used as automatic VIP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2VirtualNetworkConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "securemesh_site_v2VlanInterfaceType": { "type": "object", "title": "Vlan Interface", "x-displayname": "VLAN Interface.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.VlanInterfaceType", "properties": { "device": { "type": "string", "description": "Select a parent interface from the dropdown.", "title": "parent", "minLength": 1, "maxLength": 64, "x-displayname": "Parent Interface.", "x-ves-example": "Eth0", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "eth0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Select a parent interface from the dropdown.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "vlan_id": { "type": "integer", "description": "Configure the VLAN tag for this interface.", "title": "VLAN Id", "format": "int64", "x-displayname": "VLAN ID", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "4095" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "4095" }, "x-f5xc-description-short": "Configure the VLAN tag for this interface.", "minimum": 1, "maximum": 4095, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 4095, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for securemesh_site_v2VlanInterfaceType", "required_fields": [ "device", "vlan_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"device\": \"eth0\",\n \"vlan_id\": 1\n}", "example_yaml": "device: eth0\nvlan_id: 1" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsAdminUserCredentialsType": { "type": "object", "description": "Setup user credentials to manage access to nodes belonging to the site.\nWhen configured, 'admin' user will be setup and customers can access these nodes via\neither the node local WebUI or via SSH to access shell/CLI\nEnsure 'Node Local Services' are enabled to allow for required access.", "title": "Admin User Credentials", "x-displayname": "Admin User Credentials.", "x-ves-proto-message": "ves.io.schema.views.AdminUserCredentialsType", "properties": { "admin_password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for admin password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ssh_key": { "type": "string", "description": "Provided Public SSH key can be used for accessing nodes of the site.\nWhen provided, customers can SSH to the nodes of this Customer Edge site using admin as the user.", "title": "Public SSH key", "maxLength": 8192, "x-displayname": "Public SSH key.", "x-ves-example": "SSH-rsa AAAAB...", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-example": "ssh-rsa AAAAB...", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "8192" }, "x-f5xc-description-short": "Provided Public SSH key can be used for accessing nodes of the site.", "x-f5xc-description-medium": "Provided Public SSH key can be used for accessing nodes of the site. When provided, customers can SSH to the nodes of this Customer Edge site using admin as the user.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 8192, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Setup user credentials to manage access to nodes belonging to the site.", "x-f5xc-description-medium": "Setup user credentials to manage access to nodes belonging to the site. When configured, 'admin' user will be setup and customers can access these nodes via either the node local WebUI or via SSH to access shell/CLI Ensure 'Node Local Services' are enabled to allow for required access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAdminUserCredentialsType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsNetworkSelectType": { "type": "object", "description": "Select virtual network (VRF) for this interface.\nThere are 2 kinds of VRFs, local VRFs which are local to the site and global VRFs which extend into multiple sites.\nA site can have 2 Local VRFs, Site Local Outside (SLO), which is required for every site and Site Local Inside (SLI) which is optional.\nGlobal VRFs are configured via Networking > Segments. A site can have multiple Network Segments (global VRFs).", "title": "NetworkSelectType", "x-displayname": "Network Select.", "x-ves-oneof-field-network_choice": "[\"segment_network\",\"site_local_inside_network\",\"site_local_network\"]", "x-ves-proto-message": "ves.io.schema.views.NetworkSelectType", "properties": { "site_local_inside_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "segment_network", "site_local_network" ] }, "site_local_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "segment_network", "site_local_inside_network" ] } }, "x-required": true, "x-f5xc-description-short": "Select virtual network (VRF) for this interface.", "x-f5xc-description-medium": "Select virtual network (VRF) for this interface. There are 2 kinds of VRFs, local VRFs which are local to the site and global VRFs which extend into multiple sites. A site can have 2 Local VRFs, Site Local Outside (SLO), which is required for every site and Site Local Inside (SLI) which is optional.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsNetworkSelectType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsRegionalEdgeSelection": { "type": "object", "description": "Selection criteria to connect the site with F5 Distributed Cloud Regional Edge(s).", "title": "Regional Edge Selection", "x-displayname": "Regional Edge Selection.", "x-ves-oneof-field-re_selection_choice": "[\"geo_proximity\", \"specific_geography\", \"specific_re\"]", "x-ves-proto-message": "ves.io.schema.views.RegionalEdgeSelection", "properties": { "geo_proximity": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for geo proximity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "specific_geography", "specific_re" ] }, "specific_re": { "allOf": [ { "$ref": "#/components/schemas/viewsSpecificRE" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "geo_proximity", "specific_geography" ] }, "specific_geography": { "type": "string", "description": "Geographic selection for the site's Regional Edge connections.", "x-f5xc-conflicts-with": [ "geo_proximity", "specific_re" ] } }, "x-f5xc-description-short": "Selection criteria to connect the site with F5 Distributed Cloud Regional Edge(s).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsRegionalEdgeSelection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSpecificRE": { "type": "object", "description": "Select specific REs. This is useful when a site needs to deterministically connect to a set of REs. A site will always be connected to 2 REs.", "title": "Specific RE", "x-displayname": "Specific RE.", "x-ves-proto-message": "ves.io.schema.views.SpecificRE", "properties": { "backup_re": { "type": "string", "description": "Select backup RE for this site, cannot be the same as Primary RE.", "title": "Backup RE Geography", "x-displayname": "Backup RE Geography.", "x-f5xc-description-short": "Select backup RE for this site, cannot be the same as Primary RE.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "primary_re": { "type": "string", "description": "Select primary RE for this site.", "title": "Primary RE Geography", "minLength": 1, "maxLength": 64, "x-displayname": "Primary RE Geography.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Select specific REs. This is useful when a site needs to deterministically connect to a set of REs.", "x-f5xc-description-medium": "Select specific REs. This is useful when a site needs to deterministically connect to a set of REs. A site will always be connected to 2 REs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSpecificRE", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_site_v2CreateSpecType": { "type": "object", "description": "Shape of the Secure Mesh site specification.", "title": "CreateSpecType", "x-displayname": "Create Secure Mesh site.", "x-ves-oneof-field-advanced_delivery_choice": "[\"disable_advanced_delivery\",\"enable_advanced_delivery\"]", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\"]", "x-ves-oneof-field-enterprise_proxy_choice": "[\"custom_proxy\",\"f5_proxy\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"no_forward_proxy\"]", "x-ves-oneof-field-log_anonymization_choice": "[\"disable_log_anonymization\",\"enable_log_anonymization\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver_with_net\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-management_network_choice": "[\"disable_management_network\",\"enable_management_network\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"no_network_policy\"]", "x-ves-oneof-field-node_ha_choice": "[\"disable_ha\",\"enable_ha\"]", "x-ves-oneof-field-provider_choice": "[\"aws\",\"azure\",\"baremetal\",\"equinix\",\"gcp\",\"kvm\",\"nutanix\",\"oci\",\"openshift_virtualization\",\"openstack\",\"vmware\"]", "x-ves-oneof-field-proxy_bypass_choice": "[\"custom_proxy_bypass\",\"no_proxy_bypass\"]", "x-ves-oneof-field-s2s_connectivity_sli_choice": "[\"dc_cluster_group_sli\",\"no_s2s_connectivity_sli\"]", "x-ves-oneof-field-s2s_connectivity_slo_choice": "[\"dc_cluster_group_slo\",\"no_s2s_connectivity_slo\",\"site_mesh_group_on_slo\"]", "x-ves-oneof-field-url_categorization_choice": "[\"disable_url_categorization\",\"enable_url_categorization\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.CreateSpecType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_forward_proxy" ] }, "admin_user_credentials": { "allOf": [ { "$ref": "#/components/schemas/viewsAdminUserCredentialsType" } ], "x-f5xc-description-short": "Configuration parameter for admin user credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AWSProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "azure": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AzureProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "baremetal": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2BaremetalProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services" ] }, "custom_proxy": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomProxy" } ], "x-f5xc-description-short": "Configuration parameter for custom proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_proxy" ] }, "custom_proxy_bypass": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomProxyBypassSettings" } ], "x-f5xc-description-short": "Configuration parameter for custom proxy bypass.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_proxy_bypass" ] }, "dc_cluster_group_sli": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_s2s_connectivity_sli" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_sli", "gated_by": { "choice": "s2s_connectivity_sli_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_slo": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_s2s_connectivity_slo", "site_mesh_group_on_slo" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_slo", "gated_by": { "choice": "s2s_connectivity_slo_choice" }, "required": false, "cardinality": "single" } ] }, "disable_advanced_delivery": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable advanced delivery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_advanced_delivery" ] }, "disable_ha": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_ha" ] }, "disable_log_anonymization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable log anonymization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_log_anonymization" ] }, "disable_management_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable management network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_management_network" ] }, "disable_url_categorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_url_categorization" ] }, "dns_ntp_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2DNSNTPServerConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_advanced_delivery": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable advanced delivery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_advanced_delivery" ] }, "enable_ha": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_ha" ] }, "enable_log_anonymization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable log anonymization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_log_anonymization" ] }, "enable_management_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable management network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_management_network" ] }, "enable_url_categorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_url_categorization" ] }, "equinix": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2EquinixProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "f5_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_proxy" ] }, "gcp": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2GCPProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "kvm": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2KVMProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "load_balancing": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LoadBalancingSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for load balancing.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_vrf": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LocalVRFSettingType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver_with_net": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LogReceiverWithNet" } ], "x-f5xc-description-short": "Configuration parameter for log receiver with net.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver_with_net" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies" ] }, "no_proxy_bypass": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no proxy bypass.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_proxy_bypass" ] }, "no_s2s_connectivity_sli": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no s2s connectivity sli.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_sli" ] }, "no_s2s_connectivity_slo": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no s2s connectivity slo.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_slo", "site_mesh_group_on_slo" ] }, "nutanix": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NutanixProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "oci": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OCIProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "openshift_virtualization", "openstack", "vmware" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "openshift_virtualization": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OpenShiftProviderType" } ], "x-f5xc-description-short": "Configuration parameter for openshift virtualization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openstack", "vmware" ] }, "openstack": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OpenstackProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "vmware" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "re_select": { "allOf": [ { "$ref": "#/components/schemas/viewsRegionalEdgeSelection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment_vrf": { "type": "array", "description": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid\nper Site that can be configured here.", "items": { "$ref": "#/components/schemas/securemesh_site_v2SegmentVRFSettingType" }, "x-displayname": "Segment VRF Settings.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name.", "x-f5xc-description-medium": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid per Site that can be configured here.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_mesh_group_on_slo": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SiteMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_slo", "no_s2s_connectivity_slo" ] }, "software_settings": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SoftwareSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for software settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/schemaSiteToSiteTunnelType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upgrade_settings": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2UpgradeSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for upgrade settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vmware": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2VMwareProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack" ] } }, "x-f5xc-description-short": "Shape of the Secure Mesh site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_site_v2CreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-recommended-oneof-variant": { "provider_choice": "azure", "node_ha_choice": "disable_ha", "blocked_services_choice": "block_all_services", "network_policy_choice": "no_network_policy", "forward_proxy_choice": "no_forward_proxy", "logs_receiver_choice": "logs_streaming_disabled" }, "x-f5xc-ce-automation-contract": { "version": "7.0.0", "contract_id": "f5xc-smsv2-api/v1", "resource": "securemesh_site_v2", "api": { "collection_path": "/api/config/namespaces/{namespace}/securemesh_site_v2s", "item_path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}", "namespace": "system", "operations": [ "create", "read", "replace", "delete" ] }, "providers": { "kvm": { "availability": "image_api_and_kvm_boot_verified", "image_resolution": { "availability": "evidence_backed", "enforcement": "required", "strategy": "site_uid_os_image", "namespace": "system", "terraform_data_source": "site_image", "replaces_operation": "ves.io.schema.registration.CustomAPI.GetImageDownloadUrl", "configuration_get": { "method": "GET", "path": "/api/config/namespaces/system/securemesh_site_v2s/{site_name}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get" }, "configuration_list": { "method": "GET", "path": "/api/config/namespaces/system/securemesh_site_v2s", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.List" }, "site_list": { "method": "GET", "path": "/api/config/namespaces/system/sites", "operation_id": "ves.io.schema.site.API.List" }, "identity": { "configuration_name": "items[].name", "configuration_uid": "items[].uid", "site_uid": "items[].uid", "owner_kind": "items[].owner_view.kind", "required_owner_kind": "securemesh_site_v2", "owner_uid": "items[].owner_view.uid", "request_uid": "site_uid", "configuration_matches": 1, "owner_matches": 1 }, "query": { "method": "POST", "path": "/api/maurice/software_os_version", "operation_id": "ves.io.schema.virtual_appliance.SoftwareVersionOsImageCustomApi.GetImage", "request_schema": "virtual_applianceGetImageRequest", "response_schema": "virtual_applianceGetImageResponse", "request_field": "uids", "request_cardinality": 1, "side_effects": "none" }, "response": { "mapping": "images", "mapping_key": "site_uid", "download_url": "download_image_link", "image_name": "copy_image_name", "md5": "image_md5_sum", "error": "error_description" }, "validation": { "caller_supplied_uid": false, "static_fallback": false, "require_current_owner_mapping": true, "required_platform_field": "spec.kvm", "reject_nonempty_error": true, "require_complete_image_fields": true, "download_scheme": "https", "download_hosts": [ "downloads.volterra.io" ], "md5_pattern": "^[0-9a-fA-F]{32}$", "verify_artifact_checksum": true, "boot_acceptance_required": true }, "provenance": { "source_issue": "f5-sales-demo/api-specs-enriched#1805", "source_commit": "5c33dcf51eb8bee24e2ca1856e32cb5fef2a286f", "upstream_spec_sha256": "b36cd80bf6394741bdc8ba88ef175251129ae12be8b8f2d6eed2676227f704ef", "receipt_path": "config/evidence/kvm-site-image-resolution-20260919.json", "receipt_sha256": "fa4ed98befc906a3522cf37c13502931e976e36064217e9d45430de7e3104c34" } } }, "aws": { "availability": "evidence_backed", "node_list_path": "aws.not_managed.node_list[]", "interface_list_path": "aws.not_managed.node_list[].interface_list[]", "capabilities": { "aws_ce_create": "available", "aws_node_configuration": "available", "runtime_status": "available", "site_upgrade": "available", "tgw_connect": "available" }, "node_configuration": { "availability": "evidence_backed", "enforcement": "required", "strategy": "discovery_rebuild", "operation": { "method": "PUT", "path": "/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s/{metadata.name}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Replace", "request_schema": "securemesh_site_v2ReplaceRequest" }, "field_paths": [ "resource_version", "spec.aws.not_managed.node_list[]", "spec.aws.not_managed.node_list[].hostname", "spec.aws.not_managed.node_list[].interface_list[]", "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.device", "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.mac" ], "mapping": { "registration_source": "site_registration_hardware_inventory", "join_key": "normalized_mac", "cardinality": "one_to_one", "device_value_path": "interfaces[].device", "mac_value_path": "interfaces[].mac", "terraform_mac_source": "aws_network_interface.mac_address", "device_policy": "observed_only" }, "invariants": { "node_count": 1, "ha": "disabled", "interface_count": 2, "interface_roles": [ "slo", "sli" ], "interface_role_cardinality": "exactly_one_each", "mac_normalization": "ieee802_lowercase_colon", "device_source": "observed_registration_only" }, "unsupported_reasons": { "direct_rebuild_mode_transition": "aws_node_configuration_discovery_rebuild_requires_distinct_site", "multi_node_or_ha_input": "aws_node_configuration_requires_single_non_ha_node", "missing_mapping": "aws_node_configuration_mapping_missing", "ambiguous_mapping": "aws_node_configuration_mapping_ambiguous", "malformed_mac": "aws_node_configuration_mac_malformed", "guessed_device": "aws_node_configuration_device_must_be_observed", "incomplete_request_semantics": "aws_node_configuration_request_semantics_incomplete" }, "provenance": { "source_commit": "3be0310daf3658bc90383048cc18ab6447d18e35", "source_spec_sha256": "c6145b7096d7b08416732c8ebbd80e83be1902f73096ba08309e360d9a746eec", "probe_date": "2026-09-17", "issue": "f5-sales-demo/api-specs-enriched#1776", "evidence_receipt_sha256": "a5e423f8223bce56b83b74d0c546072984240761d392f15b664920e9fbfeec29" } }, "interface_identity": { "fields": [ "node", "ethernet_interface.mac" ], "node": { "input_field": "node", "configuration_path": "spec.aws.not_managed.node_list[].hostname", "nullable": false, "normalization": "trim" }, "mac": { "input_field": "mac", "configuration_path": "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.mac", "nullable": false, "normalization": "ieee802_lowercase_colon" }, "uniqueness_scope": "node", "guest_device": "rejected", "known_value_policy": "reject_null_incomplete_malformed_ambiguous_or_inconsistent", "unknown_value_policy": "defer" }, "roles": [ { "name": "slo", "network_option": "site_local_network" }, { "name": "sli", "network_option": "site_local_inside_network" } ], "telemetry_intake": { "schema_id": "f5xc-smsv2-aws-tgw-telemetry/v2", "availability": "available", "required_facts": [ "runtime", "gre", "bgp", "mtu", "route", "bgp_inside_cidr_block" ], "observed_facts": [ "runtime", "gre", "bgp", "mtu", "route", "bgp_inside_cidr_block" ], "unavailable_facts": [], "complete": true }, "runtime": { "configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{site}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get", "response_schema": "securemesh_site_v2GetResponse", "authority": "f5xc", "semantics": "configuration", "response_mappings": { "nodes": "spec.aws.not_managed.node_list[]", "node": "hostname", "interfaces": "interface_list[]", "mac": "ethernet_interface.mac", "role": "network_option", "mtu": "mtu", "public_ip": "public_ip" }, "nullability": { "public_ip": "nullable", "all_identity_fields": "non_null" }, "normalization": { "node": "trim", "mac": "ieee802_lowercase_colon", "role": "slo_or_sli" }, "correlation": [ "node", "normalized_mac" ] }, "health": { "method": "GET", "path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/health", "operation_id": "ves.io.schema.operate.debug.CustomPublicAPI.HealthPublic", "response_schema": "debugHealthResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "node": "hostname", "health": "state" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] }, "bgp_peers": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPPeers", "response_schema": "bgpBGPPeersResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "peers": "ver[].peer[]", "interface_name": "ver[].peer[].interface_name", "peer_address": { "ipv4": "ver[].peer[].peer_address.ipv4.addr", "ipv6": "ver[].peer[].peer_address.ipv6.addr" }, "state": "ver[].peer[].protocol_status", "received_prefix_count": "ver[].peer[].received_prefix_count", "advertised_prefix_count": "ver[].peer[].advertised_prefix_count", "state_changed_at": "ver[].peer[].up_down_timestamp" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "peer_address" ] }, "bgp_routes": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPRoutes", "response_schema": "bgpBGPRoutesResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "routing_instances": "ver[].ri_table[]", "route_tables": "ver[].ri_table[].rt_table[]", "imported_routes": "ver[].ri_table[].rt_table[].imported[]", "exported_routes": "ver[].ri_table[].rt_table[].exported[]", "route_prefixes": [ "ver[].ri_table[].rt_table[].imported[].subnet", "ver[].ri_table[].rt_table[].exported[].subnet" ] }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] }, "simplified_routes": { "method": "POST", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes", "operation_id": "ves.io.schema.operate.route.CustomPublicAPI.ShowSimplifiedRoutes", "request_schema": "routeSimplifiedRouteRequest", "response_schema": "routeSimplifiedRouteResponse", "authority": "f5xc", "semantics": "observational_read_only", "request_mappings": { "node_scope": "all_nodes", "roles": [ "slo", "sli" ] }, "response_mappings": { "nodes": "ver_routes[]", "node": "ver_routes[].node", "routes": "ver_routes[].route[]" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "role" ], "convergence": { "expected_aws_prefixes": "present_in_detailed_bgp_routes", "exported_bgp_prefixes": "present_in_selected_role_simplified_routes" } } }, "site_upgrade": { "site_status": { "method": "GET", "path": "/api/config/namespaces/{namespace}/sites/{site}", "operation_id": "ves.io.schema.site.API.Get", "response_schema": "siteGetResponse", "response_mappings": { "site_state": "spec.site_state", "software_installed_version": "status[].volterra_software_status.last_installed_version", "software_available_version": "status[].volterra_software_status.available_version", "software_deployment_phase": "status[].volterra_software_status.deployment_state.phase", "software_deployment_result": "status[].volterra_software_status.deployment_state.result", "os_installed_version": "status[].operating_system_status.deployment_state.version", "os_available_version": "status[].operating_system_status.available_version", "os_deployment_phase": "status[].operating_system_status.deployment_state.phase", "os_deployment_result": "status[].operating_system_status.deployment_state.result" } }, "target_discovery": { "method": "GET", "path": "/api/maurice/upgradable_sw_versions", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions", "query_mappings": { "installed_os_version": "current_os_version", "installed_software_version": "current_sw_version" }, "response_schema": "upgrade_statusGetUpgradableSWVersionsResponse", "response_mappings": { "upgradable_software_versions": "sw_versions[]" } }, "precheck": { "method": "GET", "path": "/api/maurice/namespaces/{namespace}/sites/{site}/pre_upgrade_check", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck", "query_mappings": { "software_version": "sw_version" }, "response_schema": "upgrade_statusPreUpgradeCheckResponse", "response_mappings": { "checks": "checklist[]", "name": "checklist[].item", "status": "checklist[].status" }, "passing_statuses": [ "CHECKLIST_PASSED", "CHECKLIST_WARNING" ], "failure_statuses": [ "CHECKLIST_FAILED", "CHECKLIST_UNKNOWN" ] }, "upgrade_status": { "method": "GET", "path": "/api/maurice/namespaces/{namespace}/sites/{site}/upgrade_status", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus", "response_schema": "upgrade_statusGetUpgradeStatusResponse", "response_mappings": { "version": "upgrade_status.sw_upgrade_progress.version", "status": "upgrade_status.sw_upgrade_progress.status", "validation_status": "upgrade_status.sw_upgrade_progress.validation.status", "site_level_status": "upgrade_status.sw_upgrade_progress.site_level_upgrade.status", "node_level_status": "upgrade_status.sw_upgrade_progress.node_level_upgrade.status", "os_setup_status": "upgrade_status.sw_upgrade_progress.os_setup.status" } }, "software_upgrade": { "method": "POST", "path": "/api/config/namespaces/{namespace}/sites/{site}/upgrade_sw", "operation_id": "ves.io.schema.site.UpgradeAPI.UpgradeSW", "request_schema": "siteUpgradeSWRequest", "request_mappings": { "site": "name", "software_version": "version", "force": "force" }, "force": false, "semantics": "asynchronous" }, "os_upgrade": { "method": "POST", "path": "/api/config/namespaces/{namespace}/sites/{site}/upgrade_os", "operation_id": "ves.io.schema.site.UpgradeAPI.UpgradeOS", "request_schema": "siteUpgradeOSRequest", "request_mappings": { "site": "name", "os_version": "version", "force": "force" }, "force": false, "semantics": "asynchronous" }, "eligibility": { "site_state": "ONLINE", "software_target": "listed_in_upgradable_software_versions", "os_target": "equals_advertised_os_available_version", "software_prechecks": "all_pass_or_warning" }, "polling": { "transient_failure_values": [ "UPGRADE_FAILED", "FAILED" ], "failure_semantics": "transient_until_bounded_timeout", "completion": "supplied_targets_installed_and_site_online", "timeout_authority": "caller" }, "redaction": { "exported": "sanitized_status_fields_only", "prohibited": [ "raw_api_messages", "node_identifiers", "urls" ] }, "verified_path": { "installed_software": "crt-20251002-0027", "installed_os": "9.2026.10", "target_software": "crt-20260201-0179", "target_os": "9.2026.17", "software_prechecks": "passed" } }, "authorities": { "f5xc": [ "smsv2_configuration", "runtime_health", "bgp_peers", "bgp_routes", "simplified_routes", "site_upgrade_observation" ], "aws": [ "eni", "transit_gateway", "transit_gateway_connect", "gre_endpoints", "bgp_inside_cidrs", "autonomous_system_numbers" ] }, "prohibited_legacy_apis": [ "aws_vpc_site", "aws_tgw_site" ], "bootstrap": { "mode": "site_bound_jwt_cloud_init", "reference": "deployment_bound_opaque_one_use", "headless_checkout": "available", "schema_support": "available", "runtime_verification": "historical_aws_acceptance", "interface_configuration": { "device_wire_requirement": "nonempty_observed_device_required_when_configuring_interfaces", "device_identity": "node_and_mac_remain_authoritative", "mac_only_create": "rejected_by_live_api", "primary_interface_settings": "configure_before_registration_immutable_after_registration", "discovery_requirement": "observe_guest_devices_before_configured_site_creation", "replacement_requirement": "couple_vm_and_site_when_initial_discovery_requires_registration", "runtime_acceptance": "observed_single_node_native_preboot_registration", "runtime_evidence": { "source_issue": "f5-sales-demo/api-specs-enriched#1752", "receipt_path": "config/evidence/aws-native-preboot-registration-20260908.json", "receipt_sha256": "5504ec73e6281fd40f1024e30f0bec3313a8ccf6b2eed1eb36fb0af02261d9ba", "qualification_receipt_sha256": "582d8a6bdef8068a4b269b5a38c3ab4ae6f878bf279253f5752d9b6c38f1aaf2", "fresh_acceptance_required": true }, "source_issue": "f5-sales-demo/api-specs-enriched#1750", "receipt_path": "config/evidence/aws-preboot-interface-api-20260908.json", "receipt_sha256": "b613d9fe858f58a36f3dc4dc7409ea95bafcb0669a70bda5d92cfd32abdb04eb" }, "sequence": [ "site_create", "jwt_issue", "cloud_init_template", "deploy", "registration" ], "token": { "method": "POST", "path": "/api/register/namespaces/system/tokens", "request_fields": { "spec.type": 1, "spec.site_name": "site_name" }, "metadata_fields": { "name": "token_name", "namespace": "system" }, "site_response_path": "spec.site_name", "type_response_path": "spec.type", "credential_response_path": "spec.content", "accepted_response_types": [ 1, "JWT" ], "site_binding_required": true }, "cloud_init": { "method": "GET", "path": "/api/register/namespaces/system/get-cloud-init-config", "operation_id": "ves.io.schema.token.CustomAPI.GetCloudInitConfig", "operation_role": "query", "query_fields": { "provider": "aws", "site_name": "site_name", "enable_management_network": false }, "response_path": "cloud_init_config", "sensitive": true, "refresh_on_read": false }, "material": { "preserve_paths": [ "/etc/vpm/config.yaml" ], "issued_path": "/etc/vpm/user_data", "token_placeholders": [ "{{ .Token }}", "{{ .token }}" ], "placeholder_value": "spec.content", "reject_unresolved_placeholders": true, "storage": "restricted_deployment_storage" }, "evidence": { "scope": "aws_only", "source_repository": "f5-sales-demo/multi-cloud-networking", "source_commit": "4dc25ec4f423c82aa9b052f81ca3c114b25a129c", "source_issue": "f5-sales-demo/multi-cloud-networking#1103", "fresh_acceptance_required": true } }, "evidence": { "provenance": "f5-distributed-cloud-smsv2-system-namespace", "recorded_at": "2026-09-05T00:15:00Z", "profiles": [ "aws-shaped-ce-configuration", "aws-site-upgrade" ], "receipts": [ { "operations": [ "create", "read", "replace", "delete" ], "result": "accepted", "topology": { "nodes": 3, "interfaces": 6, "bgp_peers": 6 }, "validated_facts": [ "mac_bound_configuration", "nullable_public_ip", "runtime_health", "tgw_connect", "established_bgp_peers", "detailed_and_simplified_route_agreement", "zero_action_post_apply_plan" ], "sanitized": true, "redaction": "no tenant response, token, bootstrap material, or resource identifier" }, { "operations": [ "site_status", "target_discovery", "precheck", "software_upgrade", "os_upgrade" ], "result": "accepted", "validated_facts": [ "installed_and_available_versions", "deployment_phase_and_result", "site_state", "software_target_advertised", "software_prechecks_passed", "transient_failure_observed" ], "upgrade_path": { "installed_software": "crt-20251002-0027", "installed_os": "9.2026.10", "target_software": "crt-20260201-0179", "target_os": "9.2026.17", "software_prechecks": "passed" }, "sanitized": true, "redaction": "no raw response, message, node identifier, URL, token, or resource identifier" } ] }, "unavailable_capabilities": [] }, "azure": { "bootstrap": { "mode": "site_bound_jwt_cloud_init", "reference": "deployment_bound_opaque_one_use", "schema_support": "available", "runtime_verification": "awaiting_evidence", "headless_checkout": "available", "image_runtime_acceptance": false, "reason": "azure_api_verified_image_runtime_not_accepted", "api_verification": { "status": "verified_api_only", "scope": "azure_bootstrap_api_only", "schema_commit": "5ce68bff35b444e5af967433ad3d14ca96a1ffe0", "source_issue": "f5-sales-demo/api-specs-enriched#1748", "receipt_path": "config/evidence/azure-bootstrap-api-20260908.json", "receipt_sha256": "ba3975c417a43e9e6a68d02bb51bec76bfe043aa1d1a756b199377be0f450e21", "runtime_acceptance": false }, "sequence": [ "site_create", "jwt_issue", "cloud_init_template" ], "token": { "method": "POST", "path": "/api/register/namespaces/system/tokens", "request_fields": { "spec.type": 1, "spec.site_name": "site_name" }, "metadata_fields": { "name": "token_name", "namespace": "system" }, "site_response_path": "spec.site_name", "type_response_path": "spec.type", "credential_response_path": "spec.content", "accepted_response_types": [ 1, "JWT" ], "site_binding_required": true }, "cloud_init": { "method": "GET", "path": "/api/register/namespaces/system/get-cloud-init-config", "operation_id": "ves.io.schema.token.CustomAPI.GetCloudInitConfig", "operation_role": "query", "query_fields": { "provider": "azure", "site_name": "site_name", "enable_management_network": false }, "response_path": "cloud_init_config", "sensitive": true, "refresh_on_read": false }, "material": { "preserve_paths": [ "/etc/vpm/config.yaml" ], "issued_path": "/etc/vpm/user_data", "token_placeholders": [ "{{ .Token }}", "{{ .token }}" ], "placeholder_value": "spec.content", "reject_unresolved_placeholders": true, "storage": "restricted_deployment_storage" }, "source_repository": "f5-sales-demo/multi-cloud-networking", "source_commit": "c1310d030cfc252571bf0e816db21b618697d991", "source_path": "docs/en/customer-edge/smsv2/azure-route-server.mdx" }, "availability": "evidence_backed", "route_server_ebgp_multihop": { "availability": "unavailable", "enforcement": "reject_before_mutation", "reason": "no_schema_valid_ebgp_multihop_request_control", "source": { "repository": "f5-sales-demo/api-specs-enriched", "commit": "322c202ed49c8cfcd5015a524f3195bbd2a8f2bc", "asset_path": "docs/specifications/api/network.json", "asset_sha256": "sha256:a7398d85475409c93750a04ccdec7c0b1a7ae12bc362ebfbc76866275904762a", "schema_paths": [ "components.schemas.bgpPeer", "components.schemas.bgpPeerExternal", "components.schemas.bgpBgpParameters" ] }, "future_mapping_requirements": { "request_schema_path": "explicit", "request_field_path": "explicit", "request_value_semantics": "explicit", "schema_validation": "required", "runtime_acceptance": "required" } }, "runtime": { "configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{site}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get", "response_schema": "securemesh_site_v2GetResponse", "authority": "f5xc", "semantics": "configuration", "response_mappings": { "nodes": "spec.azure.not_managed.node_list[]", "node": "hostname", "interfaces": "interface_list[]", "mac": "ethernet_interface.mac", "role": "network_option", "mtu": "mtu", "public_ip": "public_ip", "provider": "spec.azure.not_managed", "device": "ethernet_interface.device" }, "nullability": { "public_ip": "nullable", "all_identity_fields": "non_null" }, "normalization": { "node": "trim", "mac": "ieee802_lowercase_colon", "role": "slo_or_sli" }, "correlation": [ "node", "normalized_mac" ] }, "bgp_configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/bgps/{name}", "operation_id": "ves.io.schema.bgp.API.Get", "response_schema": "bgpGetResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "parameters": "spec.bgp_parameters", "peers": "spec.peers[]", "target_service": "spec.peers[].target_service", "family_inet_v6": "spec.peers[].external.family_inet_v6" }, "response_only_fields": [ "spec.peers[].target_service", "spec.peers[].external.family_inet_v6" ], "request_eligibility": "rejected_without_authoritative_request_schema", "source": { "repository": "f5-sales-demo/api-specs-enriched", "commit": "055d32d68c14824e32d748a425bf541dec2f529e", "asset_path": "docs/specifications/api/network.json", "asset_sha256": "sha256:0b5381bcaaf8090e0992c6923aea8ae4a3aa664c5966ad5503790e5d6a842d8d", "schema_paths": [ "components.schemas.bgpPeer", "components.schemas.bgpPeerExternal", "components.schemas.bgpBgpParameters", "components.schemas.bgpGetResponse" ] }, "evidence_receipt": { "path": "config/evidence/azure_bgp_response_drift_v7.0.0.json", "sha256": "54bf13997a6933de8431846c5d6e9267a9665e1378e1250fc06f76c77405dec7" }, "live_evidence": { "method": "GET", "selection": "unique_ownership_labeled_azure_terraform_ce_bgp", "observed_response_fields": [ "spec.peers[].target_service", "spec.peers[].external.family_inet_v6" ], "form_metadata": { "create_form": null, "replace_form": null }, "sanitized": true, "retention": "field_shapes_only_no_names_addresses_tokens_or_raw_response" } }, "bgp_peers": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPPeers", "response_schema": "bgpBGPPeersResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "peers": "ver[].peer[]", "interface_name": "ver[].peer[].interface_name", "peer_address": { "ipv4": "ver[].peer[].peer_address.ipv4.addr", "ipv6": "ver[].peer[].peer_address.ipv6.addr" }, "state": "ver[].peer[].protocol_status", "received_prefix_count": "ver[].peer[].received_prefix_count", "advertised_prefix_count": "ver[].peer[].advertised_prefix_count", "state_changed_at": "ver[].peer[].up_down_timestamp" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "peer_address" ] }, "bgp_routes": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPRoutes", "response_schema": "bgpBGPRoutesResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "routing_instances": "ver[].ri_table[]", "route_tables": "ver[].ri_table[].rt_table[]", "imported_routes": "ver[].ri_table[].rt_table[].imported[]", "exported_routes": "ver[].ri_table[].rt_table[].exported[]", "route_prefixes": [ "ver[].ri_table[].rt_table[].imported[].subnet", "ver[].ri_table[].rt_table[].exported[].subnet" ] }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] } }, "stable_identity": { "required_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, "roles": [ { "name": "slo", "required": true, "bindable": true, "network_option": "site_local_network", "vrf": "site_local_outside", "configuration_path": "azure.not_managed.node_list[].interface_list[]", "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, { "name": "external", "required": false, "bindable": false, "network_option": null, "vrf": null, "configuration_path": null, "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, { "name": "sli", "required": false, "bindable": false, "network_option": null, "vrf": null, "configuration_path": null, "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] } ], "invariants": { "first_azure_nic_is_slo_anchor": true, "macs_unique_per_node": true, "role_bindings_unique_per_node": true, "homogeneous_ha_role_vrf_shape": true, "bgp_bindable_roles": [ "slo" ] }, "runtime_evidence": { "guest_interface_names": "observational_only", "minimum_mapping_confidence": "authoritative", "provenance_required": true, "replacement_observation_required": true }, "change_risk": { "maintenance_window_required": true, "restarts_ce_data_plane_services": true, "adding_or_removing_interfaces_disruptive": true } } } }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_site_v2EthernetInterfaceType": { "type": "object", "title": "Ethernet Interface", "x-displayname": "Ethernet Interface.", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.EthernetInterfaceType", "properties": { "device": { "type": "string", "description": "Select an Ethernet device from the discovered interfaces to configure.\nOnce configured, this interface will be part of this sites dataplane and can participate in the networking services configured on this site.", "title": "Device", "minLength": 1, "maxLength": 64, "x-displayname": "Ethernet Device.", "x-ves-example": "Ver1", "x-ves-required": "false", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "false", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-required-for": { "create": false }, "x-validation-rules": { "ves.io.schema.rules.message.required": "false", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "ver1", "x-f5xc-description-short": "Select an Ethernet device from the discovered interfaces to configure.", "x-f5xc-description-medium": "Select an Ethernet device from the discovered interfaces to configure. Once configured, this interface will be part of this sites dataplane and can participate in the networking services configured on this site.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } } }, "mac": { "type": "string", "description": "Configuration parameter for mac", "title": "Mac Address", "x-displayname": "MAC Address.", "x-ves-example": "01:10:20:0a:bb:1c.", "x-ves-validation-rules": { "ves.io.schema.rules.string.mac": "true", "ves.io.schema.rules.message.required": "true" }, "x-ves-required": "true", "x-f5xc-required-for": { "create": true }, "x-validation-rules": { "ves.io.schema.rules.string.mac": "true", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "01:10:20:0a:bb:1c", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "mac-address", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_site_v2EthernetInterfaceType", "required_fields": [ "mac" ], "mutually_exclusive_groups": [], "example_json": "{\n \"mac\": \"01:10:20:0a:bb:1c\"\n}", "example_yaml": "mac: 01:10:20:0a:bb:1c" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_site_v2GetSpecType": { "type": "object", "description": "Shape of the Secure Mesh site specification.", "title": "GetSpecType", "x-displayname": "GET Secure Mesh site.", "x-ves-oneof-field-advanced_delivery_choice": "[\"disable_advanced_delivery\",\"enable_advanced_delivery\"]", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\"]", "x-ves-oneof-field-enterprise_proxy_choice": "[\"custom_proxy\",\"f5_proxy\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"no_forward_proxy\"]", "x-ves-oneof-field-log_anonymization_choice": "[\"disable_log_anonymization\",\"enable_log_anonymization\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver_with_net\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-management_network_choice": "[\"disable_management_network\",\"enable_management_network\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"no_network_policy\"]", "x-ves-oneof-field-node_ha_choice": "[\"disable_ha\",\"enable_ha\"]", "x-ves-oneof-field-provider_choice": "[\"aws\",\"azure\",\"baremetal\",\"equinix\",\"gcp\",\"kvm\",\"nutanix\",\"oci\",\"openshift_virtualization\",\"openstack\",\"vmware\"]", "x-ves-oneof-field-proxy_bypass_choice": "[\"custom_proxy_bypass\",\"no_proxy_bypass\"]", "x-ves-oneof-field-s2s_connectivity_sli_choice": "[\"dc_cluster_group_sli\",\"no_s2s_connectivity_sli\"]", "x-ves-oneof-field-s2s_connectivity_slo_choice": "[\"dc_cluster_group_slo\",\"no_s2s_connectivity_slo\",\"site_mesh_group_on_slo\"]", "x-ves-oneof-field-url_categorization_choice": "[\"disable_url_categorization\",\"enable_url_categorization\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.GetSpecType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_forward_proxy" ] }, "admin_user_credentials": { "allOf": [ { "$ref": "#/components/schemas/viewsAdminUserCredentialsType" } ], "x-f5xc-description-short": "Configuration parameter for admin user credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AWSProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "azure": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AzureProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "baremetal": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2BaremetalProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services" ] }, "custom_proxy": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomProxy" } ], "x-f5xc-description-short": "Configuration parameter for custom proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_proxy" ] }, "custom_proxy_bypass": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomProxyBypassSettings" } ], "x-f5xc-description-short": "Configuration parameter for custom proxy bypass.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_proxy_bypass" ] }, "dc_cluster_group_sli": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_s2s_connectivity_sli" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_sli", "gated_by": { "choice": "s2s_connectivity_sli_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_slo": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_s2s_connectivity_slo", "site_mesh_group_on_slo" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_slo", "gated_by": { "choice": "s2s_connectivity_slo_choice" }, "required": false, "cardinality": "single" } ] }, "disable_advanced_delivery": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable advanced delivery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_advanced_delivery" ] }, "disable_ha": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_ha" ] }, "disable_log_anonymization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable log anonymization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_log_anonymization" ] }, "disable_management_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable management network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_management_network" ] }, "disable_url_categorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_url_categorization" ] }, "dns_ntp_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2DNSNTPServerConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_advanced_delivery": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable advanced delivery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_advanced_delivery" ] }, "enable_ha": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_ha" ] }, "enable_log_anonymization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable log anonymization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_log_anonymization" ] }, "enable_management_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable management network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_management_network" ] }, "enable_url_categorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_url_categorization" ] }, "equinix": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2EquinixProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "f5_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_proxy" ] }, "gcp": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2GCPProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "kvm": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2KVMProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "load_balancing": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LoadBalancingSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for load balancing.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_vrf": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LocalVRFSettingType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver_with_net": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LogReceiverWithNet" } ], "x-f5xc-description-short": "Configuration parameter for log receiver with net.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver_with_net" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies" ] }, "no_proxy_bypass": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no proxy bypass.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_proxy_bypass" ] }, "no_s2s_connectivity_sli": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no s2s connectivity sli.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_sli" ] }, "no_s2s_connectivity_slo": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no s2s connectivity slo.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_slo", "site_mesh_group_on_slo" ] }, "nutanix": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NutanixProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "oci": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OCIProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "openshift_virtualization", "openstack", "vmware" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "openshift_virtualization": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OpenShiftProviderType" } ], "x-f5xc-description-short": "Configuration parameter for openshift virtualization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openstack", "vmware" ] }, "openstack": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OpenstackProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "vmware" ] }, "operating_system_version": { "type": "string", "description": "Select the Operating System version for the site. By default, latest available Operating System version will be used.", "maxLength": 256, "x-displayname": "Operating System Version.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Select the Operating System version for the site. By default, latest available Operating System version will be used.", "x-f5xc-description-medium": "Select the Operating System version for the site. By default, latest available Operating System version will be used.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "re_select": { "allOf": [ { "$ref": "#/components/schemas/viewsRegionalEdgeSelection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment_vrf": { "type": "array", "description": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid\nper Site that can be configured here.", "items": { "$ref": "#/components/schemas/securemesh_site_v2SegmentVRFSettingType" }, "x-displayname": "Segment VRF Settings.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name.", "x-f5xc-description-medium": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid per Site that can be configured here.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_errors": { "type": "array", "description": "Errors on site including suggested action.", "items": { "$ref": "#/components/schemas/viewsSiteError" }, "x-displayname": "Site Errors.", "x-ves-example": "Site Errors.", "x-f5xc-example": "Site Errors", "x-f5xc-description-short": "Errors on site including suggested action.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_mesh_group_on_slo": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SiteMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_slo", "no_s2s_connectivity_slo" ] }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "software_settings": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SoftwareSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for software settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/schemaSiteToSiteTunnelType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upgrade_settings": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2UpgradeSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for upgrade settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vmware": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2VMwareProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack" ] }, "volterra_software_version": { "type": "string", "description": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.", "maxLength": 256, "x-displayname": "Software Version.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.", "x-f5xc-description-medium": "Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used. Refer to release notes to find required released SW versions.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the Secure Mesh site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_site_v2GetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-recommended-oneof-variant": { "provider_choice": "azure", "node_ha_choice": "disable_ha", "blocked_services_choice": "block_all_services", "network_policy_choice": "no_network_policy", "forward_proxy_choice": "no_forward_proxy", "logs_receiver_choice": "logs_streaming_disabled" }, "x-f5xc-ce-automation-contract": { "version": "7.0.0", "contract_id": "f5xc-smsv2-api/v1", "resource": "securemesh_site_v2", "api": { "collection_path": "/api/config/namespaces/{namespace}/securemesh_site_v2s", "item_path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}", "namespace": "system", "operations": [ "create", "read", "replace", "delete" ] }, "providers": { "kvm": { "availability": "image_api_and_kvm_boot_verified", "image_resolution": { "availability": "evidence_backed", "enforcement": "required", "strategy": "site_uid_os_image", "namespace": "system", "terraform_data_source": "site_image", "replaces_operation": "ves.io.schema.registration.CustomAPI.GetImageDownloadUrl", "configuration_get": { "method": "GET", "path": "/api/config/namespaces/system/securemesh_site_v2s/{site_name}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get" }, "configuration_list": { "method": "GET", "path": "/api/config/namespaces/system/securemesh_site_v2s", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.List" }, "site_list": { "method": "GET", "path": "/api/config/namespaces/system/sites", "operation_id": "ves.io.schema.site.API.List" }, "identity": { "configuration_name": "items[].name", "configuration_uid": "items[].uid", "site_uid": "items[].uid", "owner_kind": "items[].owner_view.kind", "required_owner_kind": "securemesh_site_v2", "owner_uid": "items[].owner_view.uid", "request_uid": "site_uid", "configuration_matches": 1, "owner_matches": 1 }, "query": { "method": "POST", "path": "/api/maurice/software_os_version", "operation_id": "ves.io.schema.virtual_appliance.SoftwareVersionOsImageCustomApi.GetImage", "request_schema": "virtual_applianceGetImageRequest", "response_schema": "virtual_applianceGetImageResponse", "request_field": "uids", "request_cardinality": 1, "side_effects": "none" }, "response": { "mapping": "images", "mapping_key": "site_uid", "download_url": "download_image_link", "image_name": "copy_image_name", "md5": "image_md5_sum", "error": "error_description" }, "validation": { "caller_supplied_uid": false, "static_fallback": false, "require_current_owner_mapping": true, "required_platform_field": "spec.kvm", "reject_nonempty_error": true, "require_complete_image_fields": true, "download_scheme": "https", "download_hosts": [ "downloads.volterra.io" ], "md5_pattern": "^[0-9a-fA-F]{32}$", "verify_artifact_checksum": true, "boot_acceptance_required": true }, "provenance": { "source_issue": "f5-sales-demo/api-specs-enriched#1805", "source_commit": "5c33dcf51eb8bee24e2ca1856e32cb5fef2a286f", "upstream_spec_sha256": "b36cd80bf6394741bdc8ba88ef175251129ae12be8b8f2d6eed2676227f704ef", "receipt_path": "config/evidence/kvm-site-image-resolution-20260919.json", "receipt_sha256": "fa4ed98befc906a3522cf37c13502931e976e36064217e9d45430de7e3104c34" } } }, "aws": { "availability": "evidence_backed", "node_list_path": "aws.not_managed.node_list[]", "interface_list_path": "aws.not_managed.node_list[].interface_list[]", "capabilities": { "aws_ce_create": "available", "aws_node_configuration": "available", "runtime_status": "available", "site_upgrade": "available", "tgw_connect": "available" }, "node_configuration": { "availability": "evidence_backed", "enforcement": "required", "strategy": "discovery_rebuild", "operation": { "method": "PUT", "path": "/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s/{metadata.name}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Replace", "request_schema": "securemesh_site_v2ReplaceRequest" }, "field_paths": [ "resource_version", "spec.aws.not_managed.node_list[]", "spec.aws.not_managed.node_list[].hostname", "spec.aws.not_managed.node_list[].interface_list[]", "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.device", "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.mac" ], "mapping": { "registration_source": "site_registration_hardware_inventory", "join_key": "normalized_mac", "cardinality": "one_to_one", "device_value_path": "interfaces[].device", "mac_value_path": "interfaces[].mac", "terraform_mac_source": "aws_network_interface.mac_address", "device_policy": "observed_only" }, "invariants": { "node_count": 1, "ha": "disabled", "interface_count": 2, "interface_roles": [ "slo", "sli" ], "interface_role_cardinality": "exactly_one_each", "mac_normalization": "ieee802_lowercase_colon", "device_source": "observed_registration_only" }, "unsupported_reasons": { "direct_rebuild_mode_transition": "aws_node_configuration_discovery_rebuild_requires_distinct_site", "multi_node_or_ha_input": "aws_node_configuration_requires_single_non_ha_node", "missing_mapping": "aws_node_configuration_mapping_missing", "ambiguous_mapping": "aws_node_configuration_mapping_ambiguous", "malformed_mac": "aws_node_configuration_mac_malformed", "guessed_device": "aws_node_configuration_device_must_be_observed", "incomplete_request_semantics": "aws_node_configuration_request_semantics_incomplete" }, "provenance": { "source_commit": "3be0310daf3658bc90383048cc18ab6447d18e35", "source_spec_sha256": "c6145b7096d7b08416732c8ebbd80e83be1902f73096ba08309e360d9a746eec", "probe_date": "2026-09-17", "issue": "f5-sales-demo/api-specs-enriched#1776", "evidence_receipt_sha256": "a5e423f8223bce56b83b74d0c546072984240761d392f15b664920e9fbfeec29" } }, "interface_identity": { "fields": [ "node", "ethernet_interface.mac" ], "node": { "input_field": "node", "configuration_path": "spec.aws.not_managed.node_list[].hostname", "nullable": false, "normalization": "trim" }, "mac": { "input_field": "mac", "configuration_path": "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.mac", "nullable": false, "normalization": "ieee802_lowercase_colon" }, "uniqueness_scope": "node", "guest_device": "rejected", "known_value_policy": "reject_null_incomplete_malformed_ambiguous_or_inconsistent", "unknown_value_policy": "defer" }, "roles": [ { "name": "slo", "network_option": "site_local_network" }, { "name": "sli", "network_option": "site_local_inside_network" } ], "telemetry_intake": { "schema_id": "f5xc-smsv2-aws-tgw-telemetry/v2", "availability": "available", "required_facts": [ "runtime", "gre", "bgp", "mtu", "route", "bgp_inside_cidr_block" ], "observed_facts": [ "runtime", "gre", "bgp", "mtu", "route", "bgp_inside_cidr_block" ], "unavailable_facts": [], "complete": true }, "runtime": { "configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{site}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get", "response_schema": "securemesh_site_v2GetResponse", "authority": "f5xc", "semantics": "configuration", "response_mappings": { "nodes": "spec.aws.not_managed.node_list[]", "node": "hostname", "interfaces": "interface_list[]", "mac": "ethernet_interface.mac", "role": "network_option", "mtu": "mtu", "public_ip": "public_ip" }, "nullability": { "public_ip": "nullable", "all_identity_fields": "non_null" }, "normalization": { "node": "trim", "mac": "ieee802_lowercase_colon", "role": "slo_or_sli" }, "correlation": [ "node", "normalized_mac" ] }, "health": { "method": "GET", "path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/health", "operation_id": "ves.io.schema.operate.debug.CustomPublicAPI.HealthPublic", "response_schema": "debugHealthResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "node": "hostname", "health": "state" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] }, "bgp_peers": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPPeers", "response_schema": "bgpBGPPeersResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "peers": "ver[].peer[]", "interface_name": "ver[].peer[].interface_name", "peer_address": { "ipv4": "ver[].peer[].peer_address.ipv4.addr", "ipv6": "ver[].peer[].peer_address.ipv6.addr" }, "state": "ver[].peer[].protocol_status", "received_prefix_count": "ver[].peer[].received_prefix_count", "advertised_prefix_count": "ver[].peer[].advertised_prefix_count", "state_changed_at": "ver[].peer[].up_down_timestamp" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "peer_address" ] }, "bgp_routes": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPRoutes", "response_schema": "bgpBGPRoutesResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "routing_instances": "ver[].ri_table[]", "route_tables": "ver[].ri_table[].rt_table[]", "imported_routes": "ver[].ri_table[].rt_table[].imported[]", "exported_routes": "ver[].ri_table[].rt_table[].exported[]", "route_prefixes": [ "ver[].ri_table[].rt_table[].imported[].subnet", "ver[].ri_table[].rt_table[].exported[].subnet" ] }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] }, "simplified_routes": { "method": "POST", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes", "operation_id": "ves.io.schema.operate.route.CustomPublicAPI.ShowSimplifiedRoutes", "request_schema": "routeSimplifiedRouteRequest", "response_schema": "routeSimplifiedRouteResponse", "authority": "f5xc", "semantics": "observational_read_only", "request_mappings": { "node_scope": "all_nodes", "roles": [ "slo", "sli" ] }, "response_mappings": { "nodes": "ver_routes[]", "node": "ver_routes[].node", "routes": "ver_routes[].route[]" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "role" ], "convergence": { "expected_aws_prefixes": "present_in_detailed_bgp_routes", "exported_bgp_prefixes": "present_in_selected_role_simplified_routes" } } }, "site_upgrade": { "site_status": { "method": "GET", "path": "/api/config/namespaces/{namespace}/sites/{site}", "operation_id": "ves.io.schema.site.API.Get", "response_schema": "siteGetResponse", "response_mappings": { "site_state": "spec.site_state", "software_installed_version": "status[].volterra_software_status.last_installed_version", "software_available_version": "status[].volterra_software_status.available_version", "software_deployment_phase": "status[].volterra_software_status.deployment_state.phase", "software_deployment_result": "status[].volterra_software_status.deployment_state.result", "os_installed_version": "status[].operating_system_status.deployment_state.version", "os_available_version": "status[].operating_system_status.available_version", "os_deployment_phase": "status[].operating_system_status.deployment_state.phase", "os_deployment_result": "status[].operating_system_status.deployment_state.result" } }, "target_discovery": { "method": "GET", "path": "/api/maurice/upgradable_sw_versions", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions", "query_mappings": { "installed_os_version": "current_os_version", "installed_software_version": "current_sw_version" }, "response_schema": "upgrade_statusGetUpgradableSWVersionsResponse", "response_mappings": { "upgradable_software_versions": "sw_versions[]" } }, "precheck": { "method": "GET", "path": "/api/maurice/namespaces/{namespace}/sites/{site}/pre_upgrade_check", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck", "query_mappings": { "software_version": "sw_version" }, "response_schema": "upgrade_statusPreUpgradeCheckResponse", "response_mappings": { "checks": "checklist[]", "name": "checklist[].item", "status": "checklist[].status" }, "passing_statuses": [ "CHECKLIST_PASSED", "CHECKLIST_WARNING" ], "failure_statuses": [ "CHECKLIST_FAILED", "CHECKLIST_UNKNOWN" ] }, "upgrade_status": { "method": "GET", "path": "/api/maurice/namespaces/{namespace}/sites/{site}/upgrade_status", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus", "response_schema": "upgrade_statusGetUpgradeStatusResponse", "response_mappings": { "version": "upgrade_status.sw_upgrade_progress.version", "status": "upgrade_status.sw_upgrade_progress.status", "validation_status": "upgrade_status.sw_upgrade_progress.validation.status", "site_level_status": "upgrade_status.sw_upgrade_progress.site_level_upgrade.status", "node_level_status": "upgrade_status.sw_upgrade_progress.node_level_upgrade.status", "os_setup_status": "upgrade_status.sw_upgrade_progress.os_setup.status" } }, "software_upgrade": { "method": "POST", "path": "/api/config/namespaces/{namespace}/sites/{site}/upgrade_sw", "operation_id": "ves.io.schema.site.UpgradeAPI.UpgradeSW", "request_schema": "siteUpgradeSWRequest", "request_mappings": { "site": "name", "software_version": "version", "force": "force" }, "force": false, "semantics": "asynchronous" }, "os_upgrade": { "method": "POST", "path": "/api/config/namespaces/{namespace}/sites/{site}/upgrade_os", "operation_id": "ves.io.schema.site.UpgradeAPI.UpgradeOS", "request_schema": "siteUpgradeOSRequest", "request_mappings": { "site": "name", "os_version": "version", "force": "force" }, "force": false, "semantics": "asynchronous" }, "eligibility": { "site_state": "ONLINE", "software_target": "listed_in_upgradable_software_versions", "os_target": "equals_advertised_os_available_version", "software_prechecks": "all_pass_or_warning" }, "polling": { "transient_failure_values": [ "UPGRADE_FAILED", "FAILED" ], "failure_semantics": "transient_until_bounded_timeout", "completion": "supplied_targets_installed_and_site_online", "timeout_authority": "caller" }, "redaction": { "exported": "sanitized_status_fields_only", "prohibited": [ "raw_api_messages", "node_identifiers", "urls" ] }, "verified_path": { "installed_software": "crt-20251002-0027", "installed_os": "9.2026.10", "target_software": "crt-20260201-0179", "target_os": "9.2026.17", "software_prechecks": "passed" } }, "authorities": { "f5xc": [ "smsv2_configuration", "runtime_health", "bgp_peers", "bgp_routes", "simplified_routes", "site_upgrade_observation" ], "aws": [ "eni", "transit_gateway", "transit_gateway_connect", "gre_endpoints", "bgp_inside_cidrs", "autonomous_system_numbers" ] }, "prohibited_legacy_apis": [ "aws_vpc_site", "aws_tgw_site" ], "bootstrap": { "mode": "site_bound_jwt_cloud_init", "reference": "deployment_bound_opaque_one_use", "headless_checkout": "available", "schema_support": "available", "runtime_verification": "historical_aws_acceptance", "interface_configuration": { "device_wire_requirement": "nonempty_observed_device_required_when_configuring_interfaces", "device_identity": "node_and_mac_remain_authoritative", "mac_only_create": "rejected_by_live_api", "primary_interface_settings": "configure_before_registration_immutable_after_registration", "discovery_requirement": "observe_guest_devices_before_configured_site_creation", "replacement_requirement": "couple_vm_and_site_when_initial_discovery_requires_registration", "runtime_acceptance": "observed_single_node_native_preboot_registration", "runtime_evidence": { "source_issue": "f5-sales-demo/api-specs-enriched#1752", "receipt_path": "config/evidence/aws-native-preboot-registration-20260908.json", "receipt_sha256": "5504ec73e6281fd40f1024e30f0bec3313a8ccf6b2eed1eb36fb0af02261d9ba", "qualification_receipt_sha256": "582d8a6bdef8068a4b269b5a38c3ab4ae6f878bf279253f5752d9b6c38f1aaf2", "fresh_acceptance_required": true }, "source_issue": "f5-sales-demo/api-specs-enriched#1750", "receipt_path": "config/evidence/aws-preboot-interface-api-20260908.json", "receipt_sha256": "b613d9fe858f58a36f3dc4dc7409ea95bafcb0669a70bda5d92cfd32abdb04eb" }, "sequence": [ "site_create", "jwt_issue", "cloud_init_template", "deploy", "registration" ], "token": { "method": "POST", "path": "/api/register/namespaces/system/tokens", "request_fields": { "spec.type": 1, "spec.site_name": "site_name" }, "metadata_fields": { "name": "token_name", "namespace": "system" }, "site_response_path": "spec.site_name", "type_response_path": "spec.type", "credential_response_path": "spec.content", "accepted_response_types": [ 1, "JWT" ], "site_binding_required": true }, "cloud_init": { "method": "GET", "path": "/api/register/namespaces/system/get-cloud-init-config", "operation_id": "ves.io.schema.token.CustomAPI.GetCloudInitConfig", "operation_role": "query", "query_fields": { "provider": "aws", "site_name": "site_name", "enable_management_network": false }, "response_path": "cloud_init_config", "sensitive": true, "refresh_on_read": false }, "material": { "preserve_paths": [ "/etc/vpm/config.yaml" ], "issued_path": "/etc/vpm/user_data", "token_placeholders": [ "{{ .Token }}", "{{ .token }}" ], "placeholder_value": "spec.content", "reject_unresolved_placeholders": true, "storage": "restricted_deployment_storage" }, "evidence": { "scope": "aws_only", "source_repository": "f5-sales-demo/multi-cloud-networking", "source_commit": "4dc25ec4f423c82aa9b052f81ca3c114b25a129c", "source_issue": "f5-sales-demo/multi-cloud-networking#1103", "fresh_acceptance_required": true } }, "evidence": { "provenance": "f5-distributed-cloud-smsv2-system-namespace", "recorded_at": "2026-09-05T00:15:00Z", "profiles": [ "aws-shaped-ce-configuration", "aws-site-upgrade" ], "receipts": [ { "operations": [ "create", "read", "replace", "delete" ], "result": "accepted", "topology": { "nodes": 3, "interfaces": 6, "bgp_peers": 6 }, "validated_facts": [ "mac_bound_configuration", "nullable_public_ip", "runtime_health", "tgw_connect", "established_bgp_peers", "detailed_and_simplified_route_agreement", "zero_action_post_apply_plan" ], "sanitized": true, "redaction": "no tenant response, token, bootstrap material, or resource identifier" }, { "operations": [ "site_status", "target_discovery", "precheck", "software_upgrade", "os_upgrade" ], "result": "accepted", "validated_facts": [ "installed_and_available_versions", "deployment_phase_and_result", "site_state", "software_target_advertised", "software_prechecks_passed", "transient_failure_observed" ], "upgrade_path": { "installed_software": "crt-20251002-0027", "installed_os": "9.2026.10", "target_software": "crt-20260201-0179", "target_os": "9.2026.17", "software_prechecks": "passed" }, "sanitized": true, "redaction": "no raw response, message, node identifier, URL, token, or resource identifier" } ] }, "unavailable_capabilities": [] }, "azure": { "bootstrap": { "mode": "site_bound_jwt_cloud_init", "reference": "deployment_bound_opaque_one_use", "schema_support": "available", "runtime_verification": "awaiting_evidence", "headless_checkout": "available", "image_runtime_acceptance": false, "reason": "azure_api_verified_image_runtime_not_accepted", "api_verification": { "status": "verified_api_only", "scope": "azure_bootstrap_api_only", "schema_commit": "5ce68bff35b444e5af967433ad3d14ca96a1ffe0", "source_issue": "f5-sales-demo/api-specs-enriched#1748", "receipt_path": "config/evidence/azure-bootstrap-api-20260908.json", "receipt_sha256": "ba3975c417a43e9e6a68d02bb51bec76bfe043aa1d1a756b199377be0f450e21", "runtime_acceptance": false }, "sequence": [ "site_create", "jwt_issue", "cloud_init_template" ], "token": { "method": "POST", "path": "/api/register/namespaces/system/tokens", "request_fields": { "spec.type": 1, "spec.site_name": "site_name" }, "metadata_fields": { "name": "token_name", "namespace": "system" }, "site_response_path": "spec.site_name", "type_response_path": "spec.type", "credential_response_path": "spec.content", "accepted_response_types": [ 1, "JWT" ], "site_binding_required": true }, "cloud_init": { "method": "GET", "path": "/api/register/namespaces/system/get-cloud-init-config", "operation_id": "ves.io.schema.token.CustomAPI.GetCloudInitConfig", "operation_role": "query", "query_fields": { "provider": "azure", "site_name": "site_name", "enable_management_network": false }, "response_path": "cloud_init_config", "sensitive": true, "refresh_on_read": false }, "material": { "preserve_paths": [ "/etc/vpm/config.yaml" ], "issued_path": "/etc/vpm/user_data", "token_placeholders": [ "{{ .Token }}", "{{ .token }}" ], "placeholder_value": "spec.content", "reject_unresolved_placeholders": true, "storage": "restricted_deployment_storage" }, "source_repository": "f5-sales-demo/multi-cloud-networking", "source_commit": "c1310d030cfc252571bf0e816db21b618697d991", "source_path": "docs/en/customer-edge/smsv2/azure-route-server.mdx" }, "availability": "evidence_backed", "route_server_ebgp_multihop": { "availability": "unavailable", "enforcement": "reject_before_mutation", "reason": "no_schema_valid_ebgp_multihop_request_control", "source": { "repository": "f5-sales-demo/api-specs-enriched", "commit": "322c202ed49c8cfcd5015a524f3195bbd2a8f2bc", "asset_path": "docs/specifications/api/network.json", "asset_sha256": "sha256:a7398d85475409c93750a04ccdec7c0b1a7ae12bc362ebfbc76866275904762a", "schema_paths": [ "components.schemas.bgpPeer", "components.schemas.bgpPeerExternal", "components.schemas.bgpBgpParameters" ] }, "future_mapping_requirements": { "request_schema_path": "explicit", "request_field_path": "explicit", "request_value_semantics": "explicit", "schema_validation": "required", "runtime_acceptance": "required" } }, "runtime": { "configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{site}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get", "response_schema": "securemesh_site_v2GetResponse", "authority": "f5xc", "semantics": "configuration", "response_mappings": { "nodes": "spec.azure.not_managed.node_list[]", "node": "hostname", "interfaces": "interface_list[]", "mac": "ethernet_interface.mac", "role": "network_option", "mtu": "mtu", "public_ip": "public_ip", "provider": "spec.azure.not_managed", "device": "ethernet_interface.device" }, "nullability": { "public_ip": "nullable", "all_identity_fields": "non_null" }, "normalization": { "node": "trim", "mac": "ieee802_lowercase_colon", "role": "slo_or_sli" }, "correlation": [ "node", "normalized_mac" ] }, "bgp_configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/bgps/{name}", "operation_id": "ves.io.schema.bgp.API.Get", "response_schema": "bgpGetResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "parameters": "spec.bgp_parameters", "peers": "spec.peers[]", "target_service": "spec.peers[].target_service", "family_inet_v6": "spec.peers[].external.family_inet_v6" }, "response_only_fields": [ "spec.peers[].target_service", "spec.peers[].external.family_inet_v6" ], "request_eligibility": "rejected_without_authoritative_request_schema", "source": { "repository": "f5-sales-demo/api-specs-enriched", "commit": "055d32d68c14824e32d748a425bf541dec2f529e", "asset_path": "docs/specifications/api/network.json", "asset_sha256": "sha256:0b5381bcaaf8090e0992c6923aea8ae4a3aa664c5966ad5503790e5d6a842d8d", "schema_paths": [ "components.schemas.bgpPeer", "components.schemas.bgpPeerExternal", "components.schemas.bgpBgpParameters", "components.schemas.bgpGetResponse" ] }, "evidence_receipt": { "path": "config/evidence/azure_bgp_response_drift_v7.0.0.json", "sha256": "54bf13997a6933de8431846c5d6e9267a9665e1378e1250fc06f76c77405dec7" }, "live_evidence": { "method": "GET", "selection": "unique_ownership_labeled_azure_terraform_ce_bgp", "observed_response_fields": [ "spec.peers[].target_service", "spec.peers[].external.family_inet_v6" ], "form_metadata": { "create_form": null, "replace_form": null }, "sanitized": true, "retention": "field_shapes_only_no_names_addresses_tokens_or_raw_response" } }, "bgp_peers": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPPeers", "response_schema": "bgpBGPPeersResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "peers": "ver[].peer[]", "interface_name": "ver[].peer[].interface_name", "peer_address": { "ipv4": "ver[].peer[].peer_address.ipv4.addr", "ipv6": "ver[].peer[].peer_address.ipv6.addr" }, "state": "ver[].peer[].protocol_status", "received_prefix_count": "ver[].peer[].received_prefix_count", "advertised_prefix_count": "ver[].peer[].advertised_prefix_count", "state_changed_at": "ver[].peer[].up_down_timestamp" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "peer_address" ] }, "bgp_routes": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPRoutes", "response_schema": "bgpBGPRoutesResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "routing_instances": "ver[].ri_table[]", "route_tables": "ver[].ri_table[].rt_table[]", "imported_routes": "ver[].ri_table[].rt_table[].imported[]", "exported_routes": "ver[].ri_table[].rt_table[].exported[]", "route_prefixes": [ "ver[].ri_table[].rt_table[].imported[].subnet", "ver[].ri_table[].rt_table[].exported[].subnet" ] }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] } }, "stable_identity": { "required_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, "roles": [ { "name": "slo", "required": true, "bindable": true, "network_option": "site_local_network", "vrf": "site_local_outside", "configuration_path": "azure.not_managed.node_list[].interface_list[]", "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, { "name": "external", "required": false, "bindable": false, "network_option": null, "vrf": null, "configuration_path": null, "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, { "name": "sli", "required": false, "bindable": false, "network_option": null, "vrf": null, "configuration_path": null, "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] } ], "invariants": { "first_azure_nic_is_slo_anchor": true, "macs_unique_per_node": true, "role_bindings_unique_per_node": true, "homogeneous_ha_role_vrf_shape": true, "bgp_bindable_roles": [ "slo" ] }, "runtime_evidence": { "guest_interface_names": "observational_only", "minimum_mapping_confidence": "authoritative", "provenance_required": true, "replacement_observation_required": true }, "change_risk": { "maintenance_window_required": true, "restarts_ce_data_plane_services": true, "adding_or_removing_interfaces_disruptive": true } } } }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_site_v2Node": { "type": "object", "description": "Node definition.", "title": "Node", "x-displayname": "Node", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.Node", "properties": { "hostname": { "type": "string", "description": "Hostname for this Node.", "title": "Hostname", "maxLength": 256, "x-displayname": "Hostname", "x-ves-example": "Control", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "Control", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "interface_list": { "type": "array", "description": "Manage interfaces belonging to this node.", "title": "Interfaces", "maxItems": 128, "items": { "$ref": "#/components/schemas/securemesh_site_v2Interface" }, "x-displayname": "Interfaces.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Manage interfaces belonging to this node.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_ip": { "type": "string", "description": "Public IP for this Node.", "title": "Public IP", "maxLength": 256, "x-displayname": "Public IP", "x-ves-example": "192.0.2.242.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "nullable": true, "x-f5xc-example": "192.0.2.242", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Type for this Node, can be Control or Worker.", "title": "Type", "x-displayname": "Type", "x-ves-example": "Control", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Control\\\",\\\"Worker\\\"]" }, "x-f5xc-example": "Control", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Control\\\",\\\"Worker\\\"]" }, "x-f5xc-description-short": "Type for this Node, can be Control or Worker.", "maxLength": 1024, "enum": [ "Control", "Worker" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_site_v2Node", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewssecuremesh_site_v2ReplaceSpecType": { "type": "object", "description": "Shape of the Secure Mesh site specification.", "title": "ReplaceSpecType", "x-displayname": "Replace Secure Mesh site.", "x-ves-oneof-field-advanced_delivery_choice": "[\"disable_advanced_delivery\",\"enable_advanced_delivery\"]", "x-ves-oneof-field-blocked_services_choice": "[\"block_all_services\",\"blocked_services\"]", "x-ves-oneof-field-enterprise_proxy_choice": "[\"custom_proxy\",\"f5_proxy\"]", "x-ves-oneof-field-forward_proxy_choice": "[\"active_forward_proxy_policies\",\"no_forward_proxy\"]", "x-ves-oneof-field-log_anonymization_choice": "[\"disable_log_anonymization\",\"enable_log_anonymization\"]", "x-ves-oneof-field-logs_receiver_choice": "[\"log_receiver_with_net\",\"logs_streaming_disabled\"]", "x-ves-oneof-field-network_policy_choice": "[\"active_enhanced_firewall_policies\",\"no_network_policy\"]", "x-ves-oneof-field-node_ha_choice": "[\"disable_ha\",\"enable_ha\"]", "x-ves-oneof-field-provider_choice": "[\"aws\",\"azure\",\"baremetal\",\"equinix\",\"gcp\",\"kvm\",\"nutanix\",\"oci\",\"openshift_virtualization\",\"openstack\",\"vmware\"]", "x-ves-oneof-field-proxy_bypass_choice": "[\"custom_proxy_bypass\",\"no_proxy_bypass\"]", "x-ves-oneof-field-s2s_connectivity_sli_choice": "[\"dc_cluster_group_sli\",\"no_s2s_connectivity_sli\"]", "x-ves-oneof-field-s2s_connectivity_slo_choice": "[\"dc_cluster_group_slo\",\"no_s2s_connectivity_slo\",\"site_mesh_group_on_slo\"]", "x-ves-oneof-field-url_categorization_choice": "[\"disable_url_categorization\",\"enable_url_categorization\"]", "x-ves-proto-message": "ves.io.schema.views.securemesh_site_v2.ReplaceSpecType", "properties": { "active_enhanced_firewall_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_network_policy" ] }, "active_forward_proxy_policies": { "allOf": [ { "$ref": "#/components/schemas/network_firewallActiveForwardProxyPoliciesType" } ], "x-f5xc-description-short": "Configuration parameter for active forward proxy policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_forward_proxy" ] }, "admin_user_credentials": { "allOf": [ { "$ref": "#/components/schemas/viewsAdminUserCredentialsType" } ], "x-f5xc-description-short": "Configuration parameter for admin user credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "aws": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AWSProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "azure": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2AzureProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "baremetal": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2BaremetalProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "block_all_services": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blocked_services" ] }, "blocked_services": { "allOf": [ { "$ref": "#/components/schemas/fleetBlockedServicesListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_all_services" ] }, "custom_proxy": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomProxy" } ], "x-f5xc-description-short": "Configuration parameter for custom proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "f5_proxy" ] }, "custom_proxy_bypass": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2CustomProxyBypassSettings" } ], "x-f5xc-description-short": "Configuration parameter for custom proxy bypass.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_proxy_bypass" ] }, "dc_cluster_group_sli": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_s2s_connectivity_sli" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_sli", "gated_by": { "choice": "s2s_connectivity_sli_choice" }, "required": false, "cardinality": "single" } ] }, "dc_cluster_group_slo": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_s2s_connectivity_slo", "site_mesh_group_on_slo" ], "x-f5xc-references": [ { "resource_kind": "dc_cluster_group", "field_path": "dc_cluster_group_slo", "gated_by": { "choice": "s2s_connectivity_slo_choice" }, "required": false, "cardinality": "single" } ] }, "disable_advanced_delivery": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable advanced delivery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_advanced_delivery" ] }, "disable_ha": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_ha" ] }, "disable_log_anonymization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable log anonymization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_log_anonymization" ] }, "disable_url_categorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_url_categorization" ] }, "dns_ntp_config": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2DNSNTPServerConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enable_advanced_delivery": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable advanced delivery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_advanced_delivery" ] }, "enable_ha": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_ha" ] }, "enable_log_anonymization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable log anonymization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_log_anonymization" ] }, "enable_url_categorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_url_categorization" ] }, "equinix": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2EquinixProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "f5_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_proxy" ] }, "gcp": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2GCPProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "kvm": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2KVMProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "nutanix", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "load_balancing": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LoadBalancingSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for load balancing.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_vrf": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LocalVRFSettingType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_receiver_with_net": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2LogReceiverWithNet" } ], "x-f5xc-description-short": "Configuration parameter for log receiver with net.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "logs_streaming_disabled" ] }, "logs_streaming_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "log_receiver_with_net" ] }, "no_forward_proxy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no forward proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_forward_proxy_policies" ] }, "no_network_policy": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Policy configuration for this feature.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "active_enhanced_firewall_policies" ] }, "no_proxy_bypass": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no proxy bypass.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_proxy_bypass" ] }, "no_s2s_connectivity_sli": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no s2s connectivity sli.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_sli" ] }, "no_s2s_connectivity_slo": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no s2s connectivity slo.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_slo", "site_mesh_group_on_slo" ] }, "nutanix": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2NutanixProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "oci", "openshift_virtualization", "openstack", "vmware" ] }, "oci": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OCIProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "openshift_virtualization", "openstack", "vmware" ] }, "offline_survivability_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsOfflineSurvivabilityModeType" } ], "x-f5xc-description-short": "Configuration parameter for offline survivability mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "openshift_virtualization": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OpenShiftProviderType" } ], "x-f5xc-description-short": "Configuration parameter for openshift virtualization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openstack", "vmware" ] }, "openstack": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2OpenstackProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "vmware" ] }, "performance_enhancement_mode": { "allOf": [ { "$ref": "#/components/schemas/viewsPerformanceEnhancementModeType" } ], "x-f5xc-description-short": "Configuration parameter for performance enhancement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "re_select": { "allOf": [ { "$ref": "#/components/schemas/viewsRegionalEdgeSelection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment_vrf": { "type": "array", "description": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid\nper Site that can be configured here.", "items": { "$ref": "#/components/schemas/securemesh_site_v2SegmentVRFSettingType" }, "x-displayname": "Segment VRF Settings.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name.", "x-f5xc-description-medium": "The Segment VRF is valid across all Sites of a Tenant. These are identified with a Segment name. Though these VRFs are across all Sites of a Tenant, there are some configurations that are valid per Site that can be configured here.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_mesh_group_on_slo": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SiteMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group_slo", "no_s2s_connectivity_slo" ] }, "software_settings": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2SoftwareSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for software settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/schemaSiteToSiteTunnelType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upgrade_settings": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2UpgradeSettingsType" } ], "x-f5xc-description-short": "Configuration parameter for upgrade settings.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vmware": { "allOf": [ { "$ref": "#/components/schemas/securemesh_site_v2VMwareProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure", "baremetal", "equinix", "gcp", "kvm", "nutanix", "oci", "openshift_virtualization", "openstack" ] } }, "x-f5xc-description-short": "Shape of the Secure Mesh site specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewssecuremesh_site_v2ReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-recommended-oneof-variant": { "provider_choice": "azure", "node_ha_choice": "disable_ha", "blocked_services_choice": "block_all_services", "network_policy_choice": "no_network_policy", "forward_proxy_choice": "no_forward_proxy", "logs_receiver_choice": "logs_streaming_disabled" }, "x-f5xc-ce-automation-contract": { "version": "7.0.0", "contract_id": "f5xc-smsv2-api/v1", "resource": "securemesh_site_v2", "api": { "collection_path": "/api/config/namespaces/{namespace}/securemesh_site_v2s", "item_path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}", "namespace": "system", "operations": [ "create", "read", "replace", "delete" ] }, "providers": { "kvm": { "availability": "image_api_and_kvm_boot_verified", "image_resolution": { "availability": "evidence_backed", "enforcement": "required", "strategy": "site_uid_os_image", "namespace": "system", "terraform_data_source": "site_image", "replaces_operation": "ves.io.schema.registration.CustomAPI.GetImageDownloadUrl", "configuration_get": { "method": "GET", "path": "/api/config/namespaces/system/securemesh_site_v2s/{site_name}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get" }, "configuration_list": { "method": "GET", "path": "/api/config/namespaces/system/securemesh_site_v2s", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.List" }, "site_list": { "method": "GET", "path": "/api/config/namespaces/system/sites", "operation_id": "ves.io.schema.site.API.List" }, "identity": { "configuration_name": "items[].name", "configuration_uid": "items[].uid", "site_uid": "items[].uid", "owner_kind": "items[].owner_view.kind", "required_owner_kind": "securemesh_site_v2", "owner_uid": "items[].owner_view.uid", "request_uid": "site_uid", "configuration_matches": 1, "owner_matches": 1 }, "query": { "method": "POST", "path": "/api/maurice/software_os_version", "operation_id": "ves.io.schema.virtual_appliance.SoftwareVersionOsImageCustomApi.GetImage", "request_schema": "virtual_applianceGetImageRequest", "response_schema": "virtual_applianceGetImageResponse", "request_field": "uids", "request_cardinality": 1, "side_effects": "none" }, "response": { "mapping": "images", "mapping_key": "site_uid", "download_url": "download_image_link", "image_name": "copy_image_name", "md5": "image_md5_sum", "error": "error_description" }, "validation": { "caller_supplied_uid": false, "static_fallback": false, "require_current_owner_mapping": true, "required_platform_field": "spec.kvm", "reject_nonempty_error": true, "require_complete_image_fields": true, "download_scheme": "https", "download_hosts": [ "downloads.volterra.io" ], "md5_pattern": "^[0-9a-fA-F]{32}$", "verify_artifact_checksum": true, "boot_acceptance_required": true }, "provenance": { "source_issue": "f5-sales-demo/api-specs-enriched#1805", "source_commit": "5c33dcf51eb8bee24e2ca1856e32cb5fef2a286f", "upstream_spec_sha256": "b36cd80bf6394741bdc8ba88ef175251129ae12be8b8f2d6eed2676227f704ef", "receipt_path": "config/evidence/kvm-site-image-resolution-20260919.json", "receipt_sha256": "fa4ed98befc906a3522cf37c13502931e976e36064217e9d45430de7e3104c34" } } }, "aws": { "availability": "evidence_backed", "node_list_path": "aws.not_managed.node_list[]", "interface_list_path": "aws.not_managed.node_list[].interface_list[]", "capabilities": { "aws_ce_create": "available", "aws_node_configuration": "available", "runtime_status": "available", "site_upgrade": "available", "tgw_connect": "available" }, "node_configuration": { "availability": "evidence_backed", "enforcement": "required", "strategy": "discovery_rebuild", "operation": { "method": "PUT", "path": "/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s/{metadata.name}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Replace", "request_schema": "securemesh_site_v2ReplaceRequest" }, "field_paths": [ "resource_version", "spec.aws.not_managed.node_list[]", "spec.aws.not_managed.node_list[].hostname", "spec.aws.not_managed.node_list[].interface_list[]", "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.device", "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.mac" ], "mapping": { "registration_source": "site_registration_hardware_inventory", "join_key": "normalized_mac", "cardinality": "one_to_one", "device_value_path": "interfaces[].device", "mac_value_path": "interfaces[].mac", "terraform_mac_source": "aws_network_interface.mac_address", "device_policy": "observed_only" }, "invariants": { "node_count": 1, "ha": "disabled", "interface_count": 2, "interface_roles": [ "slo", "sli" ], "interface_role_cardinality": "exactly_one_each", "mac_normalization": "ieee802_lowercase_colon", "device_source": "observed_registration_only" }, "unsupported_reasons": { "direct_rebuild_mode_transition": "aws_node_configuration_discovery_rebuild_requires_distinct_site", "multi_node_or_ha_input": "aws_node_configuration_requires_single_non_ha_node", "missing_mapping": "aws_node_configuration_mapping_missing", "ambiguous_mapping": "aws_node_configuration_mapping_ambiguous", "malformed_mac": "aws_node_configuration_mac_malformed", "guessed_device": "aws_node_configuration_device_must_be_observed", "incomplete_request_semantics": "aws_node_configuration_request_semantics_incomplete" }, "provenance": { "source_commit": "3be0310daf3658bc90383048cc18ab6447d18e35", "source_spec_sha256": "c6145b7096d7b08416732c8ebbd80e83be1902f73096ba08309e360d9a746eec", "probe_date": "2026-09-17", "issue": "f5-sales-demo/api-specs-enriched#1776", "evidence_receipt_sha256": "a5e423f8223bce56b83b74d0c546072984240761d392f15b664920e9fbfeec29" } }, "interface_identity": { "fields": [ "node", "ethernet_interface.mac" ], "node": { "input_field": "node", "configuration_path": "spec.aws.not_managed.node_list[].hostname", "nullable": false, "normalization": "trim" }, "mac": { "input_field": "mac", "configuration_path": "spec.aws.not_managed.node_list[].interface_list[].ethernet_interface.mac", "nullable": false, "normalization": "ieee802_lowercase_colon" }, "uniqueness_scope": "node", "guest_device": "rejected", "known_value_policy": "reject_null_incomplete_malformed_ambiguous_or_inconsistent", "unknown_value_policy": "defer" }, "roles": [ { "name": "slo", "network_option": "site_local_network" }, { "name": "sli", "network_option": "site_local_inside_network" } ], "telemetry_intake": { "schema_id": "f5xc-smsv2-aws-tgw-telemetry/v2", "availability": "available", "required_facts": [ "runtime", "gre", "bgp", "mtu", "route", "bgp_inside_cidr_block" ], "observed_facts": [ "runtime", "gre", "bgp", "mtu", "route", "bgp_inside_cidr_block" ], "unavailable_facts": [], "complete": true }, "runtime": { "configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{site}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get", "response_schema": "securemesh_site_v2GetResponse", "authority": "f5xc", "semantics": "configuration", "response_mappings": { "nodes": "spec.aws.not_managed.node_list[]", "node": "hostname", "interfaces": "interface_list[]", "mac": "ethernet_interface.mac", "role": "network_option", "mtu": "mtu", "public_ip": "public_ip" }, "nullability": { "public_ip": "nullable", "all_identity_fields": "non_null" }, "normalization": { "node": "trim", "mac": "ieee802_lowercase_colon", "role": "slo_or_sli" }, "correlation": [ "node", "normalized_mac" ] }, "health": { "method": "GET", "path": "/api/operate/namespaces/system/sites/{site}/vpm/debug/global/health", "operation_id": "ves.io.schema.operate.debug.CustomPublicAPI.HealthPublic", "response_schema": "debugHealthResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "node": "hostname", "health": "state" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] }, "bgp_peers": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPPeers", "response_schema": "bgpBGPPeersResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "peers": "ver[].peer[]", "interface_name": "ver[].peer[].interface_name", "peer_address": { "ipv4": "ver[].peer[].peer_address.ipv4.addr", "ipv6": "ver[].peer[].peer_address.ipv6.addr" }, "state": "ver[].peer[].protocol_status", "received_prefix_count": "ver[].peer[].received_prefix_count", "advertised_prefix_count": "ver[].peer[].advertised_prefix_count", "state_changed_at": "ver[].peer[].up_down_timestamp" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "peer_address" ] }, "bgp_routes": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPRoutes", "response_schema": "bgpBGPRoutesResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "routing_instances": "ver[].ri_table[]", "route_tables": "ver[].ri_table[].rt_table[]", "imported_routes": "ver[].ri_table[].rt_table[].imported[]", "exported_routes": "ver[].ri_table[].rt_table[].exported[]", "route_prefixes": [ "ver[].ri_table[].rt_table[].imported[].subnet", "ver[].ri_table[].rt_table[].exported[].subnet" ] }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] }, "simplified_routes": { "method": "POST", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes", "operation_id": "ves.io.schema.operate.route.CustomPublicAPI.ShowSimplifiedRoutes", "request_schema": "routeSimplifiedRouteRequest", "response_schema": "routeSimplifiedRouteResponse", "authority": "f5xc", "semantics": "observational_read_only", "request_mappings": { "node_scope": "all_nodes", "roles": [ "slo", "sli" ] }, "response_mappings": { "nodes": "ver_routes[]", "node": "ver_routes[].node", "routes": "ver_routes[].route[]" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "role" ], "convergence": { "expected_aws_prefixes": "present_in_detailed_bgp_routes", "exported_bgp_prefixes": "present_in_selected_role_simplified_routes" } } }, "site_upgrade": { "site_status": { "method": "GET", "path": "/api/config/namespaces/{namespace}/sites/{site}", "operation_id": "ves.io.schema.site.API.Get", "response_schema": "siteGetResponse", "response_mappings": { "site_state": "spec.site_state", "software_installed_version": "status[].volterra_software_status.last_installed_version", "software_available_version": "status[].volterra_software_status.available_version", "software_deployment_phase": "status[].volterra_software_status.deployment_state.phase", "software_deployment_result": "status[].volterra_software_status.deployment_state.result", "os_installed_version": "status[].operating_system_status.deployment_state.version", "os_available_version": "status[].operating_system_status.available_version", "os_deployment_phase": "status[].operating_system_status.deployment_state.phase", "os_deployment_result": "status[].operating_system_status.deployment_state.result" } }, "target_discovery": { "method": "GET", "path": "/api/maurice/upgradable_sw_versions", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions", "query_mappings": { "installed_os_version": "current_os_version", "installed_software_version": "current_sw_version" }, "response_schema": "upgrade_statusGetUpgradableSWVersionsResponse", "response_mappings": { "upgradable_software_versions": "sw_versions[]" } }, "precheck": { "method": "GET", "path": "/api/maurice/namespaces/{namespace}/sites/{site}/pre_upgrade_check", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck", "query_mappings": { "software_version": "sw_version" }, "response_schema": "upgrade_statusPreUpgradeCheckResponse", "response_mappings": { "checks": "checklist[]", "name": "checklist[].item", "status": "checklist[].status" }, "passing_statuses": [ "CHECKLIST_PASSED", "CHECKLIST_WARNING" ], "failure_statuses": [ "CHECKLIST_FAILED", "CHECKLIST_UNKNOWN" ] }, "upgrade_status": { "method": "GET", "path": "/api/maurice/namespaces/{namespace}/sites/{site}/upgrade_status", "operation_id": "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus", "response_schema": "upgrade_statusGetUpgradeStatusResponse", "response_mappings": { "version": "upgrade_status.sw_upgrade_progress.version", "status": "upgrade_status.sw_upgrade_progress.status", "validation_status": "upgrade_status.sw_upgrade_progress.validation.status", "site_level_status": "upgrade_status.sw_upgrade_progress.site_level_upgrade.status", "node_level_status": "upgrade_status.sw_upgrade_progress.node_level_upgrade.status", "os_setup_status": "upgrade_status.sw_upgrade_progress.os_setup.status" } }, "software_upgrade": { "method": "POST", "path": "/api/config/namespaces/{namespace}/sites/{site}/upgrade_sw", "operation_id": "ves.io.schema.site.UpgradeAPI.UpgradeSW", "request_schema": "siteUpgradeSWRequest", "request_mappings": { "site": "name", "software_version": "version", "force": "force" }, "force": false, "semantics": "asynchronous" }, "os_upgrade": { "method": "POST", "path": "/api/config/namespaces/{namespace}/sites/{site}/upgrade_os", "operation_id": "ves.io.schema.site.UpgradeAPI.UpgradeOS", "request_schema": "siteUpgradeOSRequest", "request_mappings": { "site": "name", "os_version": "version", "force": "force" }, "force": false, "semantics": "asynchronous" }, "eligibility": { "site_state": "ONLINE", "software_target": "listed_in_upgradable_software_versions", "os_target": "equals_advertised_os_available_version", "software_prechecks": "all_pass_or_warning" }, "polling": { "transient_failure_values": [ "UPGRADE_FAILED", "FAILED" ], "failure_semantics": "transient_until_bounded_timeout", "completion": "supplied_targets_installed_and_site_online", "timeout_authority": "caller" }, "redaction": { "exported": "sanitized_status_fields_only", "prohibited": [ "raw_api_messages", "node_identifiers", "urls" ] }, "verified_path": { "installed_software": "crt-20251002-0027", "installed_os": "9.2026.10", "target_software": "crt-20260201-0179", "target_os": "9.2026.17", "software_prechecks": "passed" } }, "authorities": { "f5xc": [ "smsv2_configuration", "runtime_health", "bgp_peers", "bgp_routes", "simplified_routes", "site_upgrade_observation" ], "aws": [ "eni", "transit_gateway", "transit_gateway_connect", "gre_endpoints", "bgp_inside_cidrs", "autonomous_system_numbers" ] }, "prohibited_legacy_apis": [ "aws_vpc_site", "aws_tgw_site" ], "bootstrap": { "mode": "site_bound_jwt_cloud_init", "reference": "deployment_bound_opaque_one_use", "headless_checkout": "available", "schema_support": "available", "runtime_verification": "historical_aws_acceptance", "interface_configuration": { "device_wire_requirement": "nonempty_observed_device_required_when_configuring_interfaces", "device_identity": "node_and_mac_remain_authoritative", "mac_only_create": "rejected_by_live_api", "primary_interface_settings": "configure_before_registration_immutable_after_registration", "discovery_requirement": "observe_guest_devices_before_configured_site_creation", "replacement_requirement": "couple_vm_and_site_when_initial_discovery_requires_registration", "runtime_acceptance": "observed_single_node_native_preboot_registration", "runtime_evidence": { "source_issue": "f5-sales-demo/api-specs-enriched#1752", "receipt_path": "config/evidence/aws-native-preboot-registration-20260908.json", "receipt_sha256": "5504ec73e6281fd40f1024e30f0bec3313a8ccf6b2eed1eb36fb0af02261d9ba", "qualification_receipt_sha256": "582d8a6bdef8068a4b269b5a38c3ab4ae6f878bf279253f5752d9b6c38f1aaf2", "fresh_acceptance_required": true }, "source_issue": "f5-sales-demo/api-specs-enriched#1750", "receipt_path": "config/evidence/aws-preboot-interface-api-20260908.json", "receipt_sha256": "b613d9fe858f58a36f3dc4dc7409ea95bafcb0669a70bda5d92cfd32abdb04eb" }, "sequence": [ "site_create", "jwt_issue", "cloud_init_template", "deploy", "registration" ], "token": { "method": "POST", "path": "/api/register/namespaces/system/tokens", "request_fields": { "spec.type": 1, "spec.site_name": "site_name" }, "metadata_fields": { "name": "token_name", "namespace": "system" }, "site_response_path": "spec.site_name", "type_response_path": "spec.type", "credential_response_path": "spec.content", "accepted_response_types": [ 1, "JWT" ], "site_binding_required": true }, "cloud_init": { "method": "GET", "path": "/api/register/namespaces/system/get-cloud-init-config", "operation_id": "ves.io.schema.token.CustomAPI.GetCloudInitConfig", "operation_role": "query", "query_fields": { "provider": "aws", "site_name": "site_name", "enable_management_network": false }, "response_path": "cloud_init_config", "sensitive": true, "refresh_on_read": false }, "material": { "preserve_paths": [ "/etc/vpm/config.yaml" ], "issued_path": "/etc/vpm/user_data", "token_placeholders": [ "{{ .Token }}", "{{ .token }}" ], "placeholder_value": "spec.content", "reject_unresolved_placeholders": true, "storage": "restricted_deployment_storage" }, "evidence": { "scope": "aws_only", "source_repository": "f5-sales-demo/multi-cloud-networking", "source_commit": "4dc25ec4f423c82aa9b052f81ca3c114b25a129c", "source_issue": "f5-sales-demo/multi-cloud-networking#1103", "fresh_acceptance_required": true } }, "evidence": { "provenance": "f5-distributed-cloud-smsv2-system-namespace", "recorded_at": "2026-09-05T00:15:00Z", "profiles": [ "aws-shaped-ce-configuration", "aws-site-upgrade" ], "receipts": [ { "operations": [ "create", "read", "replace", "delete" ], "result": "accepted", "topology": { "nodes": 3, "interfaces": 6, "bgp_peers": 6 }, "validated_facts": [ "mac_bound_configuration", "nullable_public_ip", "runtime_health", "tgw_connect", "established_bgp_peers", "detailed_and_simplified_route_agreement", "zero_action_post_apply_plan" ], "sanitized": true, "redaction": "no tenant response, token, bootstrap material, or resource identifier" }, { "operations": [ "site_status", "target_discovery", "precheck", "software_upgrade", "os_upgrade" ], "result": "accepted", "validated_facts": [ "installed_and_available_versions", "deployment_phase_and_result", "site_state", "software_target_advertised", "software_prechecks_passed", "transient_failure_observed" ], "upgrade_path": { "installed_software": "crt-20251002-0027", "installed_os": "9.2026.10", "target_software": "crt-20260201-0179", "target_os": "9.2026.17", "software_prechecks": "passed" }, "sanitized": true, "redaction": "no raw response, message, node identifier, URL, token, or resource identifier" } ] }, "unavailable_capabilities": [] }, "azure": { "bootstrap": { "mode": "site_bound_jwt_cloud_init", "reference": "deployment_bound_opaque_one_use", "schema_support": "available", "runtime_verification": "awaiting_evidence", "headless_checkout": "available", "image_runtime_acceptance": false, "reason": "azure_api_verified_image_runtime_not_accepted", "api_verification": { "status": "verified_api_only", "scope": "azure_bootstrap_api_only", "schema_commit": "5ce68bff35b444e5af967433ad3d14ca96a1ffe0", "source_issue": "f5-sales-demo/api-specs-enriched#1748", "receipt_path": "config/evidence/azure-bootstrap-api-20260908.json", "receipt_sha256": "ba3975c417a43e9e6a68d02bb51bec76bfe043aa1d1a756b199377be0f450e21", "runtime_acceptance": false }, "sequence": [ "site_create", "jwt_issue", "cloud_init_template" ], "token": { "method": "POST", "path": "/api/register/namespaces/system/tokens", "request_fields": { "spec.type": 1, "spec.site_name": "site_name" }, "metadata_fields": { "name": "token_name", "namespace": "system" }, "site_response_path": "spec.site_name", "type_response_path": "spec.type", "credential_response_path": "spec.content", "accepted_response_types": [ 1, "JWT" ], "site_binding_required": true }, "cloud_init": { "method": "GET", "path": "/api/register/namespaces/system/get-cloud-init-config", "operation_id": "ves.io.schema.token.CustomAPI.GetCloudInitConfig", "operation_role": "query", "query_fields": { "provider": "azure", "site_name": "site_name", "enable_management_network": false }, "response_path": "cloud_init_config", "sensitive": true, "refresh_on_read": false }, "material": { "preserve_paths": [ "/etc/vpm/config.yaml" ], "issued_path": "/etc/vpm/user_data", "token_placeholders": [ "{{ .Token }}", "{{ .token }}" ], "placeholder_value": "spec.content", "reject_unresolved_placeholders": true, "storage": "restricted_deployment_storage" }, "source_repository": "f5-sales-demo/multi-cloud-networking", "source_commit": "c1310d030cfc252571bf0e816db21b618697d991", "source_path": "docs/en/customer-edge/smsv2/azure-route-server.mdx" }, "availability": "evidence_backed", "route_server_ebgp_multihop": { "availability": "unavailable", "enforcement": "reject_before_mutation", "reason": "no_schema_valid_ebgp_multihop_request_control", "source": { "repository": "f5-sales-demo/api-specs-enriched", "commit": "322c202ed49c8cfcd5015a524f3195bbd2a8f2bc", "asset_path": "docs/specifications/api/network.json", "asset_sha256": "sha256:a7398d85475409c93750a04ccdec7c0b1a7ae12bc362ebfbc76866275904762a", "schema_paths": [ "components.schemas.bgpPeer", "components.schemas.bgpPeerExternal", "components.schemas.bgpBgpParameters" ] }, "future_mapping_requirements": { "request_schema_path": "explicit", "request_field_path": "explicit", "request_value_semantics": "explicit", "schema_validation": "required", "runtime_acceptance": "required" } }, "runtime": { "configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/securemesh_site_v2s/{site}", "operation_id": "ves.io.schema.views.securemesh_site_v2.API.Get", "response_schema": "securemesh_site_v2GetResponse", "authority": "f5xc", "semantics": "configuration", "response_mappings": { "nodes": "spec.azure.not_managed.node_list[]", "node": "hostname", "interfaces": "interface_list[]", "mac": "ethernet_interface.mac", "role": "network_option", "mtu": "mtu", "public_ip": "public_ip", "provider": "spec.azure.not_managed", "device": "ethernet_interface.device" }, "nullability": { "public_ip": "nullable", "all_identity_fields": "non_null" }, "normalization": { "node": "trim", "mac": "ieee802_lowercase_colon", "role": "slo_or_sli" }, "correlation": [ "node", "normalized_mac" ] }, "bgp_configuration": { "method": "GET", "path": "/api/config/namespaces/{namespace}/bgps/{name}", "operation_id": "ves.io.schema.bgp.API.Get", "response_schema": "bgpGetResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "parameters": "spec.bgp_parameters", "peers": "spec.peers[]", "target_service": "spec.peers[].target_service", "family_inet_v6": "spec.peers[].external.family_inet_v6" }, "response_only_fields": [ "spec.peers[].target_service", "spec.peers[].external.family_inet_v6" ], "request_eligibility": "rejected_without_authoritative_request_schema", "source": { "repository": "f5-sales-demo/api-specs-enriched", "commit": "055d32d68c14824e32d748a425bf541dec2f529e", "asset_path": "docs/specifications/api/network.json", "asset_sha256": "sha256:0b5381bcaaf8090e0992c6923aea8ae4a3aa664c5966ad5503790e5d6a842d8d", "schema_paths": [ "components.schemas.bgpPeer", "components.schemas.bgpPeerExternal", "components.schemas.bgpBgpParameters", "components.schemas.bgpGetResponse" ] }, "evidence_receipt": { "path": "config/evidence/azure_bgp_response_drift_v7.0.0.json", "sha256": "54bf13997a6933de8431846c5d6e9267a9665e1378e1250fc06f76c77405dec7" }, "live_evidence": { "method": "GET", "selection": "unique_ownership_labeled_azure_terraform_ce_bgp", "observed_response_fields": [ "spec.peers[].target_service", "spec.peers[].external.family_inet_v6" ], "form_metadata": { "create_form": null, "replace_form": null }, "sanitized": true, "retention": "field_shapes_only_no_names_addresses_tokens_or_raw_response" } }, "bgp_peers": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_peers", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPPeers", "response_schema": "bgpBGPPeersResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "peers": "ver[].peer[]", "interface_name": "ver[].peer[].interface_name", "peer_address": { "ipv4": "ver[].peer[].peer_address.ipv4.addr", "ipv6": "ver[].peer[].peer_address.ipv6.addr" }, "state": "ver[].peer[].protocol_status", "received_prefix_count": "ver[].peer[].received_prefix_count", "advertised_prefix_count": "ver[].peer[].advertised_prefix_count", "state_changed_at": "ver[].peer[].up_down_timestamp" }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node", "peer_address" ] }, "bgp_routes": { "method": "GET", "path": "/api/operate/namespaces/{namespace}/sites/{site}/ver/bgp_routes", "operation_id": "ves.io.schema.operate.bgp.CustomPublicAPI.ShowBGPRoutes", "response_schema": "bgpBGPRoutesResponse", "authority": "f5xc", "semantics": "observational_read_only", "response_mappings": { "nodes": "ver[]", "node": "ver[].name", "routing_instances": "ver[].ri_table[]", "route_tables": "ver[].ri_table[].rt_table[]", "imported_routes": "ver[].ri_table[].rt_table[].imported[]", "exported_routes": "ver[].ri_table[].rt_table[].exported[]", "route_prefixes": [ "ver[].ri_table[].rt_table[].imported[].subnet", "ver[].ri_table[].rt_table[].exported[].subnet" ] }, "normalization": { "node": "configured_hostname_or_fqdn" }, "correlation": [ "canonical_node" ] } }, "stable_identity": { "required_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, "roles": [ { "name": "slo", "required": true, "bindable": true, "network_option": "site_local_network", "vrf": "site_local_outside", "configuration_path": "azure.not_managed.node_list[].interface_list[]", "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, { "name": "external", "required": false, "bindable": false, "network_option": null, "vrf": null, "configuration_path": null, "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] }, { "name": "sli", "required": false, "bindable": false, "network_option": null, "vrf": null, "configuration_path": null, "identity_fields": [ "node_hostname", "cloud_nic_position", "nic_mac", "ip_configuration", "subnet", "control_plane_interface_reference" ] } ], "invariants": { "first_azure_nic_is_slo_anchor": true, "macs_unique_per_node": true, "role_bindings_unique_per_node": true, "homogeneous_ha_role_vrf_shape": true, "bgp_bindable_roles": [ "slo" ] }, "runtime_evidence": { "guest_interface_names": "observational_only", "minimum_mapping_confidence": "authoritative", "provenance_required": true, "replacement_observation_required": true }, "change_risk": { "maintenance_window_required": true, "restarts_ce_data_plane_services": true, "adding_or_removing_interfaces_disruptive": true } } } }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterApplicationArgoCDType": { "type": "object", "description": "Description\nParameters for Argo Continuous Deployment(CD) application.", "title": "Argo CD configuration", "x-displayname": "Argo CD configuration.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ApplicationArgoCDType", "properties": { "local_domain": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterLocalAccessArgoCDType" } ], "x-f5xc-description-short": "Configuration parameter for local domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Description Parameters for Argo Continuous Deployment(CD) application.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterApplicationArgoCDType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterApplicationDashboardType": { "type": "object", "description": "Description\nParameters for K8s dashboard.", "title": "K8s Dashboard configuration", "x-displayname": "K8s Dashboard configuration.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ApplicationDashboardType", "x-f5xc-description-short": "Description Parameters for K8s dashboard.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterApplicationDashboardType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterApplicationMetricsServerType": { "type": "object", "description": "Description\nParameters for Kubernetes Metrics Server application.", "title": "K8s Metrics Server configuration", "x-displayname": "K8s Metrics Server configuration.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ApplicationMetricsServerType", "x-f5xc-description-short": "Description Parameters for Kubernetes Metrics Server application.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterApplicationMetricsServerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterApplicationPrometheusType": { "type": "object", "description": "Description\nParameters for Prometheus server access.", "title": "Prometheus configuration", "x-displayname": "Prometheus access configuration.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ApplicationPrometheusType", "x-f5xc-description-short": "Description Parameters for Prometheus server access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterApplicationPrometheusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterClusterRoleBindingListType": { "type": "object", "description": "List of active cluster role binding list for a K8s cluster.", "title": "Cluster Role Binding List", "x-displayname": "Cluster Role Binding List.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ClusterRoleBindingListType", "properties": { "cluster_role_bindings": { "type": "array", "description": "List of active cluster role binding list for a K8s cluster.", "title": "Cluster Role Binding List", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Cluster Role Binding List.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of active cluster role binding list for a K8s cluster.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List of active cluster role binding list for a K8s cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterClusterRoleBindingListType", "required_fields": [ "cluster_role_bindings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cluster_role_bindings\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "cluster_role_bindings:\n- name: contacts-route" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterClusterRoleListType": { "type": "object", "description": "List of active cluster role list for a K8s cluster.", "title": "Cluster Role List", "x-displayname": "Cluster Role List.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ClusterRoleListType", "properties": { "cluster_roles": { "type": "array", "description": "List of active cluster role list for a K8s cluster.", "title": "Cluster Role List", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Cluster Role List.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of active cluster role list for a K8s cluster.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List of active cluster role list for a K8s cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterClusterRoleListType", "required_fields": [ "cluster_roles" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cluster_roles\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "cluster_roles:\n- name: contacts-route" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterClusterWideAppListType": { "type": "object", "description": "List of cluster wide applications.", "title": "Cluster Wide Application List", "x-displayname": "Cluster Wide Application List.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ClusterWideAppListType", "properties": { "cluster_wide_apps": { "type": "array", "description": "List of cluster wide applications.", "title": "Cluster Wide Application List", "minItems": 1, "maxItems": 5, "items": { "$ref": "#/components/schemas/k8s_clusterClusterWideAppType" }, "x-displayname": "Cluster Wide Application List.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "5", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "5", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 5, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterClusterWideAppListType", "required_fields": [ "cluster_wide_apps" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cluster_wide_apps\": [\n {}\n ]\n}", "example_yaml": "cluster_wide_apps:\n- {}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterClusterWideAppType": { "type": "object", "description": "Cluster wide application configuration.", "title": "Cluster Wide Application", "x-displayname": "Cluster Wide Application.", "x-ves-oneof-field-app_choice": "[\"argo_cd\",\"dashboard\",\"metrics_server\",\"prometheus\"]", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ClusterWideAppType", "properties": { "argo_cd": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterApplicationArgoCDType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dashboard", "metrics_server", "prometheus" ] }, "dashboard": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterApplicationDashboardType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "argo_cd", "metrics_server", "prometheus" ] }, "metrics_server": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterApplicationMetricsServerType" } ], "x-f5xc-description-short": "Configuration parameter for metrics server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "argo_cd", "dashboard", "prometheus" ] }, "prometheus": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterApplicationPrometheusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "argo_cd", "dashboard", "metrics_server" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterClusterWideAppType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of k8s_cluster", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Kubernetes cluster configuration for F5 XC managed K8s", "required_fields": [ "metadata.name", "metadata.namespace" ], "mutually_exclusive_groups": [], "example_yaml": "metadata:\n name: example-k8s-cluster\n namespace: system\nspec: {}\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-k8s-cluster\",\n \"namespace\": \"system\"\n },\n \"spec\": {}\n}\n" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.k8s_cluster.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterCreateSpecType": { "type": "object", "description": "Create k8s_cluster will create the object in the storage backend for namespace metadata.namespace.", "title": "Create k8s_cluster", "x-displayname": "Create Configuration Specification.", "x-ves-oneof-field-apps_choice": "[\"cluster_wide_app_list\",\"no_cluster_wide_apps\"]", "x-ves-oneof-field-cluster_role_bindings_choice": "[\"use_custom_cluster_role_bindings\",\"use_default_cluster_role_bindings\"]", "x-ves-oneof-field-cluster_role_choice": "[\"use_custom_cluster_role_list\",\"use_default_cluster_roles\"]", "x-ves-oneof-field-cluster_scoped_resource_access_choice": "[\"cluster_scoped_access_deny\",\"cluster_scoped_access_permit\"]", "x-ves-oneof-field-global_access_choice": "[\"global_access_enable\",\"no_global_access\"]", "x-ves-oneof-field-insecure_registries_choice": "[\"insecure_registry_list\",\"no_insecure_registries\"]", "x-ves-oneof-field-local_access_choice": "[\"local_access_config\",\"no_local_access\"]", "x-ves-oneof-field-pod_security_admission_choice": "[\"use_custom_pod_security_admission\",\"use_default_pod_security_admission\"]", "x-ves-oneof-field-pod_security_policy_choice": "[\"use_custom_psp_list\",\"use_default_psp\"]", "x-ves-oneof-field-vk8s_namespace_access_choice": "[\"vk8s_namespace_access_deny\",\"vk8s_namespace_access_permit\"]", "x-ves-proto-message": "ves.io.schema.k8s_cluster.CreateSpecType", "properties": { "cluster_scoped_access_deny": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "cluster_scoped_access_permit" ] }, "cluster_scoped_access_permit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster_scoped_access_deny" ] }, "cluster_wide_app_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterWideAppListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_cluster_wide_apps" ] }, "global_access_enable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for global access enable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_access" ] }, "insecure_registry_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterInsecureRegistryListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_insecure_registries" ] }, "local_access_config": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterLocalAccessConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_local_access" ] }, "no_cluster_wide_apps": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "cluster_wide_app_list" ] }, "no_global_access": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "global_access_enable" ] }, "no_insecure_registries": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "insecure_registry_list" ] }, "no_local_access": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no local access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "local_access_config" ] }, "use_custom_cluster_role_bindings": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterRoleBindingListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_cluster_role_bindings" ] }, "use_custom_cluster_role_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterRoleListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_cluster_roles" ] }, "use_custom_pod_security_admission": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_pod_security_admission" ], "x-f5xc-references": [ { "resource_kind": null, "field_path": "use_custom_pod_security_admission", "gated_by": { "choice": "pod_security_admission_choice" }, "required": false, "cardinality": "single" } ] }, "use_custom_psp_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterPodSecurityPolicyListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_psp" ] }, "use_default_cluster_role_bindings": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_cluster_role_bindings" ] }, "use_default_cluster_roles": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_cluster_role_list" ] }, "use_default_pod_security_admission": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_custom_pod_security_admission" ] }, "use_default_psp": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use default psp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_psp_list" ] }, "vk8s_namespace_access_deny": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "vk8s_namespace_access_permit" ] }, "vk8s_namespace_access_permit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vk8s_namespace_access_deny" ] } }, "x-f5xc-description-short": "Create k8s_cluster will create the object in the storage backend for namespace metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a k8s_cluster", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read k8s_cluster", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/k8s_clusterStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterGetSpecType": { "type": "object", "description": "GET k8s_cluster will GET the object from the storage backend for namespace metadata.namespace.", "title": "Get k8s_cluster", "x-displayname": "GET Configuration Specification.", "x-ves-oneof-field-apps_choice": "[\"cluster_wide_app_list\",\"no_cluster_wide_apps\"]", "x-ves-oneof-field-cluster_role_bindings_choice": "[\"use_custom_cluster_role_bindings\",\"use_default_cluster_role_bindings\"]", "x-ves-oneof-field-cluster_role_choice": "[\"use_custom_cluster_role_list\",\"use_default_cluster_roles\"]", "x-ves-oneof-field-cluster_scoped_resource_access_choice": "[\"cluster_scoped_access_deny\",\"cluster_scoped_access_permit\"]", "x-ves-oneof-field-global_access_choice": "[\"global_access_enable\",\"no_global_access\"]", "x-ves-oneof-field-insecure_registries_choice": "[\"insecure_registry_list\",\"no_insecure_registries\"]", "x-ves-oneof-field-local_access_choice": "[\"local_access_config\",\"no_local_access\"]", "x-ves-oneof-field-pod_security_admission_choice": "[\"use_custom_pod_security_admission\",\"use_default_pod_security_admission\"]", "x-ves-oneof-field-pod_security_policy_choice": "[\"use_custom_psp_list\",\"use_default_psp\"]", "x-ves-oneof-field-vk8s_namespace_access_choice": "[\"vk8s_namespace_access_deny\",\"vk8s_namespace_access_permit\"]", "x-ves-proto-message": "ves.io.schema.k8s_cluster.GetSpecType", "properties": { "cluster_scoped_access_deny": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "cluster_scoped_access_permit" ] }, "cluster_scoped_access_permit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster_scoped_access_deny" ] }, "cluster_wide_app_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterWideAppListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_cluster_wide_apps" ] }, "global_access_enable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for global access enable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_access" ] }, "insecure_registry_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterInsecureRegistryListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_insecure_registries" ] }, "local_access_config": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterLocalAccessConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_local_access" ] }, "no_cluster_wide_apps": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "cluster_wide_app_list" ] }, "no_global_access": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "global_access_enable" ] }, "no_insecure_registries": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "insecure_registry_list" ] }, "no_local_access": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no local access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "local_access_config" ] }, "use_custom_cluster_role_bindings": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterRoleBindingListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_cluster_role_bindings" ] }, "use_custom_cluster_role_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterRoleListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_cluster_roles" ] }, "use_custom_pod_security_admission": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_pod_security_admission" ], "x-f5xc-references": [ { "resource_kind": null, "field_path": "use_custom_pod_security_admission", "gated_by": { "choice": "pod_security_admission_choice" }, "required": false, "cardinality": "single" } ] }, "use_custom_psp_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterPodSecurityPolicyListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_psp" ] }, "use_default_cluster_role_bindings": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_cluster_role_bindings" ] }, "use_default_cluster_roles": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_cluster_role_list" ] }, "use_default_pod_security_admission": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_custom_pod_security_admission" ] }, "use_default_psp": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use default psp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_psp_list" ] }, "vk8s_namespace_access_deny": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "vk8s_namespace_access_permit" ] }, "vk8s_namespace_access_permit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vk8s_namespace_access_deny" ] } }, "x-f5xc-description-short": "GET k8s_cluster will GET the object from the storage backend for namespace metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterInsecureRegistryListType": { "type": "object", "description": "List of docker insecure registries.", "title": "Docker Insecure Registry List", "x-displayname": "Docker Insecure Registry List.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.InsecureRegistryListType", "properties": { "insecure_registries": { "type": "array", "description": "List of docker insecure registries in format \"example.com:5000\"", "title": "Docker Insecure Registry List", "minItems": 1, "maxItems": 16, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Docker Insecure Registry List.", "x-ves-example": "example.com:5000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.hostport": "true", "ves.io.schema.rules.repeated.items.string.max_bytes": "256", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "example.com:5000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.hostport": "true", "ves.io.schema.rules.repeated.items.string.max_bytes": "256", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of docker insecure registries in format \"example.com:5000\".", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterInsecureRegistryListType", "required_fields": [ "insecure_registries" ], "mutually_exclusive_groups": [], "example_json": "{\n \"insecure_registries\": [\n \"value\"\n ]\n}", "example_yaml": "insecure_registries:\n- value" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of k8s_cluster", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/k8s_clusterListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterListResponseItem": { "type": "object", "description": "By default a summary of k8s_cluster is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of k8s_cluster", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this k8s_cluster.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this k8s_cluster.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this k8s_cluster.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this k8s_cluster.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates k8s_cluster is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates k8s_cluster is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this k8s_cluster.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this k8s_cluster.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this k8s_cluster.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/k8s_clusterStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this k8s_cluster.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of k8s_cluster is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of k8s_cluster is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterLocalAccessArgoCDType": { "type": "object", "description": "Parameters required to enable local access.", "title": "Local Access ArgoCD Configuration", "x-displayname": "Local Access Configuration.", "x-ves-oneof-field-port_choice": "[\"default_port\",\"port\"]", "x-ves-proto-message": "ves.io.schema.k8s_cluster.LocalAccessArgoCDType", "properties": { "default_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port" ] }, "local_domain": { "type": "string", "description": "ArgoCD will be accessible at ..", "title": "Local Domain", "minLength": 1, "maxLength": 192, "x-displayname": "Local Domain.", "x-ves-example": "example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "ArgoCD will be accessible at ..", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 192, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "port": { "type": "integer", "description": "Exclusive with [default_port]\nUse custom ArgoCD port.\nAvailable port range is less than 65000 except reserved ports.", "title": "Custom ArgoCD Port", "format": "int64", "x-displayname": "Custom ArgoCD Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.not_in_ranges": "0,6443,8005-8007,8443-8444,8505-8507,9005-9007,9090,9505-9507,9100,9115,9999,20914,23802,30805,30855,30905,30955,32222,18091-18095,65000-65334" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.not_in_ranges": "0,6443,8005-8007,8443-8444,8505-8507,9005-9007,9090,9505-9507,9100,9115,9999,20914,23802,30805,30855,30905,30955,32222,18091-18095,65000-65334" }, "x-f5xc-description-short": "Exclusive with [default_port] Use custom ArgoCD port. Available port range is less than 65000 except reserved ports.", "x-f5xc-description-medium": "Exclusive with [default_port] Use custom ArgoCD port. Available port range is less than 65000 except reserved ports.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_port" ] } }, "x-f5xc-description-short": "Parameters required to enable local access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterLocalAccessArgoCDType", "required_fields": [ "local_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"local_domain\": \"example.com\"\n}", "example_yaml": "local_domain: example.com" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterLocalAccessConfigType": { "type": "object", "description": "Parameters required to enable local access.", "title": "Local Access Configuration", "x-displayname": "Local Access Configuration.", "x-ves-oneof-field-port_choice": "[\"default_port\",\"port\"]", "x-ves-proto-message": "ves.io.schema.k8s_cluster.LocalAccessConfigType", "properties": { "default_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port" ] }, "local_domain": { "type": "string", "description": "Local K8s API server will be accessible at ..", "title": "Local Domain", "minLength": 1, "maxLength": 192, "x-displayname": "Local Domain.", "x-ves-example": "example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "192", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Local K8s API server will be accessible at ..", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 192, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "port": { "type": "integer", "description": "Exclusive with [default_port]\nUse custom K8s port for API server.\nAvailable port range is less than 65000 except reserved ports.", "title": "Custom k8s Port", "format": "int64", "x-displayname": "Custom K8s Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.not_in_ranges": "0,6443,8005-8007,8443-8444,8505-8507,9005-9007,9090,9505-9507,9100,9115,9999,20914,23802,30805,30855,30905,30955,32222,18091-18095,65000-65334" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.not_in_ranges": "0,6443,8005-8007,8443-8444,8505-8507,9005-9007,9090,9505-9507,9100,9115,9999,20914,23802,30805,30855,30905,30955,32222,18091-18095,65000-65334" }, "x-f5xc-description-short": "Exclusive with [default_port] Use custom K8s port for API server. Available port range is less than 65000 except reserved ports.", "x-f5xc-description-medium": "Exclusive with [default_port] Use custom K8s port for API server. Available port range is less than 65000 except reserved ports.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_port" ] } }, "x-f5xc-description-short": "Parameters required to enable local access.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterLocalAccessConfigType", "required_fields": [ "local_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"local_domain\": \"example.com\"\n}", "example_yaml": "local_domain: example.com" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterPodSecurityPolicyListType": { "type": "object", "description": "List of active Pod security policies for a K8s cluster.", "title": "Pod Security Policy List", "x-displayname": "Pod Security Policy List.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.PodSecurityPolicyListType", "properties": { "pod_security_policies": { "type": "array", "description": "List of active Pod security policies for a K8s cluster.", "title": "Pod Security Policy List", "minItems": 1, "maxItems": 16, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Pod Security Policy List.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of active Pod security policies for a K8s cluster.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List of active Pod security policies for a K8s cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterPodSecurityPolicyListType", "required_fields": [ "pod_security_policies" ], "mutually_exclusive_groups": [], "example_json": "{\n \"pod_security_policies\": [\n {\n \"name\": \"contacts-route\"\n }\n ]\n}", "example_yaml": "pod_security_policies:\n- name: contacts-route" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a k8s_cluster", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Kubernetes cluster configuration for F5 XC managed K8s", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterReplaceSpecType": { "type": "object", "description": "Replacing an k8s_cluster object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.", "title": "Replace k8s_cluster", "x-displayname": "Replace Configuration Specification.", "x-ves-oneof-field-apps_choice": "[\"cluster_wide_app_list\",\"no_cluster_wide_apps\"]", "x-ves-oneof-field-cluster_role_bindings_choice": "[\"use_custom_cluster_role_bindings\",\"use_default_cluster_role_bindings\"]", "x-ves-oneof-field-cluster_role_choice": "[\"use_custom_cluster_role_list\",\"use_default_cluster_roles\"]", "x-ves-oneof-field-cluster_scoped_resource_access_choice": "[\"cluster_scoped_access_deny\",\"cluster_scoped_access_permit\"]", "x-ves-oneof-field-global_access_choice": "[\"global_access_enable\",\"no_global_access\"]", "x-ves-oneof-field-insecure_registries_choice": "[\"insecure_registry_list\",\"no_insecure_registries\"]", "x-ves-oneof-field-local_access_choice": "[\"local_access_config\",\"no_local_access\"]", "x-ves-oneof-field-pod_security_admission_choice": "[\"use_custom_pod_security_admission\",\"use_default_pod_security_admission\"]", "x-ves-oneof-field-pod_security_policy_choice": "[\"use_custom_psp_list\",\"use_default_psp\"]", "x-ves-oneof-field-vk8s_namespace_access_choice": "[\"vk8s_namespace_access_deny\",\"vk8s_namespace_access_permit\"]", "x-ves-proto-message": "ves.io.schema.k8s_cluster.ReplaceSpecType", "properties": { "cluster_scoped_access_deny": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "cluster_scoped_access_permit" ] }, "cluster_scoped_access_permit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cluster_scoped_access_deny" ] }, "cluster_wide_app_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterWideAppListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_cluster_wide_apps" ] }, "global_access_enable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for global access enable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_global_access" ] }, "insecure_registry_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterInsecureRegistryListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_insecure_registries" ] }, "local_access_config": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterLocalAccessConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_local_access" ] }, "no_cluster_wide_apps": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "cluster_wide_app_list" ] }, "no_global_access": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no global access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "global_access_enable" ] }, "no_insecure_registries": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "insecure_registry_list" ] }, "no_local_access": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no local access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "local_access_config" ] }, "use_custom_cluster_role_bindings": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterRoleBindingListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_cluster_role_bindings" ] }, "use_custom_cluster_role_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterClusterRoleListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_cluster_roles" ] }, "use_custom_pod_security_admission": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_pod_security_admission" ], "x-f5xc-references": [ { "resource_kind": null, "field_path": "use_custom_pod_security_admission", "gated_by": { "choice": "pod_security_admission_choice" }, "required": false, "cardinality": "single" } ] }, "use_custom_psp_list": { "allOf": [ { "$ref": "#/components/schemas/k8s_clusterPodSecurityPolicyListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_default_psp" ] }, "use_default_cluster_role_bindings": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_cluster_role_bindings" ] }, "use_default_cluster_roles": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_cluster_role_list" ] }, "use_default_pod_security_admission": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_custom_pod_security_admission" ] }, "use_default_psp": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use default psp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "use_custom_psp_list" ] }, "vk8s_namespace_access_deny": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "default": {}, "x-f5xc-server-default": true, "x-f5xc-conflicts-with": [ "vk8s_namespace_access_permit" ] }, "vk8s_namespace_access_permit": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "vk8s_namespace_access_deny" ] } }, "x-f5xc-description-short": "Replacing an k8s_cluster object will update the object by replacing the existing spec with the provided one.", "x-f5xc-description-medium": "Replacing an k8s_cluster object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "k8s_clusterStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for K8s Cluster", "x-displayname": "K8s Cluster.", "x-ves-proto-message": "ves.io.schema.k8s_cluster.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for k8s_clusterStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Kubernetes cluster registration is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logAccessLogAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for access logs.", "title": "AccessLogAggregationRequest", "x-displayname": "Access Log Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.AccessLogAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch access logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of following fields in access log may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request path\nrsp_code - response code\nbrowser_type - browser type\ncity - name of the city\ncountry - country code\ndevice_type - device type\n := string\n := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then access logs matching ALL the matchers will be considered for aggregation.\nExample: query={src=\"service1\", dst=\"service2\"} will consider all access logs with source service \"service1\" and the destination service \"service2\"\n\nOptional: If not specified, all the access logs matching the given tenant, namespace will be considered for aggregation.", "title": "query", "x-displayname": "Query", "x-ves-example": "{vh_name=\\\"productpage\\\"}", "x-f5xc-example": "\"{vh_name=\\\"productpage\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of following fields in access log may be specified in the query. App_type - application type vh_name - name of the virtual host src_site...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch access logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for access logs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logAccessLogAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logAccessLogRequestV2": { "type": "object", "description": "Request to fetch access logs.", "title": "AccessLogRequestV2", "x-displayname": "Access Log Request V2.", "x-ves-proto-message": "ves.io.schema.log.AccessLogRequestV2", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch access logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch access logs for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch access logs for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of following fields in access log may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request path\nrsp_code - response code\nbrowser_type - browser type\ncity - name of the city\ncountry - country code\ndevice_type - device type\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then access logs matching ALL the matchers will be returned in the response.\nExample: query={src=\"service1\", dst=\"service2\"} will return all access logs with source service \"service1\" and the destination service \"service2\"\nquery={vh_name=\"vh1\", rsp_code=~\"4.*\"} will return all access logs for virtual-host \"vh1\" with response code 4xx\n\nOptional: If not specified, all the access logs matching the given tenant, namespace will be returned in the response.", "title": "query", "x-displayname": "Query", "x-ves-example": "{vh_name=\\\"productpage\\\"}", "x-f5xc-example": "\"{vh_name=\\\"productpage\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of following fields in access log may be specified in the query. App_type - application type vh_name - name of the virtual host src_site...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch access logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logAccessLogRequestV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logAuditLogAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for audit logs.", "title": "AuditLogAggregationRequest", "x-displayname": "Audit Log Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.AuditLogAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request URL\nrsp_code - response code\n := string\n := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={req_path=\"/public/namespaces/system/registrations\"} will return all audit logs with req_path equals /public/namespaces/system/registrations\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation.", "title": "query", "x-displayname": "Query", "x-ves-example": "{user=\\\"abc\\\", rsp_code=\\\"404\\\"}", "x-f5xc-example": "\"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in audit log may be specified in the query. User - user name src_site - source site src - source service...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for audit logs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logAuditLogAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logAuditLogRequestV2": { "type": "object", "description": "Request to fetch audit logs.", "title": "AuditLogRequestV2", "x-displayname": "Audit Log Request V2.", "x-ves-proto-message": "ves.io.schema.log.AuditLogRequestV2", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch audit logs for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in audit log may be specified in the query.\nUser - user name\nsrc_site - source site\nsrc - source service\nsrc_instance - source instance\ndst_site - destination site\ndst - destination service\ndst_instance - destination instance\nmethod - request method\nreq_path - request URL\nrsp_code - response code\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={req_path=\"/public/namespaces/system/registrations\"} will return all audit logs with req_path equals /public/namespaces/system/registrations\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "{user=\\\"abc\\\", rsp_code=\\\"404\\\"}", "x-f5xc-example": "\"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in audit log may be specified in the query. User - user name src_site - source site src - source service...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logAuditLogRequestV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logFirewallLogAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for Firewall logs.", "title": "FirewallLogAggregationRequest", "x-displayname": "Firewall Log Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.FirewallLogAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch Firewall logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch Firewall logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch Firewall logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of following fields in Firewall log may be specified in the query.\nSite - Name of the site\nsrc_ip - Source IP Address\ndst_ip - Destination IP Address\npolicy_hits.policy - Policy Name\npolicy_hits.policy_rule - Policy Rule Name\npolicy_hits.result - allow|deny|default_deny\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then Firewall logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the Firewall logs matching the given tenant, namespace will be returned in the response.", "title": "query", "x-displayname": "Query", "x-ves-example": "{site=\\\"site-1\\\"}", "x-f5xc-example": "\"{site=\\\"site-1\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of following fields in Firewall log may be specified in the query. Site - Name of the site src_ip - Source IP Address dst_ip ...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch Firewall logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch Firewall logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...", "x-f5xc-description-medium": "Fetch Firewall logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for Firewall logs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logFirewallLogAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logFirewallLogRequest": { "type": "object", "description": "Request to fetch Firewall logs.", "title": "FirewallLogRequest", "x-displayname": "Firewall Log Request.", "x-ves-proto-message": "ves.io.schema.log.FirewallLogRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch Firewall logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch Firewall logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch Firewall logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch Firewall logs for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch Firewall logs for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of following fields in Firewall log may be specified in the query.\nSite - Name of the site\nsrc_ip - Source IP Address\ndst_ip - Destination IP Address\npolicy_hits.policy - Policy Name\npolicy_hits.policy_rule - Policy Rule Name\npolicy_hits.result - allow|deny|default_deny\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then Firewall logs matching ALL the matchers will be returned in the response.\n\nOptional: If not specified, all the Firewall logs matching the given tenant, namespace will be returned in the response.", "title": "query", "x-displayname": "Query", "x-ves-example": "{site=\\\"site-1\\\"}", "x-f5xc-example": "\"{site=\\\"site-1\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of following fields in Firewall log may be specified in the query. Site - Name of the site src_ip - Source IP Address dst_ip ...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch Firewall logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch Firewall logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be...", "x-f5xc-description-medium": "Fetch Firewall logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logFirewallLogRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logK8SAuditLogAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for K8s audit logs.", "title": "K8SAuditLogAggregationRequest", "x-displayname": "K8s Audit Log Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.K8SAuditLogAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n := string\n := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={objectref.resource=\"deployments\"}", "x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "type": "string", "description": "Site where the K8s Cluster is running.", "title": "site", "x-displayname": "Site", "x-ves-example": "CE-1", "x-f5xc-example": "ce-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for K8s audit logs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logK8SAuditLogAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logK8SAuditLogRequest": { "type": "object", "description": "Request to fetch K8s audit logs.", "title": "K8SAuditLogRequest", "x-displayname": "K8s Audit Log Request.", "x-ves-proto-message": "ves.io.schema.log.K8SAuditLogRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch K8s audit logs for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch K8s audit logs for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={objectref.resource=\"deployments\"}", "x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "type": "string", "description": "Site where the K8s Cluster is running.", "title": "site", "x-displayname": "Site", "x-ves-example": "CE-1", "x-f5xc-example": "ce-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logK8SAuditLogRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logK8SEventsAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for K8s events in a Cluster.", "title": "K8s Events Aggregation Request", "x-displayname": "K8s Events Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.K8SEventsAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch vK8s events whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the K8s events for the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={involvedobject.kind=\"Pod\"}", "x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "type": "string", "description": "Site where the K8s Cluster is running.", "title": "site", "x-displayname": "Site", "x-ves-example": "CE-1", "x-f5xc-example": "ce-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch vK8s events whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for K8s events in a Cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logK8SEventsAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logK8SEventsRequest": { "type": "object", "description": "Request to fetch physical K8s events.", "title": "K8s Events Request", "x-displayname": "K8s Events Request.", "x-ves-proto-message": "ves.io.schema.log.K8SEventsRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch vK8s events whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of K8s events returned in the response\nOptional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of K8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of K8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch K8s events for the given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch K8s events for the given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\nsite - Name of the site\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the K8s events for the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={involvedobject.kind=\"Pod\"}", "x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of events (or all events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of events until there are no more events left to return. The number of events in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of events (or all events) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of events (or all events) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of events until there are no more events left to return. The number of events in each batch is...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "type": "string", "description": "Site where the K8s Cluster is running.", "title": "site", "x-displayname": "Site", "x-ves-example": "CE-1", "x-f5xc-example": "ce-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch vK8s events whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logK8SEventsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logLogAggregationResponse": { "type": "object", "description": "Response message for AuditLogAggregationRequest/AccessLogAggregationRequest.", "title": "LogAggregationResponse", "x-displayname": "Log Aggregation Response.", "x-ves-proto-message": "ves.io.schema.log.LogAggregationResponse", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is key'ed with the aggregation name...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_hits": { "type": "string", "description": "Total number of log messages that matched the query.", "title": "total hits", "format": "uint64", "x-displayname": "Total Hits.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Total number of log messages that matched the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response message for AuditLogAggregationRequest/AccessLogAggregationRequest.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logLogAggregationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logLogResponse": { "type": "object", "description": "Response message for AuditLogRequest/AccessLogRequest/LogScrollRequest.", "title": "LogResponse", "x-displayname": "Log Response.", "x-ves-proto-message": "ves.io.schema.log.LogResponse", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is key'ed with the aggregation name...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "logs": { "type": "array", "description": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.", "title": "logs", "items": { "type": "string" }, "x-displayname": "Logs", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.", "x-f5xc-description-medium": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll_id": { "type": "string", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the LogResponse.", "title": "scroll id", "x-displayname": "Scroll ID", "x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.", "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==", "x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.", "x-f5xc-description-medium": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request. Empty scroll_id indicates no more messages to scroll (EOF).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "total_hits": { "type": "string", "description": "Total number of log messages that matched the query.", "title": "total hits", "format": "uint64", "x-displayname": "Total Hits.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Total number of log messages that matched the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response message for AuditLogRequest/AccessLogRequest/LogScrollRequest.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logLogResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logLogScrollRequest": { "type": "object", "description": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse\ncontaining no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or\nall log messages, one can use the LogScrollRequest. Use the scroll_id returned in the LogResponse to fetch the next\nbatch of log messages and one can continue this process till the scroll_id returned in the LogResponse is \"\" which\nindicates no more log messages to scroll.", "title": "LogScrollRequest", "x-displayname": "Log Scroll Request.", "x-ves-proto-message": "ves.io.schema.log.LogScrollRequest", "properties": { "namespace": { "type": "string", "description": "Fetch the log messages scoped by namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch the log messages scoped by namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "scroll_id": { "type": "string", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "title": "scroll id", "x-displayname": "Scroll ID", "x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.", "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==", "x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for...", "x-f5xc-description-medium": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or all log messages, one can use the LogScrollRequest. Use the scroll_id returned...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logLogScrollRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logPlatformEventAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for platform events.", "title": "PlatformEventAggregationRequest", "x-displayname": "Platform event Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.PlatformEventAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in platform events may be specified in the query.\nUser - user name\nresource_type - resource type\nresource - resource\nevent_type - event type\n\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then platform events matching ALL the matchers will be returned in the response.\nExample: query={resource_type=\"CUSTOMER_EDGE\"} will return all platform events with resource_type equals CUSTOMER_EDGE\n\nOptional: If not specified, all the platform events matching the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "{user=\\\"abc\\\", rsp_code=\\\"404\\\"}", "x-f5xc-example": "\"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in platform events may be specified in the query. User - user name resource_type - resource type resource ...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for platform events.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logPlatformEventAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logPlatformEventRequest": { "type": "object", "description": "Request to fetch platform events.", "title": "PlatformEventRequest", "x-displayname": "Platform event Request.", "x-ves-proto-message": "ves.io.schema.log.PlatformEventRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "include_config_changes": { "type": "boolean", "description": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in\nresponse. It is introduced to reduce any performance impact UI may face while rendering.\nOptional: default is false.", "title": "include_config_changes", "format": "boolean", "x-displayname": "Exclude config changes.", "x-f5xc-description-short": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in response.", "x-f5xc-description-medium": "Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in response. It is introduced to reduce any performance impact UI may face while rendering.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch audit logs for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in platform events may be specified in the query.\nUser - user name\nresource_type - resource type\nresource - resource\nevent_type - event type\n\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then platform events matching ALL the matchers will be returned in the response.\nExample: query={resource_type=\"CUSTOMER_EDGE\"} will return all platform events with resource_type equals CUSTOMER_EDGE\n\nOptional: If not specified, all the platform events matching the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "{user=\\\"abc\\\", rsp_code=\\\"404\\\"}", "x-f5xc-example": "\"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in platform events may be specified in the query. User - user name resource_type - resource type resource ...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logPlatformEventRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logSearchAfterSortValues": { "type": "object", "description": "These are timestamp and doc_id values returned by elastic search in the search request.\nClient is expected to set these values in a subsequent request to GET the next page of results.", "title": "SearchAfterSortValues", "x-displayname": "Search After Sort Values.", "x-ves-proto-message": "ves.io.schema.log.SearchAfterSortValues", "properties": { "last_doc_id": { "type": "string", "description": "This is a unique UUID generated by elastic search.", "title": "last_doc_id", "x-displayname": "Last Doc ID.", "x-ves-example": "-8881051689166072872.", "x-f5xc-example": "-8881051689166072872", "x-f5xc-description-short": "Unique UUID generated by elastic search.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "last_timestamp": { "type": "number", "description": "Configuration parameter for last timestamp", "title": "last timestamp", "format": "double", "x-displayname": "Last Timestamp.", "x-f5xc-example": "1745695692759", "x-f5xc-description-short": "Configuration parameter for last timestamp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "These are timestamp and doc_id values returned by elastic search in the search request.", "x-f5xc-description-medium": "These are timestamp and doc_id values returned by elastic search in the search request. Client is expected to set these values in a subsequent request to GET the next page of results.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logSearchAfterSortValues", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logVK8SAuditLogAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for vK8s audit logs.", "title": "VK8SAuditLogAggregationRequest", "x-displayname": "VK8s Audit Log Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.VK8SAuditLogAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n := string\n := [\"=\"|\"!=\"]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all vK8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={objectref.resource=\"deployments\"}", "x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for vK8s audit logs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logVK8SAuditLogAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logVK8SAuditLogRequest": { "type": "object", "description": "Request to fetch Virtual K8s audit logs.", "title": "VK8SAuditLogRequest", "x-displayname": "VK8s Audit Log Request.", "x-ves-proto-message": "ves.io.schema.log.VK8SAuditLogRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch audit logs whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of logs returned in the response\nOptional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...", "x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch vK8s audit logs for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch vK8s audit logs for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in audit log may be specified in the query.\nuser.username - user name\nsourceIPs - source IP\nverb - method\nobjectref.resource - K8s resource\nrequestURI - request URI\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\nWhen more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\nExample: query={objectref.resource=\"deployments\"} will return all vK8s audit logs for all deployment objects in the given namespace\n\nOptional: If not specified, all the audit logs matching the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={objectref.resource=\"deployments\"}", "x-f5xc-example": "\"query={objectref.resource=\"deployments\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in audit log may be specified in the query. user.username - user name sourceIPs - source IP verb - method...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of logs until there are no more logs left to return. The number of messages in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch audit logs whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to fetch Virtual K8s audit logs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logVK8SAuditLogRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logVK8SEventsAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for vK8s events.", "title": "vK8s Events Aggregation Request", "x-displayname": "Virtual K8s Events Aggregation Request.", "x-ves-proto-message": "ves.io.schema.log.VK8SEventsAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch vK8s events whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "GET aggregation data for a given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "GET aggregation data for a given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the vK8s events for the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={involvedobject.kind=\"Pod\"}", "x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch vK8s events whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for vK8s events.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logVK8SEventsAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "logVK8SEventsRequest": { "type": "object", "description": "Request to fetch Virtual K8s events.", "title": "vK8s Events Request", "x-displayname": "VK8s Events Request.", "x-ves-proto-message": "ves.io.schema.log.VK8SEventsRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the events response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the events response. If the number of events that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch vK8s events whose timestamp <= end_time\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 ", "title": "end time", "x-displayname": "End Time", "x-ves-example": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of vK8s events returned in the response\nOptional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\nThe maximum value for limit is 500.", "title": "limit", "format": "int32", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of vK8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending...", "x-f5xc-description-medium": "Limits the number of vK8s events returned in the response Optional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Fetch vK8s events for the given namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Fetch vK8s events for the given namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "query": { "type": "string", "description": "Query is used to specify the list of matchers\nsyntax for query := {[]}\n := \"\"\n := string\nOne or more of the following fields in the event may be specified in the query.\ninvolvedobject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\ninvolvedobject.name - Name of the object\ntype - Type of event such as Warning or Normal\nreason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\nsource.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\nsite - Name of the site\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : equal to\n!= : not equal to\n=~ : regex match\n!~ : not regex match\n\nOptional: If not specified, all the vK8s events for the given tenant and namespace are returned.", "title": "query", "x-displayname": "Query", "x-ves-example": "Query={involvedobject.kind=\"Pod\"}", "x-f5xc-example": "\"query={involvedobject.kind=\"Pod\"}\"", "x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" :=...", "x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[]} := \"\" := string One or more of the following fields in the event may be specified in the query. involvedobject.kind - The object that this event is about, like Pod...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll": { "type": "boolean", "description": "Scroll is used to retrieve large number of events (or all events) that matches the query.\nIf scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\nbatch of events until there are no more events left to return. The number of events in each batch is determined\nby the limit field.\nNote: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "scroll", "format": "boolean", "x-displayname": "Scroll", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Scroll is used to retrieve large number of events (or all events) that matches the query.", "x-f5xc-description-medium": "Scroll is used to retrieve large number of events (or all events) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of events until there are no more events left to return. The number of events in each batch is...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "search_after": { "type": "boolean", "description": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.\nIf search_after is set to true, the sort_values in the response can be used in the API to fetch the next\nbatch of logs. The number of messages in each batch is determined by the limit field.\nNote: Search After is used for processing large amount of data and therefore is not intended for real time user request.\nOptional: default is false.", "title": "search after", "format": "boolean", "x-displayname": "Search After.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query.", "x-f5xc-description-medium": "Search After is used to retrieve large number of log messages (or all log messages) that matches the query. If search_after is set to true, the sort_values in the response can be used in the API to fetch the next batch of logs. The number of messages in each batch is determined by the limit field.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_values": { "allOf": [ { "$ref": "#/components/schemas/logSearchAfterSortValues" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Fetch vK8s events whose timestamp >= start_time\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 -10m.", "title": "start time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...", "x-f5xc-description-medium": "Fetch vK8s events whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for logVK8SEventsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaSortOrder": { "type": "string", "description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.", "title": "SortOrder", "enum": [ "DESCENDING", "ASCENDING" ], "default": "DESCENDING", "x-displayname": "Sort Order.", "x-ves-proto-enum": "ves.io.schema.SortOrder", "x-f5xc-description-short": "Sort algorithm Sort in descending order Sort in ascending order.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSortOrder", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DESCENDING\"", "example_yaml": "DESCENDING\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "apiHttpBody": { "type": "object", "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\nmessage GetResourceRequest {\n// A unique request ID.\nString request_id = 1;\n\n// The raw HTTP body is bound to this field.\ngoogle.api.httpbody http_body = 2;\n}\n\nservice ResourceService {\nrpc GetResource(GetResourceRequest) returns (google.api.httpbody);\nrpc UpdateResource(google.api.httpbody) returns\n(google.protobuf.empty);\n}\n\nExample with streaming methods:\n\nservice CaldavService {\nrpc GetCalendar(stream google.api.httpbody)\nreturns (stream google.api.httpbody);\nrpc UpdateCalendar(stream google.api.httpbody)\nreturns (stream google.api.httpbody);\n}\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.", "properties": { "content_type": { "type": "string", "description": "The HTTP Content-Type header value specifying the content type of the body.", "x-f5xc-description-short": "The HTTP Content-Type header value specifying the content type of the body.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "type": "string", "description": "The HTTP request/response body as raw binary.", "format": "byte", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The HTTP request/response body as raw binary.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "extensions": { "type": "array", "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.", "items": { "$ref": "#/components/schemas/protobufAny" }, "x-f5xc-description-short": "Application specific response metadata. Must be set in the first response for streaming APIs.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Message that represents an arbitrary HTTP body.", "x-f5xc-description-medium": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for apiHttpBody", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "bgpBgpPeerProtocolState": { "type": "string", "description": "Status of BGP connection to this Peer\n\nConnection state is not known\nConnection state is Idle\nConnection state is Connecting\nConnection state is Active\nConnection state is Open Sent\nConnection state is Open Confirm\nConnection state is Established\nConnection state is Clearing\nConnection state is Deleted.", "title": "BGP Protocol Status", "enum": [ "Unknown", "Idle", "Connect", "Active", "OpenSent", "OpenConfirm", "Established", "Clearing", "Deleted" ], "default": "Unknown", "x-displayname": "BGP Peer Status.", "x-ves-proto-enum": "ves.io.schema.bgp.BgpPeerProtocolState", "x-f5xc-description-short": "Status of BGP connection to this Peer Connection state is not known Connection state is Idle Connection state is Connecting Connection state is...", "x-f5xc-description-medium": "Status of BGP connection to this Peer Connection state is not known Connection state is Idle Connection state is Connecting Connection state is Active Connection state is Open Sent Connection state is Open Confirm Connection state is Established Connection state is Clearing Connection state is...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpBgpPeerProtocolState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"Unknown\"", "example_yaml": "Unknown\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "bgpBgpPeerUpDownType": { "type": "string", "description": "Indicates the state of BGP Peering session\n\nPeering session is Down (not in Established state)\nPeering session is Up (in Established state)", "title": "BGP Peer States", "enum": [ "BGP_PEER_DOWN", "BGP_PEER_UP" ], "default": "BGP_PEER_DOWN", "x-displayname": "BGP Peer States.", "x-ves-proto-enum": "ves.io.schema.bgp.BgpPeerUpDownType", "x-f5xc-description-short": "Indicates the state of BGP Peering session Peering session is Down (not in Established state) Peering session is Up (in Established state).", "x-f5xc-description-medium": "Indicates the state of BGP Peering session Peering session is Down (not in Established state) Peering session is Up (in Established state).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bgpBgpPeerUpDownType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BGP_PEER_DOWN\"", "example_yaml": "BGP_PEER_DOWN\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "BGP configuration is platform-level routing" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "corev1Node": { "type": "object", "description": "Node is a worker node in Kubernetes.\nEach node will have a unique identifier in the cache (i.e. In etcd).", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1NodeSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1NodeStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e.", "x-f5xc-description-medium": "Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. In etcd).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for corev1Node", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "intstrIntOrString": { "type": "object", "description": "+protobuf=true\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+K8s:openapi-gen=true.", "title": "IntOrString is a type that can hold an int32 or a string. When used in\nJSON or YAML marshalling and unmarshalling, it produces or consumes the\ninner type. This allows you to have, for example, a JSON field that can\naccept a name or number.\nTODO: Rename to Int32OrString", "properties": { "intVal": { "type": "integer", "format": "int32", "description": "Configuration parameter for intVal", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "strVal": { "type": "string", "description": "Configuration parameter for strVal", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "format": "int64", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "+protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +K8s:openapi-gen=true.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for intstrIntOrString", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "resourceQuantity": { "type": "object", "description": "Quantity is a fixed-point representation of a number.\nIt provides convenient marshaling/unmarshaling in JSON and YAML,\nin addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n ::= \n(Note that may be empty, from the \"\" case in .)\n ::= 0 | 1 | ... | 9\n ::= | \n ::= | . | . | .\n ::= \"+\" | \"-\"\n ::= | \n ::= | | \n ::= Ki | Mi | Gi | Ti | Pi | Ei\n(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n ::= m | \"\" | k | M | G | T | P | E\n(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n ::= \"e\" | \"E\" \n\nNo matter which of the three exponent forms is used, no quantity may represent\na number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal\nplaces. Numbers larger or more precise will be capped or rounded up.\n(E.g.: 0.1m will rounded up to 1m.)\nThis may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix\nit had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be PUT in \"canonical form\".\nThis means that Exponent/suffix will be adjusted up or down (with a\ncorresponding increase or decrease in Mantissa) such that:\na. No precision is lost\nb. No fractional digits will be emitted\nc. The exponent (or suffix) is as large as possible.\nThe sign will be omitted unless the number is negative.\n\nExamples:\n1.5 will be serialized as \"1500m\"\n1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a\nfloating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed,\nbut will be RE-emitted in their canonical form. (So always use canonical\nform, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without\nwriting some sort of special handling code in the hopes that that will\ncause implementers to also use a fixed point implementation.\n\n+protobuf=true\n+protobuf.embed=string\n+protobuf.options.marshal=false\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+K8s:deepcopy-gen=true\n+K8s:openapi-gen=true.", "properties": { "string": { "type": "string", "description": "Configuration parameter for string", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Quantity is a fixed-point representation of a number.", "x-f5xc-description-medium": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. The serialization format is: ::= (Note that may be empty, from the \"\" case in...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for resourceQuantity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaCloudLinkState": { "type": "string", "description": "State of the CloudLink connections\n\n- UP: Up\n\nCloudLink and their corresponding Direct Connect connections are up and healthy\n- DOWN: Down\n\nCloudLink and their corresponding Direct Connect connections are down\n- DEGRADED: Degraded\n\nSome of Direct Connect connections with the CloudLink are down\n- NOT_APPLICABLE: NotApplicable\n\nCloudLinkState not applicable.", "title": "CloudLink State", "enum": [ "UP", "DOWN", "DEGRADED", "NOT_APPLICABLE" ], "default": "UP", "x-displayname": "CloudLink State.", "x-ves-proto-enum": "ves.io.schema.CloudLinkState", "x-f5xc-description-short": "State of the CloudLink connections - UP: Up CloudLink and their corresponding Direct Connect connections are up and healthy - DOWN: Down CloudLink...", "x-f5xc-description-medium": "State of the CloudLink connections - UP: Up CloudLink and their corresponding Direct Connect connections are up and healthy - DOWN: Down CloudLink and their corresponding Direct Connect connections are down - DEGRADED: Degraded Some of Direct Connect connections with the CloudLink are down ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaCloudLinkState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UP\"", "example_yaml": "UP\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud link is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaDcClusterGroupStatus__ves_io_schema_site": { "type": "object", "description": "Status of the dc cluster group (this will be used in site status object and dcg status object)", "title": "dc cluster group status", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.DcClusterGroupStatus", "properties": { "site_info": { "type": "array", "description": "The list of sites in the dc cluster group and information about each.", "title": "site_info", "items": { "$ref": "#/components/schemas/schemaSiteInfo__ves_io_schema_site" }, "x-displayname": "Site info", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The list of sites in the dc cluster group and information about each.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Status of the dc cluster group (this will be used in site status object and dcg status object).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaDcClusterGroupStatus", "required_fields": [ "site_info" ], "mutually_exclusive_groups": [], "example_json": "{\n \"site_info\": [\n {\n \"annotations\": [\n \"value\"\n ],\n \"site\": [\n {}\n ]\n }\n ]\n}", "example_yaml": "site_info:\n- annotations:\n - value\n site:\n - {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Data center cluster grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaMetricValue": { "type": "object", "description": "Metric data contains timestamp and the value.", "title": "Metric Value", "x-displayname": "Metric Value.", "x-ves-proto-message": "ves.io.schema.MetricValue", "properties": { "timestamp": { "type": "number", "description": "Timestamp", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1570007981.", "x-f5xc-example": "1570007981", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend_value": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendValue" } ], "x-f5xc-description-short": "Configuration parameter for trend value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "15", "x-f5xc-example": "15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Metric data contains timestamp and the value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaMetricValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaSiteInfo__ves_io_schema_site": { "type": "object", "description": "Information about a particular site.", "title": "Site Info", "x-displayname": "Site Info", "x-ves-proto-message": "ves.io.schema.SiteInfo", "properties": { "annotations": { "type": "array", "description": "The list of annotations providing information about the referenced site.", "title": "annotations", "items": { "type": "string" }, "x-displayname": "Annotations.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The list of annotations providing information about the referenced site.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "site": { "type": "array", "description": "'site' refers to a site.", "title": "site", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Site", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSiteInfo", "required_fields": [ "annotations", "site" ], "mutually_exclusive_groups": [], "example_json": "{\n \"annotations\": [\n \"value\"\n ],\n \"site\": [\n {}\n ]\n}", "example_yaml": "annotations:\n- value\nsite:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaSiteMeshGroupStatus": { "type": "object", "description": "Status of the site mesh group (this will be used in site status object and smg status object)", "title": "Site mesh group status", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.SiteMeshGroupStatus", "properties": { "other_connected_sites": { "type": "array", "description": "List of sites connected by this Site Mesh Group.", "title": "other_connected_sites", "items": { "type": "string" }, "x-displayname": "Other Connected Sites.", "x-ves-example": "[ce01-sfo, ce01-nyc]", "x-f5xc-example": "[ce01-sfo, ce01-nyc]", "x-f5xc-description-short": "List of sites connected by this Site Mesh Group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_info": { "type": "array", "description": "The list of sites in the site mesh group and information about each.", "title": "site_info", "items": { "$ref": "#/components/schemas/schemaSiteInfo__ves_io_schema_site" }, "x-displayname": "Site info", "x-f5xc-description-short": "The list of sites in the site mesh group and information about each.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Status of the site mesh group (this will be used in site status object and smg status object).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSiteMeshGroupStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Site mesh grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaTrendSentiment": { "type": "string", "description": "Trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.", "title": "Trend Sentiment", "enum": [ "TREND_SENTIMENT_NONE", "TREND_SENTIMENT_POSITIVE", "TREND_SENTIMENT_NEGATIVE" ], "default": "TREND_SENTIMENT_NONE", "x-displayname": "Trend Sentiment.", "x-ves-proto-enum": "ves.io.schema.TrendSentiment", "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTrendSentiment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TREND_SENTIMENT_NONE\"", "example_yaml": "TREND_SENTIMENT_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaTrendValue": { "type": "object", "description": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "title": "Trend Value", "x-displayname": "Trend Value.", "x-ves-proto-message": "ves.io.schema.TrendValue", "properties": { "description": { "type": "string", "description": "Description of the method used to calculate trend.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.", "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval", "x-f5xc-description-short": "Description of the method used to calculate trend.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "previous_value": { "type": "string", "description": "Configuration parameter for previous value", "title": "Previous Value", "x-displayname": "Previous Value.", "x-ves-example": "200.00", "x-f5xc-example": "200.00", "x-f5xc-description-short": "Configuration parameter for previous value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendSentiment" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "-15", "x-f5xc-example": "-15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTrendValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaTunnelEncapsulationType": { "type": "string", "description": "Type of tunnel encapsulation\n\nIPsec using public key infrastructure\nIPsec using pre shared key\nSSL encapsulation\nGRE encapsulation.", "title": "TunnelEncapsulationType", "enum": [ "IPSEC_PKI", "IPSEC_PSK", "SSL", "GRE" ], "default": "IPSEC_PKI", "x-displayname": "Tunnel Encapsulation Type.", "x-ves-proto-enum": "ves.io.schema.TunnelEncapsulationType", "x-f5xc-description-short": "Type of tunnel encapsulation IPsec using public key infrastructure IPsec using pre shared key SSL encapsulation GRE encapsulation.", "x-f5xc-description-medium": "Type of tunnel encapsulation IPsec using public key infrastructure IPsec using pre shared key SSL encapsulation GRE encapsulation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTunnelEncapsulationType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"IPSEC_PKI\"", "example_yaml": "IPSEC_PKI\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Tunnel configuration is platform-level infrastructure" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemaUnitType": { "type": "string", "description": "UnitType is enumeration of units for scalar fields.", "title": "UnitType", "enum": [ "UNIT_MILLISECONDS", "UNIT_SECONDS", "UNIT_MINUTES", "UNIT_HOURS", "UNIT_DAYS", "UNIT_BYTES", "UNIT_KBYTES", "UNIT_MBYTES", "UNIT_GBYTES", "UNIT_TBYTES", "UNIT_KIBIBYTES", "UNIT_MIBIBYTES", "UNIT_GIBIBYTES", "UNIT_TEBIBYTES", "UNIT_BITS_PER_SECOND", "UNIT_BYTES_PER_SECOND", "UNIT_KBITS_PER_SECOND", "UNIT_KBYTES_PER_SECOND", "UNIT_MBITS_PER_SECOND", "UNIT_MBYTES_PER_SECOND", "UNIT_CONNECTIONS_PER_SECOND", "UNIT_ERRORS_PER_SECOND", "UNIT_PACKETS_PER_SECOND", "UNIT_REQUESTS_PER_SECOND", "UNIT_PACKETS", "UNIT_PERCENTAGE", "UNIT_COUNT" ], "default": "UNIT_MILLISECONDS", "x-displayname": "Unit", "x-ves-proto-enum": "ves.io.schema.UnitType", "x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaUnitType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNIT_MILLISECONDS\"", "example_yaml": "UNIT_MILLISECONDS\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemasiteGetSpecType": { "type": "object", "description": "GET of site.", "title": "Get Site", "x-displayname": "GET Site", "x-ves-proto-message": "ves.io.schema.site.GetSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "admin_user_credentials": { "allOf": [ { "$ref": "#/components/schemas/viewsAdminUserCredentialsType" } ], "x-f5xc-description-short": "Configuration parameter for admin user credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_peer_address": { "type": "string", "description": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured\nto fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.", "x-displayname": "BGP Peer Address.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object.", "x-f5xc-description-medium": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_router_id": { "type": "string", "description": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to\nfetch BGP router ID from site object. This can be used to change router ID per site in a fleet.", "x-displayname": "BGP Router ID.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.", "x-f5xc-description-medium": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object. This can be used to change router ID per site in a fleet.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "ce_site_mode": { "allOf": [ { "$ref": "#/components/schemas/siteCeSiteMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connected_re": { "type": "array", "description": "Following fields are only for customer edge sites\nList of REs to which to which this CE initiates IPsec/SSL connection to.", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Connected REs.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Following fields are only for customer edge sites List of REs to which to which this CE initiates IPsec/SSL connection to.", "x-f5xc-description-medium": "Following fields are only for customer edge sites List of REs to which to which this CE initiates IPsec/SSL connection to.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "connected_re_for_config": { "type": "array", "description": "This field is valid only for CE site object\nList of REs which can send config to this CE site.", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "REs for Configuration.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Valid only for CE site object List of REs which can send config to this CE site.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_underlay_network": { "allOf": [ { "$ref": "#/components/schemas/siteDefaultUnderlayNetworkType" } ], "x-f5xc-description-short": "Configuration parameter for default underlay network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "desired_pool_count": { "type": "integer", "description": "Desired pool count represent desired number of worker(non master) nodes\nfor manual scaling of public cloud(AWS, GCP, Azure) sites. The desired count\nmust be less than or equal to the maximum size of the scaling group for a\ngiven public cloud. One may also have to increase maximum scaling group size to\neffectively increase desired pool count.", "format": "int32", "x-displayname": "Desired Pool Count.", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.int32.gte": "-1", "ves.io.schema.rules.int32.lte": "64" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.int32.gte": "-1", "ves.io.schema.rules.int32.lte": "64" }, "x-f5xc-description-short": "Desired pool count represent desired number of worker(non master) nodes for manual scaling of public cloud(AWS, GCP, Azure) sites.", "x-f5xc-description-medium": "Desired pool count represent desired number of worker(non master) nodes for manual scaling of public cloud(AWS, GCP, Azure) sites. The desired count must be less than or equal to the maximum size of the scaling group for a given public cloud. One may also have to increase maximum scaling group...", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": -1, "maximum": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "global_access_k8s_enabled": { "type": "boolean", "format": "boolean", "description": "Enable or disable functionality flag", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_nameserver": { "type": "string", "description": "Optional IPv4 DNS server to be used for name resolution in inside network.", "x-displayname": "IPv4 DNS Server for Inside Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional IPv4 DNS server to be used for name resolution in inside network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip": { "type": "string", "description": "Optional Virtual IP to be used as automatic VIP for site local inside network.\nSee documentation for \"VIP\" in advertise policy to see when Inside VIP is used.\nWhen configured, this is used as VIP (depending on advertise policy configuration).\nWhen not configured, site local inside interface IP will be used as VIP.", "x-displayname": "Inside VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional Virtual IP to be used as automatic VIP for site local inside network.", "x-f5xc-description-medium": "Optional Virtual IP to be used as automatic VIP for site local inside network. See documentation for \"VIP\" in advertise policy to see when Inside VIP is used. When configured, this is used as VIP (depending on advertise policy configuration).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ipsec_ssl_nodes_fqdn": { "type": "array", "description": "FQDN resolves to responders node IP, if there are multiple nodes at site the resolution will give\na list of all/some individual node IP. Multiple FQDN for same site is also allowed.", "items": { "type": "string" }, "x-displayname": "FQDN for IPsec/SSL resolving to individual node IP.", "x-ves-example": "re01-node.ves.I/O.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "re01-node.F5 XC", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-description-short": "FQDN resolves to responders node IP, if there are multiple nodes at site the resolution will give a list of all/some individual node IP.", "x-f5xc-description-medium": "FQDN resolves to responders node IP, if there are multiple nodes at site the resolution will give a list of all/some individual node IP. Multiple FQDN for same site is also allowed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_access_k8s_enabled": { "type": "boolean", "format": "boolean", "description": "Enable or disable functionality flag", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local_k8s_access_enabled": { "type": "boolean", "description": "Lets user know if this site has local K8s cluster enabled via fleet configuration.", "format": "boolean", "x-displayname": "Local K8s Cluster Access Enabled.", "x-f5xc-description-short": "Lets user know if this site has local K8s cluster enabled via fleet configuration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "main_nodes": { "type": "array", "description": "Connectivity information of main/master nodes to create a full mesh of Phobos services across all CEs in a site-mesh-group or dc-cluster-group.", "items": { "$ref": "#/components/schemas/schemasiteNode" }, "x-displayname": "Main Nodes.", "x-f5xc-description-short": "Connectivity information of main/master nodes to create a full mesh of Phobos services across all CEs in a site-mesh-group or dc-cluster-group.", "x-f5xc-description-medium": "Connectivity information of main/master nodes to create a full mesh of Phobos services across all CEs in a site-mesh-group or dc-cluster-group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "multus_enabled": { "type": "boolean", "description": "Indicates that Multus cni is enabled on the site.", "format": "boolean", "x-displayname": "Multus support enabled.", "x-f5xc-description-short": "Indicates that Multus cni is enabled on the site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operating_system_version": { "type": "string", "description": "Desired Operating System version for this site.", "x-displayname": "Operating System Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Desired Operating System version for this site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_nameserver": { "type": "string", "description": "Optional IPv4 DNS server to be used for name resolution in outside network.", "x-displayname": "IPv4 DNS Server for Outside Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional IPv4 DNS server to be used for name resolution in outside network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip": { "type": "string", "description": "Optional Virtual IP to be used as automatic VIP for site local outside network.\nSee documentation for \"VIP\" in advertise policy to see when Outside VIP is used.\nWhen configured, this is used as VIP (depending on advertise policy configuration).\nWhen not configured, site local interface IP will be used as VIP.", "x-displayname": "Outside VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional Virtual IP to be used as automatic VIP for site local outside network.", "x-f5xc-description-medium": "Optional Virtual IP to be used as automatic VIP for site local outside network. See documentation for \"VIP\" in advertise policy to see when Outside VIP is used. When configured, this is used as VIP (depending on advertise policy configuration).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_connectivity": { "allOf": [ { "$ref": "#/components/schemas/viewsPrivateConnectivityType" } ], "x-f5xc-description-short": "Configuration parameter for private connectivity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "re_select": { "allOf": [ { "$ref": "#/components/schemas/viewsRegionalEdgeSelection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "string", "description": "Cloud Region. A region is a set of datacenters deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.", "x-displayname": "Region", "x-ves-example": "East-us-2", "x-f5xc-example": "east-us-2", "x-f5xc-description-medium": "Cloud Region. A region is a set of datacenters deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_subtype": { "allOf": [ { "$ref": "#/components/schemas/siteSiteSubtype" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_to_site_network_type": { "allOf": [ { "$ref": "#/components/schemas/schemaVirtualNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_to_site_tunnel_ip": { "type": "string", "description": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.", "x-displayname": "Site To Site Tunnel IP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.", "x-f5xc-description-medium": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_type": { "allOf": [ { "$ref": "#/components/schemas/siteSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/schemaSiteToSiteTunnelType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_params_per_az": { "type": "array", "description": "Optional Publish VIP Parameters Per AZ for public cloud sites.\nSee documentation for \"VIP\" in advertise policy to see when Inside VIP or Outside VIP is used.\nWhen configured, the VIP(s) defined will be used to publish to external systems like K8s, Consul.", "items": { "$ref": "#/components/schemas/sitePublishVIPParamsPerAz__ves_io_schema_views_aws_tgw_site" }, "x-displayname": "Publish VIP Params Per AZ.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.num_items": "0,1,2,3" }, "x-validation-rules": { "ves.io.schema.rules.repeated.num_items": "0,1,2,3" }, "x-f5xc-description-short": "Optional Publish VIP Parameters Per AZ for public cloud sites.", "x-f5xc-description-medium": "Optional Publish VIP Parameters Per AZ for public cloud sites. See documentation for \"VIP\" in advertise policy to see when Inside VIP or Outside VIP is used. When configured, the VIP(s) defined will be used to publish to external systems like K8s, Consul.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_vrrp_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaVipVrrpType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vm_enabled": { "type": "boolean", "description": "Indicates that virtual machine support is enabled on the site.", "format": "boolean", "x-displayname": "Virtual Machine support enabled.", "x-f5xc-description-short": "Indicates that virtual machine support is enabled on the site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_software_override": { "allOf": [ { "$ref": "#/components/schemas/siteSiteSoftwareOverrideType" } ], "x-f5xc-wire-name": "volterra_software_overide", "description": "Configuration parameter for volterra software override", "x-f5xc-description-short": "Configuration parameter for volterra software override.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_software_version": { "type": "string", "description": "Desired F5XC software version for this site, a string matching released set of software components.", "x-displayname": "Software Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Desired F5XC software version for this site, a string matching released set of software components.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasiteGetSpecType", "required_fields": [ "connected_re", "connected_re_for_config" ], "mutually_exclusive_groups": [], "example_json": "{\n \"connected_re\": [\n {}\n ],\n \"connected_re_for_config\": [\n {}\n ]\n}", "example_yaml": "connected_re:\n- {}\nconnected_re_for_config:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemasiteNode": { "type": "object", "description": "Node Information for connectivity across sites.", "title": "Node", "x-displayname": "Node", "x-ves-proto-message": "ves.io.schema.site.Node", "properties": { "name": { "type": "string", "description": "Name of the master/main node on the site.", "title": "name", "x-displayname": "Node name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the master/main node on the site.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "sli_address": { "type": "string", "description": "Site Local Inside IP address.", "title": "sli_address", "x-displayname": "Site Local Inside IP addresses.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "slo_address": { "type": "string", "description": "Site Local Outside IP address.", "title": "slo_address", "x-displayname": "Site Local Outside IP addresses.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Node Information for connectivity across sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasiteNode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemasiteReplaceSpecType": { "type": "object", "description": "Replace Site will replace address, coordinates of site.", "title": "Replace Site", "x-displayname": "Replace Site.", "x-ves-displayorder": "4,127,2,3,173,125,114,120,121,117,118,123,124,122,126,115", "x-ves-proto-message": "ves.io.schema.site.ReplaceSpecType", "properties": { "address": { "type": "string", "description": "Site's geographical address that can be used to determine its latitude and longitude.", "maxLength": 256, "x-displayname": "Geographical Address.", "x-ves-example": "123 Street, city, country, postal code.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "123 Street, city, country, postal code", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Site's geographical address that can be used to determine its latitude and longitude.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_peer_address": { "type": "string", "description": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured\nto fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.", "x-displayname": "BGP Peer Address.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object.", "x-f5xc-description-medium": "Optional BGP peer address that can be used as parameter for BGP configuration when BGP is configured to fetch BGP peer address from site Object. This can be used to change peer address per site in fleet.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_router_id": { "type": "string", "description": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to\nfetch BGP router ID from site object. This can be used to change router ID per site in a fleet.", "x-displayname": "BGP Router ID.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object.", "x-f5xc-description-medium": "Optional BGP router ID that can be used as parameter for BGP configuration when BGP is configured to fetch BGP router ID from site object. This can be used to change router ID per site in a fleet.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_views_aws_tgw_site" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_underlay_network": { "allOf": [ { "$ref": "#/components/schemas/siteDefaultUnderlayNetworkType" } ], "x-f5xc-description-short": "Configuration parameter for default underlay network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "desired_pool_count": { "type": "integer", "description": "Desired pool count represent desired number of worker(non master) nodes\nfor manual scaling of public cloud(AWS, GCP, Azure) sites. The desired count\nmust be less than or equal to the maximum size of the scaling group for a\ngiven public cloud. One may also have to increase maximum scaling group size to\neffectively increase desired pool count.", "format": "int32", "x-displayname": "Desired Pool Count.", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.int32.gte": "-1", "ves.io.schema.rules.int32.lte": "64" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.int32.gte": "-1", "ves.io.schema.rules.int32.lte": "64" }, "x-f5xc-description-short": "Desired pool count represent desired number of worker(non master) nodes for manual scaling of public cloud(AWS, GCP, Azure) sites.", "x-f5xc-description-medium": "Desired pool count represent desired number of worker(non master) nodes for manual scaling of public cloud(AWS, GCP, Azure) sites. The desired count must be less than or equal to the maximum size of the scaling group for a given public cloud. One may also have to increase maximum scaling group...", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": -1, "maximum": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_nameserver": { "type": "string", "description": "Optional IPv4 DNS server to be used for name resolution in inside network.", "x-displayname": "IPv4 DNS Server for Inside Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional IPv4 DNS server to be used for name resolution in inside network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inside_vip": { "type": "string", "description": "Optional Virtual IP to be used as automatic VIP for site local inside network.\nSee documentation for \"VIP\" in advertise policy to see when Inside VIP is used.\nWhen configured, this is used as VIP (depending on advertise policy configuration).\nWhen not configured, site local inside interface IP will be used as VIP.", "x-displayname": "Inside VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional Virtual IP to be used as automatic VIP for site local inside network.", "x-f5xc-description-medium": "Optional Virtual IP to be used as automatic VIP for site local inside network. See documentation for \"VIP\" in advertise policy to see when Inside VIP is used. When configured, this is used as VIP (depending on advertise policy configuration).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kubernetes_upgrade_drain": { "allOf": [ { "$ref": "#/components/schemas/viewsKubernetesUpgradeDrain" } ], "x-f5xc-description-short": "Configuration parameter for kubernetes upgrade drain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operating_system_version": { "type": "string", "description": "Desired Operating System version for this site.", "x-displayname": "Operating System Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Desired Operating System version for this site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_nameserver": { "type": "string", "description": "Optional IPv4 DNS server to be used for name resolution in outside network.", "x-displayname": "IPv4 DNS Server for Outside Network.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional IPv4 DNS server to be used for name resolution in outside network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "outside_vip": { "type": "string", "description": "Optional Virtual IP to be used as automatic VIP for site local outside network.\nSee documentation for \"VIP\" in advertise policy to see when Outside VIP is used.\nWhen configured, this is used as VIP (depending on advertise policy configuration).\nWhen not configured, site local interface IP will be used as VIP.", "x-displayname": "Outside VIP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optional Virtual IP to be used as automatic VIP for site local outside network.", "x-f5xc-description-medium": "Optional Virtual IP to be used as automatic VIP for site local outside network. See documentation for \"VIP\" in advertise policy to see when Outside VIP is used. When configured, this is used as VIP (depending on advertise policy configuration).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "string", "description": "Cloud Region. A region is a set of datacenters deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.", "x-displayname": "Region", "x-ves-example": "East-us-2", "x-f5xc-example": "east-us-2", "x-f5xc-description-medium": "Cloud Region. A region is a set of datacenters deployed within a latency-defined perimeter and connected through a dedicated regional low-latency network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_to_site_network_type": { "allOf": [ { "$ref": "#/components/schemas/schemaVirtualNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_to_site_tunnel_ip": { "type": "string", "description": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.", "x-displayname": "Site To Site Tunnel IP.", "x-ves-example": "192.0.2.14.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.14", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.", "x-f5xc-description-medium": "Optionsl, VIP in the site_to_site_network_type configured above used for terminating IPsec/SSL tunnels created with SiteMeshGroup.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_dead_timeout": { "type": "integer", "description": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.\nWhen not set (== 0), a default value of 10000 msec will be used.", "format": "int64", "x-displayname": "Tunnel Dead Timeout (msec)", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "180000" }, "x-f5xc-description-short": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected.", "x-f5xc-description-medium": "Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 180000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/schemaSiteToSiteTunnelType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vip_vrrp_mode": { "allOf": [ { "$ref": "#/components/schemas/schemaVipVrrpType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_software_override": { "allOf": [ { "$ref": "#/components/schemas/siteSiteSoftwareOverrideType" } ], "x-f5xc-wire-name": "volterra_software_overide", "description": "Configuration parameter for volterra software override", "x-f5xc-description-short": "Configuration parameter for volterra software override.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_software_version": { "type": "string", "description": "Desired F5XC software version for this site, a string matching released set of software components.", "x-displayname": "Software Version.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Desired F5XC software version for this site, a string matching released set of software components.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Replace Site will replace address, coordinates of site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasiteReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSElasticIPAllocationStatusType": { "type": "object", "description": "AWS Elastic IP Allocation.", "title": "AWS Elastic IP", "x-displayname": "AWS Elastic IP Allocation.", "x-ves-proto-message": "ves.io.schema.site.AWSElasticIPAllocationStatusType", "properties": { "allocation_id": { "type": "string", "description": "Allocation ID.", "title": "Allocation ID", "x-displayname": "Allocation ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "association_id": { "type": "string", "description": "Association ID.", "title": "Association ID", "x-displayname": "Association ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "private_address": { "type": "string", "description": "Private IP address.", "title": "Private IP address", "x-displayname": "Private IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_address": { "type": "string", "description": "Allocated IPv4 address.", "title": "Allocated IPv4 address", "x-displayname": "Allocated IPv4 address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSElasticIPAllocationStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSInstanceStatusType": { "type": "object", "description": "AWS Instance Status Type.", "title": "AWS Instance Status Type", "x-displayname": "AWS Instance Status Type.", "x-ves-proto-message": "ves.io.schema.site.AWSInstanceStatusType", "properties": { "ami_id": { "type": "string", "description": "AMI ID", "title": "AMI ID", "x-displayname": "AMI ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "host_name": { "type": "string", "description": "Hostname", "title": "HostName", "x-displayname": "HostName", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "instance_id": { "type": "string", "description": "Instance ID.", "title": "Instance ID", "x-displayname": "Instance ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "instance_type": { "type": "string", "description": "Instance Type.", "title": "Instance Type", "x-displayname": "Instance Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_status": { "type": "array", "description": "Network Interface Status.", "title": "Network Interface Status", "items": { "$ref": "#/components/schemas/siteAWSNetworkInterfaceStatusType" }, "x-displayname": "Network Interface Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volume_status": { "allOf": [ { "$ref": "#/components/schemas/siteAWSVolumeStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSInstanceStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSNetworkInterfaceStatusType": { "type": "object", "description": "AWS Network Interface Status Type.", "title": "AWS Network Interface Status Type", "x-displayname": "AWS Network Interface Status.", "x-ves-proto-message": "ves.io.schema.site.AWSNetworkInterfaceStatusType", "properties": { "attachment_id": { "type": "string", "description": "Attachment ID.", "title": "Attachment ID", "x-displayname": "Attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "availablity_zone": { "type": "string", "description": "Availability Zone.", "title": "Availability Zone", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "elastic_ip_status": { "allOf": [ { "$ref": "#/components/schemas/siteAWSElasticIPAllocationStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_type": { "type": "string", "title": "Interface type", "x-displayname": "Interface type.", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_interface_id": { "type": "string", "description": "Network Interface ID.", "title": "Network Interface ID", "x-displayname": "Network Interface ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "network_type": { "allOf": [ { "$ref": "#/components/schemas/siteNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_ip": { "type": "string", "description": "Private IP.", "title": "Private IP", "x-displayname": "Private IP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "security_group": { "type": "string", "description": "Security Group.", "title": "Security Group", "x-displayname": "Security Group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet_id": { "type": "string", "description": "Subnet ID", "title": "Subnet ID", "x-displayname": "Subnet ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSNetworkInterfaceStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSOrchestrationStatusType": { "type": "object", "description": "AWS Managed Sites Orchestration Status.", "title": "AWS Site Orchestration Status Type", "x-displayname": "AWS Site Orchestration Status Type.", "x-ves-proto-message": "ves.io.schema.site.AWSOrchestrationStatusType", "properties": { "instance_status": { "type": "array", "description": "AWS Instance Status.", "title": "Instance Status", "items": { "$ref": "#/components/schemas/siteAWSInstanceStatusType" }, "x-displayname": "AWS Instance Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_validation": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for replace validation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_vpc_status": { "allOf": [ { "$ref": "#/components/schemas/siteAWSSiteVPCStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet_status": { "type": "array", "description": "AWS Subnet Status.", "title": "Subnet Status", "items": { "$ref": "#/components/schemas/siteAWSSubnetStatusType" }, "x-displayname": "Subnet Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_status": { "allOf": [ { "$ref": "#/components/schemas/siteAWSTransitGatewayStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSOrchestrationStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSRouteTableStatusType": { "type": "object", "description": "AWS route table ID.", "title": "AWS Route Table ID", "x-displayname": "AWS Route Table ID.", "x-ves-proto-message": "ves.io.schema.site.AWSRouteTableStatusType", "properties": { "route_table_id": { "type": "string", "description": "Route Table ID.", "title": "Route Table ID", "x-displayname": "Route Table ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet_id": { "type": "string", "description": "Subnet ID", "title": "Subnet ID", "x-displayname": "Subnet ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSRouteTableStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSSiteVPCStatusType": { "type": "object", "description": "AWS Site VPC Status.", "title": "AWS Site VPC Status", "x-displayname": "Site VPC Status.", "x-ves-proto-message": "ves.io.schema.site.AWSSiteVPCStatusType", "properties": { "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_cidr": { "type": "string", "description": "VPC CIDR", "title": "VPC CIDR", "x-displayname": "VPC CIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vpc_owner_id": { "type": "string", "description": "VPC Owner ID.", "title": "VPC Owner ID", "x-displayname": "VPC Owner ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSSiteVPCStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSSubnetStatusType": { "type": "object", "description": "AWS Subnet Status Type.", "title": "AWS Subnet Status Type", "x-displayname": "AWS Subnet Status Type.", "x-ves-proto-message": "ves.io.schema.site.AWSSubnetStatusType", "properties": { "availablity_zone": { "type": "string", "description": "Availability Zone.", "title": "Availability Zone", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr": { "type": "string", "description": "Subnet CIDR.", "title": "CIDR", "x-displayname": "Subnet CIDR.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 9, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}/(3[0-2]|[12]?[0-9])$", "format": "cidr", "formatDescription": "CIDR notation (e.g., 10.0.0.0/24)", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_table": { "allOf": [ { "$ref": "#/components/schemas/siteAWSRouteTableStatusType" } ], "x-f5xc-description-short": "Configuration parameter for route table.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet_id": { "type": "string", "description": "Subnet ID", "title": "Subnet ID", "x-displayname": "Subnet ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSSubnetStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSTransitGatewayAttachmentResourceType": { "type": "string", "description": "AWS Transit Gateway Attachment Resource Type\n\n- VPC: VPC Resource Type\n- VPN: VPN Resource Type\n- DIRECT_CONNECT_GATEWAY: Direct Connect Gateway Resource Type\n- CONNECT: Connect Resource Type\n- PEERING: Peering Resource Type\n- TGW_PEERING: TGW Peering Resource Type\n- NETWORK_FUNCTION: Network Function Resource Type.", "title": "AWS Transit Gateway Attachment Resource Type", "enum": [ "VPC", "VPN", "DIRECT_CONNECT_GATEWAY", "CONNECT", "PEERING", "TGW_PEERING", "NETWORK_FUNCTION" ], "default": "VPC", "x-displayname": "AWS Transit Gateway Attachment Resource Type.", "x-ves-proto-enum": "ves.io.schema.site.AWSTransitGatewayAttachmentResourceType", "x-f5xc-description-short": "AWS Transit Gateway Attachment Resource Type - VPC: VPC Resource Type - VPN: VPN Resource Type - DIRECT_CONNECT_GATEWAY: Direct Connect Gateway...", "x-f5xc-description-medium": "AWS Transit Gateway Attachment Resource Type - VPC: VPC Resource Type - VPN: VPN Resource Type - DIRECT_CONNECT_GATEWAY: Direct Connect Gateway Resource Type - CONNECT: Connect Resource Type - PEERING: Peering Resource Type - TGW_PEERING: TGW Peering Resource Type - NETWORK_FUNCTION: Network...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSTransitGatewayAttachmentResourceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VPC\"", "example_yaml": "VPC\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSTransitGatewayAttachmentStatusType": { "type": "object", "description": "AWS Transit Gateway Attachment Status Type.", "title": "AWS Transit Gateway Attachment Status Type", "x-displayname": "AWS Transit Gateway Attachment Status Type.", "x-ves-proto-message": "ves.io.schema.site.AWSTransitGatewayAttachmentStatusType", "properties": { "resource_id": { "type": "string", "title": "Attachment Resource ID", "x-displayname": "Attachment Resource ID.", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_owner_id": { "type": "string", "description": "Resource Owner ID.", "title": "Resource Owner ID", "x-displayname": "Resource Owner ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_type": { "allOf": [ { "$ref": "#/components/schemas/siteAWSTransitGatewayAttachmentResourceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_attachment_id": { "type": "string", "description": "TGW Attachment ID.", "title": "TGW Attachment ID", "x-displayname": "TGW Attachment ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "AWS Transit Gateway Attachment Status Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSTransitGatewayAttachmentStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSTransitGatewayStatus": { "type": "object", "description": "AWS Transit Gateway Status.", "title": "AWS Transit Gateway Status", "x-displayname": "AWS Transit Gateway Status.", "x-ves-proto-message": "ves.io.schema.site.AWSTransitGatewayStatus", "properties": { "amazon_asn": { "type": "string", "description": "Amazon ASN.", "title": "Amazon ASN", "format": "uint64", "x-displayname": "Amazon ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr_blocks": { "type": "array", "description": "Transit gateway CIDR blocks.", "title": "Transit gateway CIDR blocks", "items": { "type": "string" }, "x-displayname": "Transit gateway CIDR blocks.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "owner_id": { "type": "string", "description": "Owner ID", "title": "Owner ID", "x-displayname": "Owner ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "site_vpc_attachment_state": { "allOf": [ { "$ref": "#/components/schemas/siteAWSTransitGatewayAttachmentStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSTransitGatewayStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSVolumeEncryptionStatusType": { "type": "object", "description": "AWS Volume Encryption Status Type.", "title": "AWS Volume Encryption Status Type", "x-displayname": "AWS Volume Encryption Status Type.", "x-ves-proto-message": "ves.io.schema.site.AWSVolumeEncryptionStatusType", "properties": { "encrypted_enabled": { "type": "boolean", "description": "Volume Encryption Status.", "title": "Volume Encryption Status", "format": "boolean", "x-displayname": "Volume Encryption Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kms_key_arn": { "type": "string", "description": "KMS Key Arn.", "title": "KMS Key arn", "x-displayname": "KMS Key ARN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSVolumeEncryptionStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAWSVolumeStatusType": { "type": "object", "description": "AWS Elastic Block Storage.", "title": "AWS Elastic Block Storage", "x-displayname": "AWS Elastic Block Storage.", "x-ves-proto-message": "ves.io.schema.site.AWSVolumeStatusType", "properties": { "availability_zone": { "type": "string", "description": "Availability Zone.", "title": "Availability Zone", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disk_size": { "type": "string", "description": "Disk Size", "title": "Disk Size", "x-displayname": "Disk Size", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "encryption": { "allOf": [ { "$ref": "#/components/schemas/siteAWSVolumeEncryptionStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteCloudResourceState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Tags for categorization and filtering", "title": "Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Volume Type.", "title": "Volume Type", "x-displayname": "Volume Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeID": { "type": "string", "description": "Volume ID", "title": "Volume ID", "x-displayname": "Volume ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAWSVolumeStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteActiveState": { "type": "string", "description": "Active/Backup state for the interface\n\nUnknown state\nInterface in active state\nInterface in backup state.", "title": "Active State", "enum": [ "STATE_UNKNOWN", "STATE_ACTIVE", "STATE_BACKUP" ], "default": "STATE_UNKNOWN", "x-displayname": "Active State.", "x-ves-proto-enum": "ves.io.schema.site.ActiveState", "x-f5xc-description-short": "Active/Backup state for the interface Unknown state Interface in active state Interface in backup state.", "x-f5xc-description-medium": "Active/Backup state for the interface Unknown state Interface in active state Interface in backup state.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteActiveState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATE_UNKNOWN\"", "example_yaml": "STATE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAddressMode": { "type": "string", "description": "AddressMode identifies the mode of address assignment on an interface\n\n- STATIC: Static\n\nInterface Address is assigned statically\n- DHCP: DHCP\n\nInterface Address is obtained via DHCP.", "title": "Interface Address Mode", "enum": [ "STATIC", "DHCP" ], "default": "STATIC", "x-displayname": "AddressMode.", "x-ves-proto-enum": "ves.io.schema.site.AddressMode", "x-f5xc-description-short": "AddressMode identifies the mode of address assignment on an interface - STATIC: Static Interface Address is assigned statically - DHCP: DHCP...", "x-f5xc-description-medium": "AddressMode identifies the mode of address assignment on an interface - STATIC: Static Interface Address is assigned statically - DHCP: DHCP Interface Address is obtained via DHCP.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAddressMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATIC\"", "example_yaml": "STATIC\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAresConnectionStatus": { "type": "object", "description": "Status of Ares Connection.", "title": "Ares Connection Status", "x-displayname": "Ares Connection Status.", "x-ves-proto-message": "ves.io.schema.site.AresConnectionStatus", "properties": { "state": { "allOf": [ { "$ref": "#/components/schemas/siteVTRPState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "URL identifies the Ares server.", "title": "url", "x-displayname": "URL", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAresConnectionStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAzureExpressRouteCircuitStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.AzureExpressRouteCircuitStatusType", "properties": { "express_route_circuit_id": { "type": "string", "description": "Express Route Circuit ID.", "title": "Express Route Circuit ID", "x-displayname": "Express Route Circuit ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "express_route_circuit_name": { "type": "string", "description": "Express Route Circuit Name.", "title": "Express Route Circuit Name", "x-displayname": "Express Route Circuit Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "express_route_circuit_state": { "type": "string", "description": "Express Route Provisioning State.", "title": "Express Route Provisioning State", "x-displayname": "Express Route Circuit Provisioning State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "express_route_connection_name": { "type": "string", "description": "Express Route Connection Name.", "title": "Express Route Connection Name", "x-displayname": "Express Route Connection Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "express_route_connection_status": { "type": "string", "description": "Express Route Connection Status.", "title": "Express Route Connection Status", "x-displayname": "Express Route Connection Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering": { "allOf": [ { "$ref": "#/components/schemas/siteExpressRoutePeeringStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAzureExpressRouteCircuitStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAzureExpressRouteStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.AzureExpressRouteStatusType", "properties": { "propagated_routes_from_azure_express_route": { "type": "array", "description": "Propagated Routes from Azure Express Route.", "title": "Propagated Routes from Azure Express Route", "items": { "type": "string" }, "x-displayname": "Propagated Routes from Azure Express Route.", "x-f5xc-description-short": "Propagated Routes from Azure Express Route.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_server_status": { "allOf": [ { "$ref": "#/components/schemas/siteRouteServerStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet_gateway_status": { "allOf": [ { "$ref": "#/components/schemas/siteVnetGatewayStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAzureExpressRouteStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAzureHubSpokeVnetPeeringStatusInfo": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.AzureHubSpokeVnetPeeringStatusInfo", "properties": { "hub_vnet": { "allOf": [ { "$ref": "#/components/schemas/siteAzureVNetToVnetPeeringStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spoke_vnets": { "type": "array", "description": "Spoke VNETs.", "title": "Spoke VNETs", "items": { "$ref": "#/components/schemas/siteAzureVNetToVnetPeeringStatus" }, "x-displayname": "Spoke VNETs.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAzureHubSpokeVnetPeeringStatusInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAzureVNetToVnetPeeringStatus": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.AzureVNetToVnetPeeringStatus", "properties": { "peers": { "type": "array", "description": "Configuration parameter for peers", "title": "Peers", "items": { "$ref": "#/components/schemas/siteAzureVnetPeeringStateType" }, "x-displayname": "Peers", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_association_state": { "type": "string", "description": "Remote Route association State.", "title": "Remote Route association State", "x-displayname": "Route association State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet_info": { "allOf": [ { "$ref": "#/components/schemas/viewsAzureVnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAzureVNetToVnetPeeringStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteAzureVnetPeeringStateType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.AzureVnetPeeringStateType", "properties": { "peering_state": { "type": "string", "description": "Azure VNet Peering State.", "title": "Azure VNET Peering State", "x-displayname": "Azure VNet Peering State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering_sync_level": { "type": "string", "description": "Azure VNet Peering Sync Level.", "title": "Azure VNET Peering Sync Level", "x-displayname": "Azure VNet Peering Sync Level.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "provisioning_state": { "type": "string", "description": "Provisioning State.", "title": "Provisioning State", "x-displayname": "Provisioning State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "remote_vnet_id": { "type": "string", "description": "Remote VNet ID.", "title": "Remote VNET ID", "x-displayname": "Remote VNet ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteAzureVnetPeeringStateType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteBios": { "type": "object", "description": "BIOS information.", "title": "Bios Data", "x-displayname": "Bios Data", "x-ves-proto-message": "ves.io.schema.site.Bios", "properties": { "date": { "type": "string", "description": "Information from /sys/class/dmi/ID/bios_date.", "title": "date", "x-displayname": "Date", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "minLength": 10, "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "format": "date", "formatDescription": "ISO 8601 date (e.g., 2026-01-19)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Information from /sys/class/dmi/ID/bios_vendor.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_vendor.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Information from /sys/class/dmi/ID/bios_version.", "title": "version", "x-displayname": "Version", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteBios", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteBoard": { "type": "object", "description": "Board information.", "title": "Board Details", "x-displayname": "Board Details.", "x-ves-proto-message": "ves.io.schema.site.Board", "properties": { "asset_tag": { "type": "string", "description": "Information from /sys/class/dmi/ID/board_asset_tag.", "title": "asset_tag", "x-displayname": "Asset Tag", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_asset_tag.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Information from /sys/class/dmi/ID/board_name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "serial": { "type": "string", "description": "Information from /sys/class/dmi/ID/board_serial.", "title": "serial", "x-displayname": "Serial Number.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_serial.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Information from /sys/class/dmi/ID/board_vendor.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_vendor.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Information from /sys/class/dmi/ID/board_version.", "title": "version", "x-displayname": "Version", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteBoard", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteBondMembersType": { "type": "object", "description": "BondMembersType represents the bond interface members along with the corresponding link state.", "title": "Bond Interface Members", "x-displayname": "Bond Interface Members.", "x-ves-proto-message": "ves.io.schema.site.BondMembersType", "properties": { "link_speed": { "type": "integer", "description": "Link speed of Bond Interface Member in Mbps.", "title": "Link Speed\nx-displayName: \"Link Speed in Mbps\"\nLink speed of Bond Interface Member in Mbps", "format": "int64", "x-displayname": "Link Speed in Mbps.", "x-f5xc-description-short": "Link speed of Bond Interface Member in Mbps.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_state": { "type": "boolean", "description": "Link state of Bond Interface Member.", "title": "Link State\nx-displayName: \"Link State\"\nLink state of Bond Interface Member", "format": "boolean", "x-displayname": "Link State.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the Bond Interface Member.", "title": "Name\nx-displayName: \"Name\"\nName of the Bond Interface Member", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "BondMembersType represents the bond interface members along with the corresponding link state.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteBondMembersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCeSiteMode": { "type": "string", "description": "If Site is CE, it can be in following modes\n\nIngress Egress Gateway CE\nIngress Gateway CE\nEgress Gateway CE\nDC Cloud Gateway CE\nCPE CE.", "title": "CeSiteMode", "enum": [ "CE_SITE_MODE_INGRESS_EGRESS_GW", "CE_SITE_MODE_INGRESS_GW", "CE_SITE_MODE_EGRESS_GW", "CE_SITE_MODE_DC_CLOUD_GW", "CE_SITE_MODE_CPE" ], "default": "CE_SITE_MODE_INGRESS_EGRESS_GW", "x-displayname": "Customer Edge Site Mode.", "x-ves-proto-enum": "ves.io.schema.site.CeSiteMode", "x-f5xc-description-short": "If Site is CE, it can be in following modes Ingress Egress Gateway CE Ingress Gateway CE Egress Gateway CE DC Cloud Gateway CE CPE CE.", "x-f5xc-description-medium": "If Site is CE, it can be in following modes Ingress Egress Gateway CE Ingress Gateway CE Egress Gateway CE DC Cloud Gateway CE CPE CE.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCeSiteMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"CE_SITE_MODE_INGRESS_EGRESS_GW\"", "example_yaml": "CE_SITE_MODE_INGRESS_EGRESS_GW\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteChassis": { "type": "object", "description": "Chassis information.", "title": "Chassis Details", "x-displayname": "Chassis Details.", "x-ves-proto-message": "ves.io.schema.site.Chassis", "properties": { "asset_tag": { "type": "string", "description": "Information from /sys/class/dmi/ID/chassis_asset_tag.", "title": "asset_tag", "x-displayname": "Asset Tag", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_asset_tag.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "serial": { "type": "string", "description": "Information from /sys/class/dmi/ID/chassis_serial.", "title": "serial", "x-displayname": "Serial Number.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_serial.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "integer", "description": "Information from /sys/class/dmi/ID/chassis_type.", "title": "type", "format": "int64", "x-displayname": "Type", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Information from /sys/class/dmi/ID/chassis_vendor.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_vendor.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Information from /sys/class/dmi/ID/chassis_version.", "title": "version", "x-displayname": "Version", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteChassis", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCheckSiteExistRequest": { "type": "object", "description": "Request to GET status for a site.", "title": "Check Site Exist Request", "x-displayname": "Check Site Exist Request.", "x-ves-proto-message": "ves.io.schema.site.CheckSiteExistRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered.\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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570007981.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570007981", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric collection from which data will be considered.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the site.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Ce01", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ce01", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered.\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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570007981.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570007981", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of metric collection from which data will be considered.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCheckSiteExistRequest", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"ce01\"\n}", "example_yaml": "name: ce01" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCheckSiteExistResponse": { "type": "object", "description": "Response for the Check Site Exist Request.", "title": "Check Site Exist Response", "x-displayname": "Check Site Exist Response.", "x-ves-proto-message": "ves.io.schema.site.CheckSiteExistResponse", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/siteSiteStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Response for the Check Site Exist Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCheckSiteExistResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCloudResourceState": { "type": "string", "description": "Cloud Resource Deployment State\n\n- RESOURCE_STATE_NONE: None\n\nNone\n- RESOURCE_DEPLOYMENT_IN_PROGRESS: In Progress\n\nResource deployment is in flight.\n- RESOURCE_IS_AVAILABLE: Available\n\nResource is deployed and is in available state.\n- RESOURCE_DEPLOYMENT_HAS_FAILED: Failed\n\nResource deployment has failed.\n- RESOURCE_IS_DELETING: Deleting\n\nResource being deleted\n- RESOURCE_IS_DELETED: Deleted\n\nResource is deleted\n- RESOURCE_DELETION_FAILED: Resource Failed to DELETE\n\nFailed to DELETE\n- INVALID_RESOURCE: INVALID\n\nResource is invalid and does not exists on the cloud\n- VALID_RESOURCE: VALID\n\nResource is valid and found on the cloud.", "title": "Cloud Resource Deployment State", "enum": [ "RESOURCE_STATE_NONE", "RESOURCE_DEPLOYMENT_IN_PROGRESS", "RESOURCE_IS_AVAILABLE", "RESOURCE_DEPLOYMENT_HAS_FAILED", "RESOURCE_IS_DELETING", "RESOURCE_IS_DELETED", "RESOURCE_DELETION_FAILED", "INVALID_RESOURCE", "VALID_RESOURCE" ], "default": "RESOURCE_STATE_NONE", "x-displayname": "Cloud Resource Deployment State.", "x-ves-proto-enum": "ves.io.schema.site.CloudResourceState", "x-f5xc-description-short": "Cloud Resource Deployment State - RESOURCE_STATE_NONE: None None - RESOURCE_DEPLOYMENT_IN_PROGRESS: In Progress Resource deployment is in flight...", "x-f5xc-description-medium": "Cloud Resource Deployment State - RESOURCE_STATE_NONE: None None - RESOURCE_DEPLOYMENT_IN_PROGRESS: In Progress Resource deployment is in flight. - RESOURCE_IS_AVAILABLE: Available Resource is deployed and is in available state. - RESOURCE_DEPLOYMENT_HAS_FAILED: Failed Resource deployment has...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCloudResourceState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"RESOURCE_STATE_NONE\"", "example_yaml": "RESOURCE_STATE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCpu": { "type": "object", "description": "CPU information.", "title": "Cpu information", "x-displayname": "CPU Information.", "x-ves-proto-message": "ves.io.schema.site.Cpu", "properties": { "cache": { "type": "integer", "description": "CPU cache size in KB.", "title": "cache", "format": "int64", "x-displayname": "Cache", "x-ves-example": "8192", "x-f5xc-example": "8192", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cores": { "type": "integer", "description": "Number of physical CPU cores.", "title": "cores", "format": "int64", "x-displayname": "Cores", "x-ves-example": "4", "x-f5xc-example": "4", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cpus": { "type": "integer", "description": "Number of physical CPUs.", "title": "cpus", "format": "int64", "x-displayname": "CPUs", "x-ves-example": "4", "x-f5xc-example": "4", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "model": { "type": "string", "description": "CPU model", "title": "model", "x-displayname": "Model", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "speed": { "type": "integer", "description": "CPU clock rate in MHz.", "title": "speed", "format": "int64", "x-displayname": "Speed", "x-ves-example": "4200", "x-f5xc-example": "4200", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "threads": { "type": "integer", "description": "Number of logical (HT) CPU cores.", "title": "threads", "format": "int64", "x-displayname": "Threads", "x-ves-example": "4", "x-f5xc-example": "4", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "CPU vendor.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCpu", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCreateGlobalKubeConfigReq": { "type": "object", "description": "Create kubeconfig request parameters.", "title": "Create Global Kube Config Request", "x-displayname": "Create Kube Config Request.", "x-ves-proto-message": "ves.io.schema.site.CreateGlobalKubeConfigReq", "properties": { "expiration_timestamp": { "type": "string", "description": "Timestamp of kubeconfig's certificate expiry.", "title": "Expiry timestamp", "format": "date-time", "x-displayname": "Expiry timestamp.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.timestamp.gt_now": "true", "ves.io.schema.rules.timestamp.within.seconds": "31536000" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.timestamp.gt_now": "true", "ves.io.schema.rules.timestamp.within.seconds": "31536000" }, "x-f5xc-description-short": "Timestamp of kubeconfig's certificate expiry.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "type": "string", "description": "Name of the site for which kubeconfig is being requested.", "title": "Site", "minLength": 1, "maxLength": 64, "x-displayname": "Site", "x-ves-example": "Ce398", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "ce398", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Name of the site for which kubeconfig is being requested.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "byteLength": { "max": 64, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCreateGlobalKubeConfigReq", "required_fields": [ "site" ], "mutually_exclusive_groups": [], "example_json": "{\n \"site\": \"ce398\"\n}", "example_yaml": "site: ce398" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteCreateKubeConfigReq": { "type": "object", "description": "Create kubeconfig request parameters.", "title": "Create Kube Config Request", "x-displayname": "Create Kube Config Request.", "x-ves-proto-message": "ves.io.schema.site.CreateKubeConfigReq", "properties": { "name": { "type": "string", "description": "K8s Cluster name.", "title": "Name", "minLength": 1, "maxLength": 63, "x-displayname": "Name", "x-ves-example": "Ce398", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "ce398", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64, "min": 1 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "K8s Cluster namespace.", "title": "Namespace", "minLength": 1, "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64, "min": 1 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteCreateKubeConfigReq", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"ce398\",\n \"namespace\": \"system\"\n}", "example_yaml": "name: ce398\nnamespace: system" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteDefaultUnderlayNetworkType": { "type": "object", "description": "Optional, virtual network to be used as underlay for different overlay protocols (SRv6, IP-in-IP tunnels for DC Cluster Group)\nDefault is site-local-outside network.", "title": "default_underlay_vn", "x-displayname": "Default Underlay Virtual Network.", "x-ves-oneof-field-private_access_choice": "[\"site_local_inside\",\"site_local_outside\"]", "x-ves-proto-message": "ves.io.schema.site.DefaultUnderlayNetworkType", "properties": { "site_local_inside": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_local_outside" ] }, "site_local_outside": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_local_inside" ] } }, "x-f5xc-description-short": "Optional, virtual network to be used as underlay for different overlay protocols (SRv6, IP-in-IP tunnels for DC Cluster Group) Default is...", "x-f5xc-description-medium": "Optional, virtual network to be used as underlay for different overlay protocols (SRv6, IP-in-IP tunnels for DC Cluster Group) Default is site-local-outside network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteDefaultUnderlayNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteDeploymentState": { "type": "object", "description": "Details of Deployment.", "title": "Deployment State", "x-displayname": "Deployment State.", "x-ves-proto-message": "ves.io.schema.site.DeploymentState", "properties": { "message": { "type": "string", "description": "A verbose human readable explanation of the reason.", "title": "message", "x-displayname": "Message", "x-f5xc-description-short": "Verbose human readable explanation of the reason.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when deployment state was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modified At.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "phase": { "allOf": [ { "$ref": "#/components/schemas/siteSoftwareUpgradePhase" } ], "x-f5xc-example": "pending", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "type": "string", "description": "Result of the deployment, one of Success, Failure, Unknown.", "title": "result", "x-displayname": "Result", "x-f5xc-description-short": "Result of the deployment, one of Success, Failure, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Version name for this deployment state.", "title": "version", "x-displayname": "Version", "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteDeploymentState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteDirectConnectBGPPeerInfo": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.DirectConnectBGPPeerInfo", "properties": { "address_family": { "type": "string", "description": "Address Family.", "title": "Address Family", "x-displayname": "Address Family.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "amazon_address": { "type": "string", "description": "Amazon side address.", "title": "Amazon side address", "x-displayname": "Amazon side address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "asn": { "type": "integer", "description": "Configuration parameter for asn", "title": "ASN", "format": "int64", "x-displayname": "ASN", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_peer_id": { "type": "string", "description": "BGP Peer ID.", "title": "BGP Peer ID", "x-displayname": "BGP Peer ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "bgp_peer_state": { "type": "string", "description": "BGP Peer State.", "title": "BGP Peer State", "x-displayname": "BGP Peer State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_status": { "type": "string", "description": "BGP Status.", "title": "BGP Status", "x-displayname": "BGP Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "customer_address": { "type": "string", "description": "Customer side Address.", "title": "Customer side Address", "x-displayname": "Customer side Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteDirectConnectBGPPeerInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteDirectConnectStatusInfo": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.DirectConnectStatusInfo", "properties": { "direct_connect_gateway_id": { "type": "string", "description": "Direct Connect Gateway ID.", "title": "Direct Connect Gateway ID", "x-displayname": "Direct Connect Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "direct_connect_gateway_state": { "type": "string", "description": "Direct Connect Gateway state.", "title": "Direct Connect Gateway State", "x-displayname": "Direct Connect Gateway State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "direct_connect_vgw_association_state": { "type": "string", "description": "Virtual Private Gateway association state.", "title": "Virtual Private Gateway association state", "x-displayname": "Virtual Private Gateway association state.", "x-f5xc-description-short": "Virtual Private Gateway association state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "propagated_routes_from_direct_connect_connection": { "type": "array", "description": "Propagated Routes from Direct Connect Connection.", "title": "Propagated Routes from Direct Connect Connection", "items": { "type": "string" }, "x-displayname": "Propagated Routes from Direct Connect Connection.", "x-f5xc-description-short": "Propagated Routes from Direct Connect Connection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vgw_id": { "type": "string", "description": "Virtual Private Gateway ID.", "title": "Virtual Private Gateway ID", "x-displayname": "Virtual Private Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vgw_state": { "type": "string", "description": "Virtual Private Gateway state.", "title": "Virtual Private Gateway state", "x-displayname": "Virtual Private Gateway state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vif_states": { "type": "array", "description": "VIF States.", "title": "VIF States", "items": { "$ref": "#/components/schemas/siteDirectConnectVIFStateInfo" }, "x-displayname": "VIF States.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteDirectConnectStatusInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteDirectConnectVIFStateInfo": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.DirectConnectVIFStateInfo", "properties": { "attachment_state": { "type": "string", "description": "VIF Attachment State.", "title": "VIF Attachment State", "x-displayname": "VIF Attachment State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_peers": { "type": "array", "description": "BGP Peers", "title": "BGP Peers", "items": { "$ref": "#/components/schemas/siteDirectConnectBGPPeerInfo" }, "x-displayname": "BGP Peers", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vif_id": { "type": "string", "description": "VIF ID", "title": "VIF ID", "x-displayname": "VIF ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vif_state": { "type": "string", "description": "VIF State", "title": "VIF State", "x-displayname": "VIF State", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteDirectConnectVIFStateInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteExpressRoutePeeringStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.ExpressRoutePeeringStatusType", "properties": { "azure_asn": { "type": "string", "description": "Express Route Azure ASN.", "title": "Express Route Azure ASN", "x-displayname": "Express Route Azure ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peer_asn": { "type": "string", "description": "Express Route Peer ASN.", "title": "Express Route Peer ASN", "x-displayname": "Express Route Peer ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering_type": { "type": "string", "description": "Express Route Peering Type.", "title": "Express Route Peering Type", "x-displayname": "Express Route Peering Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "provisioningState": { "type": "string", "description": "Provisioning Status.", "title": "Provisioning Status", "x-displayname": "Provisioning Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Express Route Peering Status.", "title": "Express Route Peering Status", "x-displayname": "Express Route Peering Status.", "x-f5xc-example": "running", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteExpressRoutePeeringStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteFleetCondition": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.FleetCondition", "properties": { "message": { "type": "string", "description": "A verbose human readable explanation of the reason.", "title": "message", "x-displayname": "Message", "x-f5xc-description-short": "Verbose human readable explanation of the reason.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "module_name": { "type": "string", "description": "A name of module that produced the condition.", "title": "module_name", "x-displayname": "Module Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of module that produced the condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "A name of condition.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "result": { "type": "string", "description": "Result of the condition.", "title": "result", "x-displayname": "Result", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteFleetCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteFleetDeploymentState": { "type": "object", "description": "Details of Fleet Deployment.", "title": "Fleet Deployment State", "x-displayname": "Fleet Deployment State.", "x-ves-proto-message": "ves.io.schema.site.FleetDeploymentState", "properties": { "condition": { "type": "array", "description": "Map of fleet conditions.", "title": "condition", "items": { "$ref": "#/components/schemas/siteFleetCondition" }, "x-displayname": "Condition", "x-f5xc-example": "ready", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hash": { "type": "string", "description": "Hash sum of fleet config.", "title": "hash", "x-displayname": "Fleet Hash.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when deployment state was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modified At.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when deployment state was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "result": { "type": "string", "description": "Summarized result of the deployment, one of Success, Failure, Unknown.", "title": "result", "x-displayname": "Result", "x-f5xc-description-short": "Summarized result of the deployment, one of Success, Failure, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteFleetDeploymentState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteFleetStatus": { "type": "object", "description": "F5XC fleet status on the node.", "title": "F5XC Fleet Status", "x-displayname": "F5XC Fleet Status.", "x-ves-proto-message": "ves.io.schema.site.FleetStatus", "properties": { "deployment_state": { "allOf": [ { "$ref": "#/components/schemas/siteFleetDeploymentState" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteFleetStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteGPU": { "type": "object", "description": "GPU information on server.", "title": "GPU", "x-displayname": "GPU", "x-ves-proto-message": "ves.io.schema.site.GPU", "properties": { "cuda_version": { "type": "string", "description": "GPU Cuda Version.", "title": "cudaVersion", "x-displayname": "Cuda Version.", "x-ves-example": "10.2", "x-f5xc-example": "10.2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "driver_version": { "type": "string", "description": "GPU Driver Version.", "title": "driverVersion", "x-displayname": "Driver Version.", "x-ves-example": "440.82", "x-f5xc-example": "440.82", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gpu_device": { "type": "array", "description": "List of GPU devices in server.", "title": "GPUDevice", "items": { "$ref": "#/components/schemas/siteGPUDevice" }, "x-displayname": "GPU devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteGPU", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteGPUDevice": { "type": "object", "title": "GPUDevice", "x-displayname": "GPUDevice", "x-ves-proto-message": "ves.io.schema.site.GPUDevice", "properties": { "id": { "type": "string", "description": "GPU ID", "title": "id", "x-displayname": "GPU ID", "x-ves-example": "00000000:17:00.0.", "x-f5xc-example": "00000000:17:00.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "processes": { "type": "string", "description": "GPU Processes.", "title": "processes", "x-displayname": "Processes", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "product_name": { "type": "string", "description": "GPU Product Name.", "title": "productName", "x-displayname": "Product Name.", "x-ves-example": "Quadro P1000.", "x-f5xc-example": "Quadro P1000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteGPUDevice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read site", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.site.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/siteReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemasiteGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/siteStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteGlobalNetworkItem": { "type": "object", "description": "Contains reference to the virtual network, and its optional description.", "title": "GlobalNetworkItem", "x-displayname": "GlobalNetworkItem.", "x-ves-proto-message": "ves.io.schema.site.GlobalNetworkItem", "properties": { "description": { "type": "string", "description": "Optional description for the virtual_network.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "Optional description for the virtual_network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ref": { "type": "array", "description": "Reference to the Global Network type virtual_network Object.", "title": "Reference", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Reference", "x-f5xc-description-short": "Reference to the Global Network type virtual_network Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains reference to the virtual network, and its optional description.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteGlobalNetworkItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteGlobalNetworkListResp": { "type": "object", "description": "Global Network List Response.", "title": "GlobalNetworkListResp", "x-displayname": "Global Network List Response.", "x-ves-proto-message": "ves.io.schema.site.GlobalNetworkListResp", "properties": { "items": { "type": "array", "description": "List of the global networks connected to site.", "title": "Item", "items": { "$ref": "#/components/schemas/siteGlobalNetworkItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "List of the global networks connected to site.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteGlobalNetworkListResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteInterfaceListResp": { "type": "object", "description": "Interface List Response.", "title": "InterfaceListResp", "x-displayname": "Interface List Response.", "x-ves-proto-message": "ves.io.schema.site.InterfaceListResp", "properties": { "interface": { "type": "array", "description": "List of the interface connected to site.", "title": "Item", "items": { "type": "string" }, "x-displayname": "Items", "x-f5xc-description-short": "List of the interface connected to site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteInterfaceListResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteInterfaceStatus__ves_io_schema_site": { "type": "object", "description": "Status of Interfaces in ver.", "title": "Interface Status", "x-displayname": "Interface Status.", "x-ves-proto-message": "ves.io.schema.site.InterfaceStatus", "properties": { "active_state": { "allOf": [ { "$ref": "#/components/schemas/siteActiveState" } ], "x-f5xc-description-short": "Configuration parameter for active state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bond_members": { "type": "array", "description": "Members of the Bond interface along with the corresponding link state.", "title": "Bond Interface Members\nx-displayName: \"Bond Members\"\nMembers of the Bond interface along with the corresponding link state", "items": { "$ref": "#/components/schemas/siteBondMembersType" }, "x-displayname": "Bond Members.", "x-f5xc-description-short": "Members of the Bond interface along with the corresponding link state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dhcp_server": { "type": "boolean", "description": "Indicate if DHCP server is configured on the interface.", "title": "DHCP Server", "format": "boolean", "x-displayname": "DHCP Server.", "x-f5xc-description-short": "Indicate if DHCP server is configured on the interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "allOf": [ { "$ref": "#/components/schemas/schemaIpSubnetType" } ], "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_mode": { "allOf": [ { "$ref": "#/components/schemas/siteAddressMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ipv6": { "allOf": [ { "$ref": "#/components/schemas/schemaIpSubnetType" } ], "x-f5xc-example": "2001:db8::1", "x-f5xc-description-short": "IPv6 address in colon-separated hexadecimal format.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_quality": { "allOf": [ { "$ref": "#/components/schemas/siteLinkQuality" } ], "x-f5xc-description-short": "Configuration parameter for link quality.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_state": { "type": "boolean", "description": "Link State for the interface.", "title": "Link State\nx-displayName: \"Link State\"\nLink State for the interface", "format": "boolean", "x-displayname": "Link State.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_type": { "allOf": [ { "$ref": "#/components/schemas/siteLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mac": { "type": "string", "description": "MAC Address of interface.", "title": "Mac Address", "x-displayname": "MAC Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of interface.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "network_name": { "type": "string", "description": "Name of Virtual Network to which the interface belongs.", "title": "Virtual Network Name", "x-displayname": "Virtual Network Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of Virtual Network to which the interface belongs.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_type": { "allOf": [ { "$ref": "#/components/schemas/schemaVirtualNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteInterfaceStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteKernel": { "type": "object", "description": "Kernel information.", "title": "Kernel Information", "x-displayname": "Kernel", "x-ves-proto-message": "ves.io.schema.site.Kernel", "properties": { "architecture": { "type": "string", "description": "Kernel architecture.", "title": "architecture", "x-displayname": "Architecture.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release": { "type": "string", "description": "Kernel release.", "title": "release", "x-displayname": "Release", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Kernel version.", "title": "version", "x-displayname": "Version", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteKernel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteKubeConfigStatusRsp": { "type": "object", "description": "Response for operation on kube config.", "title": "Kube Config status response", "x-displayname": "Kube Config status response.", "x-ves-proto-message": "ves.io.schema.site.KubeConfigStatusRsp", "properties": { "status": { "type": "boolean", "description": "Result status flag.", "title": "Status", "format": "boolean", "x-displayname": "Status", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteKubeConfigStatusRsp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteLinkQuality": { "type": "string", "description": "Link quality determined by VER using different probes\n\nUnknown quality\nLink quality is good\nLink quality is poor\nQuality disabled.", "title": "Link quality", "enum": [ "QUALITY_UNKNOWN", "QUALITY_GOOD", "QUALITY_POOR", "QUALITY_DISABLED" ], "default": "QUALITY_UNKNOWN", "x-displayname": "Link quality.", "x-ves-proto-enum": "ves.io.schema.site.LinkQuality", "x-f5xc-description-short": "Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled.", "x-f5xc-description-medium": "Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteLinkQuality", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"QUALITY_UNKNOWN\"", "example_yaml": "QUALITY_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteLinkType": { "type": "string", "description": "Link type of interface determined operationally\n\nLink type unknown\nLink type ethernet\nWi-Fi link of type 802.11ac\nWi-Fi link of type 802.11bgn\nLink type 4G\nWi-Fi link\nWan link.", "title": "Link type", "enum": [ "LINK_TYPE_UNKNOWN", "LINK_TYPE_ETHERNET", "LINK_TYPE_WIFI_802_11AC", "LINK_TYPE_WIFI_802_11BGN", "LINK_TYPE_4G", "LINK_TYPE_WIFI", "LINK_TYPE_WAN" ], "default": "LINK_TYPE_UNKNOWN", "x-displayname": "Link type", "x-ves-proto-enum": "ves.io.schema.site.LinkType", "x-f5xc-description-short": "Link type of interface determined operationally Link type unknown Link type ethernet Wi-Fi link of type 802.11ac Wi-Fi link of type 802.11bgn Link...", "x-f5xc-description-medium": "Link type of interface determined operationally Link type unknown Link type ethernet Wi-Fi link of type 802.11ac Wi-Fi link of type 802.11bgn Link type 4G Wi-Fi link Wan link.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteLinkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LINK_TYPE_UNKNOWN\"", "example_yaml": "LINK_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteListKubeConfigRsp": { "type": "object", "description": "List kubeconfig response.", "title": "List Kube Config Response", "x-displayname": "List Kube Config Response.", "x-ves-proto-message": "ves.io.schema.site.ListKubeConfigRsp", "properties": { "items": { "type": "array", "description": "List of kubeconfig items.", "title": "List of the kubeconfigs", "items": { "$ref": "#/components/schemas/siteListKubeConfigRspItem" }, "x-displayname": "List of Kube Configs.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteListKubeConfigRsp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteListKubeConfigRspItem": { "type": "object", "description": "Each item of credential list request.", "title": "List Kube Config item", "x-displayname": "List Kube Config item.", "x-ves-proto-message": "ves.io.schema.site.ListKubeConfigRspItem", "properties": { "create_timestamp": { "type": "string", "description": "Create time of API credential.", "title": "Create timestamp", "format": "date-time", "x-displayname": "Creation Time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expiry_timestamp": { "type": "string", "description": "Expiry time of credential.", "title": "Expiry time", "format": "date-time", "x-displayname": "Expiry Time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of this credential.", "title": "Name", "minLength": 1, "maxLength": 63, "x-displayname": "Name", "x-ves-example": "API-cred-x89sf.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "api-cred-x89sf", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64, "min": 1 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UUID of API credential object.", "title": "uuid of the record", "x-displayname": "UUID", "x-ves-example": "00000000-0000-4000-8000-676e83e049e2.", "x-f5xc-example": "00000000-0000-4000-8000-676e83e049e2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "user_email": { "type": "string", "description": "User email of user that requested credential .", "title": "Email of user", "x-displayname": "User", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "admin@example.com", "x-f5xc-description-short": "User email of user that requested credential .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteListKubeConfigRspItem", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"api-cred-x89sf\"\n}", "example_yaml": "name: api-cred-x89sf" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of site", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.site.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/siteListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteListResponseItem": { "type": "object", "description": "By default a summary of site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of site", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.site.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this site.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this site.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates site is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates site is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemasiteGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this site.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this site.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/siteStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this site.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of site is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteMemory": { "type": "object", "description": "Memory information.", "title": "Memory Information", "x-displayname": "Memory Information.", "x-ves-proto-message": "ves.io.schema.site.Memory", "properties": { "size_mb": { "type": "integer", "description": "RAM size in MB.", "title": "size_mb", "format": "int64", "x-displayname": "RAM", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "speed": { "type": "integer", "description": "RAM data rate in MT/s.", "title": "speed", "format": "int64", "x-displayname": "Speed", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Type of memory, eg. DDR4.", "title": "type", "x-displayname": "Type", "x-ves-example": "DDR4", "x-f5xc-example": "DDR4", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteMemory", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNetworkDevice": { "type": "object", "description": "NetworkDevice information.", "title": "Network Device Information", "x-displayname": "Network Device Information.", "x-ves-proto-message": "ves.io.schema.site.NetworkDevice", "properties": { "driver": { "type": "string", "description": "Driver of device, eg. E1000e.", "title": "driver", "x-displayname": "Driver", "x-ves-example": "E1000e", "x-f5xc-example": "e1000e", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_address": { "type": "array", "description": "IP address on interface.", "title": "ip_address", "items": { "type": "string" }, "x-displayname": "IP Address.", "x-ves-example": "192.0.2.242.", "x-f5xc-example": "192.0.2.242", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_quality": { "allOf": [ { "$ref": "#/components/schemas/siteLinkQuality" } ], "x-f5xc-description-short": "Configuration parameter for link quality.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_type": { "allOf": [ { "$ref": "#/components/schemas/siteLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mac_address": { "type": "string", "description": "MAC address on interface.", "title": "mac_address", "x-displayname": "MAC Address.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 17, "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "format": "mac-address", "formatDescription": "MAC address (e.g., 00:1A:2B:3C:4D:5E)", "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of device, eg. Eth0.", "title": "name", "x-displayname": "Name", "x-ves-example": "Eth0", "x-f5xc-example": "eth0", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "port": { "type": "string", "description": "Used port, eg. Tp.", "title": "port", "x-displayname": "Port", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "speed": { "type": "integer", "description": "Device max supported speed in Mbps.", "title": "speed", "format": "int64", "x-displayname": "Speed", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNetworkDevice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNetworkType": { "type": "string", "description": "X-displayName \"Network Type\"\nNetwork Type\n\n- SLO: x-displayName \"SLO\"\nSLO Network\n- SLI: x-displayName \"SLI\"\nSLI Network Type\n- SEGMENT: x-displayName \"Segment\"\nSegment Network Type.", "title": "Network Type", "enum": [ "SLO", "SLI", "SEGMENT" ], "default": "SLO", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.site.NetworkType", "x-f5xc-description-short": "X-displayName \"Network Type\" Network Type - SLO: x-displayName \"SLO\" SLO Network - SLI: x-displayName \"SLI\" SLI Network Type - SEGMENT...", "x-f5xc-description-medium": "X-displayName \"Network Type\" Network Type - SLO: x-displayName \"SLO\" SLO Network - SLI: x-displayName \"SLI\" SLI Network Type - SEGMENT: x-displayName \"Segment\" Segment Network Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SLO\"", "example_yaml": "SLO\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNodeInfo": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.NodeInfo", "properties": { "hostname": { "type": "string", "description": "Hostname of the node.", "title": "Hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "role": { "type": "array", "description": "Role of registered node. Roles are used by system to determine what control services they should enforce.\nK8s-master represents Kubernetes Master.", "title": "Role", "items": { "type": "string" }, "x-displayname": "Node Role", "x-ves-example": "K8s-master, K8s-minion.", "x-f5xc-example": "k8s-master, k8s-minion", "x-f5xc-description-short": "Role of registered node. Roles are used by system to determine what control services they should enforce.", "x-f5xc-description-medium": "Role of registered node. Roles are used by system to determine what control services they should enforce. K8s-master represents Kubernetes Master.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNodeInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteOS": { "type": "object", "description": "Details of Operating System.", "title": "OS", "x-displayname": "OS", "x-ves-proto-message": "ves.io.schema.site.OS", "properties": { "architecture": { "type": "string", "description": "Architecture of OS.", "title": "architecture", "x-displayname": "Architecture.", "x-ves-example": "Amd64", "x-f5xc-example": "amd64", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of OS.", "title": "name", "x-displayname": "Name", "x-ves-example": "Container Linux by CoreOS 1855.4.0 (Rhyolite)", "x-f5xc-example": "Container Linux by CoreOS 1855.4.0 (Rhyolite)", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "release": { "type": "string", "description": "Release of the OS.", "title": "release", "x-displayname": "Release", "x-ves-example": "20.04", "x-f5xc-example": "20.04", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Vendor of OS.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Coreos", "x-f5xc-example": "coreos", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of OS.", "title": "version", "x-displayname": "Version", "x-ves-example": "1855.4.0", "x-f5xc-example": "1855.4.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteOS", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteOfflineSurvivabilityPhase": { "type": "string", "description": "State of offline survivability\n\nFeature is disabled\nFeature is in process of enabling\nFeature is configured and waiting to be applied to nodes\nFeature is enabled and reported by all nodes\nFeature is in process of disabling\nFeature can't be enabled.", "title": "OfflineSurvivabilityPhase", "enum": [ "OFFLINE_DISABLED", "OFFLINE_ENABLING", "OFFLINE_CONFIGURED", "OFFLINE_ENABLED", "OFFLINE_DISABLING", "OFFLINE_FAILED" ], "default": "OFFLINE_DISABLED", "x-displayname": "Offline survivability phase.", "x-ves-proto-enum": "ves.io.schema.site.OfflineSurvivabilityPhase", "x-f5xc-description-short": "State of offline survivability Feature is disabled Feature is in process of enabling Feature is configured and waiting to be applied to nodes...", "x-f5xc-description-medium": "State of offline survivability Feature is disabled Feature is in process of enabling Feature is configured and waiting to be applied to nodes Feature is enabled and reported by all nodes Feature is in process of disabling Feature can't be enabled.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteOfflineSurvivabilityPhase", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"OFFLINE_DISABLED\"", "example_yaml": "OFFLINE_DISABLED\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteOfflineSurvivabilityStatus": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.OfflineSurvivabilityStatus", "properties": { "message": { "type": "string", "description": "Provides more detailed description of current phase.", "title": "Message", "x-displayname": "Message", "x-f5xc-description-short": "Provides more detailed description of current phase.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "allOf": [ { "$ref": "#/components/schemas/siteOfflineSurvivabilityPhase" } ], "x-f5xc-example": "pending", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteOfflineSurvivabilityStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteOperatingSystemStatus": { "type": "object", "description": "F5XC operating system version running in the site.", "title": "F5XC Operating system Status", "x-displayname": "F5XC Operating System Status.", "x-ves-proto-message": "ves.io.schema.site.OperatingSystemStatus", "properties": { "available_version": { "type": "string", "description": "Available version represent F5 Distributed Cloud operating system version ready to be upgraded in the site.", "title": "available_version", "x-displayname": "Available Version.", "x-f5xc-description-short": "Available version represent F5 Distributed Cloud operating system version ready to be upgraded in the site.", "x-f5xc-description-medium": "Available version represent F5 Distributed Cloud operating system version ready to be upgraded in the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_state": { "allOf": [ { "$ref": "#/components/schemas/siteDeploymentState" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nonconforming_state": { "type": "string", "description": "If nonconforming state is not empty, then current deployed OS version is nonconforming. Site should be upgrade to available version.", "title": "Nonconforming State", "maxLength": 256, "x-displayname": "Nonconforming State.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "If nonconforming state is not empty, then current deployed OS version is nonconforming.", "x-f5xc-description-medium": "If nonconforming state is not empty, then current deployed OS version is nonconforming. Site should be upgrade to available version.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "F5XC operating system version running in the site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteOperatingSystemStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteOrchestrationStatusType": { "type": "object", "description": "Managed Sites Orchestration Status.", "title": "Site Orchestration Status Type", "x-displayname": "Site Orchestration Status Type.", "x-ves-oneof-field-cloud_choice": "[\"aws_orchestration_status\"]", "x-ves-proto-message": "ves.io.schema.site.OrchestrationStatusType", "properties": { "aws_orchestration_status": { "allOf": [ { "$ref": "#/components/schemas/siteAWSOrchestrationStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteOrchestrationStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteOsInfo": { "type": "object", "description": "OsInfo holds information about host OS and HW.", "title": "OsInfo", "x-displayname": "OS Info", "x-ves-proto-message": "ves.io.schema.site.OsInfo", "properties": { "bios": { "allOf": [ { "$ref": "#/components/schemas/siteBios" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "board": { "allOf": [ { "$ref": "#/components/schemas/siteBoard" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "chassis": { "allOf": [ { "$ref": "#/components/schemas/siteChassis" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cpu": { "allOf": [ { "$ref": "#/components/schemas/siteCpu" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gpu": { "allOf": [ { "$ref": "#/components/schemas/siteGPU" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kernel": { "allOf": [ { "$ref": "#/components/schemas/siteKernel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "memory": { "allOf": [ { "$ref": "#/components/schemas/siteMemory" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "type": "array", "description": "List of network devices in server.", "title": "network", "items": { "$ref": "#/components/schemas/siteNetworkDevice" }, "x-displayname": "Network", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 32, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numa_nodes": { "type": "integer", "description": "Non-uniform memory access (NUMA) nodes count.", "title": "NUMA Nodes Count", "format": "int32", "x-displayname": "NUMA nodes count.", "x-ves-example": "1", "x-ves-validation-rules": { "ves.io.schema.rules.int32.gte": "0" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.int32.gte": "0" }, "x-f5xc-description-short": "Non-uniform memory access (NUMA) nodes count.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os": { "allOf": [ { "$ref": "#/components/schemas/siteOS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "product": { "allOf": [ { "$ref": "#/components/schemas/siteProduct" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storage": { "type": "array", "description": "List of storage devices in server.", "title": "storage", "items": { "$ref": "#/components/schemas/siteStorageDevice" }, "x-displayname": "Storage", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "usb": { "type": "array", "description": "List of USB devices in server.", "title": "USBDevice", "items": { "$ref": "#/components/schemas/siteUSBDevice" }, "x-displayname": "USB devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "OsInfo holds information about host OS and HW.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteOsInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePodsMetricData": { "type": "object", "description": "Pods Metric Data.", "title": "PodsMetricData", "x-displayname": "Pods Metric Data.", "x-ves-proto-message": "ves.io.schema.site.PodsMetricData", "properties": { "data": { "type": "array", "description": "List of metric data.", "title": "Data", "items": { "$ref": "#/components/schemas/sitePodsMetricTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/sitePodsMetricType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePodsMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePodsMetricLabel": { "type": "string", "description": "Labels in Pods metrics.", "title": "Pods MetricLabel", "enum": [ "POD_NAMESPACE", "POD_NAME", "POD_IF_NAME", "POD_IF_SUBNET", "POD_IF_VLAN_ID" ], "default": "POD_NAMESPACE", "x-displayname": "Pods MetricLabel.", "x-ves-proto-enum": "ves.io.schema.site.PodsMetricLabel", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePodsMetricLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"POD_NAMESPACE\"", "example_yaml": "POD_NAMESPACE\n..." }, "x-f5xc-cli-domain": "label", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePodsMetricType": { "type": "string", "description": "List of metric types for Pods.", "title": "PodsMetricType", "enum": [ "POD_METRIC_TYPE_IN_BYTES", "POD_METRIC_TYPE_OUT_BYTES", "POD_METRIC_TYPE_IN_DROP_PACKETS", "POD_METRIC_TYPE_OUT_DROP_PACKETS", "POD_METRIC_TYPE_IN_PACKETS", "POD_METRIC_TYPE_OUT_PACKETS" ], "default": "POD_METRIC_TYPE_IN_BYTES", "x-displayname": "Pods Metric Type.", "x-ves-proto-enum": "ves.io.schema.site.PodsMetricType", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePodsMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"POD_METRIC_TYPE_IN_BYTES\"", "example_yaml": "POD_METRIC_TYPE_IN_BYTES\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePodsMetricTypeData": { "type": "object", "description": "Metric Type Data contains labels that uniquely identifies individual entity and its corresponding metric values.", "title": "PodsMetricTypeData", "x-displayname": "Pods Metric Type Data.", "x-ves-proto-message": "ves.io.schema.site.PodsMetricTypeData", "properties": { "labels": { "type": "object", "description": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported.\n\"name\" is the label name defined in \"PodsMetricLabel\"", "title": "Labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. \"name\" is the label name defined in...", "x-f5xc-description-medium": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. \"name\" is the label name defined in \"PodsMetricLabel\".", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "description": "List of metric values. May contain more than one value if timeseries data is requested.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-description-short": "List of metric values. May contain more than one value if timeseries data is requested.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metric Type Data contains labels that uniquely identifies individual entity and its corresponding metric values.", "x-f5xc-description-medium": "Metric Type Data contains labels that uniquely identifies individual entity and its corresponding metric values.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePodsMetricTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePodsMetricsRequest": { "type": "object", "description": "Request to GET Pods Metrics.", "title": "PodsMetricsRequest", "x-displayname": "Pods Metrics Request.", "x-ves-proto-message": "ves.io.schema.site.PodsMetricsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric data.\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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-medium": "End time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "type": "string", "description": "Filter to filter the metrics by the given label.", "title": "Filter", "x-displayname": "Filter", "x-ves-example": "Namespace=example-namespace.", "x-f5xc-example": "namespace=example-namespace", "x-f5xc-description-short": "Filter to filter the metrics by the given label.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_by": { "type": "array", "description": "Group By to group the metrics by the given label\n\"name\" is the label name defined in \"PodsMetricLabel\"", "title": "Group By", "items": { "$ref": "#/components/schemas/sitePodsMetricLabel" }, "x-displayname": "Group By", "x-ves-example": "Name", "x-f5xc-example": "name", "x-f5xc-description-short": "Group By to group the metrics by the given label \"name\" is the label name defined in \"PodsMetricLabel\".", "x-f5xc-description-medium": "Group By to group the metrics by the given label \"name\" is the label name defined in \"PodsMetricLabel\".", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric_selector": { "type": "array", "description": "Select metrics to be returned in the response.", "title": "Metric Selector", "items": { "$ref": "#/components/schemas/sitePodsMetricType" }, "x-displayname": "Metric Selector.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select metrics to be returned in the response.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace to scope the listing of cronjobs in a site.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace to scope the listing of cronjobs in a site.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "site": { "type": "string", "description": "Site name", "title": "site", "x-displayname": "Site", "x-ves-example": "Site-1", "x-f5xc-example": "site-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of metric data.\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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-medium": "Start time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePodsMetricsRequest", "required_fields": [ "metric_selector" ], "mutually_exclusive_groups": [], "example_json": "{\n \"metric_selector\": [\n \"POD_METRIC_TYPE_IN_BYTES\"\n ]\n}", "example_yaml": "metric_selector:\n- POD_METRIC_TYPE_IN_BYTES" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "sitePodsMetricsResponse": { "type": "object", "description": "Pods Metrics Response.", "title": "PodsMetricsResponse", "x-displayname": "Pods Metrics Response.", "x-ves-proto-message": "ves.io.schema.site.PodsMetricsResponse", "properties": { "data": { "type": "array", "description": "Data for the metric types specified in the request.", "title": "Data", "items": { "$ref": "#/components/schemas/sitePodsMetricData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Data for the metric types specified in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for sitePodsMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteProduct": { "type": "object", "description": "Product information.", "title": "Product Information", "x-displayname": "Product Information.", "x-ves-proto-message": "ves.io.schema.site.Product", "properties": { "name": { "type": "string", "description": "Product name, eg. For AWS m5a.xlarge. Info taken from /sys/class/dmi/ID/product_name.", "title": "name", "x-displayname": "Name", "x-ves-example": "m5a.xlarge.", "x-f5xc-example": "m5a.xlarge", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "serial": { "type": "string", "description": "Serial number, eg. For AWS 00000000-0000-4000-8000-23460f645a1f. Info taken from /sys/class/dmi/ID/product_serial.", "title": "serial", "x-displayname": "Serial Number.", "x-ves-example": "00000000-0000-4000-8000-23460f645a1f.", "x-f5xc-example": "00000000-0000-4000-8000-23460f645a1f", "x-f5xc-description-short": "Serial number, eg. For AWS 00000000-0000-4000-8000-23460f645a1f.", "x-f5xc-description-medium": "Serial number, eg. For AWS 00000000-0000-4000-8000-23460f645a1f. Info taken from /sys/class/dmi/ID/product_serial.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Vendor name, eg. For AWS Amazon EC2. Info taken from /sys/class/dmi/ID/product_vendor.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Version name. Info taken from /sys/class/dmi/ID/product_version.", "title": "version", "x-displayname": "Version", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Version name. Info taken from /sys/class/dmi/ID/product_version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteProduct", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a site", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.site.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemasiteReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteRevokeKubeConfigReq": { "type": "object", "description": "Revoke kubeconfig object with a given name.", "title": "Revoke Kubeconfig request", "x-displayname": "Revoke Kubeconfig Request.", "x-ves-proto-message": "ves.io.schema.site.RevokeKubeConfigReq", "properties": { "name": { "type": "string", "description": "Name of kubeconfig resource.", "title": "Credential name", "minLength": 1, "maxLength": 63, "x-displayname": "Name", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "64", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64, "min": 1 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Revoke kubeconfig object with a given name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteRevokeKubeConfigReq", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"value\"\n}", "example_yaml": "name: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteRouteServerPeeringStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.RouteServerPeeringStatusType", "properties": { "peerIP": { "type": "string", "description": "Route Server Peer IP.", "title": "Route Server Peer IP", "x-displayname": "Route Server Peer IP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peer_asn": { "type": "string", "description": "Route Server Peer ASN.", "title": "Route Server Peer ASN", "x-displayname": "Route Server Peer ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "provisioningState": { "type": "string", "description": "Provisioning Status.", "title": "Provisioning Status", "x-displayname": "Provisioning Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteRouteServerPeeringStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteRouteServerStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.RouteServerStatusType", "properties": { "peers": { "type": "array", "description": "Route Server Peering State.", "title": "Route Server Peering State", "items": { "$ref": "#/components/schemas/siteRouteServerPeeringStatusType" }, "x-displayname": "Route Server Peering State.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_server_name": { "type": "string", "description": "Route Server Name.", "title": "Route Server Name", "x-displayname": "Route Server Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteRouteServerStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteScalingPhase": { "type": "string", "description": "State of Scaling phase in site\n\nInvalid scaling phase\nSite scaling is in progress\nSite scaling failed\nSite scaling is done. Site is in desired number of nodes.", "title": "ScalingPhase", "enum": [ "SCALING_INVALID", "SCALING_IN_PROGRESS", "SCALING_FAILED", "SCALING_DONE" ], "default": "SCALING_INVALID", "x-displayname": "Scaling Phase.", "x-ves-proto-enum": "ves.io.schema.site.ScalingPhase", "x-f5xc-description-short": "State of Scaling phase in site Invalid scaling phase Site scaling is in progress Site scaling failed Site scaling is done.", "x-f5xc-description-medium": "State of Scaling phase in site Invalid scaling phase Site scaling is in progress Site scaling failed Site scaling is done. Site is in desired number of nodes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteScalingPhase", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SCALING_INVALID\"", "example_yaml": "SCALING_INVALID\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteScalingStatus": { "type": "object", "description": "Details of Scaling.", "title": "Scaling Status", "x-displayname": "Scaling Status.", "x-ves-proto-message": "ves.io.schema.site.ScalingStatus", "properties": { "message": { "type": "string", "description": "Provides description of scaling action, eg. \"scaled to 3 nodes\"", "title": "Message", "x-displayname": "Message", "x-f5xc-description-short": "Provides description of scaling action, eg. \"scaled to 3 nodes\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "allOf": [ { "$ref": "#/components/schemas/siteScalingPhase" } ], "x-f5xc-example": "pending", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool_node_count_current": { "type": "integer", "description": "Current number of pool nodes in cluster.", "title": "Current pool node count", "format": "int32", "x-displayname": "Current Pool Count.", "x-f5xc-description-short": "Current number of pool nodes in cluster.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool_node_count_target": { "type": "integer", "description": "Desired pool node count defines how many nodes should be in a cluster after scaling.", "title": "Desired pool node count", "format": "int32", "x-displayname": "Desired Pool Count.", "x-f5xc-description-short": "Desired pool node count defines how many nodes should be in a cluster after scaling.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteScalingStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSegmentItem": { "type": "object", "description": "Contains reference to the segment, and its optional description.", "title": "SegmentItem", "x-displayname": "SegmentItem.", "x-ves-proto-message": "ves.io.schema.site.SegmentItem", "properties": { "description": { "type": "string", "description": "Optional description for the segment.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ref": { "type": "array", "description": "Reference to the segment object.", "title": "Reference", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Reference", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains reference to the segment, and its optional description.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSegmentItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSegmentListResp": { "type": "object", "description": "Segment List Response.", "title": "SegmentListResp", "x-displayname": "Segment List Response.", "x-ves-proto-message": "ves.io.schema.site.SegmentListResp", "properties": { "items": { "type": "array", "description": "List of the segments connected to site.", "title": "Item", "items": { "$ref": "#/components/schemas/siteSegmentItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSegmentListResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSetStateReq": { "type": "object", "description": "Set status of the site.", "title": "Set state request", "x-displayname": "Set Status Request.", "x-ves-proto-message": "ves.io.schema.site.SetStateReq", "properties": { "name": { "type": "string", "description": "Site name", "title": "Name", "x-displayname": "Name", "x-ves-example": "Ce398", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ce398", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Site namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteSiteState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSetStateReq", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"ce398\",\n \"namespace\": \"system\"\n}", "example_yaml": "name: ce398\nnamespace: system" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSetStateResp": { "type": "object", "description": "Response for set state request, empty because the only resturned information\nis currently error message.", "title": "Set state respond", "x-displayname": "Set Status Response.", "x-ves-proto-message": "ves.io.schema.site.SetStateResp", "x-f5xc-description-short": "Response for set state request, empty because the only resturned information is currently error message.", "x-f5xc-description-medium": "Response for set state request, empty because the only resturned information is currently error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSetStateResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteReachabilityStatus": { "type": "object", "description": "F5XC domain reachability in the site.", "title": "F5XC Site Reachability Scan Status", "x-displayname": "F5XC Site Reachability Scan Status.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.site.SiteReachabilityStatus", "properties": { "error_message": { "type": "string", "description": "The error message during network reachbility scan.", "title": "error_message", "x-displayname": "Error Message.", "x-f5xc-description-short": "The error message during network reachbility scan.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_name": { "type": "string", "description": "Name of the node on the site.", "title": "node_name", "x-displayname": "Node name", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scan_result": { "type": "object", "description": "Result of the domain reachability scan.", "title": "scan_result", "x-displayname": "Scan Result.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteReachabilityStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteSoftwareOverrideType": { "type": "string", "description": "Decide which software version takes effect in case of conflict between site and fleet\n\nSoftware version in site will take precedence.\nBetween site and fleet newer software version will take precedence.\nSoftware version in fleet will take precedence.", "title": "SiteSoftwareOverrideType", "enum": [ "SITE_SOFTWARE_OVERRIDE_SITE", "SITE_SOFTWARE_OVERRIDE_NEWER", "SITE_SOFTWARE_OVERRIDE_FLEET" ], "default": "SITE_SOFTWARE_OVERRIDE_SITE", "x-displayname": "Site Software Override Type.", "x-ves-proto-enum": "ves.io.schema.site.SiteSoftwareOverrideType", "x-f5xc-description-short": "Decide which software version takes effect in case of conflict between site and fleet Software version in site will take precedence.", "x-f5xc-description-medium": "Decide which software version takes effect in case of conflict between site and fleet Software version in site will take precedence. Between site and fleet newer software version will take precedence. Software version in fleet will take precedence.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteSoftwareOverrideType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_SOFTWARE_OVERRIDE_SITE\"", "example_yaml": "SITE_SOFTWARE_OVERRIDE_SITE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteStatus": { "type": "string", "description": "Status of the given site\n\n- NOT_FOUND: NOT_FOUND\n\nSite does not exist\n- FOUND: FOUND\n\nSite exists.", "title": "Site Status", "enum": [ "NOT_FOUND", "FOUND" ], "default": "NOT_FOUND", "x-displayname": "Site Status.", "x-ves-proto-enum": "ves.io.schema.site.SiteStatus", "x-f5xc-description-short": "Status of the given site - NOT_FOUND: NOT_FOUND Site does not exist - FOUND: FOUND Site exists.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NOT_FOUND\"", "example_yaml": "NOT_FOUND\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteStatusMetricsData": { "type": "object", "description": "Site Status Data contains name of the field and the corresponding data.", "title": "SiteStatusMetricsData", "x-displayname": "Site Status Metrics Data.", "x-ves-proto-message": "ves.io.schema.site.SiteStatusMetricsData", "properties": { "data": { "type": "array", "description": "List of metric data.", "title": "Data", "items": { "$ref": "#/components/schemas/siteSiteStatusMetricsFieldData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field": { "allOf": [ { "$ref": "#/components/schemas/siteSiteStatusMetricsField" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Site Status Data contains name of the field and the corresponding data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteStatusMetricsData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteStatusMetricsField": { "type": "string", "description": "Lists the fields that can queried in the site status metrics request.", "title": "SiteStatusMetricsField", "enum": [ "SITE_ACTIVE_FLOW_COUNT", "SITE_FLOW_SETUP_RATE", "SITE_IN_THROUGHPUT", "SITE_OUT_THROUGHPUT", "SITE_SYSTEM_ACTIVE_POD_COUNT", "SITE_VK8S_ACTIVE_POD_COUNT", "SITE_RE_IN_THROUGHPUT", "SITE_RE_OUT_THROUGHPUT", "SITE_SITE_IN_THROUGHPUT", "SITE_SITE_OUT_THROUGHPUT", "SITE_NODE_CPU_USAGE", "SITE_NODE_MEMORY_USAGE", "SITE_NODE_DISK_USAGE", "SITE_NODE_ACTIVE_FLOW_COUNT", "SITE_NODE_FLOW_SETUP_RATE", "SITE_NODE_IN_THROUGHPUT", "SITE_NODE_OUT_THROUGHPUT", "SITE_NODE_IF_IN_THROUGHPUT", "SITE_NODE_IF_OUT_THROUGHPUT" ], "default": "SITE_ACTIVE_FLOW_COUNT", "x-displayname": "Site Status Metrics Field.", "x-ves-proto-enum": "ves.io.schema.site.SiteStatusMetricsField", "x-f5xc-description-short": "Lists the fields that can queried in the site status metrics request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteStatusMetricsField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_ACTIVE_FLOW_COUNT\"", "example_yaml": "SITE_ACTIVE_FLOW_COUNT\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteStatusMetricsFieldData": { "type": "object", "description": "Site Status Field Data contains key/value pair for a field.", "title": "SiteStatusMetricsFieldData", "x-displayname": "Site Status Metrics Field Data.", "x-ves-proto-message": "ves.io.schema.site.SiteStatusMetricsFieldData", "properties": { "key": { "type": "object", "description": "Key contains name/value pair.\nFor SITE_RE_IN_THROUGHPUT, the key will be \"name\": \"\"\nFor SITE_NODE_IF_IN_THROUGHPUT, the key will be \"name\": \"\"", "title": "Key", "x-displayname": "Key", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-description-medium": "Key contains name/value pair. For SITE_RE_IN_THROUGHPUT, the key will be \"name\": \"\" For SITE_NODE_IF_IN_THROUGHPUT, the key will be \"name\": \"\".", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "value": { "type": "array", "description": "List of metric values.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Site Status Field Data contains key/value pair for a field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteStatusMetricsFieldData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteStatusMetricsRequest": { "type": "object", "description": "Request to GET status metrics for a site.", "title": "Site Status Metrics Request", "x-displayname": "Site Status Metrics Request.", "x-ves-proto-message": "ves.io.schema.site.SiteStatusMetricsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered.\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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570007981.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570007981", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric collection from which data will be considered.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field_selector": { "type": "array", "description": "List of fields to be returned in the response.", "title": "Field Selector", "items": { "$ref": "#/components/schemas/siteSiteStatusMetricsField" }, "x-displayname": "Field Selector.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "List of fields to be returned in the response.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Only system namespace is valid for this request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Only system namespace is valid for this request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "site": { "type": "string", "description": "Name of the site.", "title": "Site", "x-displayname": "Site", "x-ves-example": "Ce01", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ce01", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered.\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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570007981.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570007981", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of metric collection from which data will be considered.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "Step", "x-displayname": "Step", "x-ves-example": "15m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "15m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET status metrics for a site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteStatusMetricsRequest", "required_fields": [ "field_selector", "namespace", "site" ], "mutually_exclusive_groups": [], "example_json": "{\n \"field_selector\": [\n \"SITE_ACTIVE_FLOW_COUNT\"\n ],\n \"namespace\": \"system\",\n \"site\": \"ce01\"\n}", "example_yaml": "field_selector:\n- SITE_ACTIVE_FLOW_COUNT\nnamespace: system\nsite: ce01" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteStatusMetricsResponse": { "type": "object", "description": "Response for the Site Status Metrics Request.", "title": "Site Status Metrics Response", "x-displayname": "Site Status Metrics Response.", "x-ves-proto-message": "ves.io.schema.site.SiteStatusMetricsResponse", "properties": { "data": { "type": "array", "description": "Data contains time-series data for the status fields in the request.", "title": "Data", "items": { "$ref": "#/components/schemas/siteSiteStatusMetricsData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Data contains time-series data for the status fields in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for the Site Status Metrics Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteStatusMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteSubtype": { "type": "string", "description": "Sit Subtype\n\nNo Subtype\nRegional Edge isn't ready yet. Configuration isn't propagated for this site.\nRegional Edge which is hidden from customer. Configuration will be propagated.\nCE running in Kubernetes.", "title": "SiteSubtype", "enum": [ "NO_SUBTYPE", "VES_IO_USE_RE", "VES_IO_CE_IN_K8S", "VES_IO_HIDDEN_RE" ], "default": "NO_SUBTYPE", "x-displayname": "Site Subtype.", "x-ves-proto-enum": "ves.io.schema.site.SiteSubtype", "x-f5xc-description-short": "Sit Subtype No Subtype Regional Edge isn't ready yet. Configuration isn't propagated for this site.", "x-f5xc-description-medium": "Sit Subtype No Subtype Regional Edge isn't ready yet. Configuration isn't propagated for this site. Regional Edge which is hidden from customer. Configuration will be propagated. CE running in Kubernetes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteSubtype", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NO_SUBTYPE\"", "example_yaml": "NO_SUBTYPE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSiteType": { "type": "string", "description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.", "title": "SiteType", "enum": [ "INVALID", "REGIONAL_EDGE", "CUSTOMER_EDGE", "NGINX_ONE" ], "default": "INVALID", "x-displayname": "Site Type", "x-ves-proto-enum": "ves.io.schema.site.SiteType", "x-f5xc-description-short": "Site Type which can either RE or CE Invalid type of site Regional Edge site Customer Edge site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALID\"", "example_yaml": "INVALID\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteSoftwareUpgradePhase": { "type": "string", "description": "State of F5XC Software or Operating System upgrade phase in site\n\nSite Upgrade was triggered, but has not started yet\nSite upgrade was fetched and it is in progress\nSite upgrade was completed\nSite upgrade failed.", "title": "SoftwareUpgradePhase", "enum": [ "UPGRADE_INVALID", "UPGRADE_TRIGGERED", "UPGRADE_IN_PROGRESS", "UPGRADE_COMPLETED", "UPGRADE_FAILED" ], "default": "UPGRADE_INVALID", "x-displayname": "Software Upgrade Phase.", "x-ves-proto-enum": "ves.io.schema.site.SoftwareUpgradePhase", "x-f5xc-description-short": "State of F5XC Software or Operating System upgrade phase in site Site Upgrade was triggered, but has not started yet Site upgrade was fetched and...", "x-f5xc-description-medium": "State of F5XC Software or Operating System upgrade phase in site Site Upgrade was triggered, but has not started yet Site upgrade was fetched and it is in progress Site upgrade was completed Site upgrade failed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSoftwareUpgradePhase", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UPGRADE_INVALID\"", "example_yaml": "UPGRADE_INVALID\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteStatusObject": { "type": "object", "description": "Most recently observed status of site object.", "title": "Site Status Object", "x-displayname": "Status", "x-ves-displayorder": "1,3,5,13,6,7,8,12,9,10,11,14,15,16,17,18,19,20,21,22,24,26,27", "x-ves-proto-message": "ves.io.schema.site.StatusObject", "properties": { "certified_hardware": { "type": "string", "description": "Certified Hardware identifies what F5XC Certified Hardware is deployed at this site.", "title": "Certified Hardware", "x-displayname": "Certified Hardware.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Certified Hardware identifies what F5XC Certified Hardware is deployed at this site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dc_cluster_group_status": { "allOf": [ { "$ref": "#/components/schemas/schemaDcClusterGroupStatus__ves_io_schema_site" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment": { "allOf": [ { "$ref": "#/components/schemas/terraform_parametersDeploymentStatusType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "direct_connect_status": { "allOf": [ { "$ref": "#/components/schemas/siteDirectConnectStatusInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "express_route_status": { "allOf": [ { "$ref": "#/components/schemas/siteAzureExpressRouteStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fleet_status": { "allOf": [ { "$ref": "#/components/schemas/siteFleetStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostname": { "type": "string", "description": "Hostname of node in site.", "title": "Hostname", "x-displayname": "Hostname", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "hw_info": { "allOf": [ { "$ref": "#/components/schemas/siteOsInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "internet_VIP_status": { "allOf": [ { "$ref": "#/components/schemas/viewsInternetVIPStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "managed_site_orchestration_status": { "allOf": [ { "$ref": "#/components/schemas/siteOrchestrationStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_info": { "allOf": [ { "$ref": "#/components/schemas/siteNodeInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Site object reference for which this status object is generated.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-description-short": "Site object reference for which this status object is generated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "offline_survivability_status": { "allOf": [ { "$ref": "#/components/schemas/siteOfflineSurvivabilityStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operating_system_status": { "allOf": [ { "$ref": "#/components/schemas/siteOperatingSystemStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scaling_status": { "allOf": [ { "$ref": "#/components/schemas/siteScalingStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_errors": { "type": "array", "description": "Site Errors.", "title": "SiteErrors", "items": { "$ref": "#/components/schemas/viewsSiteError" }, "x-displayname": "Site Errors.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_mesh_group_status": { "allOf": [ { "$ref": "#/components/schemas/schemaSiteMeshGroupStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_reachability_scan_status_list": { "type": "array", "description": "List of SiteReachabilityStatus status shows status of domain reachability during registration.", "title": "Site Reachability Scan Status List", "items": { "$ref": "#/components/schemas/siteSiteReachabilityStatus" }, "x-displayname": "Site Reachability Scan Status List.", "x-f5xc-description-short": "List of SiteReachabilityStatus status shows status of domain reachability during registration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ver_master_status": { "allOf": [ { "$ref": "#/components/schemas/siteVerMasterStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ver_status": { "allOf": [ { "$ref": "#/components/schemas/siteVerStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet_peering_status": { "allOf": [ { "$ref": "#/components/schemas/siteAzureHubSpokeVnetPeeringStatusInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_software_status": { "allOf": [ { "$ref": "#/components/schemas/siteVolterraSoftwareStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of site object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteStorageDevice": { "type": "object", "description": "StorageDevice information.", "title": "Storage Information", "x-displayname": "Storage Information.", "x-ves-proto-message": "ves.io.schema.site.StorageDevice", "properties": { "driver": { "type": "string", "description": "Driver of device.", "title": "driver", "x-displayname": "Driver", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "model": { "type": "string", "description": "Model of device.", "title": "model", "x-displayname": "Model", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of device, eg. Nvme0n1.", "title": "name", "x-displayname": "Name", "x-ves-example": "Nvme0n1", "x-f5xc-example": "nvme0n1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "serial": { "type": "string", "description": "Serial of device.", "title": "serial", "x-displayname": "Serial Number.", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "size_gb": { "type": "integer", "description": "Device size in GB.", "title": "size_gb", "format": "int64", "x-displayname": "Size(GB)", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Vendor of device.", "title": "vendor", "x-displayname": "Vendor", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteStorageDevice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteTunnelConnectionStatus": { "type": "object", "description": "Status of tunnel connection that a Ver has originated / terminated.", "title": "Tunnel Connection Status", "x-displayname": "Tunnel Connection Status.", "x-ves-proto-message": "ves.io.schema.site.TunnelConnectionStatus", "properties": { "bgp": { "type": "array", "description": "Internal reference to BGP object corresponding to this tunnel.", "title": "BGP Object", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "BGP Object.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Internal reference to BGP object corresponding to this tunnel.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_peer_protocol_state": { "allOf": [ { "$ref": "#/components/schemas/bgpBgpPeerProtocolState" } ], "x-f5xc-description-short": "Configuration parameter for bgp peer protocol state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bgp_status": { "allOf": [ { "$ref": "#/components/schemas/bgpBgpPeerUpDownType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "encap": { "allOf": [ { "$ref": "#/components/schemas/schemaTunnelEncapsulationType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ike_tunnel_flap_reason": { "allOf": [ { "$ref": "#/components/schemas/siteTunnelFlapReason" } ], "x-f5xc-description-short": "Configuration parameter for ike tunnel flap reason.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "isLocal": { "type": "boolean", "description": "Identifies if the IPsec connection is local to the ver node or not.", "title": "isLocal", "format": "boolean", "x-displayname": "Local", "x-f5xc-description-short": "Identifies if the IPsec connection is local to the ver node or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "remoteAddress": { "type": "string", "description": "IP address of the remote end.", "title": "remoteAddress", "x-displayname": "Remote Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "role": { "allOf": [ { "$ref": "#/components/schemas/siteTunnelRole" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ssl_tunnel_flap_reason": { "allOf": [ { "$ref": "#/components/schemas/siteTunnelFlapReason" } ], "x-f5xc-description-short": "Configuration parameter for ssl tunnel flap reason.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteTunnelState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnel": { "type": "array", "description": "Internal reference to Tunnel object corresponding to this status.", "title": "Tunnel Object", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Tunnel Object.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Internal reference to Tunnel object corresponding to this status.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tunnelName": { "type": "string", "description": "Tunnel name.", "title": "tunnelName", "x-displayname": "Tunnel Name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "URL identifies the other end of the Ver for tunnel origination/termination.", "title": "url", "x-displayname": "URL", "x-f5xc-description-short": "URL identifies the other end of the Ver for tunnel origination/termination.", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "verNodeIp": { "type": "string", "description": "The VER node IP in the local site from which the connection is setup.", "title": "verNodeIP", "x-displayname": "VER Node IP.", "x-f5xc-description-short": "The VER node IP in the local site from which the connection is setup.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "verNodeName": { "type": "string", "description": "The VER node in the local site from which the connection is setup.", "title": "verNodeName", "x-displayname": "VER Node Name.", "x-f5xc-description-short": "The VER node in the local site from which the connection is setup.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Status of tunnel connection that a Ver has originated / terminated.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteTunnelConnectionStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteTunnelFlapReason": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.TunnelFlapReason", "properties": { "flap_reason": { "type": "string", "description": "Flap reason for tunnel.", "title": "Flap Reason", "x-displayname": "Flap Reason.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time": { "type": "string", "description": "Flap time for tunnel.", "title": "Flap time", "format": "date-time", "x-displayname": "Flap time", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 8, "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "formatDescription": "Time format (e.g., 14:30:00)", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteTunnelFlapReason", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteTunnelRole": { "type": "string", "description": "Role of VER in a tunnel connection\n\nInvalid role\nClient initiating the connection\nServer responding to the connection.", "title": "TunnelRole", "enum": [ "UNKNOWN_TUNNEL_ROLE", "TUNNEL_INITIATOR", "TUNNEL_RESPONDER" ], "default": "UNKNOWN_TUNNEL_ROLE", "x-displayname": "Tunnel Role.", "x-ves-proto-enum": "ves.io.schema.site.TunnelRole", "x-f5xc-description-short": "Role of VER in a tunnel connection Invalid role Client initiating the connection Server responding to the connection.", "x-f5xc-description-medium": "Role of VER in a tunnel connection Invalid role Client initiating the connection Server responding to the connection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteTunnelRole", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNKNOWN_TUNNEL_ROLE\"", "example_yaml": "UNKNOWN_TUNNEL_ROLE\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteTunnelState": { "type": "string", "description": "Tunnel state connecting the site to remote\n\nInvalid Tunnel state\nTunnel Connection is up\nTunnel Connection is down\nTunnel is disabled.", "title": "Tunnel State", "enum": [ "UNKNOWN_TUNNEL_STATE", "TUNNEL_UP", "TUNNEL_DOWN", "TUNNEL_DISABLED" ], "default": "UNKNOWN_TUNNEL_STATE", "x-displayname": "Tunnel State.", "x-ves-proto-enum": "ves.io.schema.site.TunnelState", "x-f5xc-description-short": "Tunnel state connecting the site to remote Invalid Tunnel state Tunnel Connection is up Tunnel Connection is down Tunnel is disabled.", "x-f5xc-description-medium": "Tunnel state connecting the site to remote Invalid Tunnel state Tunnel Connection is up Tunnel Connection is down Tunnel is disabled.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteTunnelState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNKNOWN_TUNNEL_STATE\"", "example_yaml": "UNKNOWN_TUNNEL_STATE\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteUSBDevice": { "type": "object", "description": "Information about USB device.", "title": "USB device", "x-displayname": "USB Device information.", "x-ves-proto-message": "ves.io.schema.site.USBDevice", "properties": { "address": { "type": "integer", "description": "Address of the device on the bus in decimal.", "title": "address", "format": "int64", "x-displayname": "Address", "x-ves-example": "4", "x-f5xc-example": "4", "x-f5xc-description-short": "Address of the device on the bus in decimal.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "b_device_class": { "type": "string", "description": "The class of this device.", "title": "b_device_class", "x-displayname": "Class", "x-ves-example": "Hub", "x-f5xc-example": "hub", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "b_device_protocol": { "type": "string", "description": "The protocol (within the sub-class) of this device.", "title": "b_device_protocol", "x-displayname": "Protocol", "x-ves-example": "0002", "x-f5xc-example": "0002", "x-f5xc-description-short": "The protocol (within the sub-class) of this device.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "b_device_sub_class": { "type": "string", "description": "The sub-class (within the class) of this device.", "title": "b_device_sub_class", "x-displayname": "Subclass", "x-ves-example": "Hub", "x-f5xc-example": "hub", "x-f5xc-description-short": "The sub-class (within the class) of this device.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "b_max_packet_size": { "type": "integer", "description": "Maximum size of the control transfer.", "title": "b_max_packet_size", "format": "int64", "x-displayname": "Max packet size.", "x-ves-example": "64", "x-f5xc-example": "64", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bcd_device": { "type": "string", "description": "The device version.", "title": "bcd_device", "x-displayname": "BCD Device.", "x-ves-example": "5.05", "x-f5xc-example": "5.05", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bcd_usb": { "type": "string", "description": "USB Specification Release Number.", "title": "bcd_usb", "x-displayname": "BCD Spec", "x-ves-example": "2.0", "x-f5xc-example": "2.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bus": { "type": "integer", "description": "The bus on which the device was detected in decimal.", "title": "bus", "format": "int64", "x-displayname": "Bus", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-description-short": "The bus on which the device was detected in decimal.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Device description.", "title": "description", "x-displayname": "Description.", "x-ves-example": "NetVista Full Width Keyboard (IBM Corp.)", "x-f5xc-example": "NetVista Full Width Keyboard (IBM Corp.)", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "i_manufacturer": { "type": "string", "description": "Manufacturer name.", "title": "i_manufacturer", "x-displayname": "Manufacturer.", "x-ves-example": "Voltera", "x-f5xc-example": "Voltera", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "i_product": { "type": "string", "description": "Product name reported by device.", "title": "i_product", "x-displayname": "Device product.", "x-ves-example": "XHCI Host Controller.", "x-f5xc-example": "xHCI Host Controller", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "i_serial": { "type": "string", "description": "Index of Serial Number String Descriptor.", "title": "i_serial_number", "x-displayname": "ISerialNumber.", "x-ves-example": "0000:00:14.0.", "x-f5xc-example": "0000:00:14.0", "x-f5xc-description-short": "Index of Serial Number String Descriptor.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id_product": { "type": "string", "description": "Product ID (Assigned by Manufacturer) in hex.", "title": "id_product", "x-displayname": "Product ID.", "x-ves-example": "0x0002", "x-f5xc-example": "0x0002", "x-f5xc-description-short": "Product ID (Assigned by Manufacturer) in hex.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id_vendor": { "type": "string", "description": "Vendor ID (Assigned by USB Org) in hex.", "title": "id_vendor", "x-displayname": "Vendor ID", "x-ves-example": "0x1d6b", "x-f5xc-example": "0x1d6b", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "port": { "type": "integer", "description": "Port on which the device was detected in decimal.", "title": "port", "format": "int64", "x-displayname": "Port", "x-ves-example": "3", "x-f5xc-example": "3", "x-f5xc-description-short": "Port on which the device was detected in decimal.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "product_name": { "type": "string", "description": "Product ID translated to name (if available)", "title": "product_name", "x-displayname": "Product name.", "x-ves-example": "NetVista Full Width Keyboard.", "x-f5xc-example": "NetVista Full Width Keyboard", "x-f5xc-description-short": "Product ID translated to name (if available).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "speed": { "type": "string", "description": "The negotiated operating speed for the device.", "title": "speed", "x-displayname": "Speed", "x-ves-example": "High", "x-f5xc-example": "high", "x-f5xc-description-short": "The negotiated operating speed for the device.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "usb_type": { "allOf": [ { "$ref": "#/components/schemas/siteUsbType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor_name": { "type": "string", "description": "Vendor ID translated to name (if available)", "title": "vendor_name", "x-displayname": "Vendor name.", "x-ves-example": "IBM Corp.", "x-f5xc-example": "IBM Corp.", "x-f5xc-description-short": "Vendor ID translated to name (if available).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteUSBDevice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteUpgradeOSRequest": { "type": "object", "description": "Request for Upgrade OS of Site.", "title": "Upgrade OS request", "x-displayname": "Upgrade OS Request.", "x-ves-proto-message": "ves.io.schema.site.UpgradeOSRequest", "properties": { "force": { "type": "boolean", "description": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress)", "title": "Force", "format": "boolean", "x-displayname": "Force", "x-ves-required": "false", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "false" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "false" }, "x-f5xc-example": "true", "x-f5xc-description-short": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e.", "x-f5xc-description-medium": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Site name", "title": "Name", "x-displayname": "Name", "x-ves-example": "Ce398", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ce398", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Site namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "Version to upgraded to.", "title": "SW/OS Version", "x-displayname": "Version", "x-ves-example": "7.2003.20", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "7.2003.20", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteUpgradeOSRequest", "required_fields": [ "name", "namespace", "version" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"ce398\",\n \"namespace\": \"system\",\n \"version\": \"7.2003.20\"\n}", "example_yaml": "name: ce398\nnamespace: system\nversion: 7.2003.20" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteUpgradeOSResponse": { "type": "object", "description": "Response for OS Upgrade Request, empty because the only returned information\nis currently error message.", "title": "Upgrade OS Response", "x-displayname": "Upgrade OS Response.", "x-ves-proto-message": "ves.io.schema.site.UpgradeOSResponse", "x-f5xc-description-short": "Response for OS Upgrade Request, empty because the only returned information is currently error message.", "x-f5xc-description-medium": "Response for OS Upgrade Request, empty because the only returned information is currently error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteUpgradeOSResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteUpgradeSWRequest": { "type": "object", "description": "Request for Upgrade SW of Site.", "title": "Upgrade SW request", "x-displayname": "Upgrade SW Request.", "x-ves-proto-message": "ves.io.schema.site.UpgradeSWRequest", "properties": { "force": { "type": "boolean", "description": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress)", "title": "Force", "format": "boolean", "x-displayname": "Force", "x-ves-required": "false", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "false" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "false" }, "x-f5xc-example": "true", "x-f5xc-description-short": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e.", "x-f5xc-description-medium": "Force upgrade even when logic checks are PUT in place to not allow software upgrades (i.e. OS upgrade in progress).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Site name", "title": "Name", "x-displayname": "Name", "x-ves-example": "Ce398", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ce398", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Site namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "Version to upgraded to.", "title": "SW/OS Version", "x-displayname": "Version", "x-ves-example": "Crt-20201010-600.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "crt-20201010-600", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteUpgradeSWRequest", "required_fields": [ "name", "namespace", "version" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"ce398\",\n \"namespace\": \"system\",\n \"version\": \"crt-20201010-600\"\n}", "example_yaml": "name: ce398\nnamespace: system\nversion: crt-20201010-600" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteUpgradeSWResponse": { "type": "object", "description": "Response for SW Upgrade Request, empty because the only returned information\nis currently error message.", "title": "Upgrade SW Response", "x-displayname": "Upgrade SW Response.", "x-ves-proto-message": "ves.io.schema.site.UpgradeSWResponse", "x-f5xc-description-short": "Response for SW Upgrade Request, empty because the only returned information is currently error message.", "x-f5xc-description-medium": "Response for SW Upgrade Request, empty because the only returned information is currently error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteUpgradeSWResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteUsbType": { "type": "string", "description": "Type of USB device\n\nUnknown USB device type\nInternal USB present in Certified HW\nUSB device present during node registration\nUSB device that can be matched by USB rules.", "title": "UsbType", "enum": [ "UNKNOWN_USB", "INTERNAL", "REGISTERED", "CONFIGURABLE" ], "default": "UNKNOWN_USB", "x-displayname": "USB Type", "x-ves-proto-enum": "ves.io.schema.site.UsbType", "x-f5xc-description-short": "Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be...", "x-f5xc-description-medium": "Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be matched by USB rules.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteUsbType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNKNOWN_USB\"", "example_yaml": "UNKNOWN_USB\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVTRPState": { "type": "string", "description": "State of VTRP connection between (VER control plane)Vega & (F5XC Fabric control)Ares\n\nConnection is initialized\nVTRP connection is active\nConnecting to the server\nTCP connection is up\nVTRP session established\nConnection is deleted.", "title": "VTRPState", "enum": [ "INIT", "ACTIVE", "CONNECTING", "CONNECTED", "ESTABLISHED", "DELETE" ], "default": "INIT", "x-displayname": "VTRP State.", "x-ves-proto-enum": "ves.io.schema.site.VTRPState", "x-f5xc-description-short": "State of VTRP connection between (VER control plane)Vega & (F5XC Fabric control)Ares Connection is initialized VTRP connection is active...", "x-f5xc-description-medium": "State of VTRP connection between (VER control plane)Vega & (F5XC Fabric control)Ares Connection is initialized VTRP connection is active Connecting to the server TCP connection is up VTRP session established Connection is deleted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVTRPState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INIT\"", "example_yaml": "INIT\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVerInstanceRunningStateStatus": { "type": "string", "description": "Details of Ver Instance Running State\n\n- OPERATIONAL_READY: Operational Ready\n\nVer instance is operational ready\n- INIT_IN_PROGRESS: Init in progress\n\nVer instance is in initializing and is not operationally ready\n- UPGRADE_READY: Upgrade Ready\n\nVer instance is upgrade ready\n- UPGRADE_READY_IN_PROGRESS: Upgrade ready in progress\n\nVer instance upgrade ready is in progress\n- OPERATIONAL_READY_IN_PROGRESS: Operational Ready in progress\n\nVer instance is operational ready in progress\n- OPERATIONAL_READY_DEGRADED: Operational Ready Degraded\n\nVer instance in operational ready with few service in degraded state.", "title": "Ver Instance Running State Status", "enum": [ "OPERATIONAL_READY", "INIT_IN_PROGRESS", "UPGRADE_READY", "UPGRADE_READY_IN_PROGRESS", "OPERATIONAL_READY_IN_PROGRESS", "OPERATIONAL_READY_DEGRADED" ], "default": "OPERATIONAL_READY", "x-displayname": "Ver Instance Running State Status.", "x-ves-proto-enum": "ves.io.schema.site.VerInstanceRunningStateStatus", "x-f5xc-description-short": "Details of Ver Instance Running State - OPERATIONAL_READY: Operational Ready Ver instance is operational ready - INIT_IN_PROGRESS: Init in...", "x-f5xc-description-medium": "Details of Ver Instance Running State - OPERATIONAL_READY: Operational Ready Ver instance is operational ready - INIT_IN_PROGRESS: Init in progress Ver instance is in initializing and is not operationally ready - UPGRADE_READY: Upgrade Ready Ver instance is upgrade ready ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVerInstanceRunningStateStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"OPERATIONAL_READY\"", "example_yaml": "OPERATIONAL_READY\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVerInstanceRunningStateStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.VerInstanceRunningStateStatusType", "properties": { "description": { "type": "string", "description": "Description gives the reason for ver being in this state.", "title": "State Description\ndescription", "x-displayname": "Description.", "x-f5xc-description-short": "Description gives the reason for ver being in this state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "state": { "allOf": [ { "$ref": "#/components/schemas/siteVerInstanceRunningStateStatus" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVerInstanceRunningStateStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVerMasterStatusType": { "type": "object", "description": "Info of the Master Ver of the site.", "title": "VerMasterStatus", "x-displayname": "Ver Master Status.", "x-ves-proto-message": "ves.io.schema.site.VerMasterStatusType", "properties": { "transition_timestamp": { "type": "string", "description": "Timestamp at which the VER became cluster master.", "title": "Mastership Transition TimeStamp", "format": "date-time", "x-displayname": "Mastership Transition TimeStamp.", "x-f5xc-description-short": "Timestamp at which the VER became cluster master.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ver_UID": { "type": "string", "description": "UID of Master VER in the Cluster.", "title": "Master Ver UID", "x-displayname": "Master Ver UID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ver_name": { "type": "string", "description": "Instance name of Master VER in the Cluster.", "title": "Master Ver Node Name", "x-displayname": "Master Ver Node Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Instance name of Master VER in the Cluster.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVerMasterStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVerStatusType": { "type": "object", "description": "Ver details in the site that has generated the site status object.", "title": "VerStatus", "x-displayname": "Ver Status.", "x-ves-proto-message": "ves.io.schema.site.VerStatusType", "properties": { "ares_status": { "type": "array", "description": "Status of every Ares connections this Ver is connecting to for routes.", "title": "ares_status", "items": { "$ref": "#/components/schemas/siteAresConnectionStatus" }, "x-displayname": "Ares Status.", "x-f5xc-description-short": "Status of every Ares connections this Ver is connecting to for routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "configured_tunnel_status": { "type": "array", "description": "Status/details of every configured connection this Ver is originating.", "title": "configured_tunnel_connection_status", "items": { "$ref": "#/components/schemas/siteTunnelConnectionStatus" }, "x-displayname": "Configured Tunnel Connection Status.", "x-f5xc-description-short": "Status/details of every configured connection this Ver is originating.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ext_connector_tunnel_status": { "type": "array", "description": "Status/details of every tunnel configured as external connector.", "title": "external_connector_tunnel_status", "items": { "$ref": "#/components/schemas/siteTunnelConnectionStatus" }, "x-displayname": "External Connector Tunnel Status.", "x-f5xc-description-short": "Status/details of every tunnel configured as external connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "intf_status": { "type": "array", "description": "Status of every inside or outside interface present in this VER.", "title": "interface_status", "items": { "$ref": "#/components/schemas/siteInterfaceStatus__ves_io_schema_site" }, "x-displayname": "Interface Status.", "x-f5xc-description-short": "Status of every inside or outside interface present in this VER.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "running_state_status": { "allOf": [ { "$ref": "#/components/schemas/siteVerInstanceRunningStateStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_tunnel_status": { "type": "array", "description": "Status/details of every site connection this Ver is originating/ terminating.", "title": "site_tunnel_status", "items": { "$ref": "#/components/schemas/siteTunnelConnectionStatus" }, "x-displayname": "Site Tunnel Status.", "x-f5xc-description-short": "Status/details of every site connection this Ver is originating/ terminating.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ver_instance_name": { "type": "string", "description": "Name of the ver instance that created this site status.", "title": "ver_instance_name", "x-displayname": "VER Instance.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the ver instance that created this site status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Ver details in the site that has generated the site status object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVerStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVirtualMachineInstancesMetricData": { "type": "object", "description": "Virtual Machine Instances Metric Data.", "title": "VirtualMachineInstancesMetricData", "x-displayname": "Virtual Machine Instances Metric Data.", "x-ves-proto-message": "ves.io.schema.site.VirtualMachineInstancesMetricData", "properties": { "data": { "type": "array", "description": "List of metric data.", "title": "Data", "items": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVirtualMachineInstancesMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVirtualMachineInstancesMetricType": { "type": "string", "description": "List of metric types for Virtual Machine Instances.", "title": "VirtualMachineInstancesMetricType", "enum": [ "VMI_METRIC_TYPE_IN_BYTES", "VMI_METRIC_TYPE_OUT_BYTES", "VMI_METRIC_TYPE_IN_DROP_PACKETS", "VMI_METRIC_TYPE_OUT_DROP_PACKETS", "VMI_METRIC_TYPE_IN_PACKETS", "VMI_METRIC_TYPE_OUT_PACKETS" ], "default": "VMI_METRIC_TYPE_IN_BYTES", "x-displayname": "Virtual Machine Instances Metric Type.", "x-ves-proto-enum": "ves.io.schema.site.VirtualMachineInstancesMetricType", "x-f5xc-description-short": "List of metric types for Virtual Machine Instances.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVirtualMachineInstancesMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VMI_METRIC_TYPE_IN_BYTES\"", "example_yaml": "VMI_METRIC_TYPE_IN_BYTES\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVirtualMachineInstancesMetricTypeData": { "type": "object", "description": "Metric Type Data contains labels that uniquely identifies individual entity and its corresponding metric values.", "title": "VirtualMachineInstancesMetricTypeData", "x-displayname": "Virtual Machine Instances Metric Type Data.", "x-ves-proto-message": "ves.io.schema.site.VirtualMachineInstancesMetricTypeData", "properties": { "labels": { "type": "object", "description": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported.\n\"name\" is the label name defined in \"VirtualMachineInstancesMetricLabel\"", "title": "Labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. \"name\" is the label name defined in...", "x-f5xc-description-medium": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. \"name\" is the label name defined in \"VirtualMachineInstancesMetricLabel\".", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "description": "List of metric values. May contain more than one value if timeseries data is requested.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-description-short": "List of metric values. May contain more than one value if timeseries data is requested.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metric Type Data contains labels that uniquely identifies individual entity and its corresponding metric values.", "x-f5xc-description-medium": "Metric Type Data contains labels that uniquely identifies individual entity and its corresponding metric values.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVirtualMachineInstancesMetricTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVirtualMachineInstancesMetricsRequest": { "type": "object", "description": "Request to GET Virtual Machine Instances Metrics.", "title": "VirtualMachineInstancesMetricsRequest", "x-displayname": "Virtual Machine Instances Metrics Request.", "x-ves-proto-message": "ves.io.schema.site.VirtualMachineInstancesMetricsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric data.\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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-medium": "End time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric_selector": { "type": "array", "description": "Select metrics to be returned in the response.", "title": "Metric Selector", "items": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricType" }, "x-displayname": "Metric Selector.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select metrics to be returned in the response.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace to scope the listing of cronjobs in a site.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace to scope the listing of cronjobs in a site.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "site": { "type": "string", "description": "Site name", "title": "site", "x-displayname": "Site", "x-ves-example": "Site-1", "x-f5xc-example": "site-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of metric data.\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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-medium": "Start time of metric data. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET Virtual Machine Instances Metrics.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVirtualMachineInstancesMetricsRequest", "required_fields": [ "metric_selector" ], "mutually_exclusive_groups": [], "example_json": "{\n \"metric_selector\": [\n \"VMI_METRIC_TYPE_IN_BYTES\"\n ]\n}", "example_yaml": "metric_selector:\n- VMI_METRIC_TYPE_IN_BYTES" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVirtualMachineInstancesMetricsResponse": { "type": "object", "description": "Virtual Machine Instances Metrics Response.", "title": "VirtualMachineInstancesMetricsResponse", "x-displayname": "Virtual Machine Instances Metrics Response.", "x-ves-proto-message": "ves.io.schema.site.VirtualMachineInstancesMetricsResponse", "properties": { "data": { "type": "array", "description": "Data for the metric types specified in the request.", "title": "Data", "items": { "$ref": "#/components/schemas/siteVirtualMachineInstancesMetricData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Data for the metric types specified in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Virtual Machine Instances Metrics Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVirtualMachineInstancesMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVnetGatewayStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.site.VnetGatewayStatusType", "properties": { "connection_status": { "type": "array", "description": "Azure Express Route Circuit Connection Status.", "title": "Azure Express Route Circuit Connection Status", "items": { "$ref": "#/components/schemas/siteAzureExpressRouteCircuitStatusType" }, "x-displayname": "Azure Express Route Circuit Connection Status.", "x-f5xc-description-short": "Azure Express Route Circuit Connection Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vgw_id": { "type": "string", "description": "VNet Gateway ID.", "title": "VNET Gateway ID", "x-displayname": "VNet Gateway ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vgw_name": { "type": "string", "description": "VNet Gateway Name.", "title": "VNET Gateway Name", "x-displayname": "VNet Gateway Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vgw_state": { "type": "string", "description": "VNet Gateway State.", "title": "VNET Gateway State", "x-displayname": "VNet Gateway State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVnetGatewayStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteVolterraSoftwareStatus": { "type": "object", "description": "F5XC software version running in the site.", "title": "F5XC Software Status", "x-displayname": "F5XC Software Status.", "x-ves-proto-message": "ves.io.schema.site.VolterraSoftwareStatus", "properties": { "available_version": { "type": "string", "description": "Available version represent F5 Distributed Cloud software version ready to be upgraded in the site.", "title": "available_version", "x-displayname": "Available Version.", "x-f5xc-description-short": "Available version represent F5 Distributed Cloud software version ready to be upgraded in the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_state": { "allOf": [ { "$ref": "#/components/schemas/siteDeploymentState" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_installed_version": { "type": "string", "description": "Last installed version represent last F5 Distributed Cloud software version that has successfully deployed in the site.", "title": "last_installed_version", "x-displayname": "Last Installed Version.", "x-f5xc-description-short": "Last installed version represent last F5 Distributed Cloud software version that has successfully deployed in the site.", "x-f5xc-description-medium": "Last installed version represent last F5 Distributed Cloud software version that has successfully deployed in the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nonconforming_state": { "type": "string", "description": "If nonconforming state is not empty, then current deployed SW version is nonconforming. Site should be upgrade to available version.", "title": "Nonconforming State", "maxLength": 256, "x-displayname": "Nonconforming State.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "If nonconforming state is not empty, then current deployed SW version is nonconforming.", "x-f5xc-description-medium": "If nonconforming state is not empty, then current deployed SW version is nonconforming. Site should be upgrade to available version.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "software_version_expiry_date": { "type": "string", "description": "Expiry date of software version in YYYY-MM-DD.", "title": "software version expiry date", "x-displayname": "Software Version Expiry Date.", "x-ves-example": "2024-12-13.", "x-f5xc-example": "2024-12-13", "x-f5xc-description-short": "Expiry date of software version in YYYY-MM-DD.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "F5XC software version running in the site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteVolterraSoftwareStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1AWSElasticBlockStoreVolumeSource": { "type": "object", "description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk\nmust also be in the same AWS zone as the kubelet. An AWS EBS disk\ncan only be mounted as read/write once. AWS EBS volumes support\nownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "partition": { "type": "integer", "title": "The partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional", "format": "int32", "description": "Configuration parameter for partition", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\".\nIf omitted, the default is \"false\".\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeID": { "type": "string", "title": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container.", "x-f5xc-description-medium": "Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1AWSElasticBlockStoreVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Affinity": { "type": "object", "description": "Affinity is a group of affinity scheduling rules.", "properties": { "nodeAffinity": { "allOf": [ { "$ref": "#/components/schemas/v1NodeAffinity" } ], "x-f5xc-description-short": "Configuration parameter for nodeAffinity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "podAffinity": { "allOf": [ { "$ref": "#/components/schemas/v1PodAffinity" } ], "x-f5xc-description-short": "Configuration parameter for podAffinity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "podAntiAffinity": { "allOf": [ { "$ref": "#/components/schemas/v1PodAntiAffinity" } ], "x-f5xc-description-short": "Configuration parameter for podAntiAffinity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Affinity is a group of affinity scheduling rules.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Affinity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1AttachedVolume": { "type": "object", "title": "AttachedVolume describes a volume attached to a node", "properties": { "devicePath": { "type": "string", "title": "DevicePath represents the device path where the volume should be available", "description": "File system or URL path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "title": "Name of the attached volume", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1AttachedVolume", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1AzureDiskVolumeSource": { "type": "object", "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", "properties": { "cachingMode": { "type": "string", "title": "Host Caching mode: None, Read Only, Read Write.\n+optional", "description": "Configuration parameter for cachingMode", "x-f5xc-description-short": "Configuration parameter for cachingMode.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "diskName": { "type": "string", "title": "The Name of the data disk in the blob storage", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "diskURI": { "type": "string", "title": "The URI the data disk in the blob storage", "description": "Uniform Resource Identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kind": { "type": "string", "title": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared", "description": "Resource type or kind", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1AzureDiskVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1AzureFilePersistentVolumeSource": { "type": "object", "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "properties": { "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretName": { "type": "string", "title": "the name of secret that contains Azure Storage Account Name and Key", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretNamespace": { "type": "string", "title": "the namespace of the secret that contains Azure Storage Account Name and Key\ndefault is the same as the Pod\n+optional", "description": "Namespace for resource isolation", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "shareName": { "type": "string", "title": "Share Name", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1AzureFilePersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1AzureFileVolumeSource": { "type": "object", "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "properties": { "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretName": { "type": "string", "title": "the name of secret that contains Azure Storage Account Name and Key", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "shareName": { "type": "string", "title": "Share Name", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1AzureFileVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1CSIPersistentVolumeSource": { "type": "object", "title": "Represents storage that is managed by an external CSI volume driver (Beta feature)", "properties": { "controllerExpandSecretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "controllerPublishSecretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "driver": { "type": "string", "description": "Driver is the name of the driver to use for this volume.\nRequired.", "x-f5xc-description-short": "Driver is the name of the driver to use for this volume. Required.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodePublishSecretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodeStageSecretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: The value to pass to ControllerPublishVolumeRequest.\nDefaults to false (read/write).\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeAttributes": { "type": "object", "title": "Attributes of the volume to publish.\n+optional", "description": "Configuration parameter for volumeAttributes", "x-f5xc-description-short": "Configuration parameter for volumeAttributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeHandle": { "type": "string", "description": "VolumeHandle is the unique volume name returned by the CSI volume\nplugin’s CreateVolume to refer to the volume on all subsequent calls.\nRequired.", "x-f5xc-description-short": "VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls.", "x-f5xc-description-medium": "VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1CSIPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1CSIVolumeSource": { "type": "object", "title": "Represents a source location of a volume to mount, managed by an external CSI driver", "properties": { "driver": { "type": "string", "description": "Driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster.", "x-f5xc-description-short": "Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.", "x-f5xc-description-medium": "Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodePublishSecretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeAttributes": { "type": "object", "title": "VolumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional", "description": "Configuration parameter for volumeAttributes", "x-f5xc-description-short": "Configuration parameter for volumeAttributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1CSIVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Capabilities": { "type": "object", "description": "Adds and removes POSIX capabilities from running containers.", "properties": { "add": { "type": "array", "title": "Added capabilities\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for add", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "drop": { "type": "array", "title": "Removed capabilities\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for drop", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Adds and removes POSIX capabilities from running containers.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Capabilities", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1CephFSPersistentVolumeSource": { "type": "object", "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod\nCephfs volumes do not support ownership management or SELinux relabeling.", "properties": { "monitors": { "type": "array", "title": "Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "items": { "type": "string" }, "description": "Configuration parameter for monitors", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "title": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretFile": { "type": "string", "title": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "string", "title": "Optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for user", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1CephFSPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1CephFSVolumeSource": { "type": "object", "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod\nCephfs volumes do not support ownership management or SELinux relabeling.", "properties": { "monitors": { "type": "array", "title": "Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "items": { "type": "string" }, "description": "Configuration parameter for monitors", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "title": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretFile": { "type": "string", "title": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "string", "title": "Optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for user", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1CephFSVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1CinderPersistentVolumeSource": { "type": "object", "description": "Represents a cinder volume resource in Openstack.\nA Cinder volume must exist before mounting to a container.\nThe volume must also be in the same region as the kubelet.\nCinder volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeID": { "type": "string", "title": "volume id used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container.", "x-f5xc-description-medium": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1CinderPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1CinderVolumeSource": { "type": "object", "description": "Represents a cinder volume resource in Openstack.\nA Cinder volume must exist before mounting to a container.\nThe volume must also be in the same region as the kubelet.\nCinder volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeID": { "type": "string", "title": "volume id used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container.", "x-f5xc-description-medium": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1CinderVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ClientIPConfig": { "type": "object", "description": "ClientIPConfig represents the configurations of Client IP based session affinity.", "properties": { "timeoutSeconds": { "type": "integer", "title": "timeoutSeconds specifies the seconds of ClientIP type session sticky time.\nThe value must be >0 && <=86400(for 1 day) if ServiceAffinity == \"ClientIP\".\nDefault value is 10800(for 3 hours).\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ClientIPConfig represents the configurations of Client IP based session affinity.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ClientIPConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMap": { "type": "object", "description": "ConfigMap holds configuration data for pods to consume.", "properties": { "binaryData": { "type": "object", "title": "BinaryData contains the binary data.\nEach key must consist of alphanumeric characters, '-', '_' or '.'.\nBinaryData can contain byte sequences that are not in the UTF-8 range.\nThe keys stored in BinaryData must not overlap with the ones in\nthe Data field, this is enforced during validation process.\nUsing this field will require 1.10+ apiserver and\nkubelet.\n+optional", "description": "Data or content configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "type": "object", "title": "Data contains the configuration data.\nEach key must consist of alphanumeric characters, '-', '_' or '.'.\nValues with non-UTF-8 byte sequences must use the BinaryData field.\nThe keys stored in Data must not overlap with the keys in\nthe BinaryData field, this is enforced during validation process.\n+optional", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ConfigMap holds configuration data for pods to consume.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMap", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMapEnvSource": { "type": "object", "description": "ConfigMapEnvSource selects a ConfigMap to populate the environment\nvariables with.\n\nThe contents of the target ConfigMap's Data field will represent the\nkey-value pairs as environment variables.", "properties": { "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the ConfigMap must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.", "x-f5xc-description-medium": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMapEnvSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMapKeySelector": { "type": "object", "description": "Selects a key from a ConfigMap.", "properties": { "key": { "type": "string", "description": "The key to select.", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the ConfigMap or its key must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMapKeySelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMapList": { "type": "object", "description": "ConfigMapList is a resource containing a list of ConfigMap objects.", "properties": { "items": { "type": "array", "description": "Items is the list of ConfigMaps.", "items": { "$ref": "#/components/schemas/v1ConfigMap" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ConfigMapList is a resource containing a list of ConfigMap objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMapList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMapNodeConfigSource": { "type": "object", "description": "ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.", "properties": { "kubeletConfigKey": { "type": "string", "description": "KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure\nThis field is required in all cases.", "x-f5xc-description-short": "KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.", "x-f5xc-description-medium": "KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name is the metadata.name of the referenced ConfigMap.\nThis field is required in all cases.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace is the metadata.namespace of the referenced ConfigMap.\nThis field is required in all cases.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.", "x-f5xc-description-medium": "Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "resourceVersion": { "type": "string", "title": "ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap.\nThis field is forbidden in Node.Spec, and required in Node.Status.\n+optional", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "title": "UID is the metadata.UID of the referenced ConfigMap.\nThis field is forbidden in Node.Spec, and required in Node.Status.\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.", "x-f5xc-description-medium": "ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMapNodeConfigSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMapProjection": { "type": "object", "description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a\nprojected volume as files using the keys in the Data field as the file names,\nunless the items element is populated with specific mappings of keys to paths.\nNote that this is identical to a configmap volume source without the default\nmode.", "properties": { "items": { "type": "array", "title": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/v1KeyToPath" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the ConfigMap or its keys must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Adapts a ConfigMap into a projected volume.", "x-f5xc-description-medium": "Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMapProjection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ConfigMapVolumeSource": { "type": "object", "description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a\nvolume as files using the keys in the Data field as the file names, unless\nthe items element is populated with specific mappings of keys to paths.\nConfigMap volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "type": "integer", "title": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "description": "Configuration parameter for defaultMode", "x-f5xc-description-short": "Configuration parameter for defaultMode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "title": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/v1KeyToPath" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the ConfigMap or its keys must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-medium": "Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ConfigMapVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Container": { "type": "object", "description": "A single application container that you want to run within a pod.", "properties": { "args": { "type": "array", "title": "Arguments to the entrypoint.\nThe docker image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for args", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "command": { "type": "array", "title": "Entrypoint array. Not executed within a shell.\nThe docker image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for command", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "env": { "type": "array", "title": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1EnvVar" }, "description": "Configuration parameter for env", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "envFrom": { "type": "array", "title": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional", "items": { "$ref": "#/components/schemas/v1EnvFromSource" }, "description": "Configuration parameter for envFrom", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "title": "Docker image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional", "description": "Configuration parameter for image", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "imagePullPolicy": { "type": "string", "title": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional", "description": "Configuration parameter for imagePullPolicy", "x-f5xc-description-short": "Configuration parameter for imagePullPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lifecycle": { "allOf": [ { "$ref": "#/components/schemas/v1Lifecycle" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "livenessProbe": { "allOf": [ { "$ref": "#/components/schemas/v1Probe" } ], "x-f5xc-description-short": "Configuration parameter for livenessProbe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL).", "x-f5xc-description-medium": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "ports": { "type": "array", "title": "List of ports to expose from the container. Exposing a port here gives\nthe system additional information about the network connections a\ncontainer uses, but is primarily informational. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"192.0.2.26\" address inside a container will be\naccessible from the network.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", "items": { "$ref": "#/components/schemas/v1ContainerPort" }, "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readinessProbe": { "allOf": [ { "$ref": "#/components/schemas/v1Probe" } ], "x-f5xc-description-short": "Configuration parameter for readinessProbe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resources": { "allOf": [ { "$ref": "#/components/schemas/v1ResourceRequirements" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "securityContext": { "allOf": [ { "$ref": "#/components/schemas/v1SecurityContext" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startupProbe": { "allOf": [ { "$ref": "#/components/schemas/v1Probe" } ], "x-f5xc-description-short": "Configuration parameter for startupProbe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "stdin": { "type": "boolean", "title": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "format": "boolean", "description": "Configuration parameter for stdin", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "stdinOnce": { "type": "boolean", "title": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "format": "boolean", "description": "Configuration parameter for stdinOnce", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "terminationMessagePath": { "type": "string", "title": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "description": "File system or URL path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "terminationMessagePolicy": { "type": "string", "title": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional", "description": "Configuration parameter for terminationMessagePolicy", "x-f5xc-description-short": "Configuration parameter for terminationMessagePolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tty": { "type": "boolean", "title": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "format": "boolean", "description": "Configuration parameter for tty", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeDevices": { "type": "array", "title": "volumeDevices is the list of block devices to be used by the container.\nThis is a beta feature.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional", "items": { "$ref": "#/components/schemas/v1VolumeDevice" }, "description": "Configuration parameter for volumeDevices", "x-f5xc-description-short": "Configuration parameter for volumeDevices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeMounts": { "type": "array", "title": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1VolumeMount" }, "description": "Configuration parameter for volumeMounts", "x-f5xc-description-short": "Configuration parameter for volumeMounts.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "workingDir": { "type": "string", "title": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "description": "Configuration parameter for workingDir", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Single application container that you want to run within a pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Container", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerImage": { "type": "object", "title": "Describe a container image", "properties": { "names": { "type": "array", "title": "Names by which this image is known.\ne.g. [\"k8s.gcr.io/hyperkube:v1.0.7\", \"dockerhub.io/google_containers/hyperkube:v1.0.7\"]", "items": { "type": "string" }, "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sizeBytes": { "type": "string", "title": "The size of the image in bytes.\n+optional", "format": "int64", "description": "Configuration parameter for sizeBytes", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerImage", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerPort": { "type": "object", "description": "ContainerPort represents a network port in a single container.", "properties": { "containerPort": { "type": "integer", "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536.", "format": "int32", "x-f5xc-description-short": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostIP": { "type": "string", "title": "What host IP to bind the external port to.\n+optional", "description": "Host configuration or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostPort": { "type": "integer", "title": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional", "format": "int32", "description": "Host configuration or identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "title": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "protocol": { "type": "string", "title": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional", "description": "Configuration parameter for protocol", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ContainerPort represents a network port in a single container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerPort", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerState": { "type": "object", "description": "ContainerState holds a possible state of container.\nOnly one of its members may be specified.\nIf none of them is specified, the default one is ContainerStateWaiting.", "properties": { "running": { "allOf": [ { "$ref": "#/components/schemas/v1ContainerStateRunning" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "terminated": { "allOf": [ { "$ref": "#/components/schemas/v1ContainerStateTerminated" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "waiting": { "allOf": [ { "$ref": "#/components/schemas/v1ContainerStateWaiting" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ContainerState holds a possible state of container. Only one of its members may be specified.", "x-f5xc-description-medium": "ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerStateRunning": { "type": "object", "description": "ContainerStateRunning is a running state of a container.", "properties": { "startedAt": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ContainerStateRunning is a running state of a container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerStateRunning", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerStateTerminated": { "type": "object", "description": "ContainerStateTerminated is a terminated state of a container.", "properties": { "containerID": { "type": "string", "title": "Container's ID in the format 'docker://'\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "exitCode": { "type": "integer", "title": "Exit status from the last termination of the container", "format": "int32", "description": "Configuration parameter for exitCode", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finishedAt": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "Message regarding the last termination of the container\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "(brief) reason from the last termination of the container\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "signal": { "type": "integer", "title": "Signal from the last termination of the container\n+optional", "format": "int32", "description": "Configuration parameter for signal", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startedAt": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ContainerStateTerminated is a terminated state of a container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerStateTerminated", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerStateWaiting": { "type": "object", "description": "ContainerStateWaiting is a waiting state of a container.", "properties": { "message": { "type": "string", "title": "Message regarding why the container is not yet running.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "(brief) reason the container is not yet running.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ContainerStateWaiting is a waiting state of a container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerStateWaiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ContainerStatus": { "type": "object", "description": "ContainerStatus contains details for the current status of this container.", "properties": { "containerID": { "type": "string", "title": "Container's ID in the format 'docker://'.\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "title": "The image the container is running.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nTODO(dchen1107): Which image the container is running with?", "description": "Configuration parameter for image", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "imageID": { "type": "string", "description": "ImageID of the container's image.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastState": { "allOf": [ { "$ref": "#/components/schemas/v1ContainerState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This must be a DNS_LABEL. Each container in a pod must have a unique name.\nCannot be updated.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Must be a DNS_LABEL. Each container in a pod must have a unique name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "ready": { "type": "boolean", "description": "Specifies whether the container has passed its readiness probe.", "format": "boolean", "x-f5xc-example": "True", "x-f5xc-description-short": "Specifies whether the container has passed its readiness probe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "restartCount": { "type": "integer", "description": "The number of times the container has been restarted, currently based on\nthe number of dead containers that have not yet been removed.\nNote that this is calculated from dead containers. But those containers are subject to\ngarbage collection. This value will GET capped at 5 by GC.", "format": "int32", "x-f5xc-description-short": "The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed.", "x-f5xc-description-medium": "The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "started": { "type": "boolean", "title": "Specifies whether the container has passed its startup probe.\nInitialized as false, becomes true after startupProbe is considered successful.\nResets to false when the container is restarted, or if kubelet loses state temporarily.\nIs always true when no startupProbe is defined.\n+optional", "format": "boolean", "description": "Configuration parameter for started", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/v1ContainerState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ContainerStatus contains details for the current status of this container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ContainerStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonEndpoint": { "type": "object", "description": "DaemonEndpoint contains information about a single Daemon endpoint.", "properties": { "Port": { "type": "integer", "description": "Port number of the given endpoint.", "format": "int32", "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DaemonEndpoint contains information about a single Daemon endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonEndpoint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonSet": { "type": "object", "description": "DaemonSet represents the configuration of a daemon set.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1DaemonSetSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1DaemonSetStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "DaemonSet represents the configuration of a daemon set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonSet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonSetCondition": { "type": "object", "description": "DaemonSetCondition describes the state of a DaemonSet at a certain point.", "properties": { "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "A human readable message indicating details about the transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "The reason for the condition's last transition.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of DaemonSet condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DaemonSetCondition describes the state of a DaemonSet at a certain point.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonSetCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonSetList": { "type": "object", "description": "DaemonSetList is a collection of daemon sets.", "properties": { "items": { "type": "array", "description": "A list of daemon sets.", "items": { "$ref": "#/components/schemas/v1DaemonSet" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DaemonSetList is a collection of daemon sets.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonSetList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonSetSpec": { "type": "object", "description": "DaemonSetSpec is the specification of a daemon set.", "properties": { "minReadySeconds": { "type": "integer", "title": "The minimum number of seconds for which a newly created DaemonSet pod should\nbe ready without any of its container crashing, for it to be considered\navailable. Defaults to 0 (pod will be considered available as soon as it\nis ready).\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "revisionHistoryLimit": { "type": "integer", "title": "The number of old history to retain to allow rollback.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 10.\n+optional", "format": "int32", "description": "Historical or audit data", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "template": { "allOf": [ { "$ref": "#/components/schemas/v1PodTemplateSpec" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updateStrategy": { "allOf": [ { "$ref": "#/components/schemas/v1DaemonSetUpdateStrategy" } ], "x-f5xc-description-short": "Configuration parameter for updateStrategy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DaemonSetSpec is the specification of a daemon set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonSetSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonSetStatus": { "type": "object", "description": "DaemonSetStatus represents the current status of a daemon set.", "properties": { "collisionCount": { "type": "integer", "title": "Count of hash collisions for the DaemonSet. The DaemonSet controller\nuses this field as a collision avoidance mechanism when it needs to\ncreate the name for the newest ControllerRevision.\n+optional", "format": "int32", "description": "Number of items or occurrences", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "Represents the latest available observations of a DaemonSet's current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1DaemonSetCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "currentNumberScheduled": { "type": "integer", "title": "The number of nodes that are running at least 1\ndaemon pod and are supposed to run the daemon pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/", "format": "int32", "description": "Configuration parameter for currentNumberScheduled", "x-f5xc-description-short": "Configuration parameter for currentNumberScheduled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "desiredNumberScheduled": { "type": "integer", "title": "The total number of nodes that should be running the daemon\npod (including nodes correctly running the daemon pod).\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/", "format": "int32", "description": "Configuration parameter for desiredNumberScheduled", "x-f5xc-description-short": "Configuration parameter for desiredNumberScheduled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numberAvailable": { "type": "integer", "title": "The number of nodes that should be running the\ndaemon pod and have one or more of the daemon pod running and\navailable (ready for at least spec.minReadySeconds)\n+optional", "format": "int32", "description": "Configuration parameter for numberAvailable", "x-f5xc-description-short": "Configuration parameter for numberAvailable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numberMisscheduled": { "type": "integer", "title": "The number of nodes that are running the daemon pod, but are\nnot supposed to run the daemon pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/", "format": "int32", "description": "Configuration parameter for numberMisscheduled", "x-f5xc-description-short": "Configuration parameter for numberMisscheduled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numberReady": { "type": "integer", "description": "The number of nodes that should be running the daemon pod and have one\nor more of the daemon pod running and ready.", "format": "int32", "x-f5xc-description-short": "The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.", "x-f5xc-description-medium": "The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numberUnavailable": { "type": "integer", "title": "The number of nodes that should be running the\ndaemon pod and have none of the daemon pod running and available\n(ready for at least spec.minReadySeconds)\n+optional", "format": "int32", "description": "Configuration parameter for numberUnavailable", "x-f5xc-description-short": "Configuration parameter for numberUnavailable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "observedGeneration": { "type": "string", "title": "The most recent generation observed by the daemon set controller.\n+optional", "format": "int64", "description": "Configuration parameter for observedGeneration", "x-f5xc-description-short": "Configuration parameter for observedGeneration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updatedNumberScheduled": { "type": "integer", "title": "The total number of nodes that are running updated daemon pod\n+optional", "format": "int32", "description": "Configuration parameter for updatedNumberScheduled", "x-f5xc-description-short": "Configuration parameter for updatedNumberScheduled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DaemonSetStatus represents the current status of a daemon set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonSetStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DaemonSetUpdateStrategy": { "type": "object", "description": "DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.", "properties": { "rollingUpdate": { "allOf": [ { "$ref": "#/components/schemas/v1RollingUpdateDaemonSet" } ], "x-f5xc-description-short": "Configuration parameter for rollingUpdate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "Type of daemon set update. Can be \"RollingUpdate\" or \"OnDelete\". Default is RollingUpdate.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DaemonSetUpdateStrategy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Deployment": { "type": "object", "description": "Deployment enables declarative updates for Pods and ReplicaSets.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1DeploymentSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1DeploymentStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Deployment enables declarative updates for Pods and ReplicaSets.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Deployment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DeploymentCondition": { "type": "object", "description": "DeploymentCondition describes the state of a deployment at a certain point.", "properties": { "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastUpdateTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastUpdateTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable message indicating details about the transition.", "x-f5xc-description-short": "Human readable message indicating details about the transition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "The reason for the condition's last transition.", "x-f5xc-description-short": "The reason for the condition's last transition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of deployment condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DeploymentCondition describes the state of a deployment at a certain point.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DeploymentCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DeploymentList": { "type": "object", "description": "DeploymentList is a list of Deployments.", "properties": { "items": { "type": "array", "description": "Items is the list of Deployments.", "items": { "$ref": "#/components/schemas/v1Deployment" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DeploymentList is a list of Deployments.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DeploymentList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DeploymentSpec": { "type": "object", "description": "DeploymentSpec is the specification of the desired behavior of the Deployment.", "properties": { "minReadySeconds": { "type": "integer", "title": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing, for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "paused": { "type": "boolean", "title": "Indicates that the deployment is paused.\n+optional", "format": "boolean", "description": "Configuration parameter for paused", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "progressDeadlineSeconds": { "type": "integer", "description": "The maximum time in seconds for a deployment to make progress before it\nis considered to be failed. The deployment controller will continue to\nprocess failed deployments and a condition with a ProgressDeadlineExceeded\nreason will be surfaced in the deployment status. Note that progress will\nnot be estimated during the time a deployment is paused. Defaults to 600s.", "format": "int32", "x-f5xc-description-short": "The maximum time in seconds for a deployment to make progress before it is considered to be failed.", "x-f5xc-description-medium": "The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replicas": { "type": "integer", "title": "Number of desired pods. This is a pointer to distinguish between explicit\nzero and not specified. Defaults to 1.\n+optional", "format": "int32", "description": "Configuration parameter for replicas", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "revisionHistoryLimit": { "type": "integer", "title": "The number of old ReplicaSets to retain to allow rollback.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 10.\n+optional", "format": "int32", "description": "Historical or audit data", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/v1DeploymentStrategy" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "template": { "allOf": [ { "$ref": "#/components/schemas/v1PodTemplateSpec" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DeploymentSpec is the specification of the desired behavior of the Deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DeploymentSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DeploymentStatus": { "type": "object", "description": "DeploymentStatus is the most recently observed status of the Deployment.", "properties": { "availableReplicas": { "type": "integer", "title": "Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.\n+optional", "format": "int32", "description": "Configuration parameter for availableReplicas", "x-f5xc-description-short": "Configuration parameter for availableReplicas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "collisionCount": { "type": "integer", "title": "Count of hash collisions for the Deployment. The Deployment controller uses this\nfield as a collision avoidance mechanism when it needs to create the name for the\nnewest ReplicaSet.\n+optional", "format": "int32", "description": "Number of items or occurrences", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "Represents the latest available observations of a deployment's current state.\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1DeploymentCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "observedGeneration": { "type": "string", "title": "The generation observed by the deployment controller.\n+optional", "format": "int64", "description": "Configuration parameter for observedGeneration", "x-f5xc-description-short": "Configuration parameter for observedGeneration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readyReplicas": { "type": "integer", "title": "Total number of ready pods targeted by this deployment.\n+optional", "format": "int32", "description": "Configuration parameter for readyReplicas", "x-f5xc-description-short": "Configuration parameter for readyReplicas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replicas": { "type": "integer", "title": "Total number of non-terminated pods targeted by this deployment (their labels match the selector).\n+optional", "format": "int32", "description": "Configuration parameter for replicas", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unavailableReplicas": { "type": "integer", "title": "Total number of unavailable pods targeted by this deployment. This is the total number of\npods that are still required for the deployment to have 100% available capacity. They may\neither be pods that are running but not yet available or pods that still have not been created.\n+optional", "format": "int32", "description": "Configuration parameter for unavailableReplicas", "x-f5xc-description-short": "Configuration parameter for unavailableReplicas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updatedReplicas": { "type": "integer", "title": "Total number of non-terminated pods targeted by this deployment that have the desired template spec.\n+optional", "format": "int32", "description": "Configuration parameter for updatedReplicas", "x-f5xc-description-short": "Configuration parameter for updatedReplicas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DeploymentStatus is the most recently observed status of the Deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DeploymentStrategy": { "type": "object", "description": "DeploymentStrategy describes how to replace existing pods with new ones.", "properties": { "rollingUpdate": { "allOf": [ { "$ref": "#/components/schemas/v1RollingUpdateDeployment" } ], "x-f5xc-description-short": "Configuration parameter for rollingUpdate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "Type of deployment. Can be \"Recreate\" or \"RollingUpdate\". Default is RollingUpdate.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DeploymentStrategy describes how to replace existing pods with new ones.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DeploymentStrategy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DownwardAPIProjection": { "type": "object", "description": "Represents downward API info for projecting into a projected volume.\nNote that this is identical to a downwardAPI volume source without the default\nmode.", "properties": { "items": { "type": "array", "title": "Items is a list of DownwardAPIVolume file\n+optional", "items": { "$ref": "#/components/schemas/v1DownwardAPIVolumeFile" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents downward API info for projecting into a projected volume.", "x-f5xc-description-medium": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DownwardAPIProjection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DownwardAPIVolumeFile": { "type": "object", "title": "DownwardAPIVolumeFile represents information to create the file containing the pod field", "properties": { "fieldRef": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mode": { "type": "integer", "title": "Optional: mode bits to use on this file, must be a value between 0\nand 0777. If not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "description": "Configuration parameter for mode", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "title": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resourceFieldRef": { "allOf": [ { "$ref": "#/components/schemas/v1ResourceFieldSelector" } ], "x-f5xc-description-short": "Configuration parameter for resourceFieldRef.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DownwardAPIVolumeFile", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1DownwardAPIVolumeSource": { "type": "object", "description": "DownwardAPIVolumeSource represents a volume containing downward API info.\nDownward API volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "type": "integer", "title": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "description": "Configuration parameter for defaultMode", "x-f5xc-description-short": "Configuration parameter for defaultMode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "title": "Items is a list of downward API volume file\n+optional", "items": { "$ref": "#/components/schemas/v1DownwardAPIVolumeFile" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.", "x-f5xc-description-medium": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1DownwardAPIVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EmptyDirVolumeSource": { "type": "object", "description": "Represents an empty directory for a pod.\nEmpty directory volumes support ownership management and SELinux relabeling.", "properties": { "medium": { "type": "string", "title": "What type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "description": "Configuration parameter for medium", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sizeLimit": { "allOf": [ { "$ref": "#/components/schemas/resourceQuantity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.", "x-f5xc-description-medium": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EmptyDirVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EndpointAddress": { "type": "object", "description": "EndpointAddress is a tuple that describes single IP address.", "properties": { "hostname": { "type": "string", "title": "The Hostname of this endpoint\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "ip": { "type": "string", "description": "The IP of this endpoint.\nMay not be loopback (192.0.2.0/24), link-local (192.0.2.0/24),\nor link-local multicast ((224.0.0.0/24).\nIPv6 is also accepted but not fully supported on all platforms. Also, certain\nKubernetes components, like kube-proxy, are not IPv6 ready.\nTODO: This should allow hostname or IP, See #4447.", "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "The IP of this endpoint. May not be loopback (192.0.2.0/24), link-local (192.0.2.0/24), or link-local multicast ((224.0.0.0/24).", "x-f5xc-description-medium": "The IP of this endpoint. May not be loopback (192.0.2.0/24), link-local (192.0.2.0/24), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodeName": { "type": "string", "title": "Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "targetRef": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EndpointAddress is a tuple that describes single IP address.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EndpointAddress", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EndpointPort": { "type": "object", "description": "EndpointPort is a tuple that describes a single port.", "properties": { "name": { "type": "string", "title": "The name of this port. This must match the 'name' field in the\ncorresponding ServicePort.\nMust be a DNS_LABEL.\nOptional only if one port is defined.\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "port": { "type": "integer", "description": "The port number of the endpoint.", "format": "int32", "x-f5xc-example": "8080", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol": { "type": "string", "title": "The IP protocol for this port.\nMust be UDP, TCP, or SCTP.\nDefault is TCP.\n+optional", "description": "Configuration parameter for protocol", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EndpointPort is a tuple that describes a single port.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EndpointPort", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EndpointSubset": { "type": "object", "title": "EndpointSubset is a group of addresses with a common set of ports. The\nexpanded set of endpoints is the Cartesian product of Addresses x Ports.\nFor example, given:\n {\n Addresses: [{\"ip\": \"192.0.2.116\"}, {\"ip\": \"192.0.2.99\"}],\n Ports: [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n }\nThe resulting set of endpoints can be viewed as:\n a: [ 192.0.2.116:8675, 192.0.2.99:8675 ],\n b: [ 192.0.2.116:309, 192.0.2.99:309 ]", "properties": { "addresses": { "type": "array", "title": "IP addresses which offer the related ports that are marked as ready. These endpoints\nshould be considered safe for load balancers and clients to utilize.\n+optional", "items": { "$ref": "#/components/schemas/v1EndpointAddress" }, "description": "Network address or location", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "notReadyAddresses": { "type": "array", "title": "IP addresses which offer the related ports but are not currently marked as ready\nbecause they have not yet finished starting, have recently failed a readiness check,\nor have recently failed a liveness check.\n+optional", "items": { "$ref": "#/components/schemas/v1EndpointAddress" }, "description": "Network address or location", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ports": { "type": "array", "title": "Port numbers available on the related IP addresses.\n+optional", "items": { "$ref": "#/components/schemas/v1EndpointPort" }, "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EndpointSubset", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Endpoints": { "type": "object", "title": "Endpoints is a collection of endpoints that implement the actual service. Example:\n Name: \"mysvc\",\n Subsets: [\n {\n Addresses: [{\"ip\": \"192.0.2.116\"}, {\"ip\": \"192.0.2.99\"}],\n Ports: [{\"name\": \"a\", \"port\": 8675}, {\"name\": \"b\", \"port\": 309}]\n },\n {\n Addresses: [{\"ip\": \"192.0.2.117\"}],\n Ports: [{\"name\": \"a\", \"port\": 93}, {\"name\": \"b\", \"port\": 76}]\n },\n ]", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subsets": { "type": "array", "title": "The set of all endpoints is the union of all subsets. Addresses are placed into\nsubsets according to the IPs they share. A single address with multiple ports,\nsome of which are ready and some of which are not (because they come from\ndifferent containers) will result in the address being displayed in different\nsubsets for the different ports. No address will appear in both Addresses and\nNotReadyAddresses in the same subset.\nSets of addresses and ports that comprise a service.\n+optional", "items": { "$ref": "#/components/schemas/v1EndpointSubset" }, "description": "Configuration parameter for subsets", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Endpoints", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EndpointsList": { "type": "object", "description": "EndpointsList is a list of endpoints.", "properties": { "items": { "type": "array", "description": "List of endpoints.", "items": { "$ref": "#/components/schemas/v1Endpoints" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EndpointsList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EnvFromSource": { "type": "object", "title": "EnvFromSource represents the source of a set of ConfigMaps", "properties": { "configMapRef": { "allOf": [ { "$ref": "#/components/schemas/v1ConfigMapEnvSource" } ], "x-f5xc-description-short": "Configuration parameter for configMapRef.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefix": { "type": "string", "title": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional", "description": "Configuration parameter for prefix", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretEnvSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EnvFromSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EnvVar": { "type": "object", "description": "EnvVar represents an environment variable present in a Container.", "properties": { "name": { "type": "string", "description": "Name of the environment variable. Must be a C_IDENTIFIER.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the environment variable. Must be a C_IDENTIFIER.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "value": { "type": "string", "title": "Variable references $(VAR_NAME) are expanded\nusing the previous defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. The $(VAR_NAME)\nsyntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped\nreferences will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional", "description": "Configuration parameter for value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "valueFrom": { "allOf": [ { "$ref": "#/components/schemas/v1EnvVarSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EnvVar represents an environment variable present in a Container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EnvVar", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EnvVarSource": { "type": "object", "description": "EnvVarSource represents a source for the value of an EnvVar.", "properties": { "configMapKeyRef": { "allOf": [ { "$ref": "#/components/schemas/v1ConfigMapKeySelector" } ], "x-f5xc-description-short": "Configuration parameter for configMapKeyRef.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fieldRef": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resourceFieldRef": { "allOf": [ { "$ref": "#/components/schemas/v1ResourceFieldSelector" } ], "x-f5xc-description-short": "Configuration parameter for resourceFieldRef.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretKeyRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretKeySelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EnvVarSource represents a source for the value of an EnvVar.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EnvVarSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EphemeralContainer": { "type": "object", "description": "An EphemeralContainer is a container that may be added temporarily to an existing pod for\nuser-initiated activities such as debugging. Ephemeral containers have no resource or\nscheduling guarantees, and they will not be restarted when they exit or when a pod is\nremoved or restarted. If an ephemeral container causes a pod to exceed its resource\nallocation, the pod may be evicted.\nEphemeral containers may not be added by directly updating the pod spec. They must be added\nvia the pod's ephemeralcontainers subresource, and they will appear in the pod spec\nonce added.\nThis is an alpha feature enabled by the EphemeralContainers feature flag.", "properties": { "ephemeralContainerCommon": { "allOf": [ { "$ref": "#/components/schemas/v1EphemeralContainerCommon" } ], "x-f5xc-description-short": "Configuration parameter for ephemeralContainerCommon.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "targetContainerName": { "type": "string", "title": "If set, the name of the container from PodSpec that this ephemeral container targets.\nThe ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.\nIf not set then the ephemeral container is run in whatever namespaces are shared\nfor the pod. Note that the container runtime must support this feature.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging.", "x-f5xc-description-medium": "EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EphemeralContainer", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1EphemeralContainerCommon": { "type": "object", "description": "EphemeralContainerCommon is a copy of all fields in Container to be inlined in\nEphemeralContainer. This separate type allows easy conversion from EphemeralContainer\nto Container and allows separate documentation for the fields of EphemeralContainer.\nWhen a new field is added to Container it must be added here as well.", "properties": { "args": { "type": "array", "title": "Arguments to the entrypoint.\nThe docker image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for args", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "command": { "type": "array", "title": "Entrypoint array. Not executed within a shell.\nThe docker image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for command", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "env": { "type": "array", "title": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1EnvVar" }, "description": "Configuration parameter for env", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "envFrom": { "type": "array", "title": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional", "items": { "$ref": "#/components/schemas/v1EnvFromSource" }, "description": "Configuration parameter for envFrom", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "title": "Docker image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images", "description": "Configuration parameter for image", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "imagePullPolicy": { "type": "string", "title": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional", "description": "Configuration parameter for imagePullPolicy", "x-f5xc-description-short": "Configuration parameter for imagePullPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lifecycle": { "allOf": [ { "$ref": "#/components/schemas/v1Lifecycle" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "livenessProbe": { "allOf": [ { "$ref": "#/components/schemas/v1Probe" } ], "x-f5xc-description-short": "Configuration parameter for livenessProbe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the ephemeral container specified as a DNS_LABEL.\nThis name must be unique among all containers, init containers and ephemeral containers.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.", "x-f5xc-description-medium": "Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "ports": { "type": "array", "description": "Ports are not allowed for ephemeral containers.", "items": { "$ref": "#/components/schemas/v1ContainerPort" }, "x-f5xc-description-short": "Ports are not allowed for ephemeral containers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readinessProbe": { "allOf": [ { "$ref": "#/components/schemas/v1Probe" } ], "x-f5xc-description-short": "Configuration parameter for readinessProbe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resources": { "allOf": [ { "$ref": "#/components/schemas/v1ResourceRequirements" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "securityContext": { "allOf": [ { "$ref": "#/components/schemas/v1SecurityContext" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startupProbe": { "allOf": [ { "$ref": "#/components/schemas/v1Probe" } ], "x-f5xc-description-short": "Configuration parameter for startupProbe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "stdin": { "type": "boolean", "title": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "format": "boolean", "description": "Configuration parameter for stdin", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "stdinOnce": { "type": "boolean", "title": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "format": "boolean", "description": "Configuration parameter for stdinOnce", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "terminationMessagePath": { "type": "string", "title": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "description": "File system or URL path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "terminationMessagePolicy": { "type": "string", "title": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional", "description": "Configuration parameter for terminationMessagePolicy", "x-f5xc-description-short": "Configuration parameter for terminationMessagePolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tty": { "type": "boolean", "title": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "format": "boolean", "description": "Configuration parameter for tty", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeDevices": { "type": "array", "title": "volumeDevices is the list of block devices to be used by the container.\nThis is a beta feature.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional", "items": { "$ref": "#/components/schemas/v1VolumeDevice" }, "description": "Configuration parameter for volumeDevices", "x-f5xc-description-short": "Configuration parameter for volumeDevices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeMounts": { "type": "array", "title": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1VolumeMount" }, "description": "Configuration parameter for volumeMounts", "x-f5xc-description-short": "Configuration parameter for volumeMounts.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "workingDir": { "type": "string", "title": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "description": "Configuration parameter for workingDir", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer.", "x-f5xc-description-medium": "EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer. This separate type allows easy conversion from EphemeralContainer to Container and allows separate documentation for the fields of EphemeralContainer. When a new field is added to Container it must...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1EphemeralContainerCommon", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ExecAction": { "type": "object", "description": "ExecAction describes a \"run in container\" action.", "properties": { "command": { "type": "array", "title": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for command", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ExecAction describes a \"run in container\" action.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ExecAction", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1FCVolumeSource": { "type": "object", "description": "Represents a Fibre Channel volume.\nFibre Channel volumes can only be mounted as read/write once.\nFibre Channel volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lun": { "type": "integer", "title": "Optional: FC target lun number\n+optional", "format": "int32", "description": "Configuration parameter for lun", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "targetWWNs": { "type": "array", "title": "Optional: FC target worldwide names (WWNs)\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for targetWWNs", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "wwids": { "type": "array", "title": "Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for wwids", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once.", "x-f5xc-description-medium": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1FCVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1FieldsV1": { "type": "object", "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set,\nor a string representing a sub-field or item. The string will follow one of these four formats:\n'f:', where is the name of a field in a struct, or key in a map\n'v:', where is the exact JSON formatted value of a list item\n'i:', where is position of a item in a list\n'k:', where is a map of a list item's key fields to their unique values\nIf a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.K8s.I/O/structured-merge-diff.", "properties": { "Raw": { "type": "string", "description": "Raw is the underlying serialization of this object.", "format": "byte", "x-f5xc-description-short": "Raw is the underlying serialization of this object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.", "x-f5xc-description-medium": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1FieldsV1", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1FlexPersistentVolumeSource": { "type": "object", "description": "FlexPersistentVolumeSource represents a generic persistent volume resource that is\nprovisioned/attached using an exec based plugin.", "properties": { "driver": { "type": "string", "description": "Driver is the name of the driver to use for this volume.", "x-f5xc-description-short": "Driver is the name of the driver to use for this volume.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "options": { "type": "object", "title": "Optional: Extra command options if any.\n+optional", "description": "Configuration parameter for options", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.", "x-f5xc-description-medium": "FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1FlexPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1FlexVolumeSource": { "type": "object", "description": "FlexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.", "properties": { "driver": { "type": "string", "description": "Driver is the name of the driver to use for this volume.", "x-f5xc-description-short": "Driver is the name of the driver to use for this volume.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "options": { "type": "object", "title": "Optional: Extra command options if any.\n+optional", "description": "Configuration parameter for options", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.", "x-f5xc-description-medium": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1FlexVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1FlockerVolumeSource": { "type": "object", "description": "Represents a Flocker volume mounted by the Flocker agent.\nOne and only one of datasetName and datasetUUID should be set.\nFlocker volumes do not support ownership management or SELinux relabeling.", "properties": { "datasetName": { "type": "string", "title": "Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated\n+optional", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "datasetUUID": { "type": "string", "title": "UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set.", "x-f5xc-description-medium": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1FlockerVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1GCEPersistentDiskVolumeSource": { "type": "object", "description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must\nalso be in the same GCE project and zone as the kubelet. A GCE PD\ncan only be mounted as read/write once or read-only many times. GCE\nPDs support ownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "partition": { "type": "integer", "title": "The partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "format": "int32", "description": "Configuration parameter for partition", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pdName": { "type": "string", "title": "Unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container.", "x-f5xc-description-medium": "Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1GCEPersistentDiskVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1GitRepoVolumeSource": { "type": "object", "description": "Represents a volume that is populated with the contents of a git repository.\nGit repo volumes do not support ownership management.\nGit repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.", "properties": { "directory": { "type": "string", "title": "Target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional", "description": "Configuration parameter for directory", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "repository": { "type": "string", "title": "Repository URL", "description": "Configuration parameter for repository", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "revision": { "type": "string", "title": "Commit hash for the specified revision.\n+optional", "description": "Configuration parameter for revision", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management.", "x-f5xc-description-medium": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1GitRepoVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1GlusterfsPersistentVolumeSource": { "type": "object", "description": "Represents a Glusterfs mount that lasts the lifetime of a pod.\nGlusterfs volumes do not support ownership management or SELinux relabeling.", "properties": { "endpoints": { "type": "string", "title": "EndpointsName is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "description": "Endpoint or connection point", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpointsNamespace": { "type": "string", "title": "EndpointsNamespace is the namespace that contains Glusterfs endpoint.\nIf this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional", "description": "Endpoint or connection point", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "title": "Path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1GlusterfsPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1GlusterfsVolumeSource": { "type": "object", "description": "Represents a Glusterfs mount that lasts the lifetime of a pod.\nGlusterfs volumes do not support ownership management or SELinux relabeling.", "properties": { "endpoints": { "type": "string", "title": "EndpointsName is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "description": "Endpoint or connection point", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "title": "Path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1GlusterfsVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1HTTPGetAction": { "type": "object", "description": "HTTPGetAction describes an action based on HTTP GET requests.", "properties": { "host": { "type": "string", "title": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional", "description": "Hostname or IP address of the target server", "x-f5xc-example": "api.example.com", "x-f5xc-description-short": "Hostname or IP address of the target server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "httpHeaders": { "type": "array", "title": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional", "items": { "$ref": "#/components/schemas/v1HTTPHeader" }, "description": "Configuration parameter for httpHeaders", "x-f5xc-description-short": "Configuration parameter for httpHeaders.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "title": "Path to access on the HTTP server.\n+optional", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "port": { "allOf": [ { "$ref": "#/components/schemas/intstrIntOrString" } ], "x-f5xc-example": "8080", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scheme": { "type": "string", "title": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional", "description": "Configuration parameter for scheme", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "HTTPGetAction describes an action based on HTTP GET requests.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1HTTPGetAction", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1HTTPHeader": { "type": "object", "title": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "type": "string", "title": "The header field name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "value": { "type": "string", "title": "The header field value", "description": "Configuration parameter for value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1HTTPHeader", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Handler": { "type": "object", "description": "Handler defines a specific action that should be taken\nTODO: pass structured data to these actions, and document that data here.", "properties": { "exec": { "allOf": [ { "$ref": "#/components/schemas/v1ExecAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "httpGet": { "allOf": [ { "$ref": "#/components/schemas/v1HTTPGetAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcpSocket": { "allOf": [ { "$ref": "#/components/schemas/v1TCPSocketAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Handler defines a specific action that should be taken TODO: pass structured data to these actions, and document that data here.", "x-f5xc-description-medium": "Handler defines a specific action that should be taken TODO: pass structured data to these actions, and document that data here.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Handler", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1HostAlias": { "type": "object", "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { "type": "array", "description": "Hostnames for the above IP address.", "items": { "type": "string" }, "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "IP address of the host file entry.", "x-f5xc-example": "192.0.2.1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.", "x-f5xc-description-medium": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1HostAlias", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1HostPathVolumeSource": { "type": "object", "description": "Represents a host path mapped into a pod.\nHost path volumes do not support ownership management or SELinux relabeling.", "properties": { "path": { "type": "string", "title": "Path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "Type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1HostPathVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ISCSIPersistentVolumeSource": { "type": "object", "description": "ISCSIPersistentVolumeSource represents an ISCSI disk.\nISCSI volumes can only be mounted as read/write once.\nISCSI volumes support ownership management and SELinux relabeling.", "properties": { "chapAuthDiscovery": { "type": "boolean", "title": "whether support iSCSI Discovery CHAP authentication\n+optional", "format": "boolean", "description": "Configuration parameter for chapAuthDiscovery", "x-f5xc-description-short": "Configuration parameter for chapAuthDiscovery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "chapAuthSession": { "type": "boolean", "title": "whether support iSCSI Session CHAP authentication\n+optional", "format": "boolean", "description": "Configuration parameter for chapAuthSession", "x-f5xc-description-short": "Configuration parameter for chapAuthSession.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initiatorName": { "type": "string", "title": "Custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iqn": { "type": "string", "description": "Target iSCSI Qualified Name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iscsiInterface": { "type": "string", "title": "iSCSI Interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional", "description": "Configuration parameter for iscsiInterface", "x-f5xc-description-short": "Configuration parameter for iscsiInterface.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lun": { "type": "integer", "description": "ISCSI Target Lun number.", "format": "int32", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "portals": { "type": "array", "title": "iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional", "items": { "type": "string" }, "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "targetPortal": { "type": "string", "description": "ISCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "x-f5xc-description-short": "ISCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "x-f5xc-description-medium": "ISCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once.", "x-f5xc-description-medium": "ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ISCSIPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ISCSIVolumeSource": { "type": "object", "description": "Represents an ISCSI disk.\nISCSI volumes can only be mounted as read/write once.\nISCSI volumes support ownership management and SELinux relabeling.", "properties": { "chapAuthDiscovery": { "type": "boolean", "title": "whether support iSCSI Discovery CHAP authentication\n+optional", "format": "boolean", "description": "Configuration parameter for chapAuthDiscovery", "x-f5xc-description-short": "Configuration parameter for chapAuthDiscovery.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "chapAuthSession": { "type": "boolean", "title": "whether support iSCSI Session CHAP authentication\n+optional", "format": "boolean", "description": "Configuration parameter for chapAuthSession", "x-f5xc-description-short": "Configuration parameter for chapAuthSession.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fsType": { "type": "string", "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initiatorName": { "type": "string", "title": "Custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iqn": { "type": "string", "description": "Target iSCSI Qualified Name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iscsiInterface": { "type": "string", "title": "iSCSI Interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional", "description": "Configuration parameter for iscsiInterface", "x-f5xc-description-short": "Configuration parameter for iscsiInterface.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lun": { "type": "integer", "description": "ISCSI Target Lun number.", "format": "int32", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "portals": { "type": "array", "title": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional", "items": { "type": "string" }, "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "targetPortal": { "type": "string", "description": "ISCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "x-f5xc-description-short": "ISCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "x-f5xc-description-medium": "ISCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once.", "x-f5xc-description-medium": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ISCSIVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Job": { "type": "object", "description": "Job represents the configuration of a single job.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1JobSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1JobStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Job represents the configuration of a single job.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Job", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1JobCondition": { "type": "object", "description": "JobCondition describes current state of a job.", "properties": { "lastProbeTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastProbeTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "Human readable message indicating details about last transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "(brief) reason for the condition's last transition.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of job condition, Complete or Failed.", "x-f5xc-description-short": "Type of job condition, Complete or Failed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "JobCondition describes current state of a job.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1JobCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1JobList": { "type": "object", "description": "JobList is a collection of jobs.", "properties": { "items": { "type": "array", "description": "Items is the list of Jobs.", "items": { "$ref": "#/components/schemas/v1Job" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1JobList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1JobSpec": { "type": "object", "description": "JobSpec describes how the job execution will look like.", "properties": { "activeDeadlineSeconds": { "type": "string", "title": "Specifies the duration in seconds relative to the startTime that the job may be active\nbefore the system tries to terminate it; value must be positive integer\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "backoffLimit": { "type": "integer", "title": "Specifies the number of retries before marking this job failed.\nDefaults to 6\n+optional", "format": "int32", "description": "Configuration parameter for backoffLimit", "x-f5xc-description-short": "Configuration parameter for backoffLimit.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "completions": { "type": "integer", "title": "Specifies the desired number of successfully finished pods the\njob should be run with. Setting to nil means that the success of any\npod signals the success of all pods, and allows parallelism to have any positive\nvalue. Setting to 1 means that parallelism is limited to 1 and the success of that\npod signals the success of the job.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/\n+optional", "format": "int32", "description": "Configuration parameter for completions", "x-f5xc-description-short": "Configuration parameter for completions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manualSelector": { "type": "boolean", "title": "manualSelector controls generation of pod labels and pod selectors.\nLeave `manualSelector` unset unless you are certain what you are doing.\nWhen false or unset, the system pick labels unique to this job\nand appends those labels to the pod template. When true,\nthe user is responsible for picking unique labels and specifying\nthe selector. Failure to pick a unique label may cause this\nand other jobs to not function correctly. However, You may see\n`manualSelector=true` in jobs that were created with the old `extensions/v1beta1`\nAPI.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector\n+optional", "format": "boolean", "description": "Manual or custom configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "parallelism": { "type": "integer", "title": "Specifies the maximum desired number of pods the job should\nrun at any given time. The actual number of pods running in steady state will\nbe less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),\ni.e. when the work left to do is less than max parallelism.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/\n+optional", "format": "int32", "description": "Configuration parameter for parallelism", "x-f5xc-description-short": "Configuration parameter for parallelism.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "template": { "allOf": [ { "$ref": "#/components/schemas/v1PodTemplateSpec" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ttlSecondsAfterFinished": { "type": "integer", "title": "ttlSecondsAfterFinished limits the lifetime of a Job that has finished\nexecution (either Complete or Failed). If this field is set,\nttlSecondsAfterFinished after the Job finishes, it is eligible to be\nautomatically deleted. When the Job is being deleted, its lifecycle\nguarantees (e.g. finalizers) will be honored. If this field is unset,\nthe Job won't be automatically deleted. If this field is set to zero,\nthe Job becomes eligible to be deleted immediately after it finishes.\nThis field is alpha-level and is only honored by servers that enable the\nTTLAfterFinished feature.\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "JobSpec describes how the job execution will look like.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1JobSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1JobStatus": { "type": "object", "description": "JobStatus represents the current state of a Job.", "properties": { "active": { "type": "integer", "title": "The number of actively running pods.\n+optional", "format": "int32", "description": "Indicates if the resource is active", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "completionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for completionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "The latest available observations of an object's current state.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1JobCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "failed": { "type": "integer", "title": "The number of pods which reached phase Failed.\n+optional", "format": "int32", "description": "Configuration parameter for failed", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "succeeded": { "type": "integer", "title": "The number of pods which reached phase Succeeded.\n+optional", "format": "int32", "description": "Configuration parameter for succeeded", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "JobStatus represents the current state of a Job.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1JobStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1KeyToPath": { "type": "object", "description": "Maps a string key to a path within a volume.", "properties": { "key": { "type": "string", "description": "The key to project.", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "mode": { "type": "integer", "title": "Optional: mode bits to use on this file, must be a value between 0\nand 0777. If not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "description": "Configuration parameter for mode", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "description": "The relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "x-f5xc-example": "/api/v1/resources", "x-f5xc-description-short": "The relative path of the file to map the key to. May not be an absolute path.", "x-f5xc-description-medium": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Maps a string key to a path within a volume.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1KeyToPath", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1LabelSelector": { "type": "object", "description": "A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects.", "properties": { "matchExpressions": { "type": "array", "title": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional", "items": { "$ref": "#/components/schemas/v1LabelSelectorRequirement" }, "description": "Configuration parameter for matchExpressions", "x-f5xc-description-short": "Configuration parameter for matchExpressions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "matchLabels": { "type": "object", "title": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional", "description": "Key-value label for organization", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed.", "x-f5xc-description-medium": "Label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1LabelSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "label", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1LabelSelectorRequirement": { "type": "object", "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "type": "string", "title": "key is the label key that the selector applies to.\n+patchMergeKey=key\n+patchStrategy=merge", "description": "Cryptographic key material", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "operator": { "type": "string", "description": "Operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "x-f5xc-description-short": "Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", "x-f5xc-description-medium": "Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "title": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for values", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "x-f5xc-description-medium": "Label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1LabelSelectorRequirement", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "label", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Lifecycle": { "type": "object", "description": "Lifecycle describes actions that the management system should take in response to container lifecycle\nevents. For the PostStart and PreStop lifecycle handlers, management of the container blocks\nuntil the action is complete, unless the container process fails, in which case the handler is aborted.", "properties": { "postStart": { "allOf": [ { "$ref": "#/components/schemas/v1Handler" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "preStop": { "allOf": [ { "$ref": "#/components/schemas/v1Handler" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Lifecycle describes actions that the management system should take in response to container lifecycle events.", "x-f5xc-description-medium": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Lifecycle", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ListMeta": { "type": "object", "description": "ListMeta describes metadata that synthetic resources must have, including lists and\nvarious status objects. A resource may have only one of {ObjectMeta, ListMeta}.", "properties": { "continue": { "type": "string", "description": "Continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "x-f5xc-description-short": "Continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available.", "x-f5xc-description-medium": "Continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "remainingItemCount": { "type": "string", "title": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "format": "int64", "description": "Number of items or occurrences", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resourceVersion": { "type": "string", "title": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "selfLink": { "type": "string", "description": "SelfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n\nDEPRECATED\nKubernetes will stop propagating this field in 1.20 release and the field is planned\nto be removed in 1.21 release.\n+optional.", "x-f5xc-description-short": "SelfLink is a URL representing this object. Populated by the system.", "x-f5xc-description-medium": "SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects.", "x-f5xc-description-medium": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ListMeta", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1LoadBalancerIngress": { "type": "object", "description": "LoadBalancerIngress represents the status of a load-balancer ingress point:\ntraffic intended for the service should be sent to an ingress point.", "properties": { "hostname": { "type": "string", "title": "Hostname is set for load-balancer ingress points that are DNS based\n(typically AWS load-balancers)\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "ip": { "type": "string", "title": "IP is set for load-balancer ingress points that are IP based\n(typically GCE or OpenStack load-balancers)\n+optional", "description": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1)", "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.", "x-f5xc-description-medium": "LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1LoadBalancerIngress", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1LoadBalancerStatus": { "type": "object", "description": "LoadBalancerStatus represents the status of a load-balancer.", "properties": { "ingress": { "type": "array", "title": "Ingress is a list containing ingress points for the load-balancer.\nTraffic intended for the service should be sent to these ingress points.\n+optional", "items": { "$ref": "#/components/schemas/v1LoadBalancerIngress" }, "description": "Configuration parameter for ingress", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "LoadBalancerStatus represents the status of a load-balancer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1LoadBalancerStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1LocalObjectReference": { "type": "object", "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "type": "string", "title": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", "x-f5xc-description-medium": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1LocalObjectReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1LocalVolumeSource": { "type": "object", "title": "Local represents directly-attached storage with node affinity (Beta feature)", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nIt applies only when the Path is a block device.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default value is to auto-select a filesystem if unspecified.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "description": "The full path to the volume on the node.\nIt can be either a directory or block device (disk, partition, ...).", "x-f5xc-example": "/api/v1/resources", "x-f5xc-description-short": "The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).", "x-f5xc-description-medium": "The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1LocalVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ManagedFieldsEntry": { "type": "object", "description": "ManagedFieldsEntry is a workflow-ID, a FieldSet and the group version of the resource\nthat the fieldset applies to.", "properties": { "apiVersion": { "type": "string", "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted.", "x-f5xc-description-short": "APIVersion defines the version of this resource that this field set applies to.", "x-f5xc-description-medium": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fieldsType": { "type": "string", "title": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"", "description": "Field specification or configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fieldsV1": { "allOf": [ { "$ref": "#/components/schemas/v1FieldsV1" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manager": { "type": "string", "description": "Manager is an identifier of the workflow managing these fields.", "x-f5xc-description-short": "Manager is an identifier of the workflow managing these fields.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operation": { "type": "string", "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'.", "x-f5xc-description-short": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.", "x-f5xc-description-medium": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ManagedFieldsEntry is a workflow-ID, a FieldSet and the group version of the resource that the fieldset applies to.", "x-f5xc-description-medium": "ManagedFieldsEntry is a workflow-ID, a FieldSet and the group version of the resource that the fieldset applies to.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ManagedFieldsEntry", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NFSVolumeSource": { "type": "object", "description": "Represents an NFS mount that lasts the lifetime of a pod.\nNFS volumes do not support ownership management or SELinux relabeling.", "properties": { "path": { "type": "string", "title": "Path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "description": "URL path for the endpoint", "x-f5xc-example": "/api/v1/resources", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force\nthe NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "server": { "type": "string", "title": "Server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "description": "Configuration parameter for server", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NFSVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Namespace": { "type": "object", "description": "Namespace provides a scope for Names.\nUse of multiple namespaces is optional.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1NamespaceSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1NamespaceStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Namespace provides a scope for Names. Use of multiple namespaces is optional.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Namespace", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NamespaceCondition": { "type": "object", "description": "NamespaceCondition contains details about state of namespace.", "properties": { "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of namespace controller condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NamespaceCondition contains details about state of namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NamespaceCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NamespaceList": { "type": "object", "description": "NamespaceList is a list of Namespaces.", "properties": { "items": { "type": "array", "title": "Items is the list of Namespace objects in the list.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", "items": { "$ref": "#/components/schemas/v1Namespace" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NamespaceList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NamespaceSpec": { "type": "object", "description": "NamespaceSpec describes the attributes on a Namespace.", "properties": { "finalizers": { "type": "array", "title": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage.\nMore info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for finalizers", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NamespaceSpec describes the attributes on a Namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NamespaceSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NamespaceStatus": { "type": "object", "description": "NamespaceStatus is information about the current status of a Namespace.", "properties": { "conditions": { "type": "array", "title": "Represents the latest available observations of a namespace's current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1NamespaceCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "type": "string", "title": "Phase is the current lifecycle phase of the namespace.\nMore info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/\n+optional", "description": "Current phase in the lifecycle", "x-f5xc-example": "pending", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NamespaceStatus is information about the current status of a Namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NamespaceStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeAddress": { "type": "object", "description": "NodeAddress contains information for the node's address.", "properties": { "address": { "type": "string", "description": "The node address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Node address type, one of Hostname, ExternalIP or InternalIP.", "x-f5xc-description-short": "Node address type, one of Hostname, ExternalIP or InternalIP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeAddress contains information for the node's address.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeAddress", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeAffinity": { "type": "object", "description": "Node affinity is a group of node affinity scheduling rules.", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "type": "array", "title": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional", "items": { "$ref": "#/components/schemas/v1PreferredSchedulingTerm" }, "description": "Uniform Resource Identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requiredDuringSchedulingIgnoredDuringExecution": { "allOf": [ { "$ref": "#/components/schemas/v1NodeSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Node affinity is a group of node affinity scheduling rules.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeAffinity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeCondition": { "type": "object", "description": "NodeCondition contains condition information for a node.", "properties": { "lastHeartbeatTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastHeartbeatTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "Human readable message indicating details about last transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "(brief) reason for the condition's last transition.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of node condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeCondition contains condition information for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeConfigSource": { "type": "object", "description": "NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.", "properties": { "configMap": { "allOf": [ { "$ref": "#/components/schemas/v1ConfigMapNodeConfigSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.", "x-f5xc-description-medium": "NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeConfigSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeConfigStatus": { "type": "object", "description": "NodeConfigStatus describes the status of the config assigned by node.spec.configsource.", "properties": { "active": { "allOf": [ { "$ref": "#/components/schemas/v1NodeConfigSource" } ], "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "assigned": { "allOf": [ { "$ref": "#/components/schemas/v1NodeConfigSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error": { "type": "string", "title": "Error describes any problems reconciling the Spec.ConfigSource to the Active config.\nErrors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned\nrecord, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting\nto load or validate the Assigned config, etc.\nErrors may occur at different points while syncing config. Earlier errors (e.g. download or\ncheckpointing errors) will not result in a rollback to LastKnownGood, and may resolve across\nKubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in\na rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error\nby fixing the config assigned in Spec.ConfigSource.\nYou can find additional information for debugging by searching the error message in the Kubelet log.\nError is a human-readable description of the error state; machines can check whether or not Error\nis empty, but should not rely on the stability of the Error text across Kubelet versions.\n+optional", "description": "Configuration parameter for error", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastKnownGood": { "allOf": [ { "$ref": "#/components/schemas/v1NodeConfigSource" } ], "x-f5xc-description-short": "Configuration parameter for lastKnownGood.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeConfigStatus describes the status of the config assigned by node.spec.configsource.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeConfigStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeDaemonEndpoints": { "type": "object", "description": "NodeDaemonEndpoints lists ports opened by daemons running on the Node.", "properties": { "kubeletEndpoint": { "allOf": [ { "$ref": "#/components/schemas/v1DaemonEndpoint" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeDaemonEndpoints lists ports opened by daemons running on the Node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeDaemonEndpoints", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeList": { "type": "object", "description": "NodeList is the whole list of all Nodes which have been registered with master.", "properties": { "items": { "type": "array", "title": "List of nodes", "items": { "$ref": "#/components/schemas/corev1Node" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeList is the whole list of all Nodes which have been registered with master.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeSelector": { "type": "object", "description": "A node selector represents the union of the results of one or more label queries\nover a set of nodes; that is, it represents the OR of the selectors represented\nby the node selector terms.", "properties": { "nodeSelectorTerms": { "type": "array", "description": "Required. A list of node selector terms. The terms are ORed.", "items": { "$ref": "#/components/schemas/v1NodeSelectorTerm" }, "x-f5xc-description-short": "Required. A list of node selector terms.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors...", "x-f5xc-description-medium": "Node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeSelectorRequirement": { "type": "object", "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "type": "string", "description": "The label key that the selector applies to.", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-description-short": "The label key that the selector applies to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "operator": { "type": "string", "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "x-f5xc-description-short": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.", "x-f5xc-description-medium": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "title": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for values", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "x-f5xc-description-medium": "Node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeSelectorRequirement", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeSelectorTerm": { "type": "object", "description": "A null or empty node selector term matches no objects. The requirements of\nthem are ANDed.\nThe TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", "properties": { "matchExpressions": { "type": "array", "title": "A list of node selector requirements by node's labels.\n+optional", "items": { "$ref": "#/components/schemas/v1NodeSelectorRequirement" }, "description": "Configuration parameter for matchExpressions", "x-f5xc-description-short": "Configuration parameter for matchExpressions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "matchFields": { "type": "array", "title": "A list of node selector requirements by node's fields.\n+optional", "items": { "$ref": "#/components/schemas/v1NodeSelectorRequirement" }, "description": "Configuration parameter for matchFields", "x-f5xc-description-short": "Configuration parameter for matchFields.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Null or empty node selector term matches no objects. The requirements of them are ANDed.", "x-f5xc-description-medium": "Null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeSelectorTerm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeSpec": { "type": "object", "description": "NodeSpec describes the attributes that a node is created with.", "properties": { "configSource": { "allOf": [ { "$ref": "#/components/schemas/v1NodeConfigSource" } ], "x-f5xc-description-short": "Configuration parameter for configSource.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalID": { "type": "string", "title": "Deprecated. Not all kubelets will set this field. Remove field after 1.13.\nsee: https://issues.k8s.io/61966\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "podCIDR": { "type": "string", "title": "PodCIDR represents the pod IP range assigned to the node.\n+optional", "description": "Configuration parameter for podCIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "podCIDRs": { "type": "array", "title": "podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this\nfield is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for\neach of IPv4 and IPv6.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "description": "Configuration parameter for podCIDRs", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "providerID": { "type": "string", "title": "ID of the node assigned by the cloud provider in the format: ://\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "taints": { "type": "array", "title": "If specified, the node's taints.\n+optional", "items": { "$ref": "#/components/schemas/v1Taint" }, "description": "Configuration parameter for taints", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unschedulable": { "type": "boolean", "title": "Unschedulable controls node schedulability of new pods. By default, node is schedulable.\nMore info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration\n+optional", "format": "boolean", "description": "Configuration parameter for unschedulable", "x-f5xc-description-short": "Configuration parameter for unschedulable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeSpec describes the attributes that a node is created with.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeStatus": { "type": "object", "description": "NodeStatus is information about the current status of a node.", "properties": { "addresses": { "type": "array", "title": "List of addresses reachable to the node.\nQueried from cloud provider, if available.\nMore info: https://kubernetes.io/docs/concepts/nodes/node/#addresses\nNote: This field is declared as mergeable, but the merge key is not sufficiently\nunique, which can cause data corruption when it is merged. Callers should instead\nuse a full-replacement patch. See http://pr.k8s.io/79391 for an example.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1NodeAddress" }, "description": "Network address or location", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allocatable": { "type": "object", "title": "Allocatable represents the resources of a node that are available for scheduling.\nDefaults to Capacity.\n+optional", "description": "Configuration parameter for allocatable", "x-f5xc-description-short": "Configuration parameter for allocatable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "capacity": { "type": "object", "title": "Capacity represents the total resources of a node.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity\n+optional", "description": "Configuration parameter for capacity", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "Conditions is an array of current observed node conditions.\nMore info: https://kubernetes.io/docs/concepts/nodes/node/#condition\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1NodeCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "config": { "allOf": [ { "$ref": "#/components/schemas/v1NodeConfigStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "daemonEndpoints": { "allOf": [ { "$ref": "#/components/schemas/v1NodeDaemonEndpoints" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "images": { "type": "array", "title": "List of container images on this node\n+optional", "items": { "$ref": "#/components/schemas/v1ContainerImage" }, "description": "Configuration parameter for images", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodeInfo": { "allOf": [ { "$ref": "#/components/schemas/v1NodeSystemInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "type": "string", "title": "NodePhase is the recently observed lifecycle phase of the node.\nMore info: https://kubernetes.io/docs/concepts/nodes/node/#phase\nThe field is never populated, and now is deprecated.\n+optional", "description": "Current phase in the lifecycle", "x-f5xc-example": "pending", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumesAttached": { "type": "array", "title": "List of volumes that are attached to the node.\n+optional", "items": { "$ref": "#/components/schemas/v1AttachedVolume" }, "description": "Configuration parameter for volumesAttached", "x-f5xc-description-short": "Configuration parameter for volumesAttached.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumesInUse": { "type": "array", "title": "List of attachable volumes in use (mounted) by the node.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for volumesInUse", "x-f5xc-description-short": "Configuration parameter for volumesInUse.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeStatus is information about the current status of a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1NodeSystemInfo": { "type": "object", "description": "NodeSystemInfo is a set of IDs/uuids to uniquely identify the node.", "properties": { "architecture": { "type": "string", "title": "The Architecture reported by the node", "description": "Configuration parameter for architecture", "x-f5xc-description-short": "Configuration parameter for architecture.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bootID": { "type": "string", "description": "Boot ID reported by the node.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "containerRuntimeVersion": { "type": "string", "description": "ContainerRuntime Version reported by the node through runtime remote API (e.g. Docker://1.5.0).", "x-f5xc-description-short": "ContainerRuntime Version reported by the node through runtime remote API (e.g. Docker://1.5.0).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kernelVersion": { "type": "string", "description": "Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).", "x-f5xc-description-short": "Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kubeProxyVersion": { "type": "string", "description": "KubeProxy Version reported by the node.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kubeletVersion": { "type": "string", "description": "Kubelet Version reported by the node.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "machineID": { "type": "string", "title": "MachineID reported by the node. For unique machine identification\nin the cluster this field is preferred. Learn more from man(5)\nmachine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operatingSystem": { "type": "string", "title": "The Operating System reported by the node", "description": "Configuration parameter for operatingSystem", "x-f5xc-description-short": "Configuration parameter for operatingSystem.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "osImage": { "type": "string", "description": "OS Image reported by the node from /etc/OS-release (e.g. Debian GNU/Linux 7 (wheezy)).", "x-f5xc-description-short": "OS Image reported by the node from /etc/OS-release (e.g. Debian GNU/Linux 7 (wheezy)).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "systemUUID": { "type": "string", "title": "SystemUUID reported by the node. For unique machine identification\nMachineID is preferred. This field is specific to Red Hat hosts\nhttps://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeSystemInfo is a set of IDs/uuids to uniquely identify the node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1NodeSystemInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ObjectFieldSelector": { "type": "object", "description": "ObjectFieldSelector selects an APIVersioned field of an object.", "properties": { "apiVersion": { "type": "string", "title": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fieldPath": { "type": "string", "description": "Path of the field to select in the specified API version.", "x-f5xc-description-short": "Path of the field to select in the specified API version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ObjectFieldSelector selects an APIVersioned field of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ObjectFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ObjectMeta": { "type": "object", "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects\nusers must create.", "properties": { "annotations": { "type": "object", "title": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations\n+optional", "description": "Additional metadata and notes", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "clusterName": { "type": "string", "title": "The name of the cluster which the object belongs to.\nThis is used to distinguish resources with same name and namespace in different clusters.\nThis field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.\n+optional", "description": "Cluster or grouping configuration", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creationTimestamp": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for creationTimestamp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deletionGracePeriodSeconds": { "type": "string", "title": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deletionTimestamp": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for deletionTimestamp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "title": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "description": "Configuration parameter for finalizers", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "generateName": { "type": "string", "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will\nNOT return a 409 - instead, it will either return 201 Created or 500 with Reason\nServerTimeout indicating a unique name could not be found in the time allotted, and the client\nshould retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified.\nMore info: HTTPS://git.K8s.I/O/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional.", "x-f5xc-description-short": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.", "x-f5xc-description-medium": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "generation": { "type": "string", "title": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "description": "Configuration parameter for generation", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "title": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels\n+optional", "description": "Key-value labels for organization and selection", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Key-value labels for organization and selection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "managedFields": { "type": "array", "description": "ManagedFields maps workflow-ID and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional.", "items": { "$ref": "#/components/schemas/v1ManagedFieldsEntry" }, "x-f5xc-description-short": "ManagedFields maps workflow-ID and version to the set of fields that are managed by that workflow.", "x-f5xc-description-medium": "ManagedFields maps workflow-ID and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "title": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace defines the space within each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: HTTP://Kubernetes.I/O/docs/user-guide/namespaces\n+optional.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Namespace defines the space within each name must be unique.", "x-f5xc-description-medium": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "ownerReferences": { "type": "array", "title": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1OwnerReference" }, "description": "Owner or responsible party", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resourceVersion": { "type": "string", "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: HTTPS://git.K8s.I/O/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional.", "x-f5xc-description-short": "Opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.", "x-f5xc-description-medium": "Opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "selfLink": { "type": "string", "description": "SelfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n\nDEPRECATED\nKubernetes will stop propagating this field in 1.20 release and the field is planned\nto be removed in 1.21 release.\n+optional.", "x-f5xc-description-short": "SelfLink is a URL representing this object. Populated by the system.", "x-f5xc-description-medium": "SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: HTTP://Kubernetes.I/O/docs/user-guide/identifiers#uids\n+optional.", "x-f5xc-description-short": "UID is the unique in time and space value for this object.", "x-f5xc-description-medium": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.", "x-f5xc-description-medium": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ObjectMeta", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ObjectReference": { "type": "object", "title": "ObjectReference contains enough information to let you inspect or modify the referred object.\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", "properties": { "apiVersion": { "type": "string", "title": "API version of the referent.\n+optional", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fieldPath": { "type": "string", "title": "If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object.\nTODO: this design is not final and this field is subject to change in the future.\n+optional", "description": "Field specification or configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kind": { "type": "string", "title": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "description": "Resource type or kind", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "title": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "title": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "resourceVersion": { "type": "string", "title": "Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "title": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ObjectReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1OwnerReference": { "type": "object", "description": "OwnerReference contains enough information to let you identify an owning\nobject. An owning object must be in the same namespace as the dependent, or\nbe cluster-scoped, so there is no namespace field.", "properties": { "apiVersion": { "type": "string", "description": "API version of the referent.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "blockOwnerDeletion": { "type": "boolean", "title": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional", "format": "boolean", "description": "Blocking or denial configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "controller": { "type": "boolean", "title": "If true, this reference points to the managing controller.\n+optional", "format": "boolean", "description": "Configuration parameter for controller", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kind": { "type": "string", "title": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "description": "Resource type or kind", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "title": "Name of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "title": "UID of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "OwnerReference contains enough information to let you identify an owning object.", "x-f5xc-description-medium": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1OwnerReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolume": { "type": "object", "title": "PersistentVolume (PV) is a storage resource provisioned by an administrator.\nIt is analogous to a node.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1PersistentVolumeSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1PersistentVolumeStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolume", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeClaim": { "type": "object", "title": "PersistentVolumeClaim is a user's request for and claim to a persistent volume", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1PersistentVolumeClaimSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1PersistentVolumeClaimStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeClaim", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeClaimCondition": { "type": "object", "title": "PersistentVolumeClaimCondition contains details about state of pvc", "properties": { "lastProbeTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastProbeTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "Human-readable message indicating details about last transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "Unique, this should be a short, machine understandable string that gives the reason\nfor condition's last transition. If it reports \"ResizeStarted\" that means the underlying\npersistent volume is being resized.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Current status of the resource", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeClaimCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeClaimList": { "type": "object", "description": "PersistentVolumeClaimList is a list of PersistentVolumeClaim items.", "properties": { "items": { "type": "array", "title": "A list of persistent volume claims.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "items": { "$ref": "#/components/schemas/v1PersistentVolumeClaim" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PersistentVolumeClaimList is a list of PersistentVolumeClaim items.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeClaimList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeClaimSpec": { "type": "object", "title": "PersistentVolumeClaimSpec describes the common attributes of storage devices\nand allows a Source for provider-specific attributes", "properties": { "accessModes": { "type": "array", "title": "AccessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for accessModes", "x-f5xc-description-short": "Configuration parameter for accessModes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dataSource": { "allOf": [ { "$ref": "#/components/schemas/v1TypedLocalObjectReference" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resources": { "allOf": [ { "$ref": "#/components/schemas/v1ResourceRequirements" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storageClassName": { "type": "string", "title": "Name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeMode": { "type": "string", "title": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.\nThis is a beta feature.\n+optional", "description": "Configuration parameter for volumeMode", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeName": { "type": "string", "title": "VolumeName is the binding reference to the PersistentVolume backing this claim.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeClaimSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeClaimStatus": { "type": "object", "description": "PersistentVolumeClaimStatus is the current status of a persistent volume claim.", "properties": { "accessModes": { "type": "array", "title": "AccessModes contains the actual access modes the volume backing the PVC has.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for accessModes", "x-f5xc-description-short": "Configuration parameter for accessModes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "capacity": { "type": "object", "title": "Represents the actual resources of the underlying volume.\n+optional", "description": "Configuration parameter for capacity", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "Current Condition of persistent volume claim. If underlying persistent volume is being\nresized then the Condition will be set to 'ResizeStarted'.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1PersistentVolumeClaimCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "type": "string", "title": "Phase represents the current phase of PersistentVolumeClaim.\n+optional", "description": "Current phase in the lifecycle", "x-f5xc-example": "pending", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PersistentVolumeClaimStatus is the current status of a persistent volume claim.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeClaimStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeClaimVolumeSource": { "type": "object", "description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.\nThis volume finds the bound PV and mounts that volume for the pod. A\nPersistentVolumeClaimVolumeSource is, essentially, a wrapper around another\ntype of volume that is owned by someone else (the system).", "properties": { "claimName": { "type": "string", "title": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.", "x-f5xc-description-medium": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeClaimVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeList": { "type": "object", "description": "PersistentVolumeList is a list of PersistentVolume items.", "properties": { "items": { "type": "array", "title": "List of persistent volumes.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes", "items": { "$ref": "#/components/schemas/v1PersistentVolume" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PersistentVolumeList is a list of PersistentVolume items.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeSource": { "type": "object", "description": "PersistentVolumeSource is similar to VolumeSource but meant for the\nadministrator who creates PVs. Exactly one of its members must be set.", "properties": { "awsElasticBlockStore": { "allOf": [ { "$ref": "#/components/schemas/v1AWSElasticBlockStoreVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "azureDisk": { "allOf": [ { "$ref": "#/components/schemas/v1AzureDiskVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "azureFile": { "allOf": [ { "$ref": "#/components/schemas/v1AzureFilePersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cephfs": { "allOf": [ { "$ref": "#/components/schemas/v1CephFSPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cinder": { "allOf": [ { "$ref": "#/components/schemas/v1CinderPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "csi": { "allOf": [ { "$ref": "#/components/schemas/v1CSIPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fc": { "allOf": [ { "$ref": "#/components/schemas/v1FCVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flexVolume": { "allOf": [ { "$ref": "#/components/schemas/v1FlexPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flocker": { "allOf": [ { "$ref": "#/components/schemas/v1FlockerVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcePersistentDisk": { "allOf": [ { "$ref": "#/components/schemas/v1GCEPersistentDiskVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for gcePersistentDisk.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "glusterfs": { "allOf": [ { "$ref": "#/components/schemas/v1GlusterfsPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostPath": { "allOf": [ { "$ref": "#/components/schemas/v1HostPathVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iscsi": { "allOf": [ { "$ref": "#/components/schemas/v1ISCSIPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "local": { "allOf": [ { "$ref": "#/components/schemas/v1LocalVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nfs": { "allOf": [ { "$ref": "#/components/schemas/v1NFSVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "photonPersistentDisk": { "allOf": [ { "$ref": "#/components/schemas/v1PhotonPersistentDiskVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for photonPersistentDisk.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "portworxVolume": { "allOf": [ { "$ref": "#/components/schemas/v1PortworxVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "quobyte": { "allOf": [ { "$ref": "#/components/schemas/v1QuobyteVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rbd": { "allOf": [ { "$ref": "#/components/schemas/v1RBDPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scaleIO": { "allOf": [ { "$ref": "#/components/schemas/v1ScaleIOPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storageos": { "allOf": [ { "$ref": "#/components/schemas/v1StorageOSPersistentVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vsphereVolume": { "allOf": [ { "$ref": "#/components/schemas/v1VsphereVirtualDiskVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for vsphereVolume.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs.", "x-f5xc-description-medium": "PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs. Exactly one of its members must be set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeSpec": { "type": "object", "description": "PersistentVolumeSpec is the specification of a persistent volume.", "properties": { "accessModes": { "type": "array", "title": "AccessModes contains all ways the volume can be mounted.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for accessModes", "x-f5xc-description-short": "Configuration parameter for accessModes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "capacity": { "type": "object", "title": "A description of the persistent volume's resources and capacity.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity\n+optional", "description": "Configuration parameter for capacity", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "claimRef": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mountOptions": { "type": "array", "title": "A list of mount options, e.g. [\"ro\", \"soft\"]. Not validated - mount will\nsimply fail if one is invalid.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for mountOptions", "x-f5xc-description-short": "Configuration parameter for mountOptions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodeAffinity": { "allOf": [ { "$ref": "#/components/schemas/v1VolumeNodeAffinity" } ], "x-f5xc-description-short": "Configuration parameter for nodeAffinity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "persistentVolumeReclaimPolicy": { "type": "string", "title": "What happens to a persistent volume when released from its claim.\nValid options are Retain (default for manually created PersistentVolumes), Delete (default\nfor dynamically provisioned PersistentVolumes), and Recycle (deprecated).\nRecycle must be supported by the volume plugin underlying this PersistentVolume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming\n+optional", "description": "Configuration parameter for persistentVolumeReclaimPolicy", "x-f5xc-description-short": "Configuration parameter for persistentVolumeReclaimPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "persistentVolumeSource": { "allOf": [ { "$ref": "#/components/schemas/v1PersistentVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for persistentVolumeSource.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storageClassName": { "type": "string", "title": "Name of StorageClass to which this persistent volume belongs. Empty value\nmeans that this volume does not belong to any StorageClass.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeMode": { "type": "string", "title": "volumeMode defines if a volume is intended to be used with a formatted filesystem\nor to remain in raw block state. Value of Filesystem is implied when not included in spec.\nThis is a beta feature.\n+optional", "description": "Configuration parameter for volumeMode", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PersistentVolumeSpec is the specification of a persistent volume.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PersistentVolumeStatus": { "type": "object", "description": "PersistentVolumeStatus is the current status of a persistent volume.", "properties": { "message": { "type": "string", "title": "A human-readable message indicating details about why the volume is in this state.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "type": "string", "title": "Phase indicates if a volume is available, bound to a claim, or released by a claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase\n+optional", "description": "Current phase in the lifecycle", "x-f5xc-example": "pending", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "Reason is a brief CamelCase string that describes any failure and is meant\nfor machine parsing and tidy display in the CLI.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "PersistentVolumeStatus is the current status of a persistent volume.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PersistentVolumeStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PhotonPersistentDiskVolumeSource": { "type": "object", "description": "Represents a Photon Controller persistent disk resource.", "properties": { "fsType": { "type": "string", "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "x-f5xc-description-short": "Filesystem type to mount. Must be a filesystem type supported by the host operating system.", "x-f5xc-description-medium": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pdID": { "type": "string", "title": "ID that identifies Photon Controller persistent disk", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Photon Controller persistent disk resource.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PhotonPersistentDiskVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Pod": { "type": "object", "description": "Pod is a collection of containers that can run on a host. This resource is created\nby clients and scheduled onto hosts.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1PodSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1PodStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.", "x-f5xc-description-medium": "Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Pod", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodAffinity": { "type": "object", "description": "Pod affinity is a group of inter pod affinity scheduling rules.", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "type": "array", "title": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional", "items": { "$ref": "#/components/schemas/v1WeightedPodAffinityTerm" }, "description": "Uniform Resource Identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requiredDuringSchedulingIgnoredDuringExecution": { "type": "array", "title": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional", "items": { "$ref": "#/components/schemas/v1PodAffinityTerm" }, "description": "Uniform Resource Identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Pod affinity is a group of inter pod affinity scheduling rules.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodAffinity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodAffinityTerm": { "type": "object", "title": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key matches that of any node on which\na pod of the set of pods is running", "properties": { "labelSelector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespaces": { "type": "array", "title": "namespaces specifies which namespaces the labelSelector applies to (matches against);\nnull or empty list means \"this pod's namespace\"\n+optional", "items": { "type": "string" }, "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topologyKey": { "type": "string", "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "x-f5xc-description-short": "Pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where...", "x-f5xc-description-medium": "Pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodAffinityTerm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodAntiAffinity": { "type": "object", "description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "type": "array", "title": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional", "items": { "$ref": "#/components/schemas/v1WeightedPodAffinityTerm" }, "description": "Uniform Resource Identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requiredDuringSchedulingIgnoredDuringExecution": { "type": "array", "title": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional", "items": { "$ref": "#/components/schemas/v1PodAffinityTerm" }, "description": "Uniform Resource Identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodAntiAffinity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodCondition": { "type": "object", "description": "PodCondition contains details for the current condition of this pod.", "properties": { "lastProbeTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastProbeTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "Human-readable message indicating details about last transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "Unique, one-word, CamelCase reason for the condition's last transition.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "title": "Status is the status of the condition.\nCan be True, False, Unknown.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions", "description": "Current status of the resource", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "title": "Type is the type of the condition.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PodCondition contains details for the current condition of this pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodDNSConfig": { "type": "object", "description": "PodDNSConfig defines the DNS parameters of a pod in addition to\nthose generated from DNSPolicy.", "properties": { "nameservers": { "type": "array", "title": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional", "items": { "type": "string" }, "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "options": { "type": "array", "title": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional", "items": { "$ref": "#/components/schemas/v1PodDNSConfigOption" }, "description": "Configuration parameter for options", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "searches": { "type": "array", "title": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for searches", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodDNSConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodDNSConfigOption": { "type": "object", "description": "PodDNSConfigOption defines DNS resolver OPTIONS of a pod.", "properties": { "name": { "type": "string", "description": "Required.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "value": { "type": "string", "title": "+optional", "description": "Configuration parameter for value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "PodDNSConfigOption defines DNS resolver OPTIONS of a pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodDNSConfigOption", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodIP": { "type": "object", "description": "IP address information for entries in the (plural) PodIPs field.\nEach entry includes:\nIP: An IP address allocated to the pod. Routable at least within the cluster.", "properties": { "ip": { "type": "string", "title": "ip is an IP address (IPv4 or IPv6) assigned to the pod", "description": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1)", "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod.", "x-f5xc-description-medium": "IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodList": { "type": "object", "description": "PodList is a list of Pods.", "properties": { "items": { "type": "array", "title": "List of pods.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md", "items": { "$ref": "#/components/schemas/v1Pod" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodReadinessGate": { "type": "object", "title": "PodReadinessGate contains the reference to a pod condition", "properties": { "conditionType": { "type": "string", "description": "ConditionType refers to a condition in the pod's condition list with matching type.", "x-f5xc-description-short": "ConditionType refers to a condition in the pod's condition list with matching type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodReadinessGate", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodSecurityContext": { "type": "object", "description": "PodSecurityContext holds pod-level security attributes and common container settings.\nSome fields are also present in container.securitycontext. Field values of\ncontainer.securitycontext take precedence over field values of PodSecurityContext.", "properties": { "fsGroup": { "type": "string", "description": "1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\n+optional.", "title": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:", "format": "int64", "x-f5xc-description-short": "1. The owning GID will be the FSGroup 2.", "x-f5xc-description-medium": "1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. +optional.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsGroup": { "type": "string", "title": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\n+optional", "format": "int64", "description": "Configuration parameter for runAsGroup", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsNonRoot": { "type": "boolean", "title": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "format": "boolean", "description": "Configuration parameter for runAsNonRoot", "x-f5xc-description-short": "Configuration parameter for runAsNonRoot.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsUser": { "type": "string", "title": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\n+optional", "format": "int64", "description": "Configuration parameter for runAsUser", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "seLinuxOptions": { "allOf": [ { "$ref": "#/components/schemas/v1SELinuxOptions" } ], "x-f5xc-description-short": "Configuration parameter for seLinuxOptions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "supplementalGroups": { "type": "array", "title": "A list of groups applied to the first process run in each container, in addition\nto the container's primary GID. If unspecified, no groups will be added to\nany container.\n+optional", "items": { "type": "string", "format": "int64" }, "description": "Configuration parameter for supplementalGroups", "x-f5xc-description-short": "Configuration parameter for supplementalGroups.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sysctls": { "type": "array", "title": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\n+optional", "items": { "$ref": "#/components/schemas/v1Sysctl" }, "description": "Configuration parameter for sysctls", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "windowsOptions": { "allOf": [ { "$ref": "#/components/schemas/v1WindowsSecurityContextOptions" } ], "x-f5xc-description-short": "Configuration parameter for windowsOptions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PodSecurityContext holds pod-level security attributes and common container settings.", "x-f5xc-description-medium": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securitycontext. Field values of container.securitycontext take precedence over field values of PodSecurityContext.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodSecurityContext", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodSpec": { "type": "object", "description": "PodSpec is a description of a pod.", "properties": { "activeDeadlineSeconds": { "type": "string", "title": "Optional duration in seconds the pod may be active on the node relative to\nStartTime before the system will actively try to mark it failed and kill associated containers.\nValue must be a positive integer.\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "affinity": { "allOf": [ { "$ref": "#/components/schemas/v1Affinity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "automountServiceAccountToken": { "type": "boolean", "title": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.\n+optional", "format": "boolean", "description": "Configuration parameter for automountServiceAccountToken", "x-f5xc-description-short": "Configuration parameter for automountServiceAccountToken.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "containers": { "type": "array", "title": "List of containers belonging to the pod.\nContainers cannot currently be added or removed.\nThere must be at least one container in a Pod.\nCannot be updated.\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1Container" }, "description": "Configuration parameter for containers", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dnsConfig": { "allOf": [ { "$ref": "#/components/schemas/v1PodDNSConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dnsPolicy": { "type": "string", "title": "Set DNS policy for the pod.\nDefaults to \"ClusterFirst\".\nValid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.\nDNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.\nTo have DNS options set along with hostNetwork, you have to specify DNS policy\nexplicitly to 'ClusterFirstWithHostNet'.\n+optional", "description": "Configuration parameter for dnsPolicy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enableServiceLinks": { "type": "boolean", "title": "EnableServiceLinks indicates whether information about services should be injected into pod's\nenvironment variables, matching the syntax of Docker links.\nOptional: Defaults to true.\n+optional", "format": "boolean", "description": "Configuration parameter for enableServiceLinks", "x-f5xc-description-short": "Configuration parameter for enableServiceLinks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ephemeralContainers": { "type": "array", "title": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing\npod to perform user-initiated actions such as debugging. This list cannot be specified when\ncreating a pod, and it cannot be modified by updating the pod spec. In order to add an\nephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.\nThis field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1EphemeralContainer" }, "description": "Configuration parameter for ephemeralContainers", "x-f5xc-description-short": "Configuration parameter for ephemeralContainers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostAliases": { "type": "array", "title": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts\nfile if specified. This is only valid for non-hostNetwork pods.\n+optional\n+patchMergeKey=ip\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1HostAlias" }, "description": "Host configuration or identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostIPC": { "type": "boolean", "title": "Use the host's ipc namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "format": "boolean", "description": "Host configuration or identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostNetwork": { "type": "boolean", "title": "Host networking requested for this pod. Use the host's network namespace.\nIf this option is set, the ports that will be used must be specified.\nDefault to false.\n+k8s:conversion-gen=false\n+optional", "format": "boolean", "description": "Host configuration or identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostPID": { "type": "boolean", "title": "Use the host's pid namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "format": "boolean", "description": "Host configuration or identifier", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostname": { "type": "string", "title": "Specifies the hostname of the Pod\nIf not specified, the pod's hostname will be set to a system-defined value.\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "imagePullSecrets": { "type": "array", "title": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.\nIf specified, these secrets will be passed to individual puller implementations for them to use. For example,\nin the case of docker, only DockerConfig type secrets are honored.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1LocalObjectReference" }, "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initContainers": { "type": "array", "title": "List of initialization containers belonging to the pod.\nInit containers are executed in order prior to containers being started. If any\ninit container fails, the pod is considered to have failed and is handled according\nto its restartPolicy. The name for an init container or normal container must be\nunique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling\nby finding the highest request/limit for each resource type, and then using the max of\nof that value or the sum of the normal containers. Limits are applied to init containers\nin a similar fashion.\nInit containers cannot currently be added or removed.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1Container" }, "description": "Configuration parameter for initContainers", "x-f5xc-description-short": "Configuration parameter for initContainers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodeName": { "type": "string", "title": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty,\nthe scheduler simply schedules this pod onto that node, assuming that it fits resource\nrequirements.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodeSelector": { "type": "object", "title": "NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional", "description": "Configuration parameter for nodeSelector", "x-f5xc-description-short": "Configuration parameter for nodeSelector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "overhead": { "type": "object", "title": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.\nThis field will be autopopulated at admission time by the RuntimeClass admission controller. If\nthe RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.\nThe RuntimeClass admission controller will reject Pod create requests which have the overhead already\nset. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value\ndefined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md\nThis field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.\n+optional", "description": "Configuration parameter for overhead", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "preemptionPolicy": { "type": "string", "title": "PreemptionPolicy is the Policy for preempting pods with lower priority.\nOne of Never, PreemptLowerPriority.\nDefaults to PreemptLowerPriority if unset.\nThis field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.\n+optional", "description": "Configuration parameter for preemptionPolicy", "x-f5xc-description-short": "Configuration parameter for preemptionPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "priority": { "type": "integer", "title": "The priority value. Various system components use this field to find the\npriority of the pod. When Priority Admission Controller is enabled, it\nprevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\n+optional", "format": "int32", "description": "Priority level for ordering", "x-f5xc-example": "10", "x-f5xc-constraints": { "constraintType": "number", "category": "ordering", "minimum": 0, "maximum": 100, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "priorityClassName": { "type": "string", "title": "If specified, indicates the pod's priority. \"system-node-critical\" and\n\"system-cluster-critical\" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readinessGates": { "type": "array", "title": "If specified, all readiness gates will be evaluated for pod readiness.\nA pod is ready when all its containers are ready AND\nall conditions specified in the readiness gates have status equal to \"True\"\nMore info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md\n+optional", "items": { "$ref": "#/components/schemas/v1PodReadinessGate" }, "description": "Configuration parameter for readinessGates", "x-f5xc-description-short": "Configuration parameter for readinessGates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "restartPolicy": { "type": "string", "title": "Restart policy for all containers within the pod.\nOne of Always, OnFailure, Never.\nDefault to Always.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy\n+optional", "description": "Configuration parameter for restartPolicy", "x-f5xc-description-short": "Configuration parameter for restartPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runtimeClassName": { "type": "string", "title": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used\nto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.\nIf unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an\nempty definition that uses the default runtime handler.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md\nThis is a beta feature as of Kubernetes v1.14.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "schedulerName": { "type": "string", "title": "If specified, the pod will be dispatched by specified scheduler.\nIf not specified, the pod will be dispatched by default scheduler.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "securityContext": { "allOf": [ { "$ref": "#/components/schemas/v1PodSecurityContext" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "serviceAccount": { "type": "string", "title": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.\nDeprecated: Use serviceAccountName instead.\n+k8s:conversion-gen=false\n+optional", "description": "Number of items or occurrences", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "serviceAccountName": { "type": "string", "title": "ServiceAccountName is the name of the ServiceAccount to use to run this pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "shareProcessNamespace": { "type": "boolean", "title": "Share a single process namespace between all of the containers in a pod.\nWhen this is set containers will be able to view and signal processes from other containers\nin the same pod, and the first process in each container will not be assigned PID 1.\nHostPID and ShareProcessNamespace cannot both be set.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "format": "boolean", "description": "Namespace for resource isolation", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subdomain": { "type": "string", "title": "If specified, the fully qualified Pod hostname will be \"...svc.\".\nIf not specified, the pod will not have a domainname at all.\n+optional", "description": "Configuration parameter for subdomain", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "terminationGracePeriodSeconds": { "type": "string", "title": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tolerations": { "type": "array", "title": "If specified, the pod's tolerations.\n+optional", "items": { "$ref": "#/components/schemas/v1Toleration" }, "description": "Configuration parameter for tolerations", "x-f5xc-description-short": "Configuration parameter for tolerations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topologySpreadConstraints": { "type": "array", "title": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nThis field is alpha-level and is only honored by clusters that enables the EvenPodsSpread\nfeature.\nAll topologySpreadConstraints are ANDed.\n+optional\n+patchMergeKey=topologyKey\n+patchStrategy=merge\n+listType=map\n+listMapKey=topologyKey\n+listMapKey=whenUnsatisfiable", "items": { "$ref": "#/components/schemas/v1TopologySpreadConstraint" }, "description": "Configuration parameter for topologySpreadConstraints", "x-f5xc-description-short": "Configuration parameter for topologySpreadConstraints.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumes": { "type": "array", "title": "List of volumes that can be mounted by containers belonging to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes\n+optional\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys", "items": { "$ref": "#/components/schemas/v1Volume" }, "description": "Configuration parameter for volumes", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodStatus": { "type": "object", "description": "PodStatus represents information about the status of a pod. Status may trail the actual\nstate of a system, especially if the node that hosts the pod cannot contact the control\nplane.", "properties": { "conditions": { "type": "array", "title": "Current service state of pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1PodCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "containerStatuses": { "type": "array", "title": "The list has one entry per container in the manifest. Each entry is currently the output\nof `docker inspect`.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status\n+optional", "items": { "$ref": "#/components/schemas/v1ContainerStatus" }, "description": "Current observed state", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ephemeralContainerStatuses": { "type": "array", "title": "Status for any ephemeral containers that have run in this pod.\nThis field is alpha-level and is only populated by servers that enable the EphemeralContainers feature.\n+optional", "items": { "$ref": "#/components/schemas/v1ContainerStatus" }, "description": "Current observed state", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostIP": { "type": "string", "title": "IP address of the host to which the pod is assigned. Empty if not yet scheduled.\n+optional", "description": "Host configuration or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initContainerStatuses": { "type": "array", "title": "The list has one entry per init container in the manifest. The most recent successful\ninit container will have ready = true, the most recently started container will have\nstartTime set.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status", "items": { "$ref": "#/components/schemas/v1ContainerStatus" }, "description": "Current observed state", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "A human readable message indicating details about why the pod is in this condition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nominatedNodeName": { "type": "string", "title": "nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be\nscheduled right away as preemption victims receive their graceful termination periods.\nThis field does not guarantee that the pod will be scheduled on this node. Scheduler may decide\nto place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to\ngive the resources on this node to a higher priority pod that is created after preemption.\nAs a result, this field may be different than PodSpec.nodeName when the pod is\nscheduled.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "phase": { "type": "string", "description": "Pending: The pod has been accepted by the Kubernetes system, but one or more of the\ncontainer images has not been created. This includes time before being scheduled as\nwell as time spent downloading images over the network, which could take a while.\nRunning: The pod has been bound to a node, and all of the containers have been created.\nAt least one container is still running, or is in the process of starting or restarting.\nSucceeded: All containers in the pod have terminated in success, and will not be restarted.\nFailed: All containers in the pod have terminated, and at least one container has\nterminated in failure. The container either exited with non-zero status or was terminated\nby the system.\nUnknown: For some reason the state of the pod could not be obtained, typically due to an\nerror in communicating with the host of the pod.\n\nMore info: HTTPS://Kubernetes.I/O/docs/concepts/workloads/pods/pod-lifecycle#pod-phase\n+optional.", "title": "The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle.\nThe conditions array, the reason and message fields, and the individual container status\narrays contain more detail about the pod's status.\nThere are five possible phase values:", "x-f5xc-example": "pending", "x-f5xc-description-short": "Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created.", "x-f5xc-description-medium": "Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "podIP": { "type": "string", "title": "IP address allocated to the pod. Routable at least within the cluster.\nEmpty if not yet allocated.\n+optional", "description": "Configuration parameter for podIP", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "podIPs": { "type": "array", "title": "podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must\nmatch the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list\nis empty if no IPs have been allocated yet.\n+optional\n+patchStrategy=merge\n+patchMergeKey=ip", "items": { "$ref": "#/components/schemas/v1PodIP" }, "description": "Configuration parameter for podIPs", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "qosClass": { "type": "string", "title": "The Quality of Service (QOS) classification assigned to the pod based on resource requirements\nSee PodQOSClass type for available QOS classes\nMore info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md\n+optional", "description": "Configuration parameter for qosClass", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "A brief CamelCase message indicating details about why the pod is in this state.\ne.g. 'Evicted'\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "startTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PodStatus represents information about the status of a pod.", "x-f5xc-description-medium": "PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PodTemplateSpec": { "type": "object", "title": "PodTemplateSpec describes the data a pod should have when created from a template", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1PodSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PodTemplateSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PortworxVolumeSource": { "type": "object", "description": "PortworxVolumeSource represents a Portworx volume resource.", "properties": { "fsType": { "type": "string", "description": "FSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "x-f5xc-description-short": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system.", "x-f5xc-description-medium": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeID": { "type": "string", "title": "VolumeID uniquely identifies a Portworx volume", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PortworxVolumeSource represents a Portworx volume resource.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PortworxVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1PreferredSchedulingTerm": { "type": "object", "description": "An empty preferred scheduling term matches all objects with implicit weight 0\n(i.e. It's a no-op). A null preferred scheduling term matches no objects (i.e. Is also a no-op).", "properties": { "preference": { "allOf": [ { "$ref": "#/components/schemas/v1NodeSelectorTerm" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "weight": { "type": "integer", "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "format": "int32", "x-f5xc-example": "50", "x-f5xc-description-short": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "x-f5xc-constraints": { "constraintType": "number", "category": "load-balancing", "minimum": 0, "maximum": 100, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Empty preferred scheduling term matches all objects with implicit weight 0 (i.e.", "x-f5xc-description-medium": "Empty preferred scheduling term matches all objects with implicit weight 0 (i.e. It's a no-op). A null preferred scheduling term matches no objects (i.e.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1PreferredSchedulingTerm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Probe": { "type": "object", "description": "Probe describes a health check to be performed against a container to determine whether it is\nalive or ready to receive traffic.", "properties": { "failureThreshold": { "type": "integer", "title": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional", "format": "int32", "description": "Configuration parameter for failureThreshold", "x-f5xc-description-short": "Configuration parameter for failureThreshold.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "handler": { "allOf": [ { "$ref": "#/components/schemas/v1Handler" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initialDelaySeconds": { "type": "integer", "title": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "periodSeconds": { "type": "integer", "title": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "successThreshold": { "type": "integer", "title": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional", "format": "int32", "description": "Configuration parameter for successThreshold", "x-f5xc-description-short": "Configuration parameter for successThreshold.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timeoutSeconds": { "type": "integer", "title": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "x-f5xc-description-medium": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Probe", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ProjectedVolumeSource": { "type": "object", "title": "Represents a projected volume source", "properties": { "defaultMode": { "type": "integer", "title": "Mode bits to use on created files by default. Must be a value between\n0 and 0777.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "description": "Configuration parameter for defaultMode", "x-f5xc-description-short": "Configuration parameter for defaultMode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sources": { "type": "array", "title": "list of volume projections", "items": { "$ref": "#/components/schemas/v1VolumeProjection" }, "description": "Configuration parameter for sources", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ProjectedVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1QuobyteVolumeSource": { "type": "object", "description": "Represents a Quobyte mount that lasts the lifetime of a pod.\nQuobyte volumes do not support ownership management or SELinux relabeling.", "properties": { "group": { "type": "string", "title": "Group to map volume access to\nDefault is no group\n+optional", "description": "Configuration parameter for group", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "registry": { "type": "string", "title": "Registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes", "description": "Configuration parameter for registry", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "title": "Tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional", "description": "Tenant identifier for multi-tenancy", "x-f5xc-example": "customer-123", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "user": { "type": "string", "title": "User to map volume access to\nDefaults to serivceaccount user\n+optional", "description": "Configuration parameter for user", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volume": { "type": "string", "description": "Volume is a string that references an already created Quobyte volume by name.", "x-f5xc-description-short": "Volume is a string that references an already created Quobyte volume by name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.", "x-f5xc-description-medium": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1QuobyteVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1RBDPersistentVolumeSource": { "type": "object", "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod.\nRBD volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "title": "The rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "description": "Configuration parameter for image", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "keyring": { "type": "string", "title": "Keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for keyring", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "monitors": { "type": "array", "title": "A collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "items": { "type": "string" }, "description": "Configuration parameter for monitors", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool": { "type": "string", "title": "The rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for pool", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "string", "title": "The rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for user", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", "x-f5xc-description-medium": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1RBDPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1RBDVolumeSource": { "type": "object", "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod.\nRBD volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "type": "string", "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image": { "type": "string", "title": "The rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "description": "Configuration parameter for image", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "keyring": { "type": "string", "title": "Keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for keyring", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "monitors": { "type": "array", "title": "A collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "items": { "type": "string" }, "description": "Configuration parameter for monitors", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pool": { "type": "string", "title": "The rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for pool", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "string", "title": "The rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "description": "Configuration parameter for user", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", "x-f5xc-description-medium": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1RBDVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ReplicaSet": { "type": "object", "description": "ReplicaSet ensures that a specified number of pod replicas are running at any given time.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1ReplicaSetSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1ReplicaSetStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ReplicaSet ensures that a specified number of pod replicas are running at any given time.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ReplicaSet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ReplicaSetCondition": { "type": "object", "description": "ReplicaSetCondition describes the state of a replica set at a certain point.", "properties": { "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "A human readable message indicating details about the transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "The reason for the condition's last transition.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of replica set condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ReplicaSetCondition describes the state of a replica set at a certain point.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ReplicaSetCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ReplicaSetList": { "type": "object", "description": "ReplicaSetList is a collection of ReplicaSets.", "properties": { "items": { "type": "array", "title": "List of ReplicaSets.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller", "items": { "$ref": "#/components/schemas/v1ReplicaSet" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ReplicaSetList is a collection of ReplicaSets.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ReplicaSetList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ReplicaSetSpec": { "type": "object", "description": "ReplicaSetSpec is the specification of a ReplicaSet.", "properties": { "minReadySeconds": { "type": "integer", "title": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing, for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n+optional", "format": "int32", "description": "Security-related configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replicas": { "type": "integer", "title": "Replicas is the number of desired replicas.\nThis is a pointer to distinguish between explicit zero and unspecified.\nDefaults to 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller\n+optional", "format": "int32", "description": "Configuration parameter for replicas", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "template": { "allOf": [ { "$ref": "#/components/schemas/v1PodTemplateSpec" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ReplicaSetSpec is the specification of a ReplicaSet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ReplicaSetSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ReplicaSetStatus": { "type": "object", "description": "ReplicaSetStatus represents the current status of a ReplicaSet.", "properties": { "availableReplicas": { "type": "integer", "title": "The number of available replicas (ready for at least minReadySeconds) for this replica set.\n+optional", "format": "int32", "description": "Configuration parameter for availableReplicas", "x-f5xc-description-short": "Configuration parameter for availableReplicas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "Represents the latest available observations of a replica set's current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1ReplicaSetCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fullyLabeledReplicas": { "type": "integer", "title": "The number of pods that have labels matching the labels of the pod template of the replicaset.\n+optional", "format": "int32", "description": "Key-value label for organization", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "observedGeneration": { "type": "string", "title": "ObservedGeneration reflects the generation of the most recently observed ReplicaSet.\n+optional", "format": "int64", "description": "Configuration parameter for observedGeneration", "x-f5xc-description-short": "Configuration parameter for observedGeneration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readyReplicas": { "type": "integer", "title": "The number of ready replicas for this replica set.\n+optional", "format": "int32", "description": "Configuration parameter for readyReplicas", "x-f5xc-description-short": "Configuration parameter for readyReplicas.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replicas": { "type": "integer", "title": "Replicas is the most recently observed number of replicas.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller", "format": "int32", "description": "Configuration parameter for replicas", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ReplicaSetStatus represents the current status of a ReplicaSet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ReplicaSetStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ResourceFieldSelector": { "type": "object", "title": "ResourceFieldSelector represents container resources (cpu, memory) and their output format", "properties": { "containerName": { "type": "string", "title": "Container name: required for volumes, optional for env vars\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "divisor": { "allOf": [ { "$ref": "#/components/schemas/resourceQuantity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource": { "type": "string", "title": "Required: resource to select", "description": "Configuration parameter for resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ResourceFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ResourceRequirements": { "type": "object", "description": "ResourceRequirements describes the compute resource requirements.", "properties": { "limits": { "type": "object", "title": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "description": "Configuration parameter for limits", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requests": { "type": "object", "title": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional", "description": "Configuration parameter for requests", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ResourceRequirements describes the compute resource requirements.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ResourceRequirements", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1RollingUpdateDaemonSet": { "type": "object", "description": "Spec to control the desired behavior of daemon set rolling update.", "properties": { "maxUnavailable": { "allOf": [ { "$ref": "#/components/schemas/intstrIntOrString" } ], "x-f5xc-description-short": "Configuration parameter for maxUnavailable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Spec to control the desired behavior of daemon set rolling update.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1RollingUpdateDaemonSet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1RollingUpdateDeployment": { "type": "object", "description": "Spec to control the desired behavior of rolling update.", "properties": { "maxSurge": { "allOf": [ { "$ref": "#/components/schemas/intstrIntOrString" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "maxUnavailable": { "allOf": [ { "$ref": "#/components/schemas/intstrIntOrString" } ], "x-f5xc-description-short": "Configuration parameter for maxUnavailable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Spec to control the desired behavior of rolling update.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1RollingUpdateDeployment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1RollingUpdateStatefulSetStrategy": { "type": "object", "description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.", "properties": { "partition": { "type": "integer", "title": "Partition indicates the ordinal at which the StatefulSet should be\npartitioned.\nDefault value is 0.\n+optional", "format": "int32", "description": "Configuration parameter for partition", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.", "x-f5xc-description-medium": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1RollingUpdateStatefulSetStrategy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SELinuxOptions": { "type": "object", "title": "SELinuxOptions are the labels to be applied to the container", "properties": { "level": { "type": "string", "title": "Level is SELinux level label that applies to the container.\n+optional", "description": "Configuration parameter for level", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "role": { "type": "string", "title": "Role is a SELinux role label that applies to the container.\n+optional", "description": "Configuration parameter for role", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "Type is a SELinux type label that applies to the container.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "string", "title": "User is a SELinux user label that applies to the container.\n+optional", "description": "Configuration parameter for user", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SELinuxOptions", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ScaleIOPersistentVolumeSource": { "type": "object", "title": "ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\"\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gateway": { "type": "string", "description": "The host address of the ScaleIO API Gateway.", "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "The host address of the ScaleIO API Gateway.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protectionDomain": { "type": "string", "title": "The name of the ScaleIO Protection Domain for the configured storage.\n+optional", "description": "Configuration parameter for protectionDomain", "x-f5xc-description-short": "Configuration parameter for protectionDomain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1SecretReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sslEnabled": { "type": "boolean", "title": "Flag to enable/disable SSL communication with Gateway, default false\n+optional", "format": "boolean", "description": "Enable or disable functionality flag", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storageMode": { "type": "string", "title": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional", "description": "Configuration parameter for storageMode", "x-f5xc-description-short": "Configuration parameter for storageMode.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storagePool": { "type": "string", "title": "The ScaleIO Storage Pool associated with the protection domain.\n+optional", "description": "Configuration parameter for storagePool", "x-f5xc-description-short": "Configuration parameter for storagePool.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system": { "type": "string", "description": "The name of the storage system as configured in ScaleIO.", "x-f5xc-description-short": "The name of the storage system as configured in ScaleIO.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeName": { "type": "string", "description": "The name of a volume already created in the ScaleIO system\nthat is associated with this volume source.", "x-f5xc-description-short": "The name of a volume already created in the ScaleIO system that is associated with this volume source.", "x-f5xc-description-medium": "The name of a volume already created in the ScaleIO system that is associated with this volume source.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ScaleIOPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ScaleIOVolumeSource": { "type": "object", "title": "ScaleIOVolumeSource represents a persistent ScaleIO volume", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gateway": { "type": "string", "description": "The host address of the ScaleIO API Gateway.", "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "The host address of the ScaleIO API Gateway.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protectionDomain": { "type": "string", "title": "The name of the ScaleIO Protection Domain for the configured storage.\n+optional", "description": "Configuration parameter for protectionDomain", "x-f5xc-description-short": "Configuration parameter for protectionDomain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sslEnabled": { "type": "boolean", "title": "Flag to enable/disable SSL communication with Gateway, default false\n+optional", "format": "boolean", "description": "Enable or disable functionality flag", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storageMode": { "type": "string", "title": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional", "description": "Configuration parameter for storageMode", "x-f5xc-description-short": "Configuration parameter for storageMode.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storagePool": { "type": "string", "title": "The ScaleIO Storage Pool associated with the protection domain.\n+optional", "description": "Configuration parameter for storagePool", "x-f5xc-description-short": "Configuration parameter for storagePool.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system": { "type": "string", "description": "The name of the storage system as configured in ScaleIO.", "x-f5xc-description-short": "The name of the storage system as configured in ScaleIO.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeName": { "type": "string", "description": "The name of a volume already created in the ScaleIO system\nthat is associated with this volume source.", "x-f5xc-description-short": "The name of a volume already created in the ScaleIO system that is associated with this volume source.", "x-f5xc-description-medium": "The name of a volume already created in the ScaleIO system that is associated with this volume source.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ScaleIOVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Secret": { "type": "object", "description": "Secret holds secret data of a certain type. The total bytes of the values in\nthe Data field must be less than MaxSecretSize bytes.", "properties": { "data": { "type": "object", "title": "Data contains the secret data. Each key must consist of alphanumeric\ncharacters, '-', '_' or '.'. The serialized form of the secret data is a\nbase64 encoded string, representing the arbitrary (possibly non-string)\ndata value here. Described in https://tools.ietf.org/html/rfc4648#section-4\n+optional", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "stringData": { "type": "object", "title": "stringData allows specifying non-binary secret data in string form.\nIt is provided as a write-only convenience method.\nAll keys and values are merged into the data field on write, overwriting any existing values.\nIt is never output when reading from the API.\n+k8s:conversion-gen=false\n+optional", "description": "Data or content configuration", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "Used to facilitate programmatic handling of secret data.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.", "x-f5xc-description-medium": "Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Secret", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecretEnvSource": { "type": "object", "description": "SecretEnvSource selects a Secret to populate the environment\nvariables with.\n\nThe contents of the target Secret's Data field will represent the\nkey-value pairs as environment variables.", "properties": { "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the Secret must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SecretEnvSource selects a Secret to populate the environment variables with.", "x-f5xc-description-medium": "SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecretEnvSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecretKeySelector": { "type": "object", "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "type": "string", "description": "The key of the secret to select from. Must be a valid secret key.", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-description-short": "The key of the secret to select from. Must be a valid secret key.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the Secret or its key must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SecretKeySelector selects a key of a Secret.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecretKeySelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecretList": { "type": "object", "description": "SecretList is a list of Secret.", "properties": { "items": { "type": "array", "title": "Items is a list of secret objects.\nMore info: https://kubernetes.io/docs/concepts/configuration/secret", "items": { "$ref": "#/components/schemas/v1Secret" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecretList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecretProjection": { "type": "object", "description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a\nprojected volume as files using the keys in the Data field as the file names.\nNote that this is identical to a secret volume source without the default\nmode.", "properties": { "items": { "type": "array", "title": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/v1KeyToPath" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "localObjectReference": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-description-short": "Configuration parameter for localObjectReference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the Secret or its key must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Adapts a secret into a projected volume.", "x-f5xc-description-medium": "Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecretProjection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecretReference": { "type": "object", "title": "SecretReference represents a Secret Reference. It has enough information to retrieve secret\nin any namespace", "properties": { "name": { "type": "string", "title": "Name is unique within a namespace to reference a secret resource.\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "title": "Namespace defines the space within which the secret name must be unique.\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecretReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecretVolumeSource": { "type": "object", "description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume\nas files using the keys in the Data field as the file names.\nSecret volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "type": "integer", "title": "Optional: mode bits to use on created files by default. Must be a\nvalue between 0 and 0777. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "description": "Configuration parameter for defaultMode", "x-f5xc-description-short": "Configuration parameter for defaultMode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "title": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/v1KeyToPath" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "optional": { "type": "boolean", "title": "Specify whether the Secret or its keys must be defined\n+optional", "format": "boolean", "description": "Indicates if this field is optional", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretName": { "type": "string", "title": "Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-medium": "Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecretVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SecurityContext": { "type": "object", "description": "SecurityContext holds security configuration that will be applied to a container.\nSome fields are present in both SecurityContext and PodSecurityContext. When both\nare set, the values in SecurityContext take precedence.", "properties": { "allowPrivilegeEscalation": { "type": "boolean", "title": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\n+optional", "format": "boolean", "description": "Configuration parameter for allowPrivilegeEscalation", "x-f5xc-description-short": "Configuration parameter for allowPrivilegeEscalation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "capabilities": { "allOf": [ { "$ref": "#/components/schemas/v1Capabilities" } ], "x-f5xc-description-short": "Configuration parameter for capabilities.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "privileged": { "type": "boolean", "title": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\n+optional", "format": "boolean", "description": "Configuration parameter for privileged", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "procMount": { "type": "string", "title": "procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\n+optional", "description": "Configuration parameter for procMount", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnlyRootFilesystem": { "type": "boolean", "title": "Whether this container has a read-only root filesystem.\nDefault is false.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnlyRootFilesystem", "x-f5xc-description-short": "Configuration parameter for readOnlyRootFilesystem.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsGroup": { "type": "string", "title": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "format": "int64", "description": "Configuration parameter for runAsGroup", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsNonRoot": { "type": "boolean", "title": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "format": "boolean", "description": "Configuration parameter for runAsNonRoot", "x-f5xc-description-short": "Configuration parameter for runAsNonRoot.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsUser": { "type": "string", "title": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "format": "int64", "description": "Configuration parameter for runAsUser", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "seLinuxOptions": { "allOf": [ { "$ref": "#/components/schemas/v1SELinuxOptions" } ], "x-f5xc-description-short": "Configuration parameter for seLinuxOptions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "windowsOptions": { "allOf": [ { "$ref": "#/components/schemas/v1WindowsSecurityContextOptions" } ], "x-f5xc-description-short": "Configuration parameter for windowsOptions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SecurityContext holds security configuration that will be applied to a container.", "x-f5xc-description-medium": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SecurityContext", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Service": { "type": "object", "description": "Service is a named abstraction of software service (for example, example-SQL) consisting of local port\n(for example 3306) that the proxy listens on, and the selector that determines which pods\nwill answer requests sent through the proxy.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1ServiceSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1ServiceStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Service is a named abstraction of software service (for example, example-SQL) consisting of local port (for example 3306) that the proxy listens...", "x-f5xc-description-medium": "Service is a named abstraction of software service (for example, example-SQL) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Service", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ServiceAccountTokenProjection": { "type": "object", "description": "ServiceAccountTokenProjection represents a projected service account token\nvolume. This projection can be used to insert a service account token into\nthe pods runtime filesystem for use against APIs (Kubernetes API Server or\notherwise).", "properties": { "audience": { "type": "string", "title": "Audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional", "description": "Configuration parameter for audience", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expirationSeconds": { "type": "string", "title": "ExpirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "description": "Path is the path relative to the mount point of the file to project the\ntoken into.", "x-f5xc-example": "/api/v1/resources", "x-f5xc-description-short": "Path is the path relative to the mount point of the file to project the token into.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ServiceAccountTokenProjection represents a projected service account token volume.", "x-f5xc-description-medium": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ServiceAccountTokenProjection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "users", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ServiceList": { "type": "object", "description": "ServiceList holds a list of services.", "properties": { "items": { "type": "array", "title": "List of services", "items": { "$ref": "#/components/schemas/v1Service" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ServiceList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ServicePort": { "type": "object", "description": "ServicePort contains information on service's port.", "properties": { "name": { "type": "string", "title": "The name of this port within the service. This must be a DNS_LABEL.\nAll ports within a ServiceSpec must have unique names. When considering\nthe endpoints for a Service, this must match the 'name' field in the\nEndpointPort.\nOptional if only one ServicePort is defined on this service.\n+optional", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "nodePort": { "type": "integer", "title": "The port on each node on which this service is exposed when type=NodePort or LoadBalancer.\nUsually assigned by the system. If specified, it will be allocated to the service\nif unused or else creation of the service will fail.\nDefault is to auto-allocate a port if the ServiceType of this Service requires one.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport\n+optional", "format": "int32", "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "port": { "type": "integer", "description": "The port that will be exposed by this service.", "format": "int32", "x-f5xc-example": "8080", "x-f5xc-description-short": "The port that will be exposed by this service.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol": { "type": "string", "title": "The IP protocol for this port. Supports \"TCP\", \"UDP\", and \"SCTP\".\nDefault is TCP.\n+optional", "description": "Configuration parameter for protocol", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "targetPort": { "allOf": [ { "$ref": "#/components/schemas/intstrIntOrString" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ServicePort contains information on service's port.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ServicePort", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ServiceSpec": { "type": "object", "description": "ServiceSpec describes the attributes that a user creates on a service.", "properties": { "clusterIP": { "type": "string", "title": "clusterIP is the IP address of the service and is usually assigned\nrandomly by the master. If an address is specified manually and is not in\nuse by others, it will be allocated to the service; otherwise, creation\nof the service will fail. This field can not be changed through updates.\nValid values are \"None\", empty string (\"\"), or a valid IP address. \"None\"\ncan be specified for headless services when proxying is not required.\nOnly applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if\ntype is ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional", "description": "Cluster or grouping configuration", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalIPs": { "type": "array", "title": "externalIPs is a list of IP addresses for which nodes in the cluster\nwill also accept traffic for this service. These IPs are not managed by\nKubernetes. The user is responsible for ensuring that traffic arrives\nat a node with this IP. A common example is external load-balancers\nthat are not part of the Kubernetes system.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for externalIPs", "x-f5xc-description-short": "Configuration parameter for externalIPs.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalName": { "type": "string", "title": "externalName is the external reference that kubedns or equivalent will\nreturn as a CNAME record for this service. No proxying will be involved.\nMust be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123)\nand requires Type to be ExternalName.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "externalTrafficPolicy": { "type": "string", "title": "externalTrafficPolicy denotes if this Service desires to route external\ntraffic to node-local or cluster-wide endpoints. \"Local\" preserves the\nclient source IP and avoids a second hop for LoadBalancer and Nodeport\ntype services, but risks potentially imbalanced traffic spreading.\n\"Cluster\" obscures the client source IP and may cause a second hop to\nanother node, but should have good overall load-spreading.\n+optional", "description": "Configuration parameter for externalTrafficPolicy", "x-f5xc-description-short": "Configuration parameter for externalTrafficPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "healthCheckNodePort": { "type": "integer", "title": "healthCheckNodePort specifies the healthcheck nodePort for the service.\nIf not specified, HealthCheckNodePort is created by the service api\nbackend with the allocated nodePort. Will use user-specified nodePort value\nif specified by the client. Only effects when Type is set to LoadBalancer\nand ExternalTrafficPolicy is set to Local.\n+optional", "format": "int32", "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ipFamily": { "type": "string", "title": "ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs.\nIPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is\navailable in the cluster. If no IP family is requested, the cluster's primary IP family will be used.\nOther IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which\nallocate external load-balancers should use the same IP family. Endpoints for this Service will be of\nthis family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the\ncluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment.\n+optional", "description": "IP address configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "loadBalancerIP": { "type": "string", "title": "Only applies to Service Type: LoadBalancer\nLoadBalancer will get created with the IP specified in this field.\nThis feature depends on whether the underlying cloud-provider supports specifying\nthe loadBalancerIP when a load balancer is created.\nThis field will be ignored if the cloud-provider does not support the feature.\n+optional", "description": "Configuration parameter for loadBalancerIP", "x-f5xc-description-short": "Configuration parameter for loadBalancerIP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "loadBalancerSourceRanges": { "type": "array", "title": "If specified and supported by the platform, this will restrict traffic through the cloud-provider\nload-balancer will be restricted to the specified client IPs. This field will be ignored if the\ncloud-provider does not support the feature.\"\nMore info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/\n+optional", "items": { "type": "string" }, "description": "Range or scope specification", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ports": { "type": "array", "title": "The list of ports that are exposed by this service.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+patchMergeKey=port\n+patchStrategy=merge\n+listType=map\n+listMapKey=port\n+listMapKey=protocol", "items": { "$ref": "#/components/schemas/v1ServicePort" }, "description": "Network port number", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "publishNotReadyAddresses": { "type": "boolean", "title": "publishNotReadyAddresses, when set to true, indicates that DNS implementations\nmust publish the notReadyAddresses of subsets for the Endpoints associated with\nthe Service. The default value is false.\nThe primary use case for setting this field is to use a StatefulSet's Headless Service\nto propagate SRV records for its Pods without respect to their readiness for purpose\nof peer discovery.\n+optional", "format": "boolean", "description": "Network address or location", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "type": "object", "title": "Route service traffic to pods with label keys and values matching this\nselector. If empty or not present, the service is assumed to have an\nexternal process managing its endpoints, which Kubernetes will not\nmodify. Only applies to types ClusterIP, NodePort, and LoadBalancer.\nIgnored if type is ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/\n+optional", "description": "Configuration parameter for selector", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sessionAffinity": { "type": "string", "title": "Supports \"ClientIP\" and \"None\". Used to maintain session affinity.\nEnable client IP based session affinity.\nMust be ClientIP or None.\nDefaults to None.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional", "description": "Configuration parameter for sessionAffinity", "x-f5xc-description-short": "Configuration parameter for sessionAffinity.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sessionAffinityConfig": { "allOf": [ { "$ref": "#/components/schemas/v1SessionAffinityConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topologyKeys": { "type": "array", "title": "topologyKeys is a preference-order list of topology keys which\nimplementations of services should use to preferentially sort endpoints\nwhen accessing this Service, it can not be used at the same time as\nexternalTrafficPolicy=Local.\nTopology keys must be valid label keys and at most 16 keys may be specified.\nEndpoints are chosen based on the first topology key with available backends.\nIf this field is specified and all entries have no backends that match\nthe topology of the client, the service has no backends for that client\nand connections should fail.\nThe special value \"*\" may be used to mean \"any topology\". This catch-all\nvalue, if used, only makes sense as the last value in the list.\nIf this is not specified or empty, no topology constraints will be applied.\n+optional", "items": { "type": "string" }, "description": "Configuration parameter for topologyKeys", "x-f5xc-description-short": "Configuration parameter for topologyKeys.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "type determines how the Service is exposed. Defaults to ClusterIP. Valid\noptions are ExternalName, ClusterIP, NodePort, and LoadBalancer.\n\"ExternalName\" maps to the specified externalName.\n\"ClusterIP\" allocates a cluster-internal IP address for load-balancing to\nendpoints. Endpoints are determined by the selector or if that is not\nspecified, by manual construction of an Endpoints object. If clusterIP is\n\"None\", no virtual IP is allocated and the endpoints are published as a\nset of endpoints rather than a stable IP.\n\"NodePort\" builds on ClusterIP and allocates a port on every node which\nroutes to the clusterIP.\n\"LoadBalancer\" builds on NodePort and creates an\nexternal load-balancer (if supported in the current cloud) which routes\nto the clusterIP.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ServiceSpec describes the attributes that a user creates on a service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ServiceSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1ServiceStatus": { "type": "object", "description": "ServiceStatus represents the current status of a service.", "properties": { "loadBalancer": { "allOf": [ { "$ref": "#/components/schemas/v1LoadBalancerStatus" } ], "x-f5xc-description-short": "Configuration parameter for loadBalancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ServiceStatus represents the current status of a service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1ServiceStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1SessionAffinityConfig": { "type": "object", "description": "SessionAffinityConfig represents the configurations of session affinity.", "properties": { "clientIP": { "allOf": [ { "$ref": "#/components/schemas/v1ClientIPConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SessionAffinityConfig represents the configurations of session affinity.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1SessionAffinityConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StatefulSet": { "type": "object", "description": "StatefulSet represents a set of pods with consistent identities.\nIdentities are defined as:\n- Network: A single stable DNS and hostname.\n- Storage: As many VolumeClaims as requested.\nThe StatefulSet guarantees that a given network identity will always\nmap to the same storage identity.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1StatefulSetSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1StatefulSetStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "StatefulSet represents a set of pods with consistent identities.", "x-f5xc-description-medium": "StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StatefulSet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StatefulSetCondition": { "type": "object", "description": "StatefulSetCondition describes the state of a statefulset at a certain point.", "properties": { "lastTransitionTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastTransitionTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "title": "A human readable message indicating details about the transition.\n+optional", "description": "Configuration parameter for message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "title": "The reason for the condition's last transition.\n+optional", "description": "Configuration parameter for reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the condition, one of True, False, Unknown.", "x-f5xc-example": "active", "x-f5xc-description-short": "Status of the condition, one of True, False, Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of statefulset condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatefulSetCondition describes the state of a statefulset at a certain point.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StatefulSetCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StatefulSetList": { "type": "object", "description": "StatefulSetList is a collection of StatefulSets.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/v1StatefulSet" }, "description": "Items in a collection or array", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatefulSetList is a collection of StatefulSets.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StatefulSetList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StatefulSetSpec": { "type": "object", "description": "A StatefulSetSpec is the specification of a StatefulSet.", "properties": { "podManagementPolicy": { "type": "string", "title": "podManagementPolicy controls how pods are created during initial scale up,\nwhen replacing pods on nodes, or when scaling down. The default policy is\n`OrderedReady`, where pods are created in increasing order (pod-0, then\npod-1, etc) and the controller will wait until each pod is ready before\ncontinuing. When scaling down, the pods are removed in the opposite order.\nThe alternative policy is `Parallel` which will create pods in parallel\nto match the desired scale without waiting, and on scale down will delete\nall pods at once.\n+optional", "description": "Configuration parameter for podManagementPolicy", "x-f5xc-description-short": "Configuration parameter for podManagementPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replicas": { "type": "integer", "title": "replicas is the desired number of replicas of the given Template.\nThese are replicas in the sense that they are instantiations of the\nsame Template, but individual replicas also have a consistent identity.\nIf unspecified, defaults to 1.\nTODO: Consider a rename of this field.\n+optional", "format": "int32", "description": "Configuration parameter for replicas", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "revisionHistoryLimit": { "type": "integer", "description": "RevisionHistoryLimit is the maximum number of revisions that will\nbe maintained in the StatefulSet's revision history. The revision history\nconsists of all revisions not represented by a currently applied\nStatefulSetSpec version. The default value is 10.", "format": "int32", "x-f5xc-description-short": "RevisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history.", "x-f5xc-description-medium": "RevisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "serviceName": { "type": "string", "description": "ServiceName is the name of the service that governs this StatefulSet.\nThis service must exist before the StatefulSet, and is responsible for\nthe network identity of the set. Pods GET DNS/hostnames that follow the\npattern: pod-specific-string.servicename.default.svc.cluster.local\nwhere \"pod-specific-string\" is managed by the StatefulSet controller.", "x-f5xc-description-short": "ServiceName is the name of the service that governs this StatefulSet.", "x-f5xc-description-medium": "ServiceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods GET DNS/hostnames that follow the pattern: pod-specific-string.servicename.default.svc.cluster.local where...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "template": { "allOf": [ { "$ref": "#/components/schemas/v1PodTemplateSpec" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updateStrategy": { "allOf": [ { "$ref": "#/components/schemas/v1StatefulSetUpdateStrategy" } ], "x-f5xc-description-short": "Configuration parameter for updateStrategy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeClaimTemplates": { "type": "array", "title": "volumeClaimTemplates is a list of claims that pods are allowed to reference.\nThe StatefulSet controller is responsible for mapping network identities to\nclaims in a way that maintains the identity of a pod. Every claim in\nthis list must have at least one matching (by name) volumeMount in one\ncontainer in the template. A claim in this list takes precedence over\nany volumes in the template, with the same name.\nTODO: Define the behavior if a claim already exists with the same name.\n+optional", "items": { "$ref": "#/components/schemas/v1PersistentVolumeClaim" }, "description": "Configuration parameter for volumeClaimTemplates", "x-f5xc-description-short": "Configuration parameter for volumeClaimTemplates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatefulSetSpec is the specification of a StatefulSet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StatefulSetSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StatefulSetStatus": { "type": "object", "description": "StatefulSetStatus represents the current state of a StatefulSet.", "properties": { "collisionCount": { "type": "integer", "title": "collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller\nuses this field as a collision avoidance mechanism when it needs to create the name for the\nnewest ControllerRevision.\n+optional", "format": "int32", "description": "Number of items or occurrences", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "conditions": { "type": "array", "title": "Represents the latest available observations of a statefulset's current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/v1StatefulSetCondition" }, "description": "Configuration parameter for conditions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "currentReplicas": { "type": "integer", "description": "CurrentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version\nindicated by currentRevision.", "format": "int32", "x-f5xc-description-short": "CurrentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.", "x-f5xc-description-medium": "CurrentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "currentRevision": { "type": "string", "description": "CurrentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the\nsequence [0,currentReplicas).", "x-f5xc-description-short": "CurrentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).", "x-f5xc-description-medium": "CurrentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "observedGeneration": { "type": "string", "title": "observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the\nStatefulSet's generation, which is updated on mutation by the API Server.\n+optional", "format": "int64", "description": "Configuration parameter for observedGeneration", "x-f5xc-description-short": "Configuration parameter for observedGeneration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readyReplicas": { "type": "integer", "description": "ReadyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.", "format": "int32", "x-f5xc-description-short": "ReadyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.", "x-f5xc-description-medium": "ReadyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replicas": { "type": "integer", "description": "Replicas is the number of Pods created by the StatefulSet controller.", "format": "int32", "x-f5xc-description-short": "Replicas is the number of Pods created by the StatefulSet controller.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updateRevision": { "type": "string", "title": "updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence\n[replicas-updatedReplicas,replicas)", "description": "Configuration parameter for updateRevision", "x-f5xc-description-short": "Configuration parameter for updateRevision.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updatedReplicas": { "type": "integer", "description": "UpdatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version\nindicated by updateRevision.", "format": "int32", "x-f5xc-description-short": "UpdatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.", "x-f5xc-description-medium": "UpdatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatefulSetStatus represents the current state of a StatefulSet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StatefulSetStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StatefulSetUpdateStrategy": { "type": "object", "description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet\ncontroller will use to perform updates. It includes any additional parameters\nnecessary to perform the update for the indicated strategy.", "properties": { "rollingUpdate": { "allOf": [ { "$ref": "#/components/schemas/v1RollingUpdateStatefulSetStrategy" } ], "x-f5xc-description-short": "Configuration parameter for rollingUpdate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "title": "Type indicates the type of the StatefulSetUpdateStrategy.\nDefault is RollingUpdate.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates.", "x-f5xc-description-medium": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StatefulSetUpdateStrategy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StorageOSPersistentVolumeSource": { "type": "object", "description": "Represents a StorageOS persistent volume resource.", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeName": { "type": "string", "description": "VolumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace.", "x-f5xc-description-short": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.", "x-f5xc-description-medium": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeNamespace": { "type": "string", "title": "VolumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional", "description": "Namespace for resource isolation", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a StorageOS persistent volume resource.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StorageOSPersistentVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1StorageOSVolumeSource": { "type": "object", "description": "Represents a StorageOS persistent volume resource.", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "readOnly": { "type": "boolean", "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secretRef": { "allOf": [ { "$ref": "#/components/schemas/v1LocalObjectReference" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeName": { "type": "string", "description": "VolumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace.", "x-f5xc-description-short": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.", "x-f5xc-description-medium": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumeNamespace": { "type": "string", "title": "VolumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional", "description": "Namespace for resource isolation", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents a StorageOS persistent volume resource.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1StorageOSVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Sysctl": { "type": "object", "title": "Sysctl defines a kernel parameter to be set", "properties": { "name": { "type": "string", "title": "Name of a property to set", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "value": { "type": "string", "title": "Value of a property to set", "description": "Configuration parameter for value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Sysctl", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1TCPSocketAction": { "type": "object", "title": "TCPSocketAction describes an action based on opening a socket", "properties": { "host": { "type": "string", "title": "Optional: Host name to connect to, defaults to the pod IP.\n+optional", "description": "Hostname or IP address of the target server", "x-f5xc-example": "api.example.com", "x-f5xc-description-short": "Hostname or IP address of the target server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "port": { "allOf": [ { "$ref": "#/components/schemas/intstrIntOrString" } ], "x-f5xc-example": "8080", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1TCPSocketAction", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Taint": { "type": "object", "description": "The node this Taint is attached to has the \"effect\" on\nany pod that does not tolerate the Taint.", "properties": { "effect": { "type": "string", "description": "Required. The effect of the taint on pods\nthat do not tolerate the taint.\nValid effects are NoSchedule, PreferNoSchedule and NoExecute.", "x-f5xc-description-short": "Required. The effect of the taint on pods that do not tolerate the taint.", "x-f5xc-description-medium": "Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "key": { "type": "string", "description": "Required. The taint key to be applied to a node.", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-description-short": "Required. The taint key to be applied to a node.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "timeAdded": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "title": "Required. The taint value corresponding to the taint key.\n+optional", "description": "Configuration parameter for value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "The node this Taint is attached to has the \"effect\" on any pod that does not tolerate the Taint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Taint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Time": { "type": "object", "description": "Time is a wrapper around time.time which supports correct\nmarshaling to YAML and JSON. Wrappers are provided for many\nof the factory methods that the time package offers.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false.", "properties": { "nanos": { "type": "integer", "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context.", "format": "int32", "x-f5xc-description-short": "Non-negative fractions of a second at nanosecond resolution.", "x-f5xc-description-medium": "Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "seconds": { "type": "string", "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive.", "format": "int64", "x-f5xc-description-short": "Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.", "x-f5xc-description-medium": "Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Time is a wrapper around time.time which supports correct marshaling to YAML and JSON.", "x-f5xc-description-medium": "Time is a wrapper around time.time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Time", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Toleration": { "type": "object", "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { "effect": { "type": "string", "title": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional", "description": "Configuration parameter for effect", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "key": { "type": "string", "title": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional", "description": "Cryptographic key material", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "operator": { "type": "string", "title": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\n+optional", "description": "Configuration parameter for operator", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tolerationSeconds": { "type": "string", "title": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "title": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional", "description": "Configuration parameter for value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", "x-f5xc-description-medium": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Toleration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1TopologySpreadConstraint": { "type": "object", "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", "properties": { "labelSelector": { "allOf": [ { "$ref": "#/components/schemas/v1LabelSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "maxSkew": { "type": "integer", "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nIt's the maximum permitted difference between the number of matching pods in\nany two topology domains of a given topology type.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 1/1/0:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P | P | |\n+-------+-------+-------+\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1;\nscheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nIt's a required field. Default value is 1 and 0 is not allowed.", "format": "int32", "x-f5xc-description-short": "MaxSkew describes the degree to which pods may be unevenly distributed.", "x-f5xc-description-medium": "MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topologyKey": { "type": "string", "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to PUT balanced number\nof pods into each bucket.\nIt's a required field.", "x-f5xc-description-short": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology.", "x-f5xc-description-medium": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a \"bucket\", and try to PUT balanced number of pods into each bucket.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "whenUnsatisfiable": { "type": "string", "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it\n- ScheduleAnyway tells the scheduler to still schedule it\nIt's considered as \"Unsatisfiable\" if and only if placing incoming pod on any\ntopology violates \"MaxSkew\".\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P P | P | P |\n+-------+-------+-------+\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field.", "x-f5xc-description-short": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not...", "x-f5xc-description-medium": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It's considered as \"Unsatisfiable\" if and only if placing incoming pod on any...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1TopologySpreadConstraint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1TypedLocalObjectReference": { "type": "object", "description": "TypedLocalObjectReference contains enough information to let you locate the\ntyped referenced object inside the same namespace.", "properties": { "apiGroup": { "type": "string", "title": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional", "description": "API version or group", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kind": { "type": "string", "title": "Kind is the type of resource being referenced", "description": "Resource type or kind", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "title": "Name is the name of resource being referenced", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.", "x-f5xc-description-medium": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1TypedLocalObjectReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1Volume": { "type": "object", "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "properties": { "name": { "type": "string", "title": "Volume's name.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "volumeSource": { "allOf": [ { "$ref": "#/components/schemas/v1VolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for volumeSource.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1Volume", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1VolumeDevice": { "type": "object", "description": "VolumeDevice describes a mapping of a raw block device within a container.", "properties": { "devicePath": { "type": "string", "description": "DevicePath is the path inside of the container that the device will be mapped to.", "x-f5xc-description-short": "DevicePath is the path inside of the container that the device will be mapped to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "title": "name must match the name of a persistentVolumeClaim in the pod", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "VolumeDevice describes a mapping of a raw block device within a container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1VolumeDevice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1VolumeMount": { "type": "object", "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { "mountPath": { "type": "string", "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "x-f5xc-description-short": "Path within the container at which the volume should be mounted. Must not contain ':'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mountPropagation": { "type": "string", "title": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\n+optional", "description": "Configuration parameter for mountPropagation", "x-f5xc-description-short": "Configuration parameter for mountPropagation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This must match the Name of a Volume.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "readOnly": { "type": "boolean", "title": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional", "format": "boolean", "description": "Configuration parameter for readOnly", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subPath": { "type": "string", "title": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional", "description": "File system or URL path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subPathExpr": { "type": "string", "title": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional", "description": "File system or URL path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "VolumeMount describes a mounting of a Volume within a container.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1VolumeMount", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1VolumeNodeAffinity": { "type": "object", "description": "VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.", "properties": { "required": { "allOf": [ { "$ref": "#/components/schemas/v1NodeSelector" } ], "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1VolumeNodeAffinity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1VolumeProjection": { "type": "object", "title": "Projection that may be projected along with other supported volume types", "properties": { "configMap": { "allOf": [ { "$ref": "#/components/schemas/v1ConfigMapProjection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "downwardAPI": { "allOf": [ { "$ref": "#/components/schemas/v1DownwardAPIProjection" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secret": { "allOf": [ { "$ref": "#/components/schemas/v1SecretProjection" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "serviceAccountToken": { "allOf": [ { "$ref": "#/components/schemas/v1ServiceAccountTokenProjection" } ], "x-f5xc-description-short": "Configuration parameter for serviceAccountToken.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1VolumeProjection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1VolumeSource": { "type": "object", "description": "Represents the source of a volume to mount.\nOnly one of its members may be specified.", "properties": { "awsElasticBlockStore": { "allOf": [ { "$ref": "#/components/schemas/v1AWSElasticBlockStoreVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "azureDisk": { "allOf": [ { "$ref": "#/components/schemas/v1AzureDiskVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "azureFile": { "allOf": [ { "$ref": "#/components/schemas/v1AzureFileVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cephfs": { "allOf": [ { "$ref": "#/components/schemas/v1CephFSVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cinder": { "allOf": [ { "$ref": "#/components/schemas/v1CinderVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "configMap": { "allOf": [ { "$ref": "#/components/schemas/v1ConfigMapVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "csi": { "allOf": [ { "$ref": "#/components/schemas/v1CSIVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "downwardAPI": { "allOf": [ { "$ref": "#/components/schemas/v1DownwardAPIVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "emptyDir": { "allOf": [ { "$ref": "#/components/schemas/v1EmptyDirVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fc": { "allOf": [ { "$ref": "#/components/schemas/v1FCVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flexVolume": { "allOf": [ { "$ref": "#/components/schemas/v1FlexVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flocker": { "allOf": [ { "$ref": "#/components/schemas/v1FlockerVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcePersistentDisk": { "allOf": [ { "$ref": "#/components/schemas/v1GCEPersistentDiskVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for gcePersistentDisk.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gitRepo": { "allOf": [ { "$ref": "#/components/schemas/v1GitRepoVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "glusterfs": { "allOf": [ { "$ref": "#/components/schemas/v1GlusterfsVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostPath": { "allOf": [ { "$ref": "#/components/schemas/v1HostPathVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "iscsi": { "allOf": [ { "$ref": "#/components/schemas/v1ISCSIVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nfs": { "allOf": [ { "$ref": "#/components/schemas/v1NFSVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "persistentVolumeClaim": { "allOf": [ { "$ref": "#/components/schemas/v1PersistentVolumeClaimVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for persistentVolumeClaim.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "photonPersistentDisk": { "allOf": [ { "$ref": "#/components/schemas/v1PhotonPersistentDiskVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for photonPersistentDisk.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "portworxVolume": { "allOf": [ { "$ref": "#/components/schemas/v1PortworxVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "projected": { "allOf": [ { "$ref": "#/components/schemas/v1ProjectedVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "quobyte": { "allOf": [ { "$ref": "#/components/schemas/v1QuobyteVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rbd": { "allOf": [ { "$ref": "#/components/schemas/v1RBDVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scaleIO": { "allOf": [ { "$ref": "#/components/schemas/v1ScaleIOVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "secret": { "allOf": [ { "$ref": "#/components/schemas/v1SecretVolumeSource" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storageos": { "allOf": [ { "$ref": "#/components/schemas/v1StorageOSVolumeSource" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vsphereVolume": { "allOf": [ { "$ref": "#/components/schemas/v1VsphereVirtualDiskVolumeSource" } ], "x-f5xc-description-short": "Configuration parameter for vsphereVolume.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Represents the source of a volume to mount. Only one of its members may be specified.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1VolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1VsphereVirtualDiskVolumeSource": { "type": "object", "description": "Represents a vSphere volume resource.", "properties": { "fsType": { "type": "string", "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "description": "Type or category classification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storagePolicyID": { "type": "string", "title": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "storagePolicyName": { "type": "string", "title": "Storage Policy Based Management (SPBM) profile name.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volumePath": { "type": "string", "title": "Path that identifies vSphere volume vmdk", "description": "File system or URL path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1VsphereVirtualDiskVolumeSource", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1WeightedPodAffinityTerm": { "type": "object", "title": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", "properties": { "podAffinityTerm": { "allOf": [ { "$ref": "#/components/schemas/v1PodAffinityTerm" } ], "x-f5xc-description-short": "Configuration parameter for podAffinityTerm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "weight": { "type": "integer", "description": "Weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "format": "int32", "x-f5xc-example": "50", "x-f5xc-description-short": "Weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", "x-f5xc-constraints": { "constraintType": "number", "category": "load-balancing", "minimum": 0, "maximum": 100, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1WeightedPodAffinityTerm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1WindowsSecurityContextOptions": { "type": "object", "description": "WindowsSecurityContextOptions contain Windows-specific OPTIONS and credentials.", "properties": { "gmsaCredentialSpec": { "type": "string", "title": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\nThis field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.\n+optional", "description": "Desired state specification", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gmsaCredentialSpecName": { "type": "string", "title": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\nThis field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "runAsUserName": { "type": "string", "title": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nThis field is beta-level and may be disabled with the WindowsRunAsUserName feature flag.\n+optional", "description": "Human-readable name for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "WindowsSecurityContextOptions contain Windows-specific OPTIONS and credentials.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1WindowsSecurityContextOptions", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1beta1CronJob": { "type": "object", "description": "CronJob represents the configuration of a single cron job.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1beta1CronJobSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/v1beta1CronJobStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "CronJob represents the configuration of a single cron job.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1beta1CronJob", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1beta1CronJobList": { "type": "object", "description": "CronJobList is a collection of cron jobs.", "properties": { "items": { "type": "array", "description": "Items is the list of CronJobs.", "items": { "$ref": "#/components/schemas/v1beta1CronJob" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ListMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CronJobList is a collection of cron jobs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1beta1CronJobList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1beta1CronJobSpec": { "type": "object", "description": "CronJobSpec describes how the job execution will look like and when it will actually run.", "properties": { "concurrencyPolicy": { "type": "string", "title": "Specifies how to treat concurrent executions of a Job.\nValid values are:\n- \"Allow\" (default): allows CronJobs to run concurrently;\n- \"Forbid\": forbids concurrent runs, skipping next run if previous run hasn't finished yet;\n- \"Replace\": cancels currently running job and replaces it with a new one\n+optional", "description": "Configuration parameter for concurrencyPolicy", "x-f5xc-description-short": "Configuration parameter for concurrencyPolicy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "failedJobsHistoryLimit": { "type": "integer", "title": "The number of failed finished jobs to retain.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 1.\n+optional", "format": "int32", "description": "Historical or audit data", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "jobTemplate": { "allOf": [ { "$ref": "#/components/schemas/v1beta1JobTemplateSpec" } ], "x-f5xc-description-short": "Configuration parameter for jobTemplate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "schedule": { "type": "string", "description": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startingDeadlineSeconds": { "type": "string", "title": "Optional deadline in seconds for starting the job if it misses scheduled\ntime for any reason. Missed jobs executions will be counted as failed ones.\n+optional", "format": "int64", "description": "Security-related configuration", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "successfulJobsHistoryLimit": { "type": "integer", "title": "The number of successful finished jobs to retain.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 3.\n+optional", "format": "int32", "description": "Historical or audit data", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "suspend": { "type": "boolean", "title": "This flag tells the controller to suspend subsequent executions, it does\nnot apply to already started executions. Defaults to false.\n+optional", "format": "boolean", "description": "Configuration parameter for suspend", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CronJobSpec describes how the job execution will look like and when it will actually run.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1beta1CronJobSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1beta1CronJobStatus": { "type": "object", "description": "CronJobStatus represents the current state of a cron job.", "properties": { "active": { "type": "array", "title": "A list of pointers to currently running jobs.\n+optional", "items": { "$ref": "#/components/schemas/v1ObjectReference" }, "description": "Indicates if the resource is active", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastScheduleTime": { "allOf": [ { "$ref": "#/components/schemas/v1Time" } ], "x-f5xc-description-short": "Configuration parameter for lastScheduleTime.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CronJobStatus represents the current state of a cron job.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1beta1CronJobStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "v1beta1JobTemplateSpec": { "type": "object", "title": "JobTemplateSpec describes the data a Job should have when created from a template", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/v1ObjectMeta" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/v1JobSpec" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for v1beta1JobTemplateSpec", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsInternetVIPListenerStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.InternetVIPListenerStatusType", "properties": { "arn": { "type": "string", "description": "Configuration parameter for arn", "title": "Name", "x-displayname": "Name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "port": { "type": "integer", "description": "TCP/UDP port number (1-65535)", "title": "Port", "format": "int64", "x-displayname": "Port", "x-f5xc-example": "8080", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "networking", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol": { "type": "string", "description": "Protocol", "title": "Protocol", "x-displayname": "Protocol", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "Reason", "title": "Reason", "x-displayname": "Reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status", "title": "Status", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsInternetVIPListenerStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsInternetVIPStatus": { "type": "object", "description": "CName and installation info.", "title": "Internet VIP Status", "x-displayname": "Internet VIP Status.", "x-ves-proto-message": "ves.io.schema.views.InternetVIPStatus", "properties": { "arn": { "type": "string", "description": "Configuration parameter for arn", "title": "ARN", "x-displayname": "ARN", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "nlb_cname": { "type": "string", "description": "NLB CNAME", "title": "NLB CNAME", "x-displayname": "NLB CNAME", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nlb_status": { "type": "string", "description": "NLB Status.", "title": "NLB Status", "x-displayname": "NLB Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "Reason", "title": "Reason", "x-displayname": "Reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "target_group_status": { "type": "array", "description": "Target Group Status.", "title": "Target Group Status", "items": { "$ref": "#/components/schemas/viewsInternetVIPTargetGroupStatusType" }, "x-displayname": "Target Group Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsInternetVIPStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsInternetVIPTargetGroupStatusType": { "type": "object", "x-ves-proto-message": "ves.io.schema.views.InternetVIPTargetGroupStatusType", "properties": { "arn": { "type": "string", "description": "Configuration parameter for arn", "title": "ARN", "x-displayname": "ARN", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "listener_status": { "type": "array", "description": "Listener status.", "title": "Listener status", "items": { "$ref": "#/components/schemas/viewsInternetVIPListenerStatusType" }, "x-displayname": "Listener status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "protocol": { "type": "string", "description": "Protocol", "title": "Protocol", "x-displayname": "Protocol", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "Reason", "title": "Reason", "x-displayname": "Reason", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status", "title": "Status", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsInternetVIPTargetGroupStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsPrivateConnectivityType": { "type": "object", "description": "Private Connectivity Information like ADN network name and cloud link information.", "title": "Private Connectivity Type", "x-displayname": "Private Connectivity Information.", "x-ves-proto-message": "ves.io.schema.views.PrivateConnectivityType", "properties": { "cloud_link": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteCloudLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_network_name": { "type": "string", "description": "ADN Network Name for private access connectivity to F5XC ADN.", "title": "Private Network Name", "x-displayname": "Private Network Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "ADN Network Name for private access connectivity to F5XC ADN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Private Connectivity Information like ADN network name and cloud link information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsPrivateConnectivityType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteCloudLinkType": { "type": "object", "description": "Information related to cloud link used by the site.", "title": "Site CloudLink Type", "x-displayname": "Site CloudLink Information.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.SiteCloudLinkType", "properties": { "name": { "type": "string", "description": "Name of the the CloudLink used with this site.", "title": "CloudLink Name", "x-displayname": "CloudLink Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the the CloudLink used with this site.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "state": { "allOf": [ { "$ref": "#/components/schemas/schemaCloudLinkState" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information related to cloud link used by the site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteCloudLinkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphEdgeMetricData": { "type": "object", "description": "EdgeMetricData contains requested metric data for an edge.", "title": "Edge Metric Data", "x-displayname": "Edge Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.EdgeMetricData", "properties": { "data": { "type": "array", "description": "List of metric specified in the request for an edge.", "title": "Data", "items": { "$ref": "#/components/schemas/graphMetricData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of metric specified in the request for an edge.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeMetricData contains requested metric data for an edge.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphEdgeMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphEdgeMetricSelector": { "type": "object", "description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.", "title": "Edge Metric Selector", "x-displayname": "Edge Metric Selector.", "x-ves-proto-message": "ves.io.schema.graph.EdgeMetricSelector", "properties": { "features": { "type": "array", "description": "Specify list of timeseries features that should be returned for each metric type\nin the request.", "title": "Features", "items": { "$ref": "#/components/schemas/timeseriesTimeseriesFeature" }, "x-displayname": "Features", "x-f5xc-example": "True", "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "types": { "type": "array", "description": "Specify list of metrics that should be returned for each edge in the connectivity graph.", "title": "Types", "items": { "$ref": "#/components/schemas/schemagraphMetricType" }, "x-displayname": "Types", "x-f5xc-description-short": "Specify list of metrics that should be returned for each edge in the connectivity graph.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphEdgeMetricSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphHealthscoreData": { "type": "object", "description": "Contains the list of healthscores requested by the user.", "title": "Healthscore Data", "x-displayname": "Healthscore Data.", "x-ves-proto-message": "ves.io.schema.graph.HealthscoreData", "properties": { "data": { "type": "array", "description": "List of healthscores specified in the request.", "title": "Data", "items": { "$ref": "#/components/schemas/graphHealthscoreTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of healthscores specified in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains the list of healthscores requested by the user.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphHealthscoreSelector": { "type": "object", "description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.", "title": "Healthscore Selector", "x-displayname": "Healthscore Selector.", "x-ves-proto-message": "ves.io.schema.graph.HealthscoreSelector", "properties": { "types": { "type": "array", "description": "Healthscore types to be returned in the response.", "title": "Types", "items": { "$ref": "#/components/schemas/graphHealthscoreType" }, "x-displayname": "Types", "x-f5xc-description-short": "Healthscore types to be returned in the response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Healthscore Selector is used to specify the healthscore types to be returned in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphHealthscoreType": { "type": "string", "description": "Healthscore for a site or service calculated based on SLAs and KPIs for the application\n\nHealthscore not requested\nx-unit: \"percentage\"\nConnectivity Healthscore\nx-unit: \"percentage\"\nPerformance Healthscore\nx-unit: \"percentage\"\nSecurity Healthscore\nx-unit: \"percentage\"\nReliability Healthscore\nx-unit: \"percentage\"\nOverall Healthscore.", "title": "Healthscore Type", "enum": [ "HEALTHSCORE_NONE", "HEALTHSCORE_CONNECTIVITY", "HEALTHSCORE_PERFORMANCE", "HEALTHSCORE_SECURITY", "HEALTHSCORE_RELIABILITY", "HEALTHSCORE_OVERALL" ], "default": "HEALTHSCORE_NONE", "x-displayname": "Healthscore Type.", "x-ves-proto-enum": "ves.io.schema.graph.HealthscoreType", "x-f5xc-description-short": "Healthscore for a site or service calculated based on SLAs and KPIs for the application Healthscore not requested x-unit: \"percentage\"...", "x-f5xc-description-medium": "Healthscore for a site or service calculated based on SLAs and KPIs for the application Healthscore not requested x-unit: \"percentage\" Connectivity Healthscore x-unit: \"percentage\" Performance Healthscore x-unit: \"percentage\" Security Healthscore x-unit: \"percentage\" Reliability Healthscore...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"HEALTHSCORE_NONE\"", "example_yaml": "HEALTHSCORE_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphHealthscoreTypeData": { "type": "object", "description": "HealthScoreTypeData contains healthscore type and the corresponding value.", "title": "Healthscore Type Data", "x-displayname": "Healthscore Type Data.", "x-ves-proto-message": "ves.io.schema.graph.HealthscoreTypeData", "properties": { "reason": { "type": "string", "description": "A human readable string explaining the reason in case of bad healthscore.", "title": "Reason", "x-displayname": "Reason", "x-ves-example": "Only one healthy RE connected.", "x-f5xc-example": "Only one healthy RE connected", "x-f5xc-description-short": "Human readable string explaining the reason in case of bad healthscore.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "array", "description": "Healthscore value.", "title": "Value", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "HealthScoreTypeData contains healthscore type and the corresponding value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphMetricData": { "type": "object", "description": "MetricData contains the metric type and the corresponding metric value(s)", "title": "Metric Data", "x-displayname": "Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.MetricData", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/schemagraphMetricType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "allOf": [ { "$ref": "#/components/schemas/graphMetricFeatureData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "MetricData contains the metric type and the corresponding metric value(s).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphMetricFeatureData": { "type": "object", "description": "Contains metric values for timeseries features specified in the request.", "title": "Metric Feature Data", "x-displayname": "Metric Feature Data.", "x-ves-proto-message": "ves.io.schema.graph.MetricFeatureData", "properties": { "anomaly": { "type": "array", "description": "Number of anomalies for the given time range.", "title": "Anomaly", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Anomaly", "x-f5xc-description-short": "Number of anomalies for the given time range.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "confidence_lower_bound": { "type": "array", "description": "Lower Bound of the metric value.", "title": "Confidence Lower Bound", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Confidence Lower Bound.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "confidence_upper_bound": { "type": "array", "description": "Upper Bound of the metric value.", "title": "Confidence Upper Bound", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Confidence Upper Bound.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "healthscore": { "type": "array", "description": "Healscore of the metric calculated based on the number of anomalies\nand the value of the anomalies for the time range.", "title": "Healthscore", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Healthscore.", "x-f5xc-description-short": "Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.", "x-f5xc-description-medium": "Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "raw": { "type": "array", "description": "List of metric values for a given metric type.", "title": "Raw", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Raw", "x-f5xc-description-short": "List of metric values for a given metric type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "array", "description": "Indicates the metric trend.", "title": "Trend", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Trend", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains metric values for timeseries features specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphMetricFeatureData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphNodeMetricData": { "type": "object", "description": "NodeMetricData contains the upstream and downstream metrics for a node.", "title": "Node Metric Data", "x-displayname": "Node Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.NodeMetricData", "properties": { "downstream": { "type": "array", "description": "Metric data for the source site/service.", "title": "Downstream", "items": { "$ref": "#/components/schemas/graphMetricData" }, "x-displayname": "Downstream.", "x-f5xc-description-short": "Metric data for the source site/service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upstream": { "type": "array", "description": "Metric data for the destination site/service.", "title": "Upstream", "items": { "$ref": "#/components/schemas/graphMetricData" }, "x-displayname": "Upstream", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Metric data for the destination site/service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeMetricData contains the upstream and downstream metrics for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphNodeMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphNodeMetricSelector": { "type": "object", "description": "NodeMetricSelector is used to select the metrics that should be returned for a node.", "title": "Node Metric Selector", "x-displayname": "Node Metric Selector.", "x-ves-proto-message": "ves.io.schema.graph.NodeMetricSelector", "properties": { "downstream": { "type": "array", "description": "Downstream refers to the service that sends requests and receives response.", "title": "Downstream", "items": { "$ref": "#/components/schemas/schemagraphMetricType" }, "x-displayname": "Downstream.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Downstream refers to the service that sends requests and receives response.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "features": { "type": "array", "description": "Specify list of timeseries features that should be returned for each metric type\nin the request.", "title": "Features", "items": { "$ref": "#/components/schemas/timeseriesTimeseriesFeature" }, "x-displayname": "Features", "x-f5xc-example": "True", "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upstream": { "type": "array", "description": "Upstream refers to the service that receives requests and sends response.", "title": "Upstream", "items": { "$ref": "#/components/schemas/schemagraphMetricType" }, "x-displayname": "Upstream", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Upstream refers to the service that receives requests and sends response.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeMetricSelector is used to select the metrics that should be returned for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphNodeMetricSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphQueryOp": { "type": "string", "description": "Match operators supported on a label\n\nIndicates that the field is not set\nSelect timeseries whose label value exactly matches the specified string\nSelect timeseries whose label value does not match the specified string.", "title": "Label Operator", "enum": [ "NOP", "EQ", "NEQ" ], "default": "NOP", "x-displayname": "Label Operator.", "x-ves-proto-enum": "ves.io.schema.graph.QueryOp", "x-f5xc-description-short": "Match operators supported on a label Indicates that the field is not set Select timeseries whose label value exactly matches the specified string...", "x-f5xc-description-medium": "Match operators supported on a label Indicates that the field is not set Select timeseries whose label value exactly matches the specified string Select timeseries whose label value does not match the specified string.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphQueryOp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NOP\"", "example_yaml": "NOP\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "graphsiteLabel": { "type": "string", "description": "Metrics used to construct the site graph are tagged with these labels and therefore\nthe metrics can be sliced and diced based on one or more labels listed below.\n\nIndicates the field not being set\nIdentifies a site (CE or RE)", "title": "Label", "enum": [ "LABEL_NONE", "LABEL_SITE" ], "default": "LABEL_NONE", "x-displayname": "Label", "x-ves-proto-enum": "ves.io.schema.graph.site.Label", "x-f5xc-description-short": "Metrics used to construct the site graph are tagged with these labels and therefore the metrics can be sliced and diced based on one or more...", "x-f5xc-description-medium": "Metrics used to construct the site graph are tagged with these labels and therefore the metrics can be sliced and diced based on one or more labels listed below. Indicates the field not being set Identifies a site (CE or RE).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphsiteLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LABEL_NONE\"", "example_yaml": "LABEL_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemagraphMetricType": { "type": "string", "description": "List of metric types that are supported for application site and service graph\n\nIndicates field not being set\nx-unit: \"per second\"\nNumber of requests per second\nDeprecated by HTTP_REQUEST_RATE, TCP_CONNECTION_RATE\nx-unit: \"per second\"\nNumber of errors per second\nDeprecated by HTTP_ERROR_RATE, TCP_ERROR_RATE\nx-unit: \"seconds\"\nAverage latency per request\nDeprecated by HTTP_RESPONSE_LATENCY and TCP_CONNECTION_DURATION\nx-unit: \"bits per second (bps)\"\nRequest Throughput\nx-unit: \"bits per second (bps)\"\nResponse Throughput\nx-unit: \"per second\"\nNumber of errors with response code 3XX\nDeprecated\nx-unit: \"per second\"\nNumber of errors with response code 4XX\nDeprecated by HTTP_ERROR_RATE_4XX\nx-unit: \"per second\"\nNumber of errors with response code 5XX\nDeprecated by HTTP_ERROR_RATE_5XX\nx-unit: \"seconds\"\nMax time taken to complete 50% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_50\nx-unit: \"seconds\"\nMax time taken to complete 90% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_90\nx-unit: \"seconds\"\nMax time taken to complete 99% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_99\nDeprecated\nx-unit: \"seconds\"\nAverage Round Trip Time for the client\nx-unit: \"seconds\"\nAverage Round Trip Time for the server\nx-unit: \"seconds\"\nAverage time taken by the server for data transfer\nDeprecated by HTTP_SERVER_DATA_TRANSFER_TIME\nx-unit: \"seconds\"\nAverage time taken by the application to service the request\nDeprecated by HTTP_APP_LATENCY\nx-unit: \"per second\"\nNumber of requests to origin (good requests) per second\nx-unit: \"per second\"\nNumber of response per second\nx-unit: \"count\"\nNumber of active connections\nx-unit: \"connections per second\"\nNumber of new connections per second\nx-unit: \"requests per second\"\nNumber of HTTP requests per second\nx-unit: \"errors per second\"\nNumber of HTTP errors per second\nx-unit: \"errors per second\"\nNumber of HTTP client errors per second\nx-unit: \"errors per second\"\nNumber of HTTP server errors per second\nx-unit: \"seconds\"\nAverage latency per HTTP request\nx-unit: \"seconds\"\nMax time taken to complete 50% of the HTTP requests\nx-unit: \"seconds\"\nMax time taken to complete 90% of the HTTP requests\nx-unit: \"seconds\"\nMax time taken to complete 99% of the HTTP requests\nx-unit: \"seconds\"\nAverage time taken by the server for data transfer\nx-unit: \"seconds\"\nAverage time taken by the application to service the HTTP request\nx-unit: \"connections per second\"\nNumber of TCP connections per second\nx-unit: \"errors per second\"\nNumber of TCP connection errors per second\nx-unit: \"errors per second\"\nNumber of TCP client errors per second\nx-unit: \"errors per second\"\nNumber of TCP server/upstream errors per second\nx-unit: \"seconds\"\nAverage connection duration\nx-unit: \"requests per second\"\nNumber of incoming HTTP requests per second\nx-unit: \"requests per second\"\nNumber of outgoing HTTP requests per Second\nx-unit: \"bits per second (bps)\"\nMaximum Request Throughput\nx-unit: \"bits per second (bps)\"\nMaximum Response Throughput\nx-unit: \"connections per second\"\nMaximum Number of new connections per second\nx-unit: \"connections error per second\"\nMaximum Number of connections error per second\nx-unit: \"seconds\"\nMaximum Round Trip Time for the client\nx-unit: \"seconds\"\nMaximum Round Trip Time for the server\nx-unit: \"seconds\"\nMaximum time taken by the application to service the request\nx-unit: \"requests per second\"\nMaximum Number of HTTP requests per second\nx-unit: \"errors per second\"\nMaximum Number of HTTP errors per second\nx-unit: \"seconds\"\nMaximum Latency per request.", "title": "Metric Type", "enum": [ "METRIC_TYPE_NONE", "REQUEST_RATE", "ERROR_RATE", "RESPONSE_LATENCY", "REQUEST_THROUGHPUT", "RESPONSE_THROUGHPUT", "ERROR_RATE_3XX", "ERROR_RATE_4XX", "ERROR_RATE_5XX", "RESPONSE_LATENCY_PERCENTILE_50", "RESPONSE_LATENCY_PERCENTILE_90", "RESPONSE_LATENCY_PERCENTILE_99", "RESPONSE_DATA_TRANSFER_DURATION", "CLIENT_RTT", "SERVER_RTT", "SERVER_DATA_TRANSFER_TIME", "APP_LATENCY", "REQUEST_TO_ORIGIN_RATE", "RESPONSE_RATE", "ACTIVE_CONNECTIONS", "NEW_CONNECTION_RATE", "HTTP_REQUEST_RATE", "HTTP_ERROR_RATE", "HTTP_ERROR_RATE_4XX", "HTTP_ERROR_RATE_5XX", "HTTP_RESPONSE_LATENCY", "HTTP_RESPONSE_LATENCY_PERCENTILE_50", "HTTP_RESPONSE_LATENCY_PERCENTILE_90", "HTTP_RESPONSE_LATENCY_PERCENTILE_99", "HTTP_SERVER_DATA_TRANSFER_TIME", "HTTP_APP_LATENCY", "TCP_CONNECTION_RATE", "TCP_ERROR_RATE", "TCP_ERROR_RATE_CLIENT", "TCP_ERROR_RATE_UPSTREAM", "TCP_CONNECTION_DURATION", "HTTP_INGRESS_REQUEST_RATE", "HTTP_EGRESS_REQUEST_RATE", "PEAK_REQUEST_THROUGHPUT", "PEAK_RESPONSE_THROUGHPUT", "PEAK_CONNECTION_RATE", "PEAK_CONNECTION_ERROR_RATE", "PEAK_CLIENT_RTT", "PEAK_SERVER_RTT", "PEAK_APP_LATENCY", "PEAK_REQUEST_RATE", "PEAK_ERROR_RATE", "PEAK_LATENCY" ], "default": "METRIC_TYPE_NONE", "x-displayname": "Metric Type.", "x-ves-proto-enum": "ves.io.schema.graph.MetricType", "x-f5xc-description-short": "List of metric types that are supported for application site and service graph Indicates field not being set x-unit: \"per second\" Number of...", "x-f5xc-description-medium": "List of metric types that are supported for application site and service graph Indicates field not being set x-unit: \"per second\" Number of requests per second Deprecated by HTTP_REQUEST_RATE, TCP_CONNECTION_RATE x-unit: \"per second\" Number of errors per second Deprecated by HTTP_ERROR_RATE...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemagraphMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"METRIC_TYPE_NONE\"", "example_yaml": "METRIC_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemagraphMetricValue": { "type": "object", "description": "Each metric value consists of a timestamp and a value.\nTimestamp in the Metric Value is based on the start_time, end_time and step in the request.\nValid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ... Tn=tn-1+step, where tn <= end_time.\nResponse may not contain values for all timestamps between start_time and end_time.", "title": "Metric Value", "x-displayname": "Metric Value.", "x-ves-proto-message": "ves.io.schema.graph.MetricValue", "properties": { "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend_value": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendValue" } ], "x-f5xc-description-short": "Configuration parameter for trend value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Metric value.", "title": "Value", "x-displayname": "Value", "x-ves-example": "10.6", "x-f5xc-example": "10.6", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request.", "x-f5xc-description-medium": "Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemagraphMetricValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteEdgeData": { "type": "object", "description": "EdgeData wraps all the response data for an edge in the site graph response.", "title": "Edge Data", "x-displayname": "Edge Data", "x-ves-proto-message": "ves.io.schema.graph.site.EdgeData", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/siteEdgeFieldData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dst_id": { "allOf": [ { "$ref": "#/components/schemas/siteId" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "src_id": { "allOf": [ { "$ref": "#/components/schemas/siteId" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "EdgeData wraps all the response data for an edge in the site graph response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteEdgeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteEdgeFieldData": { "type": "object", "description": "EdgeFieldData wraps all the metric and the healthscore data for an edge.", "title": "Edge Field data", "x-displayname": "Edge Field Data.", "x-ves-proto-message": "ves.io.schema.graph.site.EdgeFieldData", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreData" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "allOf": [ { "$ref": "#/components/schemas/graphEdgeMetricData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeFieldData wraps all the metric and the healthscore data for an edge.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteEdgeFieldData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteEdgeFieldSelector": { "type": "object", "description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.", "title": "Edge Field Selector", "x-displayname": "Edge Field Selector.", "x-ves-proto-message": "ves.io.schema.graph.site.EdgeFieldSelector", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreSelector" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "allOf": [ { "$ref": "#/components/schemas/graphEdgeMetricSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.", "x-f5xc-description-medium": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteEdgeFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteEdgeRequest": { "type": "object", "description": "Request to GET the time-series data for an edge in the site graph.\nWhile graph/site API is used to GET application traffic for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/site/edge API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.", "title": "Site Edge Request", "x-displayname": "Site Edge Request.", "x-ves-proto-message": "ves.io.schema.graph.site.EdgeRequest", "properties": { "dst_id": { "allOf": [ { "$ref": "#/components/schemas/siteId" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "end_time": { "type": "string", "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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field_selector": { "allOf": [ { "$ref": "#/components/schemas/siteEdgeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.", "x-f5xc-description-medium": "Namespace is used to scope the application traffic to a given namespace. For system namespace, application traffic across all namespaces for the tenant will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "range": { "type": "string", "description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.", "title": "Range", "x-displayname": "Range", "x-ves-example": "10m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "10m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.", "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src_id": { "allOf": [ { "$ref": "#/components/schemas/siteId" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "start_time": { "type": "string", "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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "Step", "x-displayname": "Step", "x-ves-example": "5m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "5m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET the time-series data for an edge in the site graph.", "x-f5xc-description-medium": "Request to GET the time-series data for an edge in the site graph. While graph/site API is used to GET application traffic for all sites, where each node and edge contains the aggregated value for each field; graph/site/edge API is used to GET the time-series data (drill-down of aggregated data)...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteEdgeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteEdgeResponse": { "type": "object", "description": "Response for graph/site/edge API returns the time-series data for the site edge specified in the request.", "title": "Site Edge Response", "x-displayname": "Site Edge Response.", "x-ves-proto-message": "ves.io.schema.graph.site.EdgeResponse", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/siteEdgeFieldData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for graph/site/edge API returns the time-series data for the site edge specified in the request.", "x-f5xc-description-medium": "Response for graph/site/edge API returns the time-series data for the site edge specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteEdgeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteFieldSelector": { "type": "object", "description": "FieldSelector is used to specify the list of fields to be returned in the response for site graph.", "title": "Field Selector", "x-displayname": "Field Selector.", "x-ves-proto-message": "ves.io.schema.graph.site.FieldSelector", "properties": { "edge": { "allOf": [ { "$ref": "#/components/schemas/siteEdgeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "allOf": [ { "$ref": "#/components/schemas/siteNodeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "FieldSelector is used to specify the list of fields to be returned in the response for site graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteGraphData": { "type": "object", "description": "GraphData wraps the response for the site graph request that contains\nall the nodes and the edges. Each node contains the application traffic\nflowing from/to site and each edge contains the application traffic flowing\nfrom/to the source site and the destination site.", "title": "Graph Data", "x-displayname": "Graph Data.", "x-ves-proto-message": "ves.io.schema.graph.site.GraphData", "properties": { "edges": { "type": "array", "description": "List of edges in the site graph. Each edge contains the application traffic\nflowing from/to the source site and the destination site.", "title": "Edges", "items": { "$ref": "#/components/schemas/siteEdgeData" }, "x-displayname": "Edges", "x-f5xc-description-short": "List of edges in the site graph. Each edge contains the application traffic flowing from/to the source site and the destination site.", "x-f5xc-description-medium": "List of edges in the site graph. Each edge contains the application traffic flowing from/to the source site and the destination site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodes": { "type": "array", "description": "List of nodes in the site graph. Each node contains the application traffic\nflowing from/to the site.", "title": "Nodes", "items": { "$ref": "#/components/schemas/siteNodeData" }, "x-displayname": "Nodes", "x-f5xc-description-short": "List of nodes in the site graph. Each node contains the application traffic flowing from/to the site.", "x-f5xc-description-medium": "List of nodes in the site graph. Each node contains the application traffic flowing from/to the site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GraphData wraps the response for the site graph request that contains all the nodes and the edges.", "x-f5xc-description-medium": "GraphData wraps the response for the site graph request that contains all the nodes and the edges. Each node contains the application traffic flowing from/to site and each edge contains the application traffic flowing from/to the source site and the destination site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteGraphData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteId": { "type": "object", "description": "ID uniquely identifies a node or an edge in the site graph.", "title": "Id", "x-displayname": "ID", "x-ves-proto-message": "ves.io.schema.graph.site.Id", "properties": { "site": { "type": "string", "description": "Name of the site.", "title": "Site", "x-displayname": "Site", "x-ves-example": "Ce01", "x-f5xc-example": "ce01", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ID uniquely identifies a node or an edge in the site graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteId", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteIdField": { "type": "string", "description": "IdField is used to select one or more fields that uniquely identifies\na node or an edge in the site graph.\n\nIndicates the field not being set\nIdentifies a site (CE or RE)", "title": "Id Field", "enum": [ "NONE", "SITE" ], "default": "NONE", "x-displayname": "ID Field", "x-ves-proto-enum": "ves.io.schema.graph.site.IdField", "x-f5xc-description-short": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the site graph.", "x-f5xc-description-medium": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the site graph. Indicates the field not being set Identifies a site (CE or RE).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteIdField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NONE\"", "example_yaml": "NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteLabelFilter": { "type": "object", "description": "Metrics used to render the site graph are tagged with labels listed in the enum Label.\nLabel Filter is used to filter the timeseries that match the specified label key/value\nand the operator.", "title": "Label Filter", "x-displayname": "Label Filter.", "x-ves-proto-message": "ves.io.schema.graph.site.LabelFilter", "properties": { "label": { "allOf": [ { "$ref": "#/components/schemas/graphsiteLabel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/graphQueryOp" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Value of the label.", "title": "Value", "x-displayname": "Value", "x-ves-example": "Ce01", "x-f5xc-example": "ce01", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Metrics used to render the site graph are tagged with labels listed in the enum Label.", "x-f5xc-description-medium": "Metrics used to render the site graph are tagged with labels listed in the enum Label. Label Filter is used to filter the timeseries that match the specified label key/value and the operator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteLabelFilter", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "label", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNodeData": { "type": "object", "description": "NodeData wraps all the response data for a node in the site graph response.", "title": "Node Data", "x-displayname": "Node Data", "x-ves-proto-message": "ves.io.schema.graph.site.NodeData", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/siteNodeFieldData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "allOf": [ { "$ref": "#/components/schemas/siteId" } ], "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeData wraps all the response data for a node in the site graph response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNodeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNodeFieldData": { "type": "object", "description": "NodeFieldData wraps all the metric and the healthscore data for a node.", "title": "Node Field data", "x-displayname": "Node Field Data.", "x-ves-proto-message": "ves.io.schema.graph.site.NodeFieldData", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreData" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "allOf": [ { "$ref": "#/components/schemas/graphNodeMetricData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeFieldData wraps all the metric and the healthscore data for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNodeFieldData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNodeFieldSelector": { "type": "object", "description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.", "title": "Node Field Selector", "x-displayname": "Node Field Selector.", "x-ves-proto-message": "ves.io.schema.graph.site.NodeFieldSelector", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreSelector" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "allOf": [ { "$ref": "#/components/schemas/graphNodeMetricSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.", "x-f5xc-description-medium": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNodeFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNodeRequest": { "type": "object", "description": "Request to GET time-series data for a node in the site graph.\nWhile graph/site API is used to GET application traffic for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/site/node API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.", "title": "Site Node Request", "x-displayname": "Site Node Request.", "x-ves-proto-message": "ves.io.schema.graph.site.NodeRequest", "properties": { "end_time": { "type": "string", "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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field_selector": { "allOf": [ { "$ref": "#/components/schemas/siteNodeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "allOf": [ { "$ref": "#/components/schemas/siteId" } ], "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.", "x-f5xc-description-medium": "Namespace is used to scope the application traffic to a given namespace. For system namespace, application traffic across all namespaces for the tenant will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "range": { "type": "string", "description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.", "title": "Range", "x-displayname": "Range", "x-ves-example": "10m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "10m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.", "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "Step", "x-displayname": "Step", "x-ves-example": "5m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "5m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET time-series data for a node in the site graph.", "x-f5xc-description-medium": "Request to GET time-series data for a node in the site graph. While graph/site API is used to GET application traffic for all sites, where each node and edge contains the aggregated value for each field; graph/site/node API is used to GET the time-series data (drill-down of aggregated data) for...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNodeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteNodeResponse": { "type": "object", "description": "Response for graph/site/node request returns the time-series data for the site\nspecified in the request.", "title": "Site Node Response", "x-displayname": "Site Node Response.", "x-ves-proto-message": "ves.io.schema.graph.site.NodeResponse", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/siteNodeFieldData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for graph/site/node request returns the time-series data for the site specified in the request.", "x-f5xc-description-medium": "Response for graph/site/node request returns the time-series data for the site specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteNodeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteRequest": { "type": "object", "description": "Graph/site API is used to GET intra-site and inter-site graph for application traffic.", "title": "Site Graph Request", "x-displayname": "Site Graph Request.", "x-ves-proto-message": "ves.io.schema.graph.site.Request", "properties": { "end_time": { "type": "string", "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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field_selector": { "allOf": [ { "$ref": "#/components/schemas/siteFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_by": { "type": "array", "description": "Aggregate data by site.\nOptional: If not specified, then the data is aggregated/grouped by site.", "title": "Group by", "items": { "$ref": "#/components/schemas/siteIdField" }, "x-displayname": "Group By", "x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "label_filter": { "type": "array", "description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, application traffic for all sites will be returned in the response.", "title": "Label Filter", "items": { "$ref": "#/components/schemas/siteLabelFilter" }, "x-displayname": "Label Filter.", "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".", "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, application traffic for all sites will be returned in the response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.", "x-f5xc-description-medium": "Namespace is used to scope the application traffic to a given namespace. For system namespace, application traffic across all namespaces for the tenant will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "range": { "type": "string", "description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.", "title": "Range", "x-displayname": "Range", "x-ves-example": "10m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "10m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.", "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "Step", "x-displayname": "Step", "x-ves-example": "5m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "5m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Graph/site API is used to GET intra-site and inter-site graph for application traffic.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteResponse": { "type": "object", "description": "Response for graph/site API contains list of nodes and edges.\nEach node contains application traffic flowing from/to site.\nEach edge contains application traffic flowing from src site to dst site.", "title": "Site Graph Response", "x-displayname": "Site Graph Response.", "x-ves-proto-message": "ves.io.schema.graph.site.Response", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/siteGraphData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for graph/site API contains list of nodes and edges. Each node contains application traffic flowing from/to site.", "x-f5xc-description-medium": "Response for graph/site API contains list of nodes and edges. Each node contains application traffic flowing from/to site. Each edge contains application traffic flowing from src site to dst site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "timeseriesTimeseriesFeature": { "type": "string", "description": "Various Timeseries Features that can be enabled\n\nDo not enable any feature\nEnable calculating confidence interval, upper and lower bound time series where metric is expected to vary.\nDetect anomalies and generate alarm when metric goes out of confidence interval\ndetect trend of the metric\nIndicate a score between 0 to 100 which indicates if the metric is healthy.", "title": "Timeseries", "enum": [ "TIMESERIES_FEATURE_NONE", "CONFIDENCE_INTERVAL", "ANOMALY_DETECTION", "TREND", "HEALTHSCORE" ], "default": "TIMESERIES_FEATURE_NONE", "x-displayname": "Timeseries.", "x-ves-proto-enum": "ves.io.schema.timeseries.TimeseriesFeature", "x-f5xc-description-short": "Various Timeseries Features that can be enabled Do not enable any feature Enable calculating confidence interval, upper and lower bound time...", "x-f5xc-description-medium": "Various Timeseries Features that can be enabled Do not enable any feature Enable calculating confidence interval, upper and lower bound time series where metric is expected to vary. Detect anomalies and generate alarm when metric goes out of confidence interval detect trend of the metric...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for timeseriesTimeseriesFeature", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TIMESERIES_FEATURE_NONE\"", "example_yaml": "TIMESERIES_FEATURE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "dc_cluster_groupDCClusterGroupMeshType": { "type": "object", "description": "Details of DC Cluster Group Mesh Type.", "title": "DC Cluster Group Mesh Type", "x-displayname": "DC Cluster Group Mesh Type.", "x-ves-oneof-field-dc_cluster_group_mesh_choice": "[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]", "x-ves-proto-message": "ves.io.schema.dc_cluster_group.DCClusterGroupMeshType", "properties": { "control_and_data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_plane_mesh" ] }, "data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "control_and_data_plane_mesh" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dc_cluster_groupDCClusterGroupMeshType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Data center cluster grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemasiteLinkType": { "type": "string", "description": "Link type of interface determined operationally\n\nLink type unknown\nLink type ethernet\nWi-Fi link of type 802.11ac\nWi-Fi link of type 802.11bgn\nLink type 4G\nWi-Fi link\nWan link.", "title": "Link type", "enum": [ "LINK_TYPE_UNKNOWN", "LINK_TYPE_ETHERNET", "LINK_TYPE_WIFI_802_11AC", "LINK_TYPE_WIFI_802_11BGN", "LINK_TYPE_4G", "LINK_TYPE_WIFI", "LINK_TYPE_WAN" ], "default": "LINK_TYPE_UNKNOWN", "x-displayname": "Link type", "x-ves-proto-enum": "ves.io.schema.site.LinkType", "x-f5xc-description-short": "Link type of interface determined operationally Link type unknown Link type ethernet Wi-Fi link of type 802.11ac Wi-Fi link of type 802.11bgn Link...", "x-f5xc-description-medium": "Link type of interface determined operationally Link type unknown Link type ethernet Wi-Fi link of type 802.11ac Wi-Fi link of type 802.11bgn Link type 4G Wi-Fi link Wan link.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasiteLinkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LINK_TYPE_UNKNOWN\"", "example_yaml": "LINK_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemasiteSiteType": { "type": "string", "description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.", "title": "SiteType", "enum": [ "INVALID", "REGIONAL_EDGE", "CUSTOMER_EDGE", "NGINX_ONE" ], "default": "INVALID", "x-displayname": "Site Type", "x-ves-proto-enum": "ves.io.schema.site.SiteType", "x-f5xc-description-short": "Site Type which can either RE or CE Invalid type of site Regional Edge site Customer Edge site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasiteSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALID\"", "example_yaml": "INVALID\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemasite_mesh_groupSiteMeshGroupType": { "type": "string", "description": "Defines different types of Mesh\n\nInvalid mesh type\nMesh of type Hub\nMesh of type Spoke\nFull mesh of tunnels are created between all sites.", "title": "Site Mesh Group Type", "enum": [ "SITE_MESH_GROUP_TYPE_INVALID", "SITE_MESH_GROUP_TYPE_HUB_FULL_MESH", "SITE_MESH_GROUP_TYPE_SPOKE", "SITE_MESH_GROUP_TYPE_FULL_MESH" ], "default": "SITE_MESH_GROUP_TYPE_INVALID", "x-displayname": "Mesh Type", "x-ves-proto-enum": "ves.io.schema.site_mesh_group.SiteMeshGroupType", "x-f5xc-description-short": "Defines different types of Mesh Invalid mesh type Mesh of type Hub Mesh of type Spoke Full mesh of tunnels are created between all sites.", "x-f5xc-description-medium": "Defines different types of Mesh Invalid mesh type Mesh of type Hub Mesh of type Spoke Full mesh of tunnels are created between all sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemasite_mesh_groupSiteMeshGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_MESH_GROUP_TYPE_INVALID\"", "example_yaml": "SITE_MESH_GROUP_TYPE_INVALID\n..." }, "x-f5xc-cli-domain": "service_mesh", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Site mesh grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologyLinkType": { "type": "string", "description": "Enumerates the association/relationship between 2 nodes.\n\nIndicates that 2 nodes are connected using a tunnel\nIndicates network connection\nIndicates connection to subnet\nIndicates connection to instance\nIndicates association with site mesh group\nIndicates association with DC Cluster group\nIndicates L3 connection between the nodes\nIndicates the Control plane connection between the nodes\nIndicates the BGP connection between the tgw and site.", "title": "LinkType", "enum": [ "LINK_TYPE_TUNNEL", "LINK_TYPE_NETWORK", "LINK_TYPE_SUBNET", "LINK_TYPE_INSTANCE", "LINK_TYPE_SITE_MESH_GROUP", "LINK_TYPE_DC_CLUSTER_GROUP", "LINK_TYPE_L3", "LINK_TYPE_CONTROL_PLANE", "LINK_TYPE_BGP_CONNECTION" ], "default": "LINK_TYPE_TUNNEL", "x-displayname": "Link Type", "x-ves-proto-enum": "ves.io.schema.topology.LinkType", "x-f5xc-description-short": "Enumerates the association/relationship between 2 nodes.", "x-f5xc-description-medium": "Enumerates the association/relationship between 2 nodes. Indicates that 2 nodes are connected using a tunnel Indicates network connection Indicates connection to subnet Indicates connection to instance Indicates association with site mesh group Indicates association with DC Cluster group...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologyLinkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LINK_TYPE_TUNNEL\"", "example_yaml": "LINK_TYPE_TUNNEL\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologyMetricType": { "type": "string", "description": "List of metric types applicable for the nodes and edges in the topology graph.\nNot all metric types are applicable for all nodes or edges. For example, LATENCY metric\nis applicable only for the edges where both the vertices are sites and CPU_USAGE metric is\napplicable only for node of type instance. This list is a union of all metric types.\n\nTotal incoming traffic in bytes\nTotal outgoing traffic in bytes\nTotal incoming packets dropped\nTotal outgoing packets dropped\nReachability based on probes sent periodically\nAverage latency in seconds\nAverage CPU utilization in percentage\nAverage Memory utilization in percentage\nAverage Disk utilization in percentage\nConnection status of the tunnel\nControl plane connection status of the tunnel.", "title": "Metric Type", "enum": [ "METRIC_TYPE_IN_BYTES", "METRIC_TYPE_OUT_BYTES", "METRIC_TYPE_IN_DROP_PACKETS", "METRIC_TYPE_OUT_DROP_PACKETS", "METRIC_TYPE_REACHABILITY_PERCENT", "METRIC_TYPE_LATENCY_SECONDS", "METRIC_TYPE_CPU_USAGE_PERCENT", "METRIC_TYPE_MEMORY_USAGE_PERCENT", "METRIC_TYPE_DISK_USAGE_PERCENT", "METRIC_TYPE_DATA_PLANE_CONNECTION_STATUS", "METRIC_TYPE_CONTROL_PLANE_CONNECTION_STATUS" ], "default": "METRIC_TYPE_IN_BYTES", "x-displayname": "Metric Type.", "x-ves-proto-enum": "ves.io.schema.topology.MetricType", "x-f5xc-description-short": "List of metric types applicable for the nodes and edges in the topology graph. Not all metric types are applicable for all nodes or edges.", "x-f5xc-description-medium": "List of metric types applicable for the nodes and edges in the topology graph. Not all metric types are applicable for all nodes or edges. For example, LATENCY metric is applicable only for the edges where both the vertices are sites and CPU_USAGE metric is applicable only for node of type instance.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologyMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"METRIC_TYPE_IN_BYTES\"", "example_yaml": "METRIC_TYPE_IN_BYTES\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologyMetricTypeData": { "type": "object", "description": "Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values.\nFor example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies\nthe interface name of the instance.", "title": "Metric Type Data", "x-displayname": "Metric Type Data.", "x-ves-proto-message": "ves.io.schema.topology.MetricTypeData", "properties": { "labels": { "type": "object", "description": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported.\nIf the Labels is empty, then the metric value is for the corresponding node or edge.\nFor example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies\nthe interface name of the instance.", "title": "Labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported.", "x-f5xc-description-medium": "Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "description": "List of metric values. May contain more than one value if timeseries data is requested.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-description-short": "List of metric values. May contain more than one value if timeseries data is requested.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values.", "x-f5xc-description-medium": "Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologyMetricTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologyNetworkType": { "type": "object", "description": "A canonical form of the network.", "title": "Network", "x-displayname": "Network", "x-ves-proto-message": "ves.io.schema.topology.NetworkType", "properties": { "cidr_v4": { "type": "array", "description": "IPv4 CIDR", "title": "IPv4 Cidr", "items": { "type": "string" }, "x-displayname": "IPv4 CIDR", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr_v6": { "type": "array", "description": "IPv6 CIDR", "title": "IPv6 Cidr", "items": { "type": "string" }, "x-displayname": "IPv6 CIDR", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "load_balancer": { "type": "array", "description": "Load Balancer Present in this Network.", "title": "Load Balancer", "items": { "$ref": "#/components/schemas/topologyLoadBalancer" }, "x-displayname": "Load Balancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_peers": { "type": "array", "description": "Reference to the network peers.", "title": "Network peers", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Network Peers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "array", "description": "Reference to the regions.", "title": "Region", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Region", "x-f5xc-example": "us-west-2", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologyNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologyNode": { "type": "object", "description": "Canonical representation of Node in the topology graph.", "title": "Node", "x-displayname": "Node", "x-ves-oneof-field-node_type": "[\"dc_cluster_group\",\"instance\",\"network\",\"site\",\"site_mesh_group\",\"subnet\",\"transit_gateway\"]", "x-ves-proto-message": "ves.io.schema.topology.Node", "properties": { "dc_cluster_group": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeDCClusterGroup" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "instance", "network", "site", "site_mesh_group", "subnet", "transit_gateway" ] }, "id": { "type": "string", "description": "Identifier for the node.", "title": "Id", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "instance": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeInstance" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group", "network", "site", "site_mesh_group", "subnet", "transit_gateway" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeMetaData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeNetwork" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group", "instance", "site", "site_mesh_group", "subnet", "transit_gateway" ] }, "site": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group", "instance", "network", "site_mesh_group", "subnet", "transit_gateway" ] }, "site_mesh_group": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeSiteMeshGroup" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group", "instance", "network", "site", "subnet", "transit_gateway" ] }, "subnet": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeSubnet" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-description-short": "Subnet specification for network segmentation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group", "instance", "network", "site", "site_mesh_group", "transit_gateway" ] }, "transit_gateway": { "allOf": [ { "$ref": "#/components/schemas/topologyNodeTypeTransitGateway" } ], "x-f5xc-description-short": "Configuration parameter for transit gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dc_cluster_group", "instance", "network", "site", "site_mesh_group", "subnet" ] } }, "x-f5xc-description-short": "Canonical representation of Node in the topology graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologyNode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologySiteMeshGroupType": { "type": "object", "description": "A canonical form of the site mesh group.", "title": "Site Mesh Group", "x-displayname": "Site Mesh Group.", "x-ves-oneof-field-mesh_choice": "[\"full_mesh\",\"hub_mesh\",\"spoke_mesh\"]", "x-ves-proto-message": "ves.io.schema.topology.SiteMeshGroupType", "properties": { "full_mesh": { "allOf": [ { "$ref": "#/components/schemas/site_mesh_groupFullMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hub_mesh", "spoke_mesh" ] }, "hub": { "type": "array", "description": "If 'Type' is Spoke, 'Hub' refers to a Site Mesh Group of 'type' Hub.\nSpoke sites connect to all the member sites of Hub Site Mesh Group.\nHub will be empty when Site Mesh Group type is Hub or Full Mesh.", "title": "Hub", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Hub (site mesh group)", "x-f5xc-description-short": "If 'Type' is Spoke, 'Hub' refers to a Site Mesh Group of 'type' Hub. Spoke sites connect to all the member sites of Hub Site Mesh Group.", "x-f5xc-description-medium": "If 'Type' is Spoke, 'Hub' refers to a Site Mesh Group of 'type' Hub. Spoke sites connect to all the member sites of Hub Site Mesh Group. Hub will be empty when Site Mesh Group type is Hub or Full Mesh.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_mesh": { "allOf": [ { "$ref": "#/components/schemas/site_mesh_groupHubFullMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "full_mesh", "spoke_mesh" ] }, "site_type": { "allOf": [ { "$ref": "#/components/schemas/schemasiteSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spoke_mesh": { "allOf": [ { "$ref": "#/components/schemas/site_mesh_groupSpokeMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "full_mesh", "hub_mesh" ] }, "topology_site": { "type": "array", "description": "Topology Sites referenced in this site_mesh_group.", "title": "Topology Site Reference", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Topology Site.", "x-f5xc-description-short": "Topology Sites referenced in this site_mesh_group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/schemasite_mesh_groupSiteMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_site": { "type": "array", "description": "Virtual Site referenced in this site_mesh_group.", "title": "virtual_site", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Virtual Site.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Virtual Site referenced in this site_mesh_group.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologySiteMeshGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schematopologySiteType": { "type": "object", "description": "A canonical form of the site.", "title": "Site", "x-displayname": "Site", "x-ves-proto-message": "ves.io.schema.topology.SiteType", "properties": { "app_type": { "allOf": [ { "$ref": "#/components/schemas/topologySiteAppTypeEnum" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dc_cluster_group": { "type": "array", "description": "Reference to the DC Cluster group.", "title": "DC Cluster Group", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "DC Cluster Group.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gateway_type": { "allOf": [ { "$ref": "#/components/schemas/topologyGatewayTypeEnum" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "type": "array", "description": "Reference to the network.", "title": "Network", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Network", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 32, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "orchestration_mode": { "allOf": [ { "$ref": "#/components/schemas/topologyOrchestrationMode" } ], "x-f5xc-description-short": "Configuration parameter for orchestration mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_type": { "allOf": [ { "$ref": "#/components/schemas/schemasiteSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw": { "type": "array", "description": "Reference to the transit gateway.", "title": "TransitGateway", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "TransitGateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schematopologySiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "siteInterfaceStatus__ves_io_schema_topology": { "type": "object", "description": "Status of Interfaces in ver.", "title": "Interface Status", "x-displayname": "Interface Status.", "x-ves-proto-message": "ves.io.schema.site.InterfaceStatus", "properties": { "active_state": { "allOf": [ { "$ref": "#/components/schemas/siteActiveState" } ], "x-f5xc-description-short": "Configuration parameter for active state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bond_members": { "type": "array", "description": "Members of the Bond interface along with the corresponding link state.", "title": "Bond Interface Members\nx-displayName: \"Bond Members\"\nMembers of the Bond interface along with the corresponding link state", "items": { "$ref": "#/components/schemas/siteBondMembersType" }, "x-displayname": "Bond Members.", "x-f5xc-description-short": "Members of the Bond interface along with the corresponding link state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dhcp_server": { "type": "boolean", "description": "Indicate if DHCP server is configured on the interface.", "title": "DHCP Server", "format": "boolean", "x-displayname": "DHCP Server.", "x-f5xc-description-short": "Indicate if DHCP server is configured on the interface.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "allOf": [ { "$ref": "#/components/schemas/schemaIpSubnetType" } ], "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_mode": { "allOf": [ { "$ref": "#/components/schemas/siteAddressMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ipv6": { "allOf": [ { "$ref": "#/components/schemas/schemaIpSubnetType" } ], "x-f5xc-example": "2001:db8::1", "x-f5xc-description-short": "IPv6 address in colon-separated hexadecimal format.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_quality": { "allOf": [ { "$ref": "#/components/schemas/siteLinkQuality" } ], "x-f5xc-description-short": "Configuration parameter for link quality.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_state": { "type": "boolean", "description": "Link State for the interface.", "title": "Link State\nx-displayName: \"Link State\"\nLink State for the interface", "format": "boolean", "x-displayname": "Link State.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_type": { "allOf": [ { "$ref": "#/components/schemas/schemasiteLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mac": { "type": "string", "description": "MAC Address of interface.", "title": "Mac Address", "x-displayname": "MAC Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of interface.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "network_name": { "type": "string", "description": "Name of Virtual Network to which the interface belongs.", "title": "Virtual Network Name", "x-displayname": "Virtual Network Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of Virtual Network to which the interface belongs.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_type": { "allOf": [ { "$ref": "#/components/schemas/schemaVirtualNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteInterfaceStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "site_mesh_groupFullMeshGroupType": { "type": "object", "description": "Details of Full Mesh Group Type.", "title": "Full Mesh Group Type", "x-displayname": "Full Mesh", "x-ves-oneof-field-full_mesh_choice": "[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]", "x-ves-proto-message": "ves.io.schema.site_mesh_group.FullMeshGroupType", "properties": { "control_and_data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_plane_mesh" ] }, "data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "control_and_data_plane_mesh" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for site_mesh_groupFullMeshGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "service_mesh", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Site mesh grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "site_mesh_groupHubFullMeshGroupType": { "type": "object", "description": "Details of Hub Full Mesh Group Type.", "title": "Hub Full Mesh Group Type", "x-displayname": "Hub Full Mesh.", "x-ves-oneof-field-hub_full_mesh_choice": "[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]", "x-ves-proto-message": "ves.io.schema.site_mesh_group.HubFullMeshGroupType", "properties": { "control_and_data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_plane_mesh" ] }, "data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "control_and_data_plane_mesh" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for site_mesh_groupHubFullMeshGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "service_mesh", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Site mesh grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "site_mesh_groupSpokeMeshGroupType": { "type": "object", "description": "Details of Spoke Mesh Group Type.", "title": "Spoke Mesh Group Type", "x-displayname": "Spoke", "x-ves-oneof-field-spoke_hub_mesh_choice": "[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]", "x-ves-proto-message": "ves.io.schema.site_mesh_group.SpokeMeshGroupType", "properties": { "control_and_data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "data_plane_mesh" ] }, "data_plane_mesh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "control_and_data_plane_mesh" ] }, "hub_mesh_group": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for hub mesh group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "site_mesh_group", "field_path": "hub_mesh_group", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for site_mesh_groupSpokeMeshGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "service_mesh", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Site mesh grouping is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyAWSNetworkMetaData": { "type": "object", "description": "Network attributes specific to AWS.", "title": "AWSNetworkMetaData", "x-displayname": "AWS Network Meta Data.", "x-ves-proto-message": "ves.io.schema.topology.AWSNetworkMetaData", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/topologyMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway": { "allOf": [ { "$ref": "#/components/schemas/topologyTransitGatewayType" } ], "x-f5xc-description-short": "Configuration parameter for transit gateway.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyAWSNetworkMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyAWSRouteAttributes": { "type": "object", "description": "Route attributes specific to AWS.", "title": "AWSRouteAttributes", "x-displayname": "AWS Route Attributes.", "x-ves-proto-message": "ves.io.schema.topology.AWSRouteAttributes", "properties": { "propagated": { "type": "boolean", "description": "Is route propagated.", "title": "Propagated", "format": "boolean", "x-displayname": "Propagated.", "x-f5xc-example": "false", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw": { "allOf": [ { "$ref": "#/components/schemas/topologyAWSTgwRouteAttributes" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyAWSRouteAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyAWSTGWAttachment": { "type": "object", "description": "AWS TGW Attachment.", "title": "AWSTGWAttachment", "x-displayname": "AWS TGW Attachment.", "x-ves-proto-message": "ves.io.schema.topology.AWSTGWAttachment", "properties": { "associated_route_table_id": { "type": "string", "description": "Associated Route Table ID.", "title": "Associated Route Table ID", "x-displayname": "Associated Route Table ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "association_state": { "type": "string", "description": "Association State.", "title": "Association State", "x-displayname": "Association State.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr": { "type": "string", "description": "Configuration parameter for cidr", "title": "CIDR", "x-displayname": "CIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 9, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}/(3[0-2]|[12]?[0-9])$", "format": "cidr", "formatDescription": "CIDR notation (e.g., 10.0.0.0/24)", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cloud_connect": { "type": "array", "description": "Reference to the Cloud Connect.", "title": "Cloud Connect", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Cloud Connect.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "TGW Attachment ID.", "title": "ID", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "TGW Attachment Name.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "resource_id": { "type": "string", "description": "Resource ID.", "title": "Resource ID", "x-displayname": "Resource ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_name": { "type": "string", "description": "Resource Name.", "title": "Resource Name", "x-displayname": "Resource Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_type": { "type": "string", "description": "Resource Type.", "title": "Resource Type", "x-displayname": "Resource Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment": { "type": "array", "description": "Reference to the Segment.", "title": "Segment", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Segment", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Transit gateway attachment tags.", "title": "Tags", "x-displayname": "Tags", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyAWSTGWAttachment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyAWSTGWAttachmentMetaData": { "type": "object", "description": "AWS TGW AWSTGWAttachment MetaData.", "title": "AWSTGWAttachmentMetaData", "x-displayname": "AWS TGW AWSTGWAttachment MetaData.", "x-ves-proto-message": "ves.io.schema.topology.AWSTGWAttachmentMetaData", "properties": { "id": { "type": "string", "description": "TGW Attachment ID.", "title": "Attachment ID", "x-displayname": "Attachment ID.", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_id": { "type": "string", "description": "Resource ID.", "title": "Resource ID", "x-displayname": "Resource ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_name": { "type": "string", "description": "Resource Name.", "title": "Resource Name", "x-displayname": "Resource Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_type": { "type": "string", "description": "Resource Type.", "title": "Resource Type", "x-displayname": "Resource Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Association/Propagation State.", "title": "Association/Propagation State", "x-displayname": "Association/Propagation State.", "x-f5xc-example": "running", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyAWSTGWAttachmentMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyAWSTgwRouteAttributes": { "type": "object", "description": "Route attributes specific to AWS TGW.", "title": "AWSTgwRouteAttributes", "x-displayname": "AWS TGW Route Attributes.", "x-ves-proto-message": "ves.io.schema.topology.AWSTgwRouteAttributes", "properties": { "next_hop_attachment": { "type": "array", "description": "Next Hop Attachment.", "title": "Next Hop Attachment", "items": { "$ref": "#/components/schemas/topologyAWSTGWAttachmentMetaData" }, "x-displayname": "Next Hop Attachment.", "x-f5xc-example": "next_hop_attachment", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_type": { "type": "string", "description": "Route Type.", "title": "Route Type", "x-displayname": "Route Type.", "x-ves-example": "Propagated.", "x-f5xc-example": "propagated", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyAWSTgwRouteAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyAddressInfoType": { "type": "object", "description": "Address with additional information.", "title": "Address Info Type", "x-displayname": "Address Info Type.", "x-ves-proto-message": "ves.io.schema.topology.AddressInfoType", "properties": { "address": { "type": "string", "description": "Address", "title": "Address", "x-displayname": "Address", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_name": { "type": "string", "description": "Address type.", "title": "DNS Name", "x-displayname": "Public Address.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9.-]", "description": "Dot-separated DNS labels" }, "format": "fqdn", "formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "primary": { "type": "boolean", "description": "Indicate this address is primary or not.", "title": "Primary", "format": "boolean", "x-displayname": "Primary", "x-f5xc-description-short": "Indicate this address is primary or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyAddressInfoType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyCloudNetworkType": { "type": "string", "description": "Cloud Network Type.\n\nNetwork None\nNetwork Type Azure Hub VNet\nNetwork Type Spoke VNet\nNetwork Type Service VPC\nNetwork Type Spoke VPC.", "title": "Cloud NetworkType", "enum": [ "NETWORK_TYPE_NONE", "NETWORK_TYPE_HUB_VNET", "NETWORK_TYPE_SPOKE_VNET", "NETWORK_TYPE_SERVICE_VPC", "NETWORK_TYPE_SPOKE_VPC" ], "default": "NETWORK_TYPE_NONE", "x-displayname": "Cloud Network Type.", "x-ves-proto-enum": "ves.io.schema.topology.CloudNetworkType", "x-f5xc-description-short": "Cloud Network Type. Network None Network Type Azure Hub VNet Network Type Spoke VNet Network Type Service VPC Network Type Spoke VPC.", "x-f5xc-description-medium": "Cloud Network Type. Network None Network Type Azure Hub VNet Network Type Spoke VNet Network Type Service VPC Network Type Spoke VPC.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyCloudNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NETWORK_TYPE_NONE\"", "example_yaml": "NETWORK_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyDCClusterGroupSummaryInfo": { "type": "object", "description": "Summary information related to the DC Cluster Group.", "title": "DCClusterGroupSummaryInfo", "x-displayname": "DC Cluster Group Summary.", "x-ves-proto-message": "ves.io.schema.topology.DCClusterGroupSummaryInfo", "properties": { "sites": { "type": "integer", "description": "This field indicates the number of sites that are part of this DC Cluster group.", "title": "Sites", "format": "int64", "x-displayname": "Sites", "x-f5xc-description-short": "Field indicates the number of sites that are part of this DC Cluster group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Summary information related to the DC Cluster Group.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyDCClusterGroupSummaryInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyDCClusterGroupType": { "type": "object", "description": "A canonical form of the DC cluster group.", "title": "DC Cluster Group", "x-displayname": "DC Cluster Group.", "x-ves-proto-message": "ves.io.schema.topology.DCClusterGroupType", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/dc_cluster_groupDCClusterGroupMeshType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyDCClusterGroupType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyDCClusterTopologyRequest": { "type": "object", "description": "Request to GET DC Cluster group topology and the associated metrics.", "title": "DC Cluster Group Topology Request", "x-displayname": "DC Cluster Group Topology Request.", "x-ves-proto-message": "ves.io.schema.topology.DCClusterTopologyRequest", "properties": { "dc_cluster_group": { "type": "string", "description": "Name of the DC Cluster group.", "title": "DC Cluster group", "x-displayname": "DC Cluster group.", "x-ves-example": "Dcg-1", "x-f5xc-example": "dcg-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric_selector": { "allOf": [ { "$ref": "#/components/schemas/topologyMetricSelector" } ], "x-f5xc-description-short": "Configuration parameter for metric selector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET DC Cluster group topology and the associated metrics.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyDCClusterTopologyRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyEdge": { "type": "object", "description": "Canonical representation of Edge in the topology graph.", "title": "Edge", "x-displayname": "Edge", "x-ves-proto-message": "ves.io.schema.topology.Edge", "properties": { "links": { "type": "array", "description": "An edge may be composed of multiple links.\nFor example, there may be multiple tunnels between a transit gateway and a site and each tunnel\nis represented as individual links. In some cases, we may want to show only one link between 2 nodes,\neven though there may be multiple connections/tunnels between these nodes.", "title": "Links", "items": { "$ref": "#/components/schemas/topologyLinkTypeData" }, "x-displayname": "Links", "x-f5xc-description-medium": "Edge may be composed of multiple links. For example, there may be multiple tunnels between a transit gateway and a site and each tunnel is represented as individual links. In some cases, we may want to show only one link between 2 nodes, even though there may be multiple connections/tunnels...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_id1": { "type": "string", "description": "Node identifier.", "title": "Node Id1", "x-displayname": "Node Id1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "node_id2": { "type": "string", "description": "Node identifier.", "title": "Node Id2", "x-displayname": "Node Id2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "status": { "allOf": [ { "$ref": "#/components/schemas/topologyLinkStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Canonical representation of Edge in the topology graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyEdge", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyEdgeInfoSummary": { "type": "object", "description": "Summary information for an edge.", "title": "EdgeInfoSummary", "x-displayname": "Edge Info Summary.", "x-ves-proto-message": "ves.io.schema.topology.EdgeInfoSummary", "properties": { "count": { "type": "integer", "description": "Links count.", "title": "Count", "format": "int64", "x-displayname": "Count", "x-f5xc-example": "42", "x-f5xc-constraints": { "constraintType": "number", "category": "general", "minimum": 0, "maximum": 10000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/topologyLinkStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyEdgeInfoSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyGCPRouteAttributes": { "type": "object", "description": "Route attributes specific to GCP.", "title": "GCPRouteAttributes", "x-displayname": "GCP Route Attributes.", "x-ves-proto-message": "ves.io.schema.topology.GCPRouteAttributes", "properties": { "ip_version": { "type": "string", "description": "Version of IP protocol.", "title": "IP version", "x-displayname": "IP version.", "x-ves-example": "IPv4", "x-f5xc-example": "ipv4", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "priority": { "type": "integer", "description": "Route Priority.", "title": "Priority", "format": "int64", "x-displayname": "Priority", "x-f5xc-example": "1", "x-f5xc-constraints": { "constraintType": "number", "category": "ordering", "minimum": 0, "maximum": 100, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_name": { "type": "string", "description": "GCP Route Name.", "title": "GCP Route Name", "x-displayname": "GCP Route Name.", "x-ves-example": "Default-route.", "x-f5xc-example": "default-route", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_type": { "allOf": [ { "$ref": "#/components/schemas/topologyGCPRouteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scope_limits": { "type": "array", "description": "Limits on the scope of route like network tag.", "title": "Scope Limits", "items": { "type": "string" }, "x-displayname": "Scope Limits.", "x-ves-example": "Tag-1, tag-2.", "x-f5xc-example": "tag-1, tag-2", "x-f5xc-description-short": "Limits on the scope of route like network tag.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyGCPRouteAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyGCPRouteType": { "type": "string", "description": "GCP Route Type\n\n- GCP_ROUTE_TYPE_NONE: GCP Route Type None\n\nGCP Route Type None\n- GCP_ROUTE_TYPE_TRANSIT: GCP Route Type Transit\n\nGCP Route Type Transit\n- GCP_ROUTE_TYPE_SUBNET: GCP Route Type Subnet\n\nGCP Route Type Subnet\n- GCP_ROUTE_TYPE_STATIC: GCP Route Type Static\n\nGCP Route Type Static\n- GCP_ROUTE_TYPE_BGP: GCP Route Type BGP\n\nGCP Route Type BGP.", "title": "GCPRouteType", "enum": [ "GCP_ROUTE_TYPE_NONE", "GCP_ROUTE_TYPE_TRANSIT", "GCP_ROUTE_TYPE_SUBNET", "GCP_ROUTE_TYPE_STATIC", "GCP_ROUTE_TYPE_BGP" ], "default": "GCP_ROUTE_TYPE_NONE", "x-displayname": "GCP Route type.", "x-ves-proto-enum": "ves.io.schema.topology.GCPRouteType", "x-f5xc-description-short": "GCP Route Type - GCP_ROUTE_TYPE_NONE: GCP Route Type None GCP Route Type None - GCP_ROUTE_TYPE_TRANSIT: GCP Route Type Transit GCP Route Type...", "x-f5xc-description-medium": "GCP Route Type - GCP_ROUTE_TYPE_NONE: GCP Route Type None GCP Route Type None - GCP_ROUTE_TYPE_TRANSIT: GCP Route Type Transit GCP Route Type Transit - GCP_ROUTE_TYPE_SUBNET: GCP Route Type Subnet GCP Route Type Subnet - GCP_ROUTE_TYPE_STATIC: GCP Route Type Static GCP Route Type Static ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyGCPRouteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"GCP_ROUTE_TYPE_NONE\"", "example_yaml": "GCP_ROUTE_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyGatewayTypeEnum": { "type": "string", "description": "Gateway Type\n\n- INGRESS_GATEWAY: Ingress gateway\n\nIngress gateway (single NIC)\n- INGRESS_EGRESS_GATEWAY: Ingress and Egress gateway\n\nIngress and Egress gateway (dual NIC)", "title": "GatewayType", "enum": [ "INGRESS_GATEWAY", "INGRESS_EGRESS_GATEWAY" ], "default": "INGRESS_GATEWAY", "x-displayname": "Gateway type.", "x-ves-proto-enum": "ves.io.schema.topology.GatewayTypeEnum", "x-f5xc-description-short": "Gateway Type - INGRESS_GATEWAY: Ingress gateway Ingress gateway (single NIC) - INGRESS_EGRESS_GATEWAY: Ingress and Egress gateway Ingress and...", "x-f5xc-description-medium": "Gateway Type - INGRESS_GATEWAY: Ingress gateway Ingress gateway (single NIC) - INGRESS_EGRESS_GATEWAY: Ingress and Egress gateway Ingress and Egress gateway (dual NIC).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyGatewayTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INGRESS_GATEWAY\"", "example_yaml": "INGRESS_GATEWAY\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyInstanceType": { "type": "object", "description": "A canonical form of the instance.", "title": "Instance", "x-displayname": "Instance", "x-ves-proto-message": "ves.io.schema.topology.InstanceType", "properties": { "architecture": { "type": "string", "description": "Architecture.", "title": "Architecture", "x-displayname": "Architecture.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "availability_zone": { "type": "string", "description": "Availability Zone.", "title": "Availability Zone", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cpu": { "type": "integer", "description": "CPU Count", "title": "CPU", "format": "int64", "x-displayname": "CPU Count", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "f5xc_node_name": { "type": "string", "description": "F5XC node name.", "title": "F5XC Node name", "x-displayname": "F5XC Node Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "instance_type": { "type": "string", "description": "Instance type.", "title": "Instance type", "x-displayname": "Instance type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interfaces": { "type": "array", "description": "A list of network interfaces.", "title": "Interfaces", "items": { "$ref": "#/components/schemas/topologyNetworkInterfaceType" }, "x-displayname": "Network Interfaces.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "platform": { "type": "string", "description": "Platform", "title": "Platform", "x-displayname": "Platform", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_address": { "type": "string", "description": "Private Address.", "title": "Private addresses", "x-displayname": "Private Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "private_dns_name": { "type": "string", "description": "Private DNS Name.", "title": "Private DNS Name", "x-displayname": "Private DNS Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_address": { "type": "string", "description": "Public address.", "title": "Public address", "x-displayname": "Public Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_dns_name": { "type": "string", "description": "Public DNS Name.", "title": "Public DNS Name", "x-displayname": "Public DNS Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "security_group": { "type": "array", "description": "Security groups.", "title": "Security Groups", "items": { "type": "string" }, "x-displayname": "Security Groups.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyInstanceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyInterfaceTypeEnum": { "type": "string", "description": "- INSIDE: INSIDE Interface\n\n- WORKLOAD: Workload Interface\n\n- NOT_APPLICABLE: NOT_APPLICABLE\n\nEx - When the subnet belongs to a Azure spoke VNet\n- SEGMENT: SEGMENT Interface.", "title": "- OUTSIDE: OUTSIDE Interface", "enum": [ "OUTSIDE", "INSIDE", "WORKLOAD", "NOT_APPLICABLE", "SEGMENT" ], "default": "OUTSIDE", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.topology.InterfaceTypeEnum", "x-f5xc-description-short": "- INSIDE: INSIDE Interface - WORKLOAD: Workload Interface - NOT_APPLICABLE: NOT_APPLICABLE Ex - When the subnet belongs to a Azure spoke VNet ...", "x-f5xc-description-medium": "- INSIDE: INSIDE Interface - WORKLOAD: Workload Interface - NOT_APPLICABLE: NOT_APPLICABLE Ex - When the subnet belongs to a Azure spoke VNet - SEGMENT: SEGMENT Interface.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyInterfaceTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"OUTSIDE\"", "example_yaml": "OUTSIDE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyLinkInfo": { "type": "object", "description": "Information about the link that connects 2 nodes in the topology graph.", "title": "LinkInfo", "x-displayname": "Link Info", "x-ves-proto-message": "ves.io.schema.topology.LinkInfo", "properties": { "dst_id": { "type": "string", "description": "Endpoint identifier. Dst_id is the destination endpoint for the link is between src_id and dst_id.", "title": "Destination ID", "x-displayname": "Destination ID.", "x-ves-example": "Master-0", "x-f5xc-example": "master-0", "x-f5xc-description-short": "Endpoint identifier. Dst_id is the destination endpoint for the link is between src_id and dst_id.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "name": { "type": "string", "description": "Name of the link.\nLink name may or may not be present depending on the type of link.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Tunnel-1", "x-f5xc-example": "tunnel-1", "x-f5xc-description-short": "Name of the link. Link name may or may not be present depending on the type of link.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "src_id": { "type": "string", "description": "Endpoint identifier. Src_id is the source endpoint for the link is between src_id and dst_id.", "title": "Source ID", "x-displayname": "Source ID", "x-ves-example": "Master-0", "x-f5xc-example": "master-0", "x-f5xc-description-short": "Endpoint identifier. Src_id is the source endpoint for the link is between src_id and dst_id.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "status": { "allOf": [ { "$ref": "#/components/schemas/topologyLinkStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "allOf": [ { "$ref": "#/components/schemas/schematopologyLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about the link that connects 2 nodes in the topology graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyLinkInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyLinkInfoSummary": { "type": "object", "description": "Summary information for a link type.", "title": "LinkInfoSummary", "x-displayname": "Link Info Summary.", "x-ves-proto-message": "ves.io.schema.topology.LinkInfoSummary", "properties": { "count": { "type": "integer", "description": "Links count.", "title": "Count", "format": "int64", "x-displayname": "Count", "x-f5xc-example": "42", "x-f5xc-constraints": { "constraintType": "number", "category": "general", "minimum": 0, "maximum": 10000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/topologyLinkStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "allOf": [ { "$ref": "#/components/schemas/schematopologyLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyLinkInfoSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyLinkStatus": { "type": "string", "description": "Enumerates link status.\n\nStatus not applicable for this link\nStatus unknown for this link\nIndicates status up/active\nIndicates status down/inactive\nIndicates status degraded.", "title": "LinkStatus", "enum": [ "LINK_STATUS_NOT_APPLICABLE", "LINK_STATUS_UNKNOWN", "LINK_STATUS_UP", "LINK_STATUS_DOWN", "LINK_STATUS_DEGRADED" ], "default": "LINK_STATUS_NOT_APPLICABLE", "x-displayname": "Link Status.", "x-ves-proto-enum": "ves.io.schema.topology.LinkStatus", "x-f5xc-description-medium": "Enumerates link status. Status not applicable for this link Status unknown for this link Indicates status up/active Indicates status down/inactive Indicates status degraded.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyLinkStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LINK_STATUS_NOT_APPLICABLE\"", "example_yaml": "LINK_STATUS_NOT_APPLICABLE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyLinkTypeData": { "type": "object", "description": "LinkTypeData contains details about the link and the metrics (if requested/available).", "title": "LinkTypeData", "x-displayname": "Link Type Data.", "x-ves-proto-message": "ves.io.schema.topology.LinkTypeData", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/topologyLinkInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Metric data for the link.", "title": "Metric", "items": { "$ref": "#/components/schemas/topologyMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "LinkTypeData contains details about the link and the metrics (if requested/available).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyLinkTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyLoadBalancer": { "type": "object", "description": "Load Balancer.", "title": "LB", "x-displayname": "Load Balancer.", "x-ves-proto-message": "ves.io.schema.topology.LoadBalancer", "properties": { "id": { "type": "string", "description": "ID of the LB.", "title": "Id", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the LB.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyLoadBalancer", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyMetaType": { "type": "object", "description": "A metadata for topology objects.", "title": "Metadata", "x-displayname": "MetaType", "x-ves-proto-message": "ves.io.schema.topology.MetaType", "properties": { "cloud_user_accounts": { "type": "array", "description": "Reference to cloud user account to fetch cloud resources.", "title": "Cloud User Account", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Cloud User Account.", "x-f5xc-description-short": "Reference to cloud user account to fetch cloud resources.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creds": { "type": "array", "description": "Reference to cloud credentials to fetch cloud resources.", "title": "Cloud Credentials", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Cloud Credentials.", "x-f5xc-description-short": "Reference to cloud credentials to fetch cloud resources.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID in the external system (such as cloud specific ID).", "title": "ID", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "x-f5xc-description-short": "ID in the external system (such as cloud specific ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name in the external system.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_id": { "type": "string", "description": "Owner ID in the cloud side.", "title": "OwnerID", "x-displayname": "Owner ID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "provider_type": { "allOf": [ { "$ref": "#/components/schemas/topologyProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "raw_json": { "type": "string", "description": "Raw JSON string.", "title": "Raw JSON", "x-displayname": "Raw JSON", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of topology node.", "title": "Status", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tags": { "type": "object", "description": "Map of string keys and values that annotated in the topology node.", "title": "tags", "x-displayname": "Tags", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that annotated in the topology node.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyMetricData": { "type": "object", "description": "Metric Data contains the metric type and the metric data.", "title": "Metric Data", "x-displayname": "Metric Data.", "x-ves-proto-message": "ves.io.schema.topology.MetricData", "properties": { "data": { "type": "array", "description": "Metric Data.", "title": "Data", "items": { "$ref": "#/components/schemas/schematopologyMetricTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/schematopologyMetricType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metric Data contains the metric type and the metric data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyMetricSelector": { "type": "object", "description": "MetricSelector is used to specify the list of metrics to be returned in the response.", "title": "Metric Selector", "x-displayname": "Metric Selector.", "x-ves-proto-message": "ves.io.schema.topology.MetricSelector", "properties": { "edge": { "type": "array", "description": "List of metrics to be returned for the edges.", "title": "Edge Metric Types", "items": { "$ref": "#/components/schemas/schematopologyMetricType" }, "x-displayname": "Edge Metric Types.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of metrics to be returned for the edges.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time of metric data. This field is applicable only if \"include_metrics\" is set to true.\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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric data. This field is applicable only if \"include_metrics\" is set to true.", "x-f5xc-description-medium": "End time of metric data. This field is applicable only if \"include_metrics\" is set to true. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "type": "array", "description": "List of metrics to be returned for the nodes.", "title": "Node Metric Types", "items": { "$ref": "#/components/schemas/schematopologyMetricType" }, "x-displayname": "Node Metric Types.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of metrics to be returned for the nodes.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of metric data. This field is applicable only if \"include_metrics\" is set to true.\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 -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of metric data. This field is applicable only if \"include_metrics\" is set to true.", "x-f5xc-description-medium": "Start time of metric data. This field is applicable only if \"include_metrics\" is set to true. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "Step", "x-displayname": "Step", "x-ves-example": "5m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "5m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "MetricSelector is used to specify the list of metrics to be returned in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyMetricSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkInterfaceType": { "type": "object", "description": "A canonical form of the network interface.", "title": "Network Interface", "x-displayname": "Network Interface.", "x-ves-proto-message": "ves.io.schema.topology.NetworkInterfaceType", "properties": { "f5xc_status": { "allOf": [ { "$ref": "#/components/schemas/siteInterfaceStatus__ves_io_schema_topology" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of this interface.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "private_addresses": { "type": "array", "description": "Private Address.", "title": "Private addresses", "items": { "$ref": "#/components/schemas/topologyAddressInfoType" }, "x-displayname": "Private Addresses.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_address": { "type": "array", "description": "Public address.", "title": "Public address", "items": { "$ref": "#/components/schemas/topologyAddressInfoType" }, "x-displayname": "Public Address.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "security_group": { "type": "array", "description": "Security groups.", "title": "Security Groups", "items": { "type": "string" }, "x-displayname": "Security Groups.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status", "title": "Status", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "subnet": { "type": "array", "description": "Reference to the subnets connected.", "title": "Subnets", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Subnets", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Canonical form of the network interface.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkInterfaceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkRouteTableData": { "type": "object", "description": "Data associated with the network route tables.", "title": "NetworkRouteTableData", "x-displayname": "Network Route Data.", "x-ves-proto-message": "ves.io.schema.topology.NetworkRouteTableData", "properties": { "route_table_data": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet_data": { "type": "array", "description": "Subnet Data.", "title": "Subnet Data", "items": { "$ref": "#/components/schemas/topologySubnetData" }, "x-displayname": "Subnet Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Data associated with the network route tables.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkRouteTableData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkRouteTableMetaData": { "type": "object", "description": "Metadata associated with the network route tables.", "title": "NetworkRouteTableMetaData", "x-displayname": "Network RouteTable Metadata.", "x-ves-proto-message": "ves.io.schema.topology.NetworkRouteTableMetaData", "properties": { "route_table_metadata": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableMetaData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet_metadata": { "type": "array", "description": "Subnet Metadata.", "title": "Subnet Metadata", "items": { "$ref": "#/components/schemas/topologySubnetMetaData" }, "x-displayname": "Subnet Metadata.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metadata associated with the network route tables.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkRouteTableMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkRouteTablesResponse": { "type": "object", "description": "List of RouteTables Associated in the Network.", "title": "Network Route Tables Response", "x-displayname": "Network Route Tables Response.", "x-ves-proto-message": "ves.io.schema.topology.NetworkRouteTablesResponse", "properties": { "routes_data": { "type": "array", "description": "Network Routes Data.", "title": "Network Routes Data", "items": { "$ref": "#/components/schemas/topologyNetworkRoutesData" }, "x-displayname": "Network Routes Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of RouteTables Associated in the Network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkRouteTablesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkRoutesData": { "type": "object", "description": "Data associated with the network routes.", "title": "NetworkRoutesData", "x-displayname": "Network Routes Data.", "x-ves-proto-message": "ves.io.schema.topology.NetworkRoutesData", "properties": { "network_id": { "type": "string", "description": "Network ID.", "title": "Network Id", "x-displayname": "Network ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "route_tables_data": { "type": "array", "description": "Network Route Tables Data.", "title": "Network Routes Data", "items": { "$ref": "#/components/schemas/topologyNetworkRouteTableData" }, "x-displayname": "Network Route Tables Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Data associated with the network routes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkRoutesData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkRoutesMetaData": { "type": "object", "description": "Metadata associated with the network routes.", "title": "NetworkRoutesMetaData", "x-displayname": "Network RouteTable Metadata.", "x-ves-proto-message": "ves.io.schema.topology.NetworkRoutesMetaData", "properties": { "cloud_resource_id": { "type": "string", "description": "Cloud Resource ID.", "title": "Cloud Resource Id", "x-displayname": "Cloud Resource ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "id": { "type": "string", "description": "Network ID.", "title": "Network Id", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Network Name.", "title": "Network Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "network_type": { "allOf": [ { "$ref": "#/components/schemas/topologyCloudNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "regions": { "type": "array", "description": "Regions in Network.", "title": "Regions", "items": { "type": "string" }, "x-displayname": "Regions", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_tables_metadata": { "type": "array", "description": "Network Route Tables Metadata.", "title": "Network Route Tables Metadata", "items": { "$ref": "#/components/schemas/topologyNetworkRouteTableMetaData" }, "x-displayname": "Network Route Tables Metadata.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metadata associated with the network routes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkRoutesMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNetworkSummaryInfo": { "type": "object", "description": "Summary information related to the network.", "title": "NetworkSummaryInfo", "x-displayname": "Network Summary.", "x-ves-proto-message": "ves.io.schema.topology.NetworkSummaryInfo", "properties": { "route_tables": { "type": "array", "description": "List of route tables associated with the network.", "title": "Route Tables", "items": { "$ref": "#/components/schemas/topologyRouteTableMetaData" }, "x-displayname": "Route Tables.", "x-f5xc-description-short": "List of route tables associated with the network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Summary information related to the network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNetworkSummaryInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeMetaData": { "type": "object", "description": "Metadata for node.", "title": "Node Metadata", "x-displayname": "Node Metadata.", "x-ves-proto-message": "ves.io.schema.topology.NodeMetaData", "properties": { "cloud_resource_id": { "type": "string", "description": "Cloud Resource Identifier for the node. This is only used for node which represent the cloud resource.", "title": "Cloud Resource Id", "x-displayname": "Cloud Resource ID.", "x-f5xc-description-short": "Cloud Resource Identifier for the node. This is only used for node which represent the cloud resource.", "x-f5xc-description-medium": "Cloud Resource Identifier for the node. This is only used for node which represent the cloud resource.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "description": { "type": "string", "description": "Description of the node.\nThis field may or may not be populated depending on the node type and if the user provided description\nwhile creating the resource.", "title": "Description", "x-displayname": "Description.", "x-f5xc-description-medium": "Description of the node. This field may or may not be populated depending on the node type and if the user provided description while creating the resource.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "level": { "type": "integer", "description": "Level indicates the distance of the node from the root node. A value of 0 indicates the root node.", "title": "Level", "format": "int64", "x-displayname": "Level", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-description-short": "Level indicates the distance of the node from the root node. A value of 0 indicates the root node.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the node.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Site-1", "x-f5xc-example": "site-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_id": { "type": "string", "description": "Owner ID", "title": "Owner Id", "x-displayname": "Owner ID", "x-ves-example": "Owner-1", "x-f5xc-example": "owner-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "provider_type": { "allOf": [ { "$ref": "#/components/schemas/topologyProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status in the node.", "title": "Status", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tags": { "type": "object", "description": "List of key/value pairs associated with the node.", "title": "Tags", "x-displayname": "Tags", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of key/value pairs associated with the node.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeDCClusterGroup": { "type": "object", "description": "DC Cluster group is represented as a node in the site topology graph.\nIn the DCClusterTopology API, dc_cluster_group is represented as a node and all the sites\nthat are part of the DC Cluster group are represented as edges (site -> dc_cluster_group) in\naddition to the edges between the sites (site <-> site).", "title": "NodeTypeDCClusterGroup", "x-displayname": "DC Cluster Group.", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeDCClusterGroup", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/topologyDCClusterGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/topologyDCClusterGroupSummaryInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DC Cluster group is represented as a node in the site topology graph.", "x-f5xc-description-medium": "DC Cluster group is represented as a node in the site topology graph. In the DCClusterTopology API, dc_cluster_group is represented as a node and all the sites that are part of the DC Cluster group are represented as edges (site -> dc_cluster_group) in addition to the edges between the sites...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeDCClusterGroup", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeInstance": { "type": "object", "description": "NodeTypeInstance contains details about the instance and the metrics (if requested/available).", "title": "NodeTypeInstance", "x-displayname": "Instance", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeInstance", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/topologyInstanceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Metric data for the Instance.", "title": "Metric", "items": { "$ref": "#/components/schemas/topologyMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeTypeInstance contains details about the instance and the metrics (if requested/available).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeInstance", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeNetwork": { "type": "object", "description": "NodeTypeNetwork contains details about the network and the metrics (if requested/available).", "title": "NodeTypeNetwork", "x-displayname": "Network", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeNetwork", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/schematopologyNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Metric data for the Network.", "title": "Metric", "items": { "$ref": "#/components/schemas/topologyMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/topologyNetworkSummaryInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeTypeNetwork contains details about the network and the metrics (if requested/available).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeNetwork", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeSite": { "type": "object", "description": "NodeTypeSite contains details about the site and the metrics (if requested/available).", "title": "NodeTypeSite", "x-displayname": "Site", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeSite", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/schematopologySiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Metric data for the Site.", "title": "Metric", "items": { "$ref": "#/components/schemas/topologyMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/topologySiteSummaryInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeTypeSite contains details about the site and the metrics (if requested/available).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeSite", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeSiteMeshGroup": { "type": "object", "description": "Site mesh group is represented as a node in the site topology graph.\nIn the SiteMeshTopology API, site_mesh_group is represented as a node and all the sites\nthat are part of the site mesh group are represented as edges (site -> site_mesh_group) in\naddition to the edges between the sites (site <-> site). If the site_mesh_group is of type \"Spoke\",\nthen the node representing the site_mesh_group will have an edge with another site_mesh_group node\nthat represents the \"Hub\" and vice-versa.", "title": "NodeTypeSiteMeshGroup", "x-displayname": "Site Mesh Group.", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeSiteMeshGroup", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/schematopologySiteMeshGroupType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/topologySiteMeshGroupSummaryInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Site mesh group is represented as a node in the site topology graph.", "x-f5xc-description-medium": "Site mesh group is represented as a node in the site topology graph. In the SiteMeshTopology API, site_mesh_group is represented as a node and all the sites that are part of the site mesh group are represented as edges (site -> site_mesh_group) in addition to the edges between the sites (site...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeSiteMeshGroup", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeSubnet": { "type": "object", "description": "NodeTypeSubnet contains details about the subnet and the metrics (if requested/available).", "title": "NodeTypeSubnet", "x-displayname": "Subnet", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeSubnet", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/topologySubnetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Metric data for the Subnet.", "title": "Metric", "items": { "$ref": "#/components/schemas/topologyMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/topologySubnetSummaryInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeTypeSubnet contains details about the subnet and the metrics (if requested/available).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeSubnet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyNodeTypeTransitGateway": { "type": "object", "description": "NodeTypeTransitGateway contains details about the transit gateway and the metrics (if requested/available).", "title": "NodeTypeTransitGateway", "x-displayname": "Transit Gateway.", "x-ves-proto-message": "ves.io.schema.topology.NodeTypeTransitGateway", "properties": { "info": { "allOf": [ { "$ref": "#/components/schemas/topologyTransitGatewayType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Metric data for the Transit Gateway.", "title": "Metric", "items": { "$ref": "#/components/schemas/topologyMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeTypeTransitGateway contains details about the transit gateway and the metrics (if requested/available).", "x-f5xc-description-medium": "NodeTypeTransitGateway contains details about the transit gateway and the metrics (if requested/available).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyNodeTypeTransitGateway", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyOrchestrationMode": { "type": "string", "description": "Orchestration mode of a given site\n\n- NOT_MANAGED: Unmanaged mode\n\nUnmanaged mode\n- MANAGED: Managed mode\n\nManaged mode.", "title": "Orchestration Mode", "enum": [ "NOT_MANAGED", "MANAGED" ], "default": "NOT_MANAGED", "x-displayname": "Orchestration Mode.", "x-ves-proto-enum": "ves.io.schema.topology.OrchestrationMode", "x-f5xc-description-short": "Orchestration mode of a given site - NOT_MANAGED: Unmanaged mode Unmanaged mode - MANAGED: Managed mode Managed mode.", "x-f5xc-description-medium": "Orchestration mode of a given site - NOT_MANAGED: Unmanaged mode Unmanaged mode - MANAGED: Managed mode Managed mode.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyOrchestrationMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NOT_MANAGED\"", "example_yaml": "NOT_MANAGED\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyProviderType": { "type": "string", "description": "Provider type\n\nProviderType unspecified\nAWS backend\nGCP backend\nAzure backend\nF5XC backend\nVMware backend\nKVM backend\nOCI backend\nBaremetal backend\nF5 rSeries backend\nCE on K8s backend.", "title": "ProviderType", "enum": [ "PROVIDER_TYPE_UNSPECIFIED", "PROVIDER_TYPE_AWS", "PROVIDER_TYPE_GCP", "PROVIDER_TYPE_AZURE", "PROVIDER_TYPE_VOLTERRA", "PROVIDER_TYPE_VMWARE", "PROVIDER_TYPE_KVM", "PROVIDER_TYPE_OCI", "PROVIDER_TYPE_BAREMETAL", "PROVIDER_TYPE_F5RSERIES", "PROVIDER_TYPE_K8S" ], "default": "PROVIDER_TYPE_UNSPECIFIED", "x-displayname": "Provider Type.", "x-ves-proto-enum": "ves.io.schema.topology.ProviderType", "x-f5xc-description-short": "Provider type ProviderType unspecified AWS backend GCP backend Azure backend F5XC backend VMware backend KVM backend OCI backend Baremetal backend...", "x-f5xc-description-medium": "Provider type ProviderType unspecified AWS backend GCP backend Azure backend F5XC backend VMware backend KVM backend OCI backend Baremetal backend F5 rSeries backend CE on K8s backend.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PROVIDER_TYPE_UNSPECIFIED\"", "example_yaml": "PROVIDER_TYPE_UNSPECIFIED\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteNextHopTypeEnum": { "type": "string", "description": "RouteNextHopTypeEnum\n\n- VIRTUAL_NETWORK_GATEWAY: VIRTUAL NETWORK GATEWAY\n\nVIRTUAL NETWORK GATEWAY\n- VNET_LOCAL: VNet LOCAL\n\nVNet LOCAL\n- INTERNET: INTERNET\n\nINTERNET\n- VIRTUAL_APPLIANCE: VIRTUAL APPLIANCE\n\nVIRTUAL APPLIANCE\n- NONE: NONE\n\nNONE\n- VNET_PEERING: VNet PEERING\n\nVNet PEERING\n- VIRTUAL_NETWORK_SERVICE_ENDPOINT: VIRTUAL NETWORK SERVICE ENDPOINT\n\nVIRTUAL NETWORK SERVICE ENDPOINT\n- NEXT_HOP_TYPE_NOT_APPLICABLE: NEXT_HOP_TYPE_NOT_APPLICABLE\n\nNEXT_HOP_TYPE_NOT_APPLICABLE should be used when the cloud provider doesn't support this.\n- LOADBALANCER: LOAD BALANCER\n\nLOAD BALANCER\n- VPC_NETWORK: VPC NETWORK\n\nVPC NETWORK\n- VPC_PEERING: VPC PEERING\n\nVPC PEERING\n- INTERNAL_LOAD_BALANCER: INTERNAL LOAD BALANCER\n\nINTERNAL LOAD BALANCER\n- INSTANCE: INSTANCE\n\nINSTANCE\n- INTERCONNECT: INTERCONNECT\n\nINTERCONNECT\n- INTERNET_GATEWAY: INTERNET GATEWAY\n\nINTERNET GATEWAY\n- IP: IP\n\nIP\n- VPN_TUNNEL: VPN TUNNEL\n\nVPN TUNNEL\n- TGW_ATTACHMENT: TGW ATTACHMENT\n\nTGW ATTACHMENT.", "title": "RouteNextHopTypeEnum", "enum": [ "VIRTUAL_NETWORK_GATEWAY", "VNET_LOCAL", "INTERNET", "VIRTUAL_APPLIANCE", "NONE", "VNET_PEERING", "VIRTUAL_NETWORK_SERVICE_ENDPOINT", "NEXT_HOP_TYPE_NOT_APPLICABLE", "LOADBALANCER", "VPC_NETWORK", "VPC_PEERING", "INTERNAL_LOAD_BALANCER", "INSTANCE", "INTERCONNECT", "INTERNET_GATEWAY", "IP", "VPN_TUNNEL", "TGW_ATTACHMENT" ], "default": "VIRTUAL_NETWORK_GATEWAY", "x-displayname": "RouteNextHopTypeEnum.", "x-ves-proto-enum": "ves.io.schema.topology.RouteNextHopTypeEnum", "x-f5xc-description-short": "RouteNextHopTypeEnum - VIRTUAL_NETWORK_GATEWAY: VIRTUAL NETWORK GATEWAY VIRTUAL NETWORK GATEWAY - VNET_LOCAL: VNet LOCAL VNet LOCAL - INTERNET...", "x-f5xc-description-medium": "RouteNextHopTypeEnum - VIRTUAL_NETWORK_GATEWAY: VIRTUAL NETWORK GATEWAY VIRTUAL NETWORK GATEWAY - VNET_LOCAL: VNet LOCAL VNet LOCAL - INTERNET: INTERNET INTERNET - VIRTUAL_APPLIANCE: VIRTUAL APPLIANCE VIRTUAL APPLIANCE - NONE: NONE NONE - VNET_PEERING: VNet PEERING VNet PEERING ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteNextHopTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VIRTUAL_NETWORK_GATEWAY\"", "example_yaml": "VIRTUAL_NETWORK_GATEWAY\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteSourceTypeEnum": { "type": "string", "description": "RouteSourceTypeEnum\n\n- INVALID_SOURCE: INVALID_SOURCE\n\nINVALID_SOURCE\n- DEFAULT: DEFAULT\n\nDEFAULT\n- USER: USER\n\nUSER\n- UNKNOWN: UNKNOWN\n\nUNKNOWN\n- VIRTUAL_NETWORK_GATEWAY_SOURCE: VIRTUAL_NETWORK_GATEWAY_SOURCE\n\nVIRTUAL_NETWORK_GATEWAY_SOURCE\n- SOURCE_NOT_APPLICABLE: SOURCE_NOT_APPLICABLE\n\nSOURCE_NOT_APPLICABLE should be used when the cloud provider does not supports this.", "title": "RouteSourceTypeEnum", "enum": [ "INVALID_SOURCE", "DEFAULT", "USER", "UNKNOWN", "VIRTUAL_NETWORK_GATEWAY_SOURCE", "SOURCE_NOT_APPLICABLE" ], "default": "INVALID_SOURCE", "x-displayname": "RouteSourceTypeEnum.", "x-ves-proto-enum": "ves.io.schema.topology.RouteSourceTypeEnum", "x-f5xc-description-short": "RouteSourceTypeEnum - INVALID_SOURCE: INVALID_SOURCE INVALID_SOURCE - DEFAULT: DEFAULT DEFAULT - USER: USER USER - UNKNOWN: UNKNOWN UNKNOWN ...", "x-f5xc-description-medium": "RouteSourceTypeEnum - INVALID_SOURCE: INVALID_SOURCE INVALID_SOURCE - DEFAULT: DEFAULT DEFAULT - USER: USER USER - UNKNOWN: UNKNOWN UNKNOWN - VIRTUAL_NETWORK_GATEWAY_SOURCE: VIRTUAL_NETWORK_GATEWAY_SOURCE VIRTUAL_NETWORK_GATEWAY_SOURCE - SOURCE_NOT_APPLICABLE: SOURCE_NOT_APPLICABLE...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteSourceTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALID_SOURCE\"", "example_yaml": "INVALID_SOURCE\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteStateTypeEnum": { "type": "string", "description": "RouteStateTypeEnum\n\n- ACTIVE_STATE: ACTIVE_STATE\n\nACTIVE_STATE\n- INVALID_STATE: INVALID_STATE\n\nINVALID_STATE\n- STATE_NOT_APPLICABLE: STATE_NOT_APPLICABLE\n\nSTATE_NOT_APPLICABLE should be used when the cloud provider doesn't supports this\n- STATE_BLACKHOLE: STATE_BLACKHOLE\n\nSTATE_BLACKHOLE\n- STATE_UNAVAILABLE: STATE_UNAVAILABLE\n\nSTATE_UNAVAILABLE\n- STATE_PENDING: STATE_PENDING\n\nSTATE_PENDING\n- STATE_DELETING: STATE_DELETING\n\nSTATE_DELETING\n- STATE_DELETED: STATE_DELETING\n\nSTATE_DELETED.", "title": "RouteStateTypeEnum", "enum": [ "ACTIVE_STATE", "INVALID_STATE", "STATE_NOT_APPLICABLE", "STATE_BLACKHOLE", "STATE_UNAVAILABLE", "STATE_PENDING", "STATE_DELETING", "STATE_DELETED" ], "default": "ACTIVE_STATE", "x-displayname": "RouteStateTypeEnum.", "x-ves-proto-enum": "ves.io.schema.topology.RouteStateTypeEnum", "x-f5xc-description-short": "RouteStateTypeEnum - ACTIVE_STATE: ACTIVE_STATE ACTIVE_STATE - INVALID_STATE: INVALID_STATE INVALID_STATE - STATE_NOT_APPLICABLE...", "x-f5xc-description-medium": "RouteStateTypeEnum - ACTIVE_STATE: ACTIVE_STATE ACTIVE_STATE - INVALID_STATE: INVALID_STATE INVALID_STATE - STATE_NOT_APPLICABLE: STATE_NOT_APPLICABLE STATE_NOT_APPLICABLE should be used when the cloud provider doesn't supports this - STATE_BLACKHOLE: STATE_BLACKHOLE STATE_BLACKHOLE ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteStateTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ACTIVE_STATE\"", "example_yaml": "ACTIVE_STATE\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteTableData": { "type": "object", "description": "Data associated with the route table.", "title": "RouteTableData", "x-displayname": "Route Table Data.", "x-ves-proto-message": "ves.io.schema.topology.RouteTableData", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableMetaData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_table": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableType" } ], "x-f5xc-description-short": "Configuration parameter for route table.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteTableData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteTableMetaData": { "type": "object", "description": "Metadata associated with the route table.", "title": "RouteTableMetaData", "x-displayname": "Route Table Metadata.", "x-ves-proto-message": "ves.io.schema.topology.RouteTableMetaData", "properties": { "cloud_resource_id": { "type": "string", "description": "Cloud Resource Identifier this route table.", "title": "Cloud Resource Id", "x-displayname": "Cloud Resource ID.", "x-f5xc-description-short": "Cloud Resource Identifier this route table.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "name": { "type": "string", "description": "Name of the route table.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Rt-1", "x-f5xc-example": "rt-1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tags": { "type": "object", "description": "Map of string keys and values that annotated in the topology node.", "title": "tags", "x-displayname": "Tags", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that annotated in the topology node.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Metadata associated with the route table.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteTableMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteTableResponse": { "type": "object", "description": "Route table.", "title": "Route Table Response", "x-displayname": "Route Table Response.", "x-ves-proto-message": "ves.io.schema.topology.RouteTableResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableMetaData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_table": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableType" } ], "x-f5xc-description-short": "Configuration parameter for route table.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteTableResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteTableStateEnum": { "type": "string", "description": "Route table state\n\nRoute table state None\nRoute table state Pending\nRoute table state Available\nRoute table state Deleting\nRoute table state Deleted.", "title": "RouteTableStateEnum", "enum": [ "ROUTE_TABLE_STATE_NONE", "ROUTE_TABLE_STATE_PENDING", "ROUTE_TABLE_STATE_AVAILABLE", "ROUTE_TABLE_STATE_DELETING", "ROUTE_TABLE_STATE_DELETED" ], "default": "ROUTE_TABLE_STATE_NONE", "x-displayname": "Route Table State.", "x-ves-proto-enum": "ves.io.schema.topology.RouteTableStateEnum", "x-f5xc-description-short": "Route table state Route table state None Route table state Pending Route table state Available Route table state Deleting Route table state Deleted.", "x-f5xc-description-medium": "Route table state Route table state None Route table state Pending Route table state Available Route table state Deleting Route table state Deleted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteTableStateEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ROUTE_TABLE_STATE_NONE\"", "example_yaml": "ROUTE_TABLE_STATE_NONE\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteTableType": { "type": "object", "description": "A canonical form of the route table.", "title": "RouteTableType", "x-displayname": "Route Table.", "x-ves-proto-message": "ves.io.schema.topology.RouteTableType", "properties": { "associations": { "type": "array", "description": "List of associations.", "title": "Associations", "items": { "$ref": "#/components/schemas/topologyAWSTGWAttachmentMetaData" }, "x-displayname": "Associations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "explicit_subnet": { "type": "array", "description": "Reference to the subnet explicitly associated.", "title": "Explicit Subnet Association", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Explicit Subnet Association.", "x-f5xc-description-short": "Reference to the subnet explicitly associated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "implicit_subnet": { "type": "array", "description": "Reference to the subnet implicitly associated.", "title": "Implicit Subnet Association", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Implicit Subnet Association.", "x-f5xc-description-short": "Reference to the subnet implicitly associated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "type": "array", "description": "Reference to the network.", "title": "Network", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Network", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 32, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "propagations": { "type": "array", "description": "List of propagations.", "title": "Propagations", "items": { "$ref": "#/components/schemas/topologyAWSTGWAttachmentMetaData" }, "x-displayname": "Propagations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_table_state": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableStateEnum" } ], "x-f5xc-description-short": "Configuration parameter for route table state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "route_table_type": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteTableTypeEnum" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "routes": { "type": "array", "description": "List of routes.", "title": "Routes", "items": { "$ref": "#/components/schemas/topologyRouteType" }, "x-displayname": "Routes", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet": { "type": "array", "description": "Reference to the subnet.", "title": "Subnet", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Subnet", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway": { "type": "array", "description": "Reference to the transit gateway if a transit gateway owns this resource.", "title": "Transit Gateway", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Transit Gateway.", "x-f5xc-description-short": "Reference to the transit gateway if a transit gateway owns this resource.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteTableType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteTableTypeEnum": { "type": "string", "description": "Route table backend.\n\nRoute table for network\nRoute Table for transit gateway.", "title": "RouteTableTypeEnum", "enum": [ "ROUTE_TABLE_NETWORK", "ROUTE_TABLE_TGW" ], "default": "ROUTE_TABLE_NETWORK", "x-displayname": "Route Table Type.", "x-ves-proto-enum": "ves.io.schema.topology.RouteTableTypeEnum", "x-f5xc-description-short": "Route table backend. Route table for network Route Table for transit gateway.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteTableTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ROUTE_TABLE_NETWORK\"", "example_yaml": "ROUTE_TABLE_NETWORK\n..." }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyRouteType": { "type": "object", "description": "A canonical form of the route.", "title": "RouteType", "x-displayname": "Route Type.", "x-ves-oneof-field-cloud_route_attributes": "[\"aws\",\"gcp\"]", "x-ves-proto-message": "ves.io.schema.topology.RouteType", "properties": { "aws": { "allOf": [ { "$ref": "#/components/schemas/topologyAWSRouteAttributes" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gcp" ] }, "destination": { "type": "string", "description": "Destination.", "title": "Destination", "x-displayname": "Destination.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp": { "allOf": [ { "$ref": "#/components/schemas/topologyGCPRouteAttributes" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws" ] }, "next_hop_type": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteNextHopTypeEnum" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nexthop": { "type": "string", "description": "Nexthop (IP subnet or gateway ID)", "title": "Nexthop", "x-displayname": "Nexthop", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "source": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteSourceTypeEnum" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/topologyRouteStateTypeEnum" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_defined_route_name": { "type": "string", "description": "User Defined Route Name.", "title": "User Defined Route Name", "x-displayname": "User Defined Route Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyRouteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySiteAppTypeEnum": { "type": "string", "description": "Site App Type\n\n- SITE_APPTYPE_NONE: Not applicable\n\nNot applicable\n- SITE_APPTYPE_APPSTACK: AppStack Site\n\nAppStack Site\n- SITE_APPTYPE_MESH: Mesh site\n\nMesh site.", "title": "Site App Type", "enum": [ "SITE_APPTYPE_NONE", "SITE_APPTYPE_APPSTACK", "SITE_APPTYPE_MESH" ], "default": "SITE_APPTYPE_NONE", "x-displayname": "Site App type.", "x-ves-proto-enum": "ves.io.schema.topology.SiteAppTypeEnum", "x-f5xc-description-short": "Site App Type - SITE_APPTYPE_NONE: Not applicable Not applicable - SITE_APPTYPE_APPSTACK: AppStack Site AppStack Site - SITE_APPTYPE_MESH: Mesh...", "x-f5xc-description-medium": "Site App Type - SITE_APPTYPE_NONE: Not applicable Not applicable - SITE_APPTYPE_APPSTACK: AppStack Site AppStack Site - SITE_APPTYPE_MESH: Mesh site Mesh site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySiteAppTypeEnum", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_APPTYPE_NONE\"", "example_yaml": "SITE_APPTYPE_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySiteMeshGroupSummaryInfo": { "type": "object", "description": "Summary information related to the site mesh group.", "title": "SiteMeshGroupSummaryInfo", "x-displayname": "Site Mesh Group Summary.", "x-ves-proto-message": "ves.io.schema.topology.SiteMeshGroupSummaryInfo", "properties": { "edge_status_summary": { "type": "array", "description": "Summary of the edges status between the sites in the site mesh group.", "title": "Edge Summary", "items": { "$ref": "#/components/schemas/topologyEdgeInfoSummary" }, "x-displayname": "Edge Summary.", "x-f5xc-description-short": "Summary of the edges status between the sites in the site mesh group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link_status_summary": { "type": "array", "description": "Summary of the link status between the sites in the site mesh group.", "title": "Link Status Summary", "items": { "$ref": "#/components/schemas/topologyLinkInfoSummary" }, "x-displayname": "Link Status Summary.", "x-f5xc-description-short": "Summary of the link status between the sites in the site mesh group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "other_connected_site_mesh_group_sites": { "type": "integer", "description": "If the site mesh group is of type \"Hub\", this field indicates the number of sites in all the spoke mesh groups\nthat are connected to this site mesh group.\nIf the site mesh group is of type \"Spoke\", this field indicates the number of sites in the hub as well as the sites\nin other spoke groups that are attached to this hub.", "title": "Other Connected Site Mesh Group Sites", "format": "int64", "x-displayname": "Other Connected Site Mesh Group Sites.", "x-f5xc-description-short": "If the site mesh group is of type \"Hub\", this field indicates the number of sites in all the spoke mesh groups that are connected to this site...", "x-f5xc-description-medium": "If the site mesh group is of type \"Hub\", this field indicates the number of sites in all the spoke mesh groups that are connected to this site mesh group. If the site mesh group is of type \"Spoke\", this field indicates the number of sites in the hub as well as the sites in other spoke groups...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sites": { "type": "integer", "description": "This field indicates the number of sites that are part of this site mesh group.", "title": "Sites", "format": "int64", "x-displayname": "Sites", "x-f5xc-description-short": "Field indicates the number of sites that are part of this site mesh group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Summary information related to the site mesh group.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySiteMeshGroupSummaryInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySiteMeshTopologyRequest": { "type": "object", "description": "Request to GET site mesh group topology and the associated metrics.", "title": "Site Mesh Group Topology Request", "x-displayname": "Site Mesh Group Topology Request.", "x-ves-proto-message": "ves.io.schema.topology.SiteMeshTopologyRequest", "properties": { "metric_selector": { "allOf": [ { "$ref": "#/components/schemas/topologyMetricSelector" } ], "x-f5xc-description-short": "Configuration parameter for metric selector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_mesh_group": { "type": "string", "description": "Name of the site mesh group.", "title": "Site Mesh Group", "x-displayname": "Site Mesh Group.", "x-ves-example": "Smg-1", "x-f5xc-example": "smg-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET site mesh group topology and the associated metrics.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySiteMeshTopologyRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySiteNetworksResponse": { "type": "object", "description": "List of Networks Associated to Site.", "title": "Site Networks Response", "x-displayname": "Site Networks Response.", "x-ves-oneof-field-cloud_network_meta_data": "[\"aws\"]", "x-ves-proto-message": "ves.io.schema.topology.SiteNetworksResponse", "properties": { "aws": { "allOf": [ { "$ref": "#/components/schemas/topologyAWSNetworkMetaData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "routes_metadata": { "type": "array", "description": "Network Routes Meta Data.", "title": "Network Routes Meta Data", "items": { "$ref": "#/components/schemas/topologyNetworkRoutesMetaData" }, "x-displayname": "Network Routes Meta Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySiteNetworksResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySiteSummaryInfo": { "type": "object", "description": "Summary information related to the site.", "title": "SiteSummaryInfo", "x-displayname": "Site Summary.", "x-ves-proto-message": "ves.io.schema.topology.SiteSummaryInfo", "properties": { "availability_zone": { "type": "array", "description": "Availability zone.", "title": "Availability Zone", "items": { "type": "string" }, "x-displayname": "Availability Zone.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_count": { "type": "integer", "description": "Site Node Count.", "title": "Node Count", "format": "int64", "x-displayname": "Node Count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_info": { "type": "array", "description": "Provides mapping for node, private IP and public IP.", "title": "node_info", "items": { "$ref": "#/components/schemas/schemasiteNode" }, "x-displayname": "Node info", "x-f5xc-description-short": "Provides mapping for node, private IP and public IP.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Summary information related to the site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySiteSummaryInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySiteTopologyRequest": { "type": "object", "description": "Request to GET site topology and the associated metrics.", "title": "Site Topology Request", "x-displayname": "Site Topology Request.", "x-ves-proto-message": "ves.io.schema.topology.SiteTopologyRequest", "properties": { "group_dc_cluster_nodes": { "type": "boolean", "description": "Option to enable or disable grouping of sites in a DC Cluster group.\nIf enabled, then all the sites in a DC Cluster group are returned as a single node in the response.", "title": "Group DC Cluster nodes", "format": "boolean", "x-displayname": "Group DC Cluster nodes.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Option to enable or disable grouping of sites in a DC Cluster group.", "x-f5xc-description-medium": "Option to enable or disable grouping of sites in a DC Cluster group. If enabled, then all the sites in a DC Cluster group are returned as a single node in the response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_site_mesh_nodes": { "type": "boolean", "description": "Option to enable or disable grouping of sites in a site mesh group.\nIf enabled, then all the sites in a site mesh group are returned as a single node in the response.", "title": "Group Site Mesh nodes", "format": "boolean", "x-displayname": "Group Site Mesh nodes.", "x-f5xc-description-short": "Option to enable or disable grouping of sites in a site mesh group.", "x-f5xc-description-medium": "Option to enable or disable grouping of sites in a site mesh group. If enabled, then all the sites in a site mesh group are returned as a single node in the response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "level": { "type": "integer", "description": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node.\nIf the level specified in the request is 1, then the response contains the root node (level:0) and all its immediate neighbors (level:1).\nIf the level is set to -1, then all the nodes and edges in the topology graph will be returned in the response.", "title": "Level", "format": "int32", "x-displayname": "Level", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node.", "x-f5xc-description-medium": "Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node. If the level specified in the request is 1, then the response contains the root node (level:0) and all its immediate neighbors (level:1). If the level is set to -1...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric_selector": { "allOf": [ { "$ref": "#/components/schemas/topologyMetricSelector" } ], "x-f5xc-description-short": "Configuration parameter for metric selector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node_id": { "type": "string", "description": "Specifies the node in the topology graph to start the graph traversal.", "title": "Node Id", "x-displayname": "Node ID", "x-ves-example": "Site:site-1.", "x-f5xc-example": "site:site-1", "x-f5xc-description-short": "Specifies the node in the topology graph to start the graph traversal.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "site": { "type": "string", "description": "Name of the site.", "title": "Site", "x-displayname": "Site", "x-ves-example": "Ce01", "x-f5xc-example": "ce01", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET site topology and the associated metrics.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySiteTopologyRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySubnetData": { "type": "object", "description": "Data associated with the subnets.", "title": "SubnetData", "x-displayname": "Subnet Data.", "x-ves-proto-message": "ves.io.schema.topology.SubnetData", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/topologySubnetMetaData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnet": { "allOf": [ { "$ref": "#/components/schemas/topologySubnetType" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-description-short": "Subnet specification for network segmentation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySubnetData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySubnetMetaData": { "type": "object", "description": "Metadata associated with the subnets.", "title": "SubnetMetaData", "x-displayname": "Subnet MetaData.", "x-ves-proto-message": "ves.io.schema.topology.SubnetMetaData", "properties": { "cidr_v4": { "type": "array", "description": "IPv4 CIDR", "title": "IPv4 Cidr", "items": { "type": "string" }, "x-displayname": "IPv4 CIDR", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr_v6": { "type": "array", "description": "IPv6 CIDR", "title": "IPv6 Cidr", "items": { "type": "string" }, "x-displayname": "IPv6 CIDR", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cloud_resource_id": { "type": "string", "description": "Cloud Resource Identifier the subnet.", "title": "Cloud Resource Id", "x-displayname": "Cloud Resource ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "name": { "type": "string", "description": "Name of the subnet.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySubnetMetaData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySubnetSummaryInfo": { "type": "object", "description": "Summary information related to the subnet.", "title": "SubnetSummaryInfo", "x-displayname": "Subnet Summary.", "x-ves-proto-message": "ves.io.schema.topology.SubnetSummaryInfo", "properties": { "route_tables": { "type": "array", "description": "List of route tables associated with the subnet.", "title": "Route Tables", "items": { "$ref": "#/components/schemas/topologyRouteTableMetaData" }, "x-displayname": "Route Tables.", "x-f5xc-description-short": "List of route tables associated with the subnet.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Summary information related to the subnet.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySubnetSummaryInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologySubnetType": { "type": "object", "description": "A canonical form of the subnet.", "title": "Subnet", "x-displayname": "Subnet", "x-ves-proto-message": "ves.io.schema.topology.SubnetType", "properties": { "availability_zone": { "type": "string", "description": "Availability zone.", "title": "Availability Zone", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr_v4": { "type": "array", "description": "IPv4 CIDR", "title": "IPv4 Cidr", "items": { "type": "string" }, "x-displayname": "IPv4 CIDR", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidr_v6": { "type": "array", "description": "IPv6 CIDR", "title": "IPv6 Cidr", "items": { "type": "string" }, "x-displayname": "IPv6 CIDR", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_type": { "allOf": [ { "$ref": "#/components/schemas/topologyInterfaceTypeEnum" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "type": "array", "description": "Reference to the network.", "title": "Network", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Network", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 32, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "array", "description": "Reference to the regions. (Used for GCP)", "title": "Region", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Region", "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Reference to the regions. (Used for GCP).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologySubnetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyTGWRouteTablesResponse": { "type": "object", "description": "List of RouteTables Associated with TGW.", "title": "TGW Route Tables Response", "x-displayname": "TGW Route Tables Response.", "x-ves-proto-message": "ves.io.schema.topology.TGWRouteTablesResponse", "properties": { "routes_data": { "type": "array", "description": "TGW Routes Data.", "title": "TGW Routes Data", "items": { "$ref": "#/components/schemas/topologyRouteTableData" }, "x-displayname": "TGW Routes Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of RouteTables Associated with TGW.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyTGWRouteTablesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyTopologyResponse": { "type": "object", "description": "Relationship between the resources associated with a site is represented as a graph, where each resource/entity is\nrepresented as a node (example: Site (CE, RE), Network (VPC, Virtual Network), Subnet, etc.,) and their association is\nrepresented as edges (example: Site (CE) - Site (CE, RE), Network (VPC) - Subnets, etc.,). All edges are directed.\nHowever if 2 nodes have bidirectional connection, (example: Site - Site), there may be 2 edges in the response for the same\npair of nodes.", "title": "Topology Response", "x-displayname": "Topology Response.", "x-ves-proto-message": "ves.io.schema.topology.TopologyResponse", "properties": { "edges": { "type": "array", "description": "List of edges in the topology graph.", "title": "Edges", "items": { "$ref": "#/components/schemas/topologyEdge" }, "x-displayname": "Edges", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodes": { "type": "array", "description": "List of nodes in the topology graph.", "title": "Nodes", "items": { "$ref": "#/components/schemas/schematopologyNode" }, "x-displayname": "Nodes", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Relationship between the resources associated with a site is represented as a graph, where each resource/entity is represented as a node (.", "x-f5xc-description-medium": "Relationship between the resources associated with a site is represented as a graph, where each resource/entity is represented as a node (.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyTopologyResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "topologyTransitGatewayType": { "type": "object", "description": "A canonical form of the transit gateway.", "title": "TransitGateway", "x-displayname": "Transit gateway.", "x-ves-proto-message": "ves.io.schema.topology.TransitGatewayType", "properties": { "attachments": { "type": "array", "description": "TGW Attachments.", "title": "Attachments", "items": { "$ref": "#/components/schemas/topologyAWSTGWAttachment" }, "x-displayname": "Attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "auto_accept_shared_attachments": { "type": "boolean", "description": "Auto accept shared attachment.", "title": "Auto accept shared attachment", "format": "boolean", "x-displayname": "Auto accept shared attachment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_support": { "type": "boolean", "description": "DNS support.", "title": "DNS support", "format": "boolean", "x-displayname": "DNS Support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "type": "array", "description": "Reference to the network.", "title": "Network", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Network", "x-f5xc-example": "192.0.2.0/24", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 32, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpn_ecmp_support": { "type": "boolean", "description": "VPN ecmp support.", "title": "vpn ecmp support", "format": "boolean", "x-displayname": "VpnEcmpSupport Support.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for topologyTransitGatewayType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud site infrastructure managed at platform level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "virtual_k8sCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of virtual_k8s", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.virtual_k8s.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sCreateSpecType": { "type": "object", "description": "Create virtual_k8s will create the object in the storage backend for namespace metadata.namespace.", "title": "Create Virtual K8s", "x-displayname": "Create Virtual Kubernetes.", "x-ves-oneof-field-service_isolation_choice": "[\"disabled\",\"isolated\"]", "x-ves-proto-message": "ves.io.schema.virtual_k8s.CreateSpecType", "properties": { "default_flavor_ref": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for default flavor ref.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "workload_flavor", "field_path": "default_flavor_ref", "gated_by": null, "required": false, "cardinality": "single" } ] }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "isolated" ] }, "isolated": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disabled" ] }, "vsite_refs": { "type": "array", "description": "Reference to virtual-sites\nDefault virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object\nannotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the\nKubernetes API resource object.", "maxItems": 32, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Virtual Sites.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.", "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Create virtual_k8s will create the object in the storage backend for namespace metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a virtual_k8s", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read virtual_k8s", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/virtual_k8sStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sGetSpecType": { "type": "object", "description": "GET virtual_k8s will GET the object from the storage backend for namespace metadata.namespace.", "title": "Get Virtual K8s", "x-displayname": "GET Virtual Kubernetes.", "x-ves-oneof-field-service_isolation_choice": "[\"disabled\",\"isolated\"]", "x-ves-proto-message": "ves.io.schema.virtual_k8s.GetSpecType", "properties": { "default_flavor_ref": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for default flavor ref.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "workload_flavor", "field_path": "default_flavor_ref", "gated_by": null, "required": false, "cardinality": "single" } ] }, "disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "isolated" ] }, "isolated": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disabled" ] }, "vsite_refs": { "type": "array", "description": "Reference to virtual-sites\nDefault virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object\nannotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the\nKubernetes API resource object.", "maxItems": 32, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Virtual Sites.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32" }, "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.", "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GET virtual_k8s will GET the object from the storage backend for namespace metadata.namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of virtual_k8s", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/virtual_k8sListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sListResponseItem": { "type": "object", "description": "By default a summary of virtual_k8s is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of virtual_k8s", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.virtual_k8s.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this virtual_k8s.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this virtual_k8s.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this virtual_k8s.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this virtual_k8s.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates virtual_k8s is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates virtual_k8s is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this virtual_k8s.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this virtual_k8s.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this virtual_k8s.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/virtual_k8sStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this virtual_k8s.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of virtual_k8s is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of virtual_k8s is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sPVCMetricData": { "type": "object", "description": "PVC Metric data contains the metric type and the corresponding metric value.", "title": "PVC Metric Data", "x-displayname": "PVC Metric Data.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.PVCMetricData", "properties": { "data": { "type": "array", "description": "List of metric data.", "title": "Data", "items": { "$ref": "#/components/schemas/virtual_k8sPVCMetricTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/virtual_k8sPVCMetricType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "PVC Metric data contains the metric type and the corresponding metric value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sPVCMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sPVCMetricLabel": { "type": "string", "description": "Labels in PVC metrics.", "title": "PVC Metric Label", "enum": [ "NAMESPACE", "PVC", "SITE" ], "default": "NAMESPACE", "x-displayname": "PVC Metric Label.", "x-ves-proto-enum": "ves.io.schema.virtual_k8s.PVCMetricLabel", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sPVCMetricLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NAMESPACE\"", "example_yaml": "NAMESPACE\n..." }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sPVCMetricType": { "type": "string", "description": "List of PVC metric types\n\nx-unit: \"bytes\"\nx-unit: \"bytes\"", "title": "PVC Metric Type", "enum": [ "PVC_USAGE", "PVC_CAPACITY" ], "default": "PVC_USAGE", "x-displayname": "PVC Metric Type.", "x-ves-proto-enum": "ves.io.schema.virtual_k8s.PVCMetricType", "x-f5xc-description-short": "List of PVC metric types x-unit: \"bytes\" x-unit: \"bytes\".", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sPVCMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PVC_USAGE\"", "example_yaml": "PVC_USAGE\n..." }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sPVCMetricTypeData": { "type": "object", "description": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.", "title": "PVC Metric Type Data", "x-displayname": "PVC Metric Type Data.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.PVCMetricTypeData", "properties": { "key": { "type": "object", "description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"PVCMetricLabel\"", "title": "Key", "x-displayname": "Key", "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"PVCMetricLabel\".", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "value": { "type": "array", "description": "List of metric values.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.", "x-f5xc-description-medium": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_k8sPVCMetricTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "container_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Virtual K8s clusters are tenant-scoped workload resources" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "per-tenant" } } }, "virtual_k8sPVCMetricsRequest": { "type": "object", "description": "Request to GET the metrics for PVC.", "title": "PVC Metrics Request", "x-displayname": "PVC Metrics Request.", "x-ves-proto-message": "ves.io.schema.virtual_k8s.PVCMetricsRequest", "properties": { "end_time": { "type": "string", "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 ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "field_selector": { "type": "array", "description": "Select fields to be returned in the response.\nOne or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.", "title": "Field Selector", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/virtual_k8sPVCMetricType" }, "x-displayname": "Field Selector.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.", "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "filter": { "type": "string", "description": "Filter is used to specify the list of matchers\nsyntax for filter := {[]}\n :=