@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0077.public.ves.io.schema.views.securemesh_site_v2.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.securemesh_site_v2","description":"Secure Mesh site defines a required parameters that can be used in CRUD, to create and manage an Secure Mesh site.","version":""},"paths":{"/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":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/securemesh_site_v2CreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-securemesh_site_v2-api-create"},"x-ves-proto-rpc":"ves.io.schema.views.securemesh_site_v2.API.Create"},"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":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\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"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/securemesh_site_v2ReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-securemesh_site_v2-api-replace"},"x-ves-proto-rpc":"ves.io.schema.views.securemesh_site_v2.API.Replace"},"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":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of securemesh_site_v2","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"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://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-securemesh_site_v2-api-list"},"x-ves-proto-rpc":"ves.io.schema.views.securemesh_site_v2.API.List"},"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":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"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 referrred 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://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-securemesh_site_v2-api-get"},"x-ves-proto-rpc":"ves.io.schema.views.securemesh_site_v2.API.Get"},"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":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/securemesh_site_v2DeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-securemesh_site_v2-api-delete"},"x-ves-proto-rpc":"ves.io.schema.views.securemesh_site_v2.API.Delete"},"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"}},"x-displayname":"Configure Secure Mesh Site","x-ves-proto-package":"ves.io.schema.views.securemesh_site_v2","components":{"schemas":{"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"network_type":{"$ref":"#/components/schemas/schemaVirtualNetworkType"},"ssh":{"$ref":"#/components/schemas/ioschemaEmpty"},"web_user_interface":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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_sevice":{"type":"array","description":"\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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\n\nExample: ` \"30\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 30\n","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"}}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"devices":{"type":"array","description":" Ethernet devices that will make up this bond\n\nExample: ` \"eth0\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 64\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","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"}},"lacp":{"$ref":"#/components/schemas/fleetBondLacpType"},"link_polling_interval":{"type":"integer","description":" Link polling interval in milliseconds\n\nExample: ` \"1000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 500\n  ves.io.schema.rules.uint32.lte: 5000\n","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"}},"link_up_delay":{"type":"integer","description":" Milliseconds wait before link is declared up\n\nExample: ` \"200\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 1000\n","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"}},"name":{"type":"string","description":" Name for the Bond. Ex 'bond0'\n\nExample: ` \"bond0\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n","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"}}}},"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"},"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)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","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"}}}},"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\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","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"}}}},"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 []\n Network Prefix to be used for IPV6 address auto configuration\n\nExample: ` \"2001::0/64\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6_prefix: true\n","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"}},"pool_settings":{"$ref":"#/components/schemas/network_interfaceDHCPPoolSettingType"},"pools":{"type":"array","description":" List of non overlapping ip address ranges.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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.\n In case of address allocator, offset is derived based on network prefix.\n\nExample: ` \"2001::200\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"End IP","x-displayname":"Ending IPV6","x-ves-example":"2001::200","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}},"start_ip":{"type":"string","description":" Starting IPV6 address of the pool range.\n In case of address allocator, offset is derived based on network prefix.\n 2001::1 with prefix length of 64, start offset is 5\n\nExample: ` \"2001::1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"Start IPV6","x-displayname":"Starting IPV6","x-ves-example":"2001::1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"automatic_from_start":{"$ref":"#/components/schemas/ioschemaEmpty"},"dhcp_networks":{"type":"array","description":" List of networks from which DHCP server can allocate ip addresses\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","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"}},"fixed_ip_map":{"type":"object","description":" Fixed MAC address to ipv6 assignments, Key: Mac address, Value: IPV6 Address\n Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.mac: true\n  ves.io.schema.rules.map.max_pairs: 128\n  ves.io.schema.rules.map.unique_values: true\n  ves.io.schema.rules.map.values.string.ipv6: true\n","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"}},"interface_ip_map":{"$ref":"#/components/schemas/network_interfaceDHCPInterfaceIPV6Type"}}},"network_interfaceDHCPInterfaceIPType":{"type":"object","description":"x-displayName: \"Interface IPv4 Assignments\"\nSpecify static IPv4 addresses per node.","title":"Interface IPv4 Assignments","properties":{"interface_ip_map":{"type":"object","description":"x-displayName: \"Site:Node to IPv4 Address Mapping\"\nx-example: \"value\"\nSpecify static IPv4 addresses per site:node.","title":"Site:Node to IP mapping"}}},"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.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 64\n  ves.io.schema.rules.map.values.string.ipv6: true\n","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"}}}},"network_interfaceDHCPNetworkType":{"type":"object","description":"x-displayName: \"DHCP Network\"\nDHCP network configuration","title":"DHCP Network","properties":{"dgw_address":{"type":"string","description":"x-displayName: \"Static IPv4 Configuration\"\nx-example: \"10.1.1.10\"\nEnter a IPv4 address from the network prefix to be used as the default gateway.","title":"Configured Address"},"dns_address":{"type":"string","description":"x-displayName: \"Static IPv4 Configuration\"\nx-example: \"10.1.1.11\"\nEnter a IPv4 address from the network prefix to be used as the DNS server.","title":"Configured Address"},"first_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"last_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"network_prefix":{"type":"string","description":"x-displayName: \"Network Prefix\"\nx-example: \"10.1.1.0/24\"\nSet the network prefix for the site. ex: 10.1.1.0/24","title":"Network Prefix"},"network_prefix_allocator":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"pool_settings":{"$ref":"#/components/schemas/network_interfaceDHCPPoolSettingType"},"pools":{"type":"array","description":"x-displayName: \"DHCP Pools\"\nList of non overlapping ip address ranges.","title":"DHCP pools","items":{"$ref":"#/components/schemas/network_interfaceDHCPPoolType"}},"same_as_dgw":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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"},"network_interfaceDHCPPoolType":{"type":"object","description":"x-displayName: \"DHCP IP Range\"\nDHCP pool is a range of IP addresses (start ip and end ip).","title":"DHCP IP Range","properties":{"end_ip":{"type":"string","description":"x-displayName: \"Ending IP\"\nx-example: \"10.1.1.200\"\nEnding IP of the pool range.\nIn case of address allocator, offset is derived based on network prefix.\n10.1.1.200 with prefix length of 24, end offset is 0.0.0.200","title":"End IP"},"exclude":{"type":"boolean","description":"x-displayName: \"Exclude\"\nIf exclude is true, IP addresses are not assigned from this range.","title":"Exclude","format":"boolean"},"start_ip":{"type":"string","description":"x-displayName: \"Starting IP\"\nx-example: \"10.1.1.5\"\nStarting IP of the pool range.\nIn case of address allocator, offset is derived based on network prefix.\n10.1.1.5 with prefix length of 24, start offset is 0.0.0.5","title":"Start IP"}}},"network_interfaceDHCPServerParametersType":{"type":"object","description":"x-displayName: \"DHCPServerParametersType\"","title":"DHCPServerParametersType","properties":{"automatic_from_end":{"$ref":"#/components/schemas/ioschemaEmpty"},"automatic_from_start":{"$ref":"#/components/schemas/ioschemaEmpty"},"dhcp_networks":{"type":"array","description":"x-displayName: \"DHCP Networks\"\nx-required\nList of networks from which DHCP Server can allocate IPv4 Addresses","title":"DHCP Networks","items":{"$ref":"#/components/schemas/network_interfaceDHCPNetworkType"}},"dhcp_option82_tag":{"type":"string","description":"x-displayName: \"Option 82 Tag\"\nx-example: \"network_red\"\nOptional tag that can be given to this configuration","title":"Option 82 Tag"},"fixed_ip_map":{"type":"object","description":"x-displayName: \"Fixed MAC Address to IPv4 Assignments\"\nx-example: \"value\"\nAssign fixed IPv4 addresses based on the MAC Address of the DHCP Client.","title":"Fixed IP Assignments"},"interface_ip_map":{"$ref":"#/components/schemas/network_interfaceDHCPInterfaceIPType"}}},"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":{"$ref":"#/components/schemas/network_interfaceIPV6DnsConfig"},"network_prefix":{"type":"string","description":"Exclusive with [stateful]\n Nework prefix that is used as Prefix information\n Allowed only /64 prefix length as per RFC 4862\n\nExample: ` \"2001::0/64\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6_prefix: true\n  ves.io.schema.rules.string.pattern: .*::/64$\n","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$"}},"stateful":{"$ref":"#/components/schemas/network_interfaceDHCPIPV6StatefulServer"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"router":{"$ref":"#/components/schemas/network_interfaceIPV6AutoConfigRouterType"}}},"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":{"$ref":"#/components/schemas/network_interfaceIPV6DnsList"},"local_dns":{"$ref":"#/components/schemas/network_interfaceIPV6LocalDnsAddress"}}},"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\n\nExample: ` \"2001::11\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.ipv6: true\n","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"}}}},"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]\n Configured address from the network prefix is chosen as dns server\n\nExample: ` \"2001::10\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"Configured Address","x-displayname":"Configured Address","x-ves-example":"2001::10","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}},"first_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"last_address":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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"},"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":{"$ref":"#/components/schemas/network_interfaceStaticIpParametersClusterType"},"node_static_ip":{"$ref":"#/components/schemas/network_interfaceStaticIpParametersNodeType"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 128\n","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"}}}},"network_interfaceStaticIpParametersFleetType":{"type":"object","description":"x-displayName: \"Fleet: Static IP Parameters\"\nConfigure Static IP parameters","title":"Static IP Parameters","properties":{"default_gw":{"type":"string","description":"x-displayName: \"Default Gateway\"\nx-example: \"192.168.20.1\"\nIP address offset of the default gateway, prefix len is used to calculate offset","title":"Default Gateway"},"dns_server":{"type":"string","description":"x-displayName: \"DNS Server\"\nx-example: \"192.168.20.1\"\nIP address offset of the DNS server, prefix len is used to calculate offset","title":"DNS Server"},"network_prefix_allocator":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"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.\n\nExample: ` \"192.168.20.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n","title":"Default Gateway","x-displayname":"Default Gateway","x-ves-example":"192.168.20.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true"}},"ip_address":{"type":"string","description":" IP address of the interface and prefix length\n\nExample: ` \"192.168.20.1/24\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ip_prefix: true\n","title":"Default Gateway","x-displayname":"IP address/Prefix Length","x-ves-example":"192.168.20.1/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ip_prefix":"true"}}}},"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\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if 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.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\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\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\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][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking 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."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"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.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","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"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"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\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","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"}}}},"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"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. 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\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","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\\\"]"}},"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\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"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"},"schemaErrorType":{"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":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"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"}}},"schemaInitializersType":{"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.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"Interface","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Interface","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"node":{"type":"string","description":" Node name on this site\n\nExample: ` \"master-0\"`","title":"Node","x-displayname":"Node","x-ves-example":"master-0"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 8\n","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"}}}},"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\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"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\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"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\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"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\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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"},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"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":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaSiteToSiteTunnelType":{"type":"string","description":"Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being prefered 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"},"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\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"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"}}},"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"},"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.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"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\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients 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"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"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\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"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\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"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"},"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 conects 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 Neworks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nfor volterra 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 volterra 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","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"],"default":"VIRTUAL_NETWORK_SITE_LOCAL","x-displayname":"Virtual Network Type","x-ves-proto-enum":"ves.io.schema.VirtualNetworkType"},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemaviewsCloudSubnetParamType":{"type":"object","description":"x-displayName: \"New Cloud Subnet Parameters\"\nParameters for creating a new cloud subnet","title":"Cloud Subnet Param","properties":{"ipv4":{"type":"string","description":"x-displayName: \"IPv4 Subnet\"\nx-required\nx-example: \"10.1.2.0/24\"\nIPv4 subnet prefix for this subnet","title":"IPv4 Subnet"},"ipv6":{"type":"string","description":"x-displayName: \"IPv6 Subnet\"\nx-example: \"1234:568:abcd:9100::/64\"\nIPv6 subnet prefix for this subnet","title":"IPv6 Subnet"}}},"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)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","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"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"securemesh_site_v2AWSCloudSubnetParamType":{"type":"object","description":"x-displayName: \"New Cloud Subnet Parameters\"\nParameters for creating a new cloud subnet","title":"Cloud Subnet Param","properties":{"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"ipv4":{"type":"string","description":"x-displayName: \"IPv4 Subnet\"\nx-required\nx-example: \"10.1.2.0/24\"\nIPv4 subnet prefix for this subnet","title":"IPv4 Subnet"},"ipv6":{"type":"string","description":"x-displayName: \"IPv6 Subnet\"\nx-example: \"1234:568:abcd:9100::/64\"\nIPv6 subnet prefix for this subnet","title":"IPv6 Subnet"},"name":{"type":"string","description":"x-displayName: \"Choose Subnet Name\"\nSpecify the Subnet Name","title":"name"}}},"securemesh_site_v2AWSManagedMode":{"type":"object","description":"x-displayName: \"Managed By F5XC\"\nF5 Distributed Cloud will automate provisioning (ex: node bringup) for this AWS site.","title":"AWSManagedMode","properties":{"aws_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"aws_region":{"type":"string","description":"x-displayName: \"AWS Region\"\nx-example: \"us-east-1\"\nx-required\nAWS Region of your services vpc, where F5XC site will be deployed.","title":"AWS Region"},"custom_security_group":{"$ref":"#/components/schemas/viewsSecurityGroupType"},"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"disk_size":{"type":"integer","description":"x-displayName: \"Node Disk Size\"\nx-example: \"80\"\nNode disk size for all node in the F5XC site. Unit is GiB","title":"Node Disk size","format":"int64"},"egress_gateway_default":{"$ref":"#/components/schemas/ioschemaEmpty"},"egress_nat_gw":{"$ref":"#/components/schemas/viewsAWSNATGatewaychoiceType"},"egress_virtual_private_gateway":{"$ref":"#/components/schemas/viewsAWSVirtualPrivateGatewaychoiceType"},"f5xc_security_group":{"$ref":"#/components/schemas/ioschemaEmpty"},"instance_type":{"type":"string","description":"x-displayName: \"AWS Instance Type for Node\"\nx-example: \"a1.xlarge\"\nx-required\nInstance size based on the performance.","title":"AWS Instance Type"},"multiple_interface":{"$ref":"#/components/schemas/securemesh_site_v2MultipleInterface"},"new_vpc":{"$ref":"#/components/schemas/viewsAWSVPCParamsType"},"private_connectivity":{"$ref":"#/components/schemas/viewsPrivateConnectConfigType"},"private_connectivity_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"single_interface":{"$ref":"#/components/schemas/securemesh_site_v2SingleInterface"},"tags":{"type":"object","description":"x-displayName: \"AWS Tags\"\nx-example: \"dev: staging\"\nAWS 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.","title":"AWS Tags"},"tgw":{"$ref":"#/components/schemas/securemesh_site_v2TGWType"},"vpc_id":{"type":"string","description":"x-displayName: \"Existing VPC ID\"\nx-example: \"vpc-12345678901234567\"\nExisting VPC ID","title":"Existing VPC ID"}}},"securemesh_site_v2AWSManagedNode":{"type":"object","description":"x-displayName: \"Nodes\"\nThis section will show nodes associated with this site.","title":"AWSManagedNode","properties":{"aws_az_name":{"type":"string","description":"x-displayName: \"AWS AZ Name\"\nx-required\nx-example: \"us-west-2a\"\nAWS availability zone, must be consistent with the selected AWS region.","title":"AWS AZ"},"hostname":{"type":"string","description":"x-displayName: \"Hostname\"\nHostname for this Node","title":"Hostname"},"interface_list":{"type":"array","description":"x-displayName: \"Interfaces\"\nx-required\nInterfaces belonging to this node","title":"AWSOrchestratedInterface","items":{"$ref":"#/components/schemas/securemesh_site_v2AWSOrchestratedInterface"}},"type":{"type":"string","description":"x-displayName: \"Type\"\nx-required\nx-example: \"Control\"\nType for this Node, can be Control","title":"Type"}}},"securemesh_site_v2AWSManagedNodeList":{"type":"object","description":"x-displayName: \"List of Nodes\"\nThis section will show nodes associated with this site.","title":"AWSManagedNodeList","properties":{"node_list":{"type":"array","description":"x-displayName: \"Nodes\"\nx-required\nThis section will show nodes associated with this site.","title":"Nodes","items":{"$ref":"#/components/schemas/securemesh_site_v2AWSManagedNode"}}}},"securemesh_site_v2AWSOrchestratedInterface":{"type":"object","description":"x-displayName: \"Interfaces\"\nInterfaces belonging to this node","title":"AWSOrchestratedInterface","properties":{"mtu":{"type":"integer","description":"x-displayName: \"Maximum Packet Size (MTU)\"\nx-example: \"1450\"\nMaximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, mtu must be between 512 and 16384","title":"Maximum Packet Size (MTU)","format":"int64"},"network_option":{"$ref":"#/components/schemas/viewsNetworkSelectType"},"site_to_site_connectivity_interface_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_to_site_connectivity_interface_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"subnet":{"$ref":"#/components/schemas/securemesh_site_v2AWSSubnetChoiceType"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"securemesh_site_v2AWSSubnetChoiceType":{"type":"object","description":"x-displayName: \"AWS Subnet\"\nParameters for subnet","title":"AWS Subnet","properties":{"existing_subnet_id":{"type":"string","description":"x-displayName: \"Existing Subnet ID\"\nx-example: \"subnet-12345678901234567\"\nInformation about existing subnet ID","title":"Existing Subnet ID"},"subnet_param":{"$ref":"#/components/schemas/securemesh_site_v2AWSCloudSubnetParamType"}}},"securemesh_site_v2AzureManagedMode":{"type":"object","description":"x-displayName: \"Managed By F5XC\"\nF5 Distributed Cloud will automate provisioning (ex: node bringup) for this Azure site.","title":"AzureManagedMode","properties":{"accelerated_networking":{"$ref":"#/components/schemas/viewsAcceleratedNetworkingType"},"azure_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"azure_region":{"type":"string","description":"x-displayName: \"Recommended Azure Region Name\"\nx-example: \"eastus\"\nx-required\nName of the azure region which supports availability zones.","title":"Recommended Azure Region Name"},"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"disk_size":{"type":"integer","description":"x-displayName: \"Cloud Disk Size\"\nx-example: \"80\"\nDisk size to be used for this instance in GiB. 80 is 80 GiB","title":"Cloud Disk size","format":"int64"},"enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"machine_type":{"type":"string","description":"x-displayName: \"Azure Machine Type for Node\"\nx-example: \"Standard_D3_v2\"\nx-required\nSelect 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.","title":"Machine Type"},"multiple_interface":{"$ref":"#/components/schemas/securemesh_site_v2AzureMultipleInterface"},"resource_group":{"type":"string","description":"x-displayName: \"Resource Group\"\nx-example: \"my-resources\"\nx-required\nAzure resource group for resources that will be created","title":"Resource Group"},"single_interface":{"$ref":"#/components/schemas/securemesh_site_v2AzureSingleInterface"},"tags":{"type":"object","description":"x-displayName: \"Azure Tags\"\nx-example: \"dev: staging\"\nAzure 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.","title":"Azure Tags"},"vnet":{"$ref":"#/components/schemas/viewsAzureVnetChoiceType"}}},"securemesh_site_v2AzureManagedNode":{"type":"object","description":"x-displayName: \"Nodes\"\nThis section will show nodes associated with this site.","title":"AzureManagedNode","properties":{"azure_az":{"type":"string","description":"x-displayName: \"Azure Availability Zone\"\nx-required\nx-example: \"1\"\nA zone depicting a grouping of datacenters within an Azure region. Expecting numeric input","title":"Azure AZ"},"hostname":{"type":"string","description":"x-displayName: \"Hostname\"\nHostname for this Node","title":"Hostname"},"interface_list":{"type":"array","description":"x-displayName: \"Interfaces\"\nx-required\nInterfaces belonging to this node","title":"AzureOrchestratedInterface","items":{"$ref":"#/components/schemas/securemesh_site_v2AzureOrchestratedInterface"}},"type":{"type":"string","description":"x-displayName: \"Type\"\nx-required\nx-example: \"Control\"\nType for this Node, can be Control","title":"Type"}}},"securemesh_site_v2AzureManagedNodeList":{"type":"object","description":"x-displayName: \"List of Nodes\"\nThis section will show nodes associated with this site.","title":"AzureManagedNodeList","properties":{"node_list":{"type":"array","description":"x-displayName: \"Nodes\"\nx-required\nThis section will show nodes associated with this site.","title":"Nodes","items":{"$ref":"#/components/schemas/securemesh_site_v2AzureManagedNode"}}}},"securemesh_site_v2AzureMultipleInterface":{"type":"object","description":"x-displayName: \"Multiple Interface\"\nMultiple interface site is useful when site is used as ingress/egress gateway to the VNET.","title":"Multiple Interface Site","properties":{"node_list":{"$ref":"#/components/schemas/securemesh_site_v2AzureManagedNodeList"}}},"securemesh_site_v2AzureOrchestratedInterface":{"type":"object","description":"x-displayName: \"Interfaces\"\nInterfaces belonging to this node","title":"AzureOrchestratedInterface","properties":{"mtu":{"type":"integer","description":"x-displayName: \"Maximum Packet Size (MTU)\"\nx-example: \"1450\"\nMaximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, mtu must be between 512 and 16384","title":"Maximum Packet Size (MTU)","format":"int64"},"network_option":{"$ref":"#/components/schemas/viewsNetworkSelectType"},"site_to_site_connectivity_interface_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_to_site_connectivity_interface_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"subnet":{"$ref":"#/components/schemas/viewssecuremesh_site_v2AzureSubnetChoiceType"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"securemesh_site_v2AzureSingleInterface":{"type":"object","description":"x-displayName: \"One Interface\"\nOne interface site is useful when site is only used as ingress gateway to the VNET.","title":"One Interface","properties":{"node_list":{"$ref":"#/components/schemas/securemesh_site_v2AzureManagedNodeList"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"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":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/viewssecuremesh_site_v2CreateSpecType"}}},"securemesh_site_v2CreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.securemesh_site_v2.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/viewssecuremesh_site_v2GetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_re_tunnel":{"$ref":"#/components/schemas/ioschemaEmpty"},"password":{"$ref":"#/components/schemas/schemaSecretType"},"proxy_ip_address":{"type":"string","description":" Specify the IPv4 Address of the internal Enterprise Proxy\n\nExample: ` \"123.234.0.1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ipv4: true\n","title":"Proxy IPv4 Address","x-displayname":"Proxy IPv4 Address","x-ves-example":"123.234.0.1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4":"true"}},"proxy_port":{"type":"integer","description":" Specify the Port of the internal Enterprise Proxy\n\nExample: ` 443`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","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"}},"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"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.hostname_or_ip: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2CustomDNSSettings"},"custom_ntp":{"$ref":"#/components/schemas/securemesh_site_v2CustomNTPSettings"},"f5_dns_default":{"$ref":"#/components/schemas/ioschemaEmpty"},"f5_ntp_default":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"securemesh_site_v2GCPCloudSubnetParamType":{"type":"object","description":"x-displayName: \"New Cloud Subnet Parameters\"\nParameters for creating a new cloud subnet","title":"Cloud Subnet Param","properties":{"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"ipv4":{"type":"string","description":"x-displayName: \"IPv4 Subnet Prefix\"\nx-required\nx-example: \"10.1.0.0/16\"\nEnter an IPv4 prefix for this subnet. The IP address must be in a private address space.","title":"IPv4 CIDR block"},"name":{"type":"string","description":"x-displayName: \"User Specified Subnet Name\"\nThis options allows you to enter subnet name.","title":"name"}}},"securemesh_site_v2GCPCloudVPCParamsType":{"type":"object","description":"x-displayName: \"GCP VPC Parameters\"\nParameters to create new GCP VPC","title":"GCP VPC Parameters","properties":{"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"name_tag":{"type":"string","description":"x-displayName: \"User Specified Name\"\nWith this option, user can specify a unique name for VPC.","title":"name_tag"}}},"securemesh_site_v2GCPManagedMode":{"type":"object","description":"x-displayName: \"Managed By F5XC\"\nF5 Distributed Cloud will automate all provisioning (ex: node bringup, cloud route table addition) for this site.","title":"GCPManagedMode","properties":{"disk_size":{"type":"integer","description":"x-displayName: \"Node Disk Size\"\nx-example: \"80\"\nSelect the disk size of the node. The default value is 80GB.","title":"Node Disk size","format":"int64"},"gcp_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"gcp_region":{"type":"string","description":"x-displayName: \"GCP Region\"\nx-example: \"us-east-1\"\nx-required\nSelect the GCP Region where you want to deploy F5 Distributed Cloud Customer Edge site.","title":"GCP Region"},"instance_type":{"type":"string","description":"x-displayName: \"GCP Instance Type\"\nx-example: \"a1.xlarge\"\nx-required\nSelect the GCP instance type for deploying nodes of CE (customer edge) site.","title":"GCP Instance Type"},"multiple_interface":{"$ref":"#/components/schemas/securemesh_site_v2GCPMultipleInterface"},"private_connectivity":{"$ref":"#/components/schemas/viewsPrivateConnectConfigType"},"private_connectivity_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"single_interface":{"$ref":"#/components/schemas/securemesh_site_v2GCPSingleInterface"},"tags":{"type":"object","description":"x-displayName: \"GCP Tags\"\nx-example: \"dev: staging\"\nGCP Tags 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.","title":"GCP Tags"}}},"securemesh_site_v2GCPManagedNode":{"type":"object","description":"x-displayName: \"Nodes\"\nThis section will show nodes associated with this site.","title":"GCPManagedNode","properties":{"gcp_az_name":{"type":"string","description":"x-displayName: \"GCP Availability Zone\"\nx-required\nx-example: \"us-west-2a\"\nSelect the GCP availability zone. This must be consistent with the selected GCP region.","title":"GCP AZ"},"hostname":{"type":"string","description":"x-displayName: \"Hostname\"\nHostname for this Node","title":"Hostname"},"interface_list":{"type":"array","description":"x-displayName: \"Interfaces\"\nx-required\nConfigure Interfaces for this node","title":"GCPOrchestratedInterface","items":{"$ref":"#/components/schemas/securemesh_site_v2GCPOrchestratedInterface"}}}},"securemesh_site_v2GCPManagedNodeList":{"type":"object","description":"x-displayName: \"List of Nodes\"\nThis section will show nodes associated with this site.","title":"GCPManagedNodeList","properties":{"node_list":{"type":"array","description":"x-displayName: \"Nodes\"\nx-required\nThis section will show nodes associated with this site.","title":"Nodes","items":{"$ref":"#/components/schemas/securemesh_site_v2GCPManagedNode"}}}},"securemesh_site_v2GCPMultipleInterface":{"type":"object","description":"x-displayName: \"Multiple Interfaces\"\nThis option deploys the CE (Customer Edge) Site as an ingress/egress gateway.","title":"Multiple Interface Site","properties":{"node_list":{"$ref":"#/components/schemas/securemesh_site_v2GCPManagedNodeList"}}},"securemesh_site_v2GCPOrchestratedInterface":{"type":"object","description":"x-displayName: \"Interfaces\"\nInterfaces belonging to this node","title":"GCPOrchestratedInterface","properties":{"mtu":{"type":"integer","description":"x-displayName: \"Maximum Packet Size (MTU)\"\nx-example: \"1450\"\nMaximum packet size (Maximum Transfer Unit) of the interface\nWhen configured, mtu must be between 512 and 16384","title":"Maximum Packet Size (MTU)","format":"int64"},"network_option":{"$ref":"#/components/schemas/viewsNetworkSelectType"},"site_to_site_connectivity_interface_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_to_site_connectivity_interface_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"subnet":{"$ref":"#/components/schemas/securemesh_site_v2GCPSubnetChoiceType"},"vpc":{"$ref":"#/components/schemas/securemesh_site_v2GCPVPCChoiceType"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"securemesh_site_v2GCPSingleInterface":{"type":"object","description":"x-displayName: \"One Interface\"\nThis option deploys the CE (Customer Edge) Site as an ingress gateway.","title":"One Interface","properties":{"node_list":{"$ref":"#/components/schemas/securemesh_site_v2GCPManagedNodeList"}}},"securemesh_site_v2GCPSubnetChoiceType":{"type":"object","description":"x-displayName: \"GCP Subnet\"\nParameters for subnet","title":"GCP Subnet","properties":{"existing_subnet_id":{"type":"string","description":"x-displayName: \"Existing Subnet ID\"\nx-example: \"subnet-12345678901234567\"\nSelect this option when you want to use an existing subnet","title":"Existing Subnet ID"},"subnet_param":{"$ref":"#/components/schemas/securemesh_site_v2GCPCloudSubnetParamType"}}},"securemesh_site_v2GCPVPCChoiceType":{"type":"object","description":"x-displayName: \"GCP VPC\"\nParameters for VPC","title":"GCP VPC","properties":{"existing_vpc_id":{"type":"string","description":"x-displayName: \"Existing VPC ID\"\nx-example: \"inside-12345678901234567\"\nSelect this option when you want to use an existing VPC.","title":"Existing VPC ID"},"new_vpc":{"$ref":"#/components/schemas/securemesh_site_v2GCPCloudVPCParamsType"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2CreateRequest"},"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"},"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"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"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"},"replace_form":{"$ref":"#/components/schemas/securemesh_site_v2ReplaceRequest"},"spec":{"$ref":"#/components/schemas/viewssecuremesh_site_v2GetSpecType"},"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"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"securemesh_site_v2GetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","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"},"securemesh_site_v2Interface":{"type":"object","description":"Interface definition","title":"Interface","x-displayname":"Interface","x-ves-oneof-field-address_choice":"[\"dhcp_client\",\"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":{"$ref":"#/components/schemas/fleetFleetBondDeviceType"},"description":{"type":"string","description":" Description for this Interface\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","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"}},"dhcp_client":{"$ref":"#/components/schemas/ioschemaEmpty"},"ethernet_interface":{"$ref":"#/components/schemas/viewssecuremesh_site_v2EthernetInterfaceType"},"ipv6_auto_config":{"$ref":"#/components/schemas/network_interfaceIPV6AutoConfigType"},"labels":{"type":"object","description":" Add Labels for this Interface, these labels can be used in firewall policy\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 16\n  ves.io.schema.rules.map.values.string.max_len: 64\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"monitor":{"$ref":"#/components/schemas/network_interfaceLinkQualityMonitorConfig"},"monitor_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtu":{"type":"integer","description":" Maximum packet size (Maximum Transfer Unit) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"1450\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","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"}},"name":{"type":"string","description":" Name of this Interface\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","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"}},"network_option":{"$ref":"#/components/schemas/viewsNetworkSelectType"},"no_ipv4_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_ipv6_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"priority":{"type":"integer","description":" For a node, if multiple interfaces are configured in a VRF, interfaces with highest priority will be used as active\n and interfaces with lower priority will be used as backup.\n If multiple interfaces have the same priority, ECMP will be used.\n Greater the value, higher the priority\n\nExample: ` \"42\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","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"}},"site_to_site_connectivity_interface_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_to_site_connectivity_interface_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_ip":{"$ref":"#/components/schemas/network_interfaceStaticIpParametersNodeType"},"static_ipv6_address":{"$ref":"#/components/schemas/network_interfaceStaticIPParametersType"},"vlan_interface":{"$ref":"#/components/schemas/securemesh_site_v2VlanInterfaceType"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"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"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/securemesh_site_v2ListResponseItem"},"x-displayname":"Items"}}},"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"},"description":{"type":"string","description":" The description set for this securemesh_site_v2","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates securemesh_site_v2 is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/viewssecuremesh_site_v2GetSpecType"},"labels":{"type":"object","description":" The set of labels present on this securemesh_site_v2","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this securemesh_site_v2\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"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"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this securemesh_site_v2\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"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":{"$ref":"#/components/schemas/schemaVipVrrpType"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_sli_config":{"$ref":"#/components/schemas/ioschemaEmpty"},"sli_config":{"$ref":"#/components/schemas/securemesh_site_v2VirtualNetworkConfiguration"},"slo_config":{"$ref":"#/components/schemas/securemesh_site_v2VirtualNetworkConfiguration"}}},"securemesh_site_v2MultipleInterface":{"type":"object","description":"x-displayName: \"Multiple Interface\"\nMultiple interface site is useful when site is used as ingress/egress gateway to the VPC.","title":"Multiple Interface Site","properties":{"node_list":{"$ref":"#/components/schemas/securemesh_site_v2AWSManagedNodeList"}}},"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.\n Once a node is created and registers with the site, it will be shown in this section.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"securemesh_site_v2RSeriesProviderType":{"type":"object","description":"x-displayName: \"RSeries Provider Type\"\nRSeries Provider Type","title":"RSeries Provider Type","properties":{"not_managed":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"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":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/viewssecuremesh_site_v2ReplaceSpecType"}}},"securemesh_site_v2ReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.securemesh_site_v2.ReplaceResponse"},"securemesh_site_v2SegmentNetworkConfiguration":{"type":"object","description":"x-displayName: \"Segment Network Configuration\"\nSegment Network Configuration","title":"Segment Network Configuration","properties":{"nameserver":{"type":"string","description":"x-displayName: \"DNS V4 Server\"\nx-example: \"10.1.1.1\"\nOptional DNS V4 server IP to be used for name resolution","title":"nameserver"},"nameserver_v6":{"type":"string","description":"x-displayName: \"DNS V6 Server\"\nx-example: \"1001::1\"\nOptional DNS V6 server IP to be used for name resolution","title":"nameserver_v6"},"no_static_routes":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_v6_static_routes":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_routes":{"$ref":"#/components/schemas/securemesh_site_v2StaticRoutesListType"},"static_v6_routes":{"$ref":"#/components/schemas/virtual_networkStaticV6RoutesListType"}}},"securemesh_site_v2SegmentVRFSettingType":{"type":"object","description":"x-displayName: \"Segment VRF Settings\"\nThe 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","properties":{"segment_config":{"$ref":"#/components/schemas/securemesh_site_v2SegmentNetworkConfiguration"},"segment_network":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"securemesh_site_v2SingleInterface":{"type":"object","description":"x-displayName: \"One Interface\"\nOne interface site is useful when site is only used as ingress gateway to the VPC.","title":"One Interface","properties":{"node_list":{"$ref":"#/components/schemas/securemesh_site_v2AWSManagedNodeList"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_mesh_group":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"sm_connection_public_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"sm_connection_pvt_ip":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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":{"$ref":"#/components/schemas/viewsOperatingSystemType"},"sw":{"$ref":"#/components/schemas/viewsVolterraSoftwareType"}}},"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":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}},"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"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" F5XC Secure Mesh Site object direct reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"securemesh_site_v2TGWType":{"type":"object","description":"x-displayName: \"Transit Gateway Configuration\"\nConfigure Transit Gateway to be used with Cloud Connect","title":"Transit Gateway for Cloud Connect","properties":{"existing_tgw":{"$ref":"#/components/schemas/viewsExistingTGWType"},"new_tgw":{"$ref":"#/components/schemas/viewsTGWParamsType"},"reserved_tgw_cidr":{"$ref":"#/components/schemas/ioschemaEmpty"},"tgw_cidr":{"$ref":"#/components/schemas/schemaviewsCloudSubnetParamType"}}},"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":{"$ref":"#/components/schemas/viewsKubernetesUpgradeDrain"}}},"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":{"$ref":"#/components/schemas/securemesh_site_v2NodeList"}}},"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\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 16\n  ves.io.schema.rules.map.values.string.max_len: 64\n  ves.io.schema.rules.map.values.string.min_len: 1\n","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"}},"nameserver":{"type":"string","description":" Optional DNS V4 server IP to be used for name resolution\n\nExample: ` \"10.1.1.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"nameserver","x-displayname":"DNS V4 Server","x-ves-example":"10.1.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"no_static_routes":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_v6_static_routes":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_routes":{"$ref":"#/components/schemas/securemesh_site_v2StaticRoutesListType"},"static_v6_routes":{"$ref":"#/components/schemas/virtual_networkStaticV6RoutesListType"},"vip":{"type":"string","description":" Optional common virtual V4 IP across all nodes to be used as automatic VIP.\n\nExample: ` \"10.1.1.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Common V4 VIP","x-displayname":"Common V4 VIP","x-ves-example":"10.1.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"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.\n\nExample: ` \"eth0\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","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"}},"vlan_id":{"type":"integer","description":" Configure the VLAN tag for this interface.\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 4095\n","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"}}}},"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.","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"],"default":"ONLINE","x-displayname":"Site State","x-ves-proto-enum":"ves.io.schema.site.SiteState"},"viewsAWSNATGatewaychoiceType":{"type":"object","description":"x-displayName: \"AWS NAT Gateway choice\"\nWith this option, egress site traffic will be routed through an Network Address Translation(NAT) Gateway.","title":"AWS NAT Gateway choice","properties":{"nat_gw_id":{"type":"string","description":"x-displayName: \"Existing NAT Gateway ID\"","title":"AWS existing NAT Gateway ID"}}},"viewsAWSVPCParamsType":{"type":"object","description":"x-displayName: \"AWS VPC Parameters\"\nParameters to create new AWS VPC","title":"AWS VPC Parameters","properties":{"allocate_ipv6":{"type":"boolean","description":"x-displayName: \"Allocate IPv6 CIDR block from AWS\"\nAllocate IPv6 CIDR block from AWS","title":"Allocate IPv6 CIDR block","format":"boolean"},"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"name_tag":{"type":"string","description":"x-displayName: \"Choose VPC Name\"\nSpecify the VPC Name","title":"name_tag"},"primary_ipv4":{"type":"string","description":"x-displayName: \"Primary IPv4 CIDR block\"\nx-required\nx-example: \"10.1.0.0/16\"\nIPv4 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"}}},"viewsAWSVirtualPrivateGatewaychoiceType":{"type":"object","description":"x-displayName: \"AWS Virtual Private Gateway choice\"\nWith this option, egress site traffic will be routed through an Virtual Private Gateway.","title":"AWS Virtual Private Gateway choice","properties":{"vgw_id":{"type":"string","description":"x-displayName: \"Existing Virtual Private Gateway ID\"","title":"AWS existing Virtual Private Gateway ID"}}},"viewsAcceleratedNetworkingType":{"type":"object","description":"x-displayName: \"Accelerated Networking Type\"\nx-required\nAccelerated Networking to reduce Latency, When Mode is toggled, traffic\ndisruption will be seen","title":"Accelerated Networking Type","properties":{"disable":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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":{"$ref":"#/components/schemas/schemaSecretType"},"ssh_key":{"type":"string","description":" Provided Public SSH key can be used for accessing nodes of the site.\n When provided, customers can ssh to the nodes of this Customer Edge site using admin as the user.\n\nExample: ` \"ssh-rsa AAAAB...\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8192\n","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"}}}},"viewsAzureVnetChoiceType":{"type":"object","description":"x-displayName: \"Azure Vnet choice\"\nThis defines choice about Azure Vnet for a view","title":"Azure Vnet choice","properties":{"existing_vnet":{"$ref":"#/components/schemas/viewsAzureVnetType"},"new_vnet":{"$ref":"#/components/schemas/viewsAzureVnetParamsType"}}},"viewsAzureVnetParamsType":{"type":"object","description":"x-displayName: \"Azure Vnet Parameters\"\nParameters to create a new Azure Vnet","title":"Azure Vnet Parameters","properties":{"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"name":{"type":"string","description":"x-displayName: \"Choose Vnet Name\"\nSpecify the Vnet Name","title":"name"},"primary_ipv4":{"type":"string","description":"x-displayName: \"IPv4 CIDR block\"\nx-required\nx-example: \"10.1.0.0/16\"\nIPv4 CIDR block for this Vnet. It has to be private address space.","title":"IPv4 CIDR block"}}},"viewsAzureVnetType":{"type":"object","description":"x-displayName: \"Azure Existing Vnet Type\"\nResource group and name of existing Azure Vnet","title":"Azure Existing Vnet Type","properties":{"f5_orchestrated_routing":{"$ref":"#/components/schemas/ioschemaEmpty"},"manual_routing":{"$ref":"#/components/schemas/ioschemaEmpty"},"resource_group":{"type":"string","description":"x-displayName: \"Existing Vnet Resource Group\"\nx-required\nx-example: \"MyResourceGroup\"\nResource group of existing Vnet","title":"Existing Vnet Resource Group"},"vnet_name":{"type":"string","description":"x-displayName: \"Existing Vnet Name\"\nx-required\nx-example: \"MyVnet\"\nName of existing Vnet","title":"Existing Vnet Name"}}},"viewsExistingTGWType":{"type":"object","description":"x-displayName: \"Existing TGW Type\"\nInformation needed for existing TGW","title":"Existing TGW Type","properties":{"tgw_asn":{"type":"integer","description":"x-displayName: \"Enter TGW ASN\"\nx-example: \"64500\"\nTGW ASN.","title":"TGW ASN","format":"int64"},"tgw_id":{"type":"string","description":"x-displayName: \"Existing TGW ID\"\nx-example: \"tgw-12345678901234567\"\nExisting TGW ID","title":"Existing TGW ID"},"volterra_site_asn":{"type":"integer","description":"x-displayName: \"Enter F5XC Site ASN\"\nx-example: \"64501\"\nF5XC Site ASN.","title":"F5XC Site ASN","format":"int64"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_upgrade_drain":{"$ref":"#/components/schemas/viewsKubernetesUpgradeDrainConfig"}}},"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\"]","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":{"$ref":"#/components/schemas/ioschemaEmpty"},"drain_max_unavailable_node_count":{"type":"integer","description":"Exclusive with []\n\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 5000\n","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"}},"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).\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 900\n","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"}},"enable_vega_upgrade_mode":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsL3PerformanceEnhancementType":{"type":"object","description":"x-required\nL3 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":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_jumbo":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsNetworkSelectType":{"type":"object","description":"x-required\nSelect 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 multple 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":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local_network":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_offline_survivability_mode":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"operating_system_version":{"type":"string","description":"Exclusive with [default_os_version]\n Specify a OS version to be used e.g. 9.2024.6.\n\nExample: ` \"9.2024.6\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 20\n","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"}}}},"viewsPerformanceEnhancementModeType":{"type":"object","description":"x-required\nOptimize 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":{"$ref":"#/components/schemas/viewsL3PerformanceEnhancementType"},"perf_mode_l7_enhanced":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsPrivateConnectConfigType":{"type":"object","description":"x-displayName: \"Private Connect Configuration\"\nPrivate Connect Configuration","title":"PrivateConnectConfigType","properties":{"cloud_link":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"inside":{"$ref":"#/components/schemas/ioschemaEmpty"},"outside":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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_re\"]","x-ves-proto-message":"ves.io.schema.views.RegionalEdgeSelection","properties":{"geo_proximity":{"$ref":"#/components/schemas/ioschemaEmpty"},"specific_re":{"$ref":"#/components/schemas/viewsSpecificRE"}}},"viewsSecurityGroupType":{"type":"object","description":"x-displayName: \"Security Group IDS\"\nEnter 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","properties":{"inside_security_group_id":{"type":"string","description":"x-displayName: \"Inside Security Group ID\"\nx-example: \"sg-0db952838ba829943\"\nSecurity Group ID to be attached to SLI(Site Local Inside) Interface","title":"Inside Security Group ID"},"outside_security_group_id":{"type":"string","description":"x-displayName: \"Outside Security Group ID\"\nx-example: \"sg-0db952838ba829943\"\nSecurity Group ID to be attached to SLO(Site Local Outside) Interface","title":"Outside Security Group ID"}}},"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 \n\nExample: ` \"invalid VPC ID\"`","title":"Error Description","x-displayname":"Error Description","x-ves-example":"invalid VPC ID"},"suggested_action":{"type":"string","description":" Suggested Action \n\nExample: ` \"update VPC ID\"`","title":"Suggested Action","x-displayname":"Suggested Action","x-ves-example":"update VPC ID"}}},"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":{"primary_re":{"type":"string","description":" Select primary RE for this site.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","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"}}}},"viewsTGWAssignedASNType":{"type":"object","description":"x-displayName: \"TGW Assigned ASN Type\"\nInformation needed when ASNs are assigned by the user","title":"TGW Assigned ASN Type","properties":{"tgw_asn":{"type":"integer","description":"x-displayName: \"Enter TGW ASN\"\nx-example: \"64512\"\nTGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.","title":"TGW ASN","format":"int64"},"volterra_site_asn":{"type":"integer","description":"x-displayName: \"Enter F5XC Site ASN\"\nx-example: \"64500\"\nF5XC Site ASN.","title":"F5XC Site ASN","format":"int64"}}},"viewsTGWParamsType":{"type":"object","description":"x-displayName: \"TGWParamsType\"","title":"TGWParamsType","properties":{"system_generated":{"$ref":"#/components/schemas/ioschemaEmpty"},"user_assigned":{"$ref":"#/components/schemas/viewsTGWAssignedASNType"}}},"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":{"$ref":"#/components/schemas/ioschemaEmpty"},"volterra_software_version":{"type":"string","description":"Exclusive with [default_sw_version]\n Specify a F5XC Software Version to be used e.g. crt-20210329-1002.\n\nExample: ` \"crt-20210329-1002\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 20\n","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"}}}},"viewssecuremesh_site_v2AzureSubnetChoiceType":{"type":"object","description":"x-displayName: \"Azure Subnet\"\nParameters for Azure subnet","title":"Azure Cloud Subnet","properties":{"existing_subnet":{"$ref":"#/components/schemas/viewssecuremesh_site_v2AzureSubnetType"},"subnet_param":{"$ref":"#/components/schemas/viewssecuremesh_site_v2CloudSubnetParamType"}}},"viewssecuremesh_site_v2AzureSubnetType":{"type":"object","description":"x-displayName: \"Azure Subnet\"\nParameters for Azure subnet","title":"Azure Cloud Subnet","properties":{"subnet_name":{"type":"string","description":"x-displayName: \"Subnet Name\"\nx-example: \"MySubnet\"\nx-required\nName of existing subnet.","title":"Existing Subnet Name"},"vnet_resource_group":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewssecuremesh_site_v2CloudSubnetParamType":{"type":"object","description":"x-displayName: \"New Cloud Subnet Parameters\"\nParameters for creating a new cloud subnet","title":"Cloud Subnet Param","properties":{"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"ipv4":{"type":"string","description":"x-displayName: \"IPv4 Subnet\"\nx-required\nx-example: \"10.1.2.0/24\"\nIPv4 subnet prefix for this subnet","title":"IPv4 Subnet"},"name":{"type":"string","description":"x-displayName: \"Choose Subnet Name\"\nSpecify the Subnet Name","title":"name"}}},"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-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-logs_receiver_choice":"[\"log_receiver\",\"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\",\"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":{"$ref":"#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/network_firewallActiveForwardProxyPoliciesType"},"admin_user_credentials":{"$ref":"#/components/schemas/viewsAdminUserCredentialsType"},"aws":{"$ref":"#/components/schemas/securemesh_site_v2AWSProviderType"},"azure":{"$ref":"#/components/schemas/securemesh_site_v2AzureProviderType"},"baremetal":{"$ref":"#/components/schemas/securemesh_site_v2BaremetalProviderType"},"block_all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocked_services":{"$ref":"#/components/schemas/fleetBlockedServicesListType"},"custom_proxy":{"$ref":"#/components/schemas/securemesh_site_v2CustomProxy"},"custom_proxy_bypass":{"$ref":"#/components/schemas/securemesh_site_v2CustomProxyBypassSettings"},"dc_cluster_group_sli":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"dc_cluster_group_slo":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"disable_ha":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_url_categorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"dns_ntp_config":{"$ref":"#/components/schemas/securemesh_site_v2DNSNTPServerConfig"},"enable_ha":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_url_categorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"equinix":{"$ref":"#/components/schemas/securemesh_site_v2EquinixProviderType"},"f5_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"gcp":{"$ref":"#/components/schemas/securemesh_site_v2GCPProviderType"},"kvm":{"$ref":"#/components/schemas/securemesh_site_v2KVMProviderType"},"load_balancing":{"$ref":"#/components/schemas/securemesh_site_v2LoadBalancingSettingsType"},"local_vrf":{"$ref":"#/components/schemas/securemesh_site_v2LocalVRFSettingType"},"log_receiver":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"logs_streaming_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_forward_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_proxy_bypass":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_s2s_connectivity_sli":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_s2s_connectivity_slo":{"$ref":"#/components/schemas/ioschemaEmpty"},"nutanix":{"$ref":"#/components/schemas/securemesh_site_v2NutanixProviderType"},"oci":{"$ref":"#/components/schemas/securemesh_site_v2OCIProviderType"},"offline_survivability_mode":{"$ref":"#/components/schemas/viewsOfflineSurvivabilityModeType"},"openstack":{"$ref":"#/components/schemas/securemesh_site_v2OpenstackProviderType"},"performance_enhancement_mode":{"$ref":"#/components/schemas/viewsPerformanceEnhancementModeType"},"re_select":{"$ref":"#/components/schemas/viewsRegionalEdgeSelection"},"site_mesh_group_on_slo":{"$ref":"#/components/schemas/securemesh_site_v2SiteMeshGroupType"},"software_settings":{"$ref":"#/components/schemas/securemesh_site_v2SoftwareSettingsType"},"tunnel_dead_timeout":{"type":"integer","description":" Time interval, in millisec, within which any ipsec / ssl connection from the site going down is detected.\n When not set (== 0), a default value of 10000 msec will be used.\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 180000\n","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"}},"tunnel_type":{"$ref":"#/components/schemas/schemaSiteToSiteTunnelType"},"upgrade_settings":{"$ref":"#/components/schemas/securemesh_site_v2UpgradeSettingsType"},"vmware":{"$ref":"#/components/schemas/securemesh_site_v2VMwareProviderType"}}},"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.\n Once configured, this interface will be part of this sites dataplane and can participate in the networking services configured on this site.\n\nExample: ` \"ver1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","title":"Device","minLength":1,"maxLength":64,"x-displayname":"Ethernet Device","x-ves-example":"ver1","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"}},"mac":{"type":"string","description":"\n\nExample: ` \"01:10:20:0a:bb:1c\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.mac: true\n","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"}}}},"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-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-logs_receiver_choice":"[\"log_receiver\",\"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\",\"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":{"$ref":"#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/network_firewallActiveForwardProxyPoliciesType"},"admin_user_credentials":{"$ref":"#/components/schemas/viewsAdminUserCredentialsType"},"aws":{"$ref":"#/components/schemas/securemesh_site_v2AWSProviderType"},"azure":{"$ref":"#/components/schemas/securemesh_site_v2AzureProviderType"},"baremetal":{"$ref":"#/components/schemas/securemesh_site_v2BaremetalProviderType"},"block_all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocked_services":{"$ref":"#/components/schemas/fleetBlockedServicesListType"},"custom_proxy":{"$ref":"#/components/schemas/securemesh_site_v2CustomProxy"},"custom_proxy_bypass":{"$ref":"#/components/schemas/securemesh_site_v2CustomProxyBypassSettings"},"dc_cluster_group_sli":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"dc_cluster_group_slo":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"disable_ha":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_url_categorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"dns_ntp_config":{"$ref":"#/components/schemas/securemesh_site_v2DNSNTPServerConfig"},"enable_ha":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_url_categorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"equinix":{"$ref":"#/components/schemas/securemesh_site_v2EquinixProviderType"},"f5_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"gcp":{"$ref":"#/components/schemas/securemesh_site_v2GCPProviderType"},"kvm":{"$ref":"#/components/schemas/securemesh_site_v2KVMProviderType"},"load_balancing":{"$ref":"#/components/schemas/securemesh_site_v2LoadBalancingSettingsType"},"local_vrf":{"$ref":"#/components/schemas/securemesh_site_v2LocalVRFSettingType"},"log_receiver":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"logs_streaming_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_forward_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_proxy_bypass":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_s2s_connectivity_sli":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_s2s_connectivity_slo":{"$ref":"#/components/schemas/ioschemaEmpty"},"nutanix":{"$ref":"#/components/schemas/securemesh_site_v2NutanixProviderType"},"oci":{"$ref":"#/components/schemas/securemesh_site_v2OCIProviderType"},"offline_survivability_mode":{"$ref":"#/components/schemas/viewsOfflineSurvivabilityModeType"},"openstack":{"$ref":"#/components/schemas/securemesh_site_v2OpenstackProviderType"},"operating_system_version":{"type":"string","description":" Select the Operating System version for the site. By default, latest available Operating System version will be used.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Operating System Version","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"performance_enhancement_mode":{"$ref":"#/components/schemas/viewsPerformanceEnhancementModeType"},"re_select":{"$ref":"#/components/schemas/viewsRegionalEdgeSelection"},"site_errors":{"type":"array","description":" Errors on site including suggested action\n\nExample: ` \"Site Errors\"`","items":{"$ref":"#/components/schemas/viewsSiteError"},"x-displayname":"Site Errors","x-ves-example":"Site Errors"},"site_mesh_group_on_slo":{"$ref":"#/components/schemas/securemesh_site_v2SiteMeshGroupType"},"site_state":{"$ref":"#/components/schemas/siteSiteState"},"software_settings":{"$ref":"#/components/schemas/securemesh_site_v2SoftwareSettingsType"},"tunnel_dead_timeout":{"type":"integer","description":" Time interval, in millisec, within which any ipsec / ssl connection from the site going down is detected.\n When not set (== 0), a default value of 10000 msec will be used.\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 180000\n","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"}},"tunnel_type":{"$ref":"#/components/schemas/schemaSiteToSiteTunnelType"},"upgrade_settings":{"$ref":"#/components/schemas/securemesh_site_v2UpgradeSettingsType"},"vmware":{"$ref":"#/components/schemas/securemesh_site_v2VMwareProviderType"},"volterra_software_version":{"type":"string","description":" Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\n Refer to release notes to find required released SW versions.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Software Version","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}}}},"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\n\nExample: ` \"Control\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"Hostname","maxLength":256,"x-displayname":"Hostname","x-ves-example":"Control","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"interface_list":{"type":"array","description":" Manage interfaces belonging to this node\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique: true\n","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"}},"public_ip":{"type":"string","description":" Public IP for this Node\n\nExample: ` \"1.1.1.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"Public IP","maxLength":256,"x-displayname":"Public IP","x-ves-example":"1.1.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"type":{"type":"string","description":" Type for this Node, can be Control or Worker\n\nExample: ` \"Control\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Control\\\",\\\"Worker\\\"]\n","title":"Type","x-displayname":"Type","x-ves-example":"Control","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Control\\\",\\\"Worker\\\"]"}}}},"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-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-logs_receiver_choice":"[\"log_receiver\",\"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\",\"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":{"$ref":"#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/network_firewallActiveForwardProxyPoliciesType"},"admin_user_credentials":{"$ref":"#/components/schemas/viewsAdminUserCredentialsType"},"aws":{"$ref":"#/components/schemas/securemesh_site_v2AWSProviderType"},"azure":{"$ref":"#/components/schemas/securemesh_site_v2AzureProviderType"},"baremetal":{"$ref":"#/components/schemas/securemesh_site_v2BaremetalProviderType"},"block_all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocked_services":{"$ref":"#/components/schemas/fleetBlockedServicesListType"},"custom_proxy":{"$ref":"#/components/schemas/securemesh_site_v2CustomProxy"},"custom_proxy_bypass":{"$ref":"#/components/schemas/securemesh_site_v2CustomProxyBypassSettings"},"dc_cluster_group_sli":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"dc_cluster_group_slo":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"disable_ha":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_url_categorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"dns_ntp_config":{"$ref":"#/components/schemas/securemesh_site_v2DNSNTPServerConfig"},"enable_ha":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_url_categorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"equinix":{"$ref":"#/components/schemas/securemesh_site_v2EquinixProviderType"},"f5_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"gcp":{"$ref":"#/components/schemas/securemesh_site_v2GCPProviderType"},"kvm":{"$ref":"#/components/schemas/securemesh_site_v2KVMProviderType"},"load_balancing":{"$ref":"#/components/schemas/securemesh_site_v2LoadBalancingSettingsType"},"local_vrf":{"$ref":"#/components/schemas/securemesh_site_v2LocalVRFSettingType"},"log_receiver":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"logs_streaming_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_forward_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_proxy_bypass":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_s2s_connectivity_sli":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_s2s_connectivity_slo":{"$ref":"#/components/schemas/ioschemaEmpty"},"nutanix":{"$ref":"#/components/schemas/securemesh_site_v2NutanixProviderType"},"oci":{"$ref":"#/components/schemas/securemesh_site_v2OCIProviderType"},"offline_survivability_mode":{"$ref":"#/components/schemas/viewsOfflineSurvivabilityModeType"},"openstack":{"$ref":"#/components/schemas/securemesh_site_v2OpenstackProviderType"},"performance_enhancement_mode":{"$ref":"#/components/schemas/viewsPerformanceEnhancementModeType"},"re_select":{"$ref":"#/components/schemas/viewsRegionalEdgeSelection"},"site_mesh_group_on_slo":{"$ref":"#/components/schemas/securemesh_site_v2SiteMeshGroupType"},"software_settings":{"$ref":"#/components/schemas/securemesh_site_v2SoftwareSettingsType"},"tunnel_dead_timeout":{"type":"integer","description":" Time interval, in millisec, within which any ipsec / ssl connection from the site going down is detected.\n When not set (== 0), a default value of 10000 msec will be used.\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 180000\n","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"}},"tunnel_type":{"$ref":"#/components/schemas/schemaSiteToSiteTunnelType"},"upgrade_settings":{"$ref":"#/components/schemas/securemesh_site_v2UpgradeSettingsType"},"vmware":{"$ref":"#/components/schemas/securemesh_site_v2VMwareProviderType"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.unique: true\n","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"}},"default_gateway":{"$ref":"#/components/schemas/ioschemaEmpty"},"ip_address":{"type":"string","description":"Exclusive with [default_gateway node_interface]\n Traffic matching the ip prefixes is sent to this IP Address\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"IP Address","x-displayname":"IP Address","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"ip_prefixes":{"type":"array","description":" List of route prefixes that have common next hop and attributes\n\nExample: ` \"10.0.0.0/24\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ipv4_prefix: true\n  ves.io.schema.rules.repeated.max_items: 256\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"IP Prefixes","minItems":1,"maxItems":256,"items":{"type":"string"},"x-displayname":"IP Prefixes","x-ves-example":"10.0.0.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"}},"node_interface":{"$ref":"#/components/schemas/schemaNodeInterfaceType"}}},"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\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.unique: true\n","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"}},"default_gateway":{"$ref":"#/components/schemas/ioschemaEmpty"},"ip_address":{"type":"string","description":"Exclusive with [default_gateway node_interface]\n Traffic matching the ip prefixes is sent to this IP Address\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"IP Address","x-displayname":"IP Address","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}},"ip_prefixes":{"type":"array","description":" List of IPv6 route prefixes that have common next hop and attributes\n\nExample: ` \"2001::/92\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ipv6_prefix: true\n  ves.io.schema.rules.repeated.max_items: 256\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","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"}},"node_interface":{"$ref":"#/components/schemas/schemaNodeInterfaceType"}}},"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\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","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"}}}}}}}