@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0240.public.ves.io.schema.topology.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.topology","description":"APIs to get topology of all the resources associated/connected to a site such as other CEs (Customer Edge),\nREs (Regional Edge), VPCs (Virtual Private Cloud) networks, etc., and the associated metrics. Relationship between\nthe resources associated with a site is represented as a graph, where each resource/entity is represented as a node\n(example: CE, RE, VPC, Subnet, etc.,) and their association is represented as edge (example: CE - RE connection,\nNetwork - Subnets association, etc.,)","version":""},"paths":{"/api/data/namespaces/system/topology/dc_cluster_group/{dc_cluster_group}":{"post":{"summary":"DC Cluster Topology","description":"Get topology of a DC Cluster.","operationId":"ves.io.schema.topology.CustomDataAPI.DCClusterTopology","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyTopologyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"dc_cluster_group","description":"DC Cluster group\n\nx-example: \"dcg-1\"\nName of the DC Cluster group","in":"path","required":true,"x-displayname":"DC Cluster group","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyDCClusterTopologyRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-dcclustertopology"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.DCClusterTopology"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/dc_cluster_groups":{"get":{"summary":"DC Cluster Groups Summary","description":"Get summary of all DC Cluster groups.","operationId":"ves.io.schema.topology.CustomDataAPI.DCClusterGroupsSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyTopologyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-dcclustergroupssummary"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.DCClusterGroupsSummary"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/network/{id}/route_tables":{"get":{"summary":"Get Network Route Tables","description":"Gets Route Tables Associated with a Network","operationId":"ves.io.schema.topology.CustomDataAPI.GetNetworkRouteTables","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyNetworkRouteTablesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"vpc-1234567898\"\nx-required\nNetwork Id","in":"path","required":true,"x-displayname":"Id","schema":{"type":"string"}},{"name":"route_table_ids","description":"x-example: \"rtb-1234567898, rtb-2345678901\"\nRoute Table Ids used as filters","in":"query","required":false,"x-displayname":"Route Table Ids","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"subnet_ids","description":"x-example: \"sub-1234567898, sub-2345678901\"\nSubnet Ids used as filters","in":"query","required":false,"x-displayname":"Subnet Ids","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"subnet_cidrs","description":"x-example: \"10.10.0.0/16, 10.22.0.0/16\"\nSubnet cidrs used as filters","in":"query","required":false,"x-displayname":"Subnet Cidrs","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"regions","description":"x-example: \"us-west1, us-east1\"\nRegions used as filters","in":"query","required":false,"x-displayname":"Regions","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"site","description":"x-example: \"site-name1\"\nSite Name","in":"query","required":false,"x-displayname":"Site","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-getnetworkroutetables"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.GetNetworkRouteTables"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/route_table/{name}":{"get":{"summary":"Get Route Table","description":"Get Route Table","operationId":"ves.io.schema.topology.CustomDataAPI.GetRouteTable","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyRouteTableResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"name","description":"Name\n\nx-required\nx-example: \"rt-1\"\nRoute table name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-getroutetable"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.GetRouteTable"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/site/{name}/networks":{"get":{"summary":"Get Site Networks","description":"Gets Networks Associated to Site","operationId":"ves.io.schema.topology.CustomDataAPI.GetSiteNetworks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologySiteNetworksResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"name","description":"Name\n\nx-required\nx-example: \"site-1\"\nSite name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-getsitenetworks"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.GetSiteNetworks"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/site/{site}":{"post":{"summary":"Site Topology","description":"Get topology of a site and the resources associated/connected to the site such as other Customer sites,\nRegional Sites, VPCs (Virtual Private Cloud) networks, etc., and the associated metrics.","operationId":"ves.io.schema.topology.CustomDataAPI.SiteTopology","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyTopologyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"site","description":"Site\n\n\nx-example: \"ce01\"\nName of the site","in":"path","required":true,"x-displayname":"Site","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologySiteTopologyRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-sitetopology"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.SiteTopology"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/site_mesh_group/{site_mesh_group}":{"post":{"summary":"Site Mesh Topology","description":"Get topology of a site mesh.","operationId":"ves.io.schema.topology.CustomDataAPI.SiteMeshTopology","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyTopologyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"site_mesh_group","description":"Site Mesh Group\n\n\nx-example: \"smg-1\"\nName of the site mesh group","in":"path","required":true,"x-displayname":"Site Mesh Group","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologySiteMeshTopologyRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-sitemeshtopology"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.SiteMeshTopology"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/site_mesh_groups":{"get":{"summary":"Site Mesh Groups Summary","description":"Get summary of all site mesh groups.","operationId":"ves.io.schema.topology.CustomDataAPI.SiteMeshGroupsSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyTopologyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-topology-customdataapi-sitemeshgroupssummary"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.SiteMeshGroupsSummary"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/system/topology/tgw/{id}/route_tables":{"get":{"summary":"Get TGW Route Tables","description":"Gets Route Tables Associated with a TGW","operationId":"ves.io.schema.topology.CustomDataAPI.GetTGWRouteTables","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/topologyTGWRouteTablesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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":"id","description":"Id\n\nx-example: \"tgw-1234567898\"\nx-required\nTGW Id","in":"path","required":true,"x-displayname":"Id","schema":{"type":"string"}},{"name":"route_table_ids","description":"x-example: \"rtb-1234567898, rtb-2345678901\"\nRoute Table Ids used as filters","in":"query","required":false,"x-displayname":"Route Table Ids","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"attachment_ids","description":"x-example: \"attach-1234567898, attach-2345678901\"\nRoute Table Ids used as filters","in":"query","required":false,"x-displayname":"TGW Attachment Ids","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-topology-customdataapi-gettgwroutetables"},"x-ves-proto-rpc":"ves.io.schema.topology.CustomDataAPI.GetTGWRouteTables"},"x-displayname":"Topology","x-ves-proto-service":"ves.io.schema.topology.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Topology","x-ves-proto-package":"ves.io.schema.topology","components":{"schemas":{"dc_cluster_groupDCClusterGroupMeshType":{"type":"object","description":"Details of DC Cluster Group Mesh Type","title":"DC Cluster Group Mesh Type","x-displayname":"DC Cluster Group Mesh Type","x-ves-oneof-field-dc_cluster_group_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.dc_cluster_group.DCClusterGroupMeshType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"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"}}},"schemaIpSubnetType":{"type":"object","description":"IP Address used to specify an IPv4 or IPv6 subnet addresses","title":"IP Subnet","x-displayname":"IP Subnet","x-ves-displayorder":"3","x-ves-oneof-field-ver":"[\"ipv4\",\"ipv6\"]","x-ves-proto-message":"ves.io.schema.IpSubnetType","properties":{"ipv4":{"$ref":"#/components/schemas/schemaIpv4SubnetType"},"ipv6":{"$ref":"#/components/schemas/schemaIpv6SubnetType"}}},"schemaIpv4SubnetType":{"type":"object","description":"IPv4 subnets specified as prefix and prefix-length. Prefix length must be <= 32","title":"IPv4 Subnet","x-displayname":"IPv4 Subnet","x-ves-proto-message":"ves.io.schema.Ipv4SubnetType","properties":{"plen":{"type":"integer","description":" Prefix-length of the IPv4 subnet. Must be <= 32\n\nExample: ` \"24\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 32\n","title":"Prefix Length","format":"int64","x-displayname":"Prefix Length","x-ves-example":"24","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"32"}},"prefix":{"type":"string","description":" Prefix part of the IPv4 subnet in string form with dot-decimal notation\n\nExample: ` \"192.168.1.0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Prefix","x-displayname":"Prefix","x-ves-example":"192.168.1.0","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"schemaIpv6SubnetType":{"type":"object","description":"IPv6 subnets specified as prefix and prefix-length. prefix-legnth must be <= 128","title":"IPv6 Subnet","x-displayname":"IPv6 Subnet","x-ves-proto-message":"ves.io.schema.Ipv6SubnetType","properties":{"plen":{"type":"integer","description":" Prefix length of the IPv6 subnet. Must be <= 128\n\nExample: ` \"38\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 128\n","title":"Prefix length","format":"int64","x-displayname":"Prefix Length","x-ves-example":"38","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"128"}},"prefix":{"type":"string","description":" Prefix part of the IPv6 subnet given in form of string.\n IPv6 address must be specified as hexadecimal numbers separated by ':'\n e.g. \"2001:db8:0:0:0:2:0:0\"\n The address can be compacted by suppressing zeros\n e.g. \"2001:db8::2::\"\n\nExample: ` \"2001:db8:0:0:0:0:2:0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"Prefix","x-displayname":"Prefix","x-ves-example":"2001:db8:0:0:0:0:2:0","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}}}},"schemaMetricValue":{"type":"object","description":"Metric data contains timestamp and the value.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.MetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":"\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"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"},"schemasiteLinkType":{"type":"string","description":"Link type of interface determined operationally\n\nLink type unknown\nLink type ethernet\nWiFi link of type 802.11ac\nWiFi link of type 802.11bgn\nLink type 4G\nWiFi link\nWan link","title":"Link type","enum":["LINK_TYPE_UNKNOWN","LINK_TYPE_ETHERNET","LINK_TYPE_WIFI_802_11AC","LINK_TYPE_WIFI_802_11BGN","LINK_TYPE_4G","LINK_TYPE_WIFI","LINK_TYPE_WAN"],"default":"LINK_TYPE_UNKNOWN","x-displayname":"Link type","x-ves-proto-enum":"ves.io.schema.site.LinkType"},"schemasiteNode":{"type":"object","description":"Node Information for connectivity across sites.","title":"Node","x-displayname":"Node","x-ves-proto-message":"ves.io.schema.site.Node","properties":{"name":{"type":"string","description":" Name of the master/main node on the site.","title":"name","x-displayname":"Node name"},"sli_address":{"type":"string","description":" Site Local Inside IP address.","title":"sli_address","x-displayname":"Site Local Inside IP addresses"},"slo_address":{"type":"string","description":" Site Local Outside IP address.","title":"slo_address","x-displayname":"Site Local Outside IP addresses"}}},"schemasiteSiteType":{"type":"string","description":"Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site","title":"SiteType","enum":["INVALID","REGIONAL_EDGE","CUSTOMER_EDGE","NGINX_ONE"],"default":"INVALID","x-displayname":"Site Type","x-ves-proto-enum":"ves.io.schema.site.SiteType"},"schemasite_mesh_groupSiteMeshGroupType":{"type":"string","description":"Defines different types of Mesh\n\nInvalid mesh type\nMesh of type Hub\nMesh of type Spoke\nFull mesh of tunnels are created between all sites","title":"Site Mesh Group Type","enum":["SITE_MESH_GROUP_TYPE_INVALID","SITE_MESH_GROUP_TYPE_HUB_FULL_MESH","SITE_MESH_GROUP_TYPE_SPOKE","SITE_MESH_GROUP_TYPE_FULL_MESH"],"default":"SITE_MESH_GROUP_TYPE_INVALID","x-displayname":"Mesh Type","x-ves-proto-enum":"ves.io.schema.site_mesh_group.SiteMeshGroupType"},"schematopologyLinkType":{"type":"string","description":"Enumerates the association/relationship between 2 nodes.\n\nIndicates that 2 nodes are connected using a tunnel\nIndicates network connection\nIndicates connection to subnet\nIndicates connection to instance\nIndicates association with site mesh group\nIndicates association with DC Cluster group\nIndicates L3 connection between the nodes\nIndicates the Control plane connection between the nodes\nIndicates the BGP connection between the tgw and site","title":"LinkType","enum":["LINK_TYPE_TUNNEL","LINK_TYPE_NETWORK","LINK_TYPE_SUBNET","LINK_TYPE_INSTANCE","LINK_TYPE_SITE_MESH_GROUP","LINK_TYPE_DC_CLUSTER_GROUP","LINK_TYPE_L3","LINK_TYPE_CONTROL_PLANE","LINK_TYPE_BGP_CONNECTION"],"default":"LINK_TYPE_TUNNEL","x-displayname":"Link Type","x-ves-proto-enum":"ves.io.schema.topology.LinkType"},"schematopologyMetricType":{"type":"string","description":"List of metric types applicable for the nodes and edges in the topology graph.\nNot all metric types are applicable for all nodes or edges. For example, LATENCY metric\nis applicable only for the edges where both the vertices are sites and CPU_USAGE metric is\napplicable only for node of type instance. This list is a union of all metric types.\n\nTotal incoming traffic in bytes\nTotal outgoing traffic in bytes\nTotal incoming packets dropped\nTotal outgoing packets dropped\nReachability based on probes sent periodically\nAverage latency in seconds\nAverage CPU utilization in percentage\nAverage Memory utilization in percentage\nAverage Disk utilization in percentage\nConnection status of the tunnel\nControl plane connection status of the tunnel","title":"Metric Type","enum":["METRIC_TYPE_IN_BYTES","METRIC_TYPE_OUT_BYTES","METRIC_TYPE_IN_DROP_PACKETS","METRIC_TYPE_OUT_DROP_PACKETS","METRIC_TYPE_REACHABILITY_PERCENT","METRIC_TYPE_LATENCY_SECONDS","METRIC_TYPE_CPU_USAGE_PERCENT","METRIC_TYPE_MEMORY_USAGE_PERCENT","METRIC_TYPE_DISK_USAGE_PERCENT","METRIC_TYPE_DATA_PLANE_CONNECTION_STATUS","METRIC_TYPE_CONTROL_PLANE_CONNECTION_STATUS"],"default":"METRIC_TYPE_IN_BYTES","x-displayname":"Metric Type","x-ves-proto-enum":"ves.io.schema.topology.MetricType"},"schematopologyMetricTypeData":{"type":"object","description":"Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values.\nFor example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies\nthe interface name of the instance.","title":"Metric Type Data","x-displayname":"Metric Type Data","x-ves-proto-message":"ves.io.schema.topology.MetricTypeData","properties":{"labels":{"type":"object","description":" Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported.\n If the Labels is empty, then the metric value is for the corresponding node or edge.\n For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies\n the interface name of the instance.","title":"Labels","x-displayname":"Labels"},"values":{"type":"array","description":" List of metric values. May contain more than one value if timeseries data is requested.","title":"Value","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Value"}}},"schematopologyNode":{"type":"object","description":"Canonical representation of Node in the topology graph.","title":"Node","x-displayname":"Node","x-ves-oneof-field-node_type":"[\"dc_cluster_group\",\"instance\",\"network\",\"site\",\"site_mesh_group\",\"subnet\",\"transit_gateway\"]","x-ves-proto-message":"ves.io.schema.topology.Node","properties":{"dc_cluster_group":{"$ref":"#/components/schemas/topologyNodeTypeDCClusterGroup"},"id":{"type":"string","description":" Identifier for the node.","title":"Id","x-displayname":"Id"},"instance":{"$ref":"#/components/schemas/topologyNodeTypeInstance"},"metadata":{"$ref":"#/components/schemas/topologyNodeMetaData"},"network":{"$ref":"#/components/schemas/topologyNodeTypeNetwork"},"site":{"$ref":"#/components/schemas/topologyNodeTypeSite"},"site_mesh_group":{"$ref":"#/components/schemas/topologyNodeTypeSiteMeshGroup"},"subnet":{"$ref":"#/components/schemas/topologyNodeTypeSubnet"},"transit_gateway":{"$ref":"#/components/schemas/topologyNodeTypeTransitGateway"}}},"schematopologySiteMeshGroupType":{"type":"object","description":"A canonical form of the site mesh group.","title":"Site Mesh Group","x-displayname":"site Mesh Group","x-ves-oneof-field-mesh_choice":"[\"full_mesh\",\"hub_mesh\",\"spoke_mesh\"]","x-ves-proto-message":"ves.io.schema.topology.SiteMeshGroupType","properties":{"full_mesh":{"$ref":"#/components/schemas/site_mesh_groupFullMeshGroupType"},"hub":{"type":"array","description":" If 'Type' is Spoke, 'Hub' refers to a Site Mesh Group of 'type' Hub.\n Spoke sites connect to all the member sites of Hub Site Mesh Group.\n Hub will be empty when Site Mesh Group type is Hub or Full Mesh.","title":"Hub","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Hub (site mesh group)"},"hub_mesh":{"$ref":"#/components/schemas/site_mesh_groupHubFullMeshGroupType"},"site_type":{"$ref":"#/components/schemas/schemasiteSiteType"},"spoke_mesh":{"$ref":"#/components/schemas/site_mesh_groupSpokeMeshGroupType"},"topology_site":{"type":"array","description":" Topology Sites referenced in this site_mesh_group","title":"Topology Site Reference","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Topology Site"},"type":{"$ref":"#/components/schemas/schemasite_mesh_groupSiteMeshGroupType"},"virtual_site":{"type":"array","description":" Virtual Site referenced in this site_mesh_group\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"virtual_site","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Site","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"schematopologySiteType":{"type":"object","description":"A canonical form of the site.","title":"Site","x-displayname":"site","x-ves-proto-message":"ves.io.schema.topology.SiteType","properties":{"app_type":{"$ref":"#/components/schemas/topologySiteAppTypeEnum"},"dc_cluster_group":{"type":"array","description":" Reference to the DC Cluster group","title":"DC Cluster Group","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"DC Cluster Group"},"gateway_type":{"$ref":"#/components/schemas/topologyGatewayTypeEnum"},"network":{"type":"array","description":" Reference to the network.","title":"Network","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Network"},"orchestration_mode":{"$ref":"#/components/schemas/topologyOrchestrationMode"},"site_type":{"$ref":"#/components/schemas/schemasiteSiteType"},"tgw":{"type":"array","description":" Reference to the transit gateway","title":"TransitGateway","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"TransitGateway"}}},"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"}}}},"siteActiveState":{"type":"string","description":"Active/Backup state for the interface\n\nUnknown state\nInterface in active state\nInterface in backup state","title":"Active State","enum":["STATE_UNKNOWN","STATE_ACTIVE","STATE_BACKUP"],"default":"STATE_UNKNOWN","x-displayname":"Active State","x-ves-proto-enum":"ves.io.schema.site.ActiveState"},"siteAddressMode":{"type":"string","description":"AddressMode identifies the mode of address assignment on an interface\n\n - STATIC: Static\n\nInterface Address is assigned statically\n - DHCP: DHCP\n\nInterface Address is obtained via DHCP","title":"Interface Address Mode","enum":["STATIC","DHCP"],"default":"STATIC","x-displayname":"AddressMode","x-ves-proto-enum":"ves.io.schema.site.AddressMode"},"siteBondMembersType":{"type":"object","description":"BondMembersType represents the bond interface members  along with the corresponding link state","title":"Bond Interface Members","x-displayname":"Bond Interface Members","x-ves-proto-message":"ves.io.schema.site.BondMembersType","properties":{"link_speed":{"type":"integer","description":" Link speed of Bond Interface Member in Mbps","title":"Link Speed\nx-displayName: \"Link Speed in Mbps\"\nLink speed of Bond Interface Member in Mbps","format":"int64","x-displayname":"Link Speed in Mbps"},"link_state":{"type":"boolean","description":" Link state of Bond Interface Member","title":"Link State\nx-displayName: \"Link State\"\nLink state of Bond Interface Member","format":"boolean","x-displayname":"Link State"},"name":{"type":"string","description":" Name of the Bond Interface Member","title":"Name\nx-displayName: \"Name\"\nName of the Bond Interface Member","x-displayname":"Name"}}},"siteInterfaceStatus":{"type":"object","description":"Status of Interfaces in ver","title":"Interface Status","x-displayname":"Interface Status","x-ves-proto-message":"ves.io.schema.site.InterfaceStatus","properties":{"active_state":{"$ref":"#/components/schemas/siteActiveState"},"bond_members":{"type":"array","description":" Members of the Bond interface along with the corresponding link state","title":"Bond Interface Members\nx-displayName: \"Bond Members\"\nMembers of the Bond interface along with the corresponding link state","items":{"$ref":"#/components/schemas/siteBondMembersType"},"x-displayname":"Bond Members"},"dhcp_server":{"type":"boolean","description":" Indicate if DHCP server is configured on the interface","title":"DHCP Server","format":"boolean","x-displayname":"DHCP Server"},"ip":{"$ref":"#/components/schemas/schemaIpSubnetType"},"ip_mode":{"$ref":"#/components/schemas/siteAddressMode"},"ipv6":{"$ref":"#/components/schemas/schemaIpSubnetType"},"link_quality":{"$ref":"#/components/schemas/siteLinkQuality"},"link_state":{"type":"boolean","description":" Link State for the interface","title":"Link State\nx-displayName: \"Link State\"\nLink State for the interface","format":"boolean","x-displayname":"Link State"},"link_type":{"$ref":"#/components/schemas/schemasiteLinkType"},"mac":{"type":"string","description":" Mac Address of interface","title":"Mac Address","x-displayname":"Mac Address"},"name":{"type":"string","description":" Name of interface","title":"Name","x-displayname":"Name"},"network_name":{"type":"string","description":" Name of Virtual Network to which the interface belongs","title":"Virtual Network Name","x-displayname":"Virtual Network Name"},"network_type":{"$ref":"#/components/schemas/schemaVirtualNetworkType"}}},"siteLinkQuality":{"type":"string","description":"Link quality determined by VER using different probes\n\nUnknown quality\nLink quality is good\nLink quality is poor\nQuality disabled","title":"Link quality","enum":["QUALITY_UNKNOWN","QUALITY_GOOD","QUALITY_POOR","QUALITY_DISABLED"],"default":"QUALITY_UNKNOWN","x-displayname":"Link quality","x-ves-proto-enum":"ves.io.schema.site.LinkQuality"},"site_mesh_groupFullMeshGroupType":{"type":"object","description":"Details of Full Mesh Group Type","title":"Full Mesh Group Type","x-displayname":"Full Mesh","x-ves-oneof-field-full_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.FullMeshGroupType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"site_mesh_groupHubFullMeshGroupType":{"type":"object","description":"Details of Hub Full Mesh Group Type","title":"Hub Full Mesh Group Type","x-displayname":"Hub Full Mesh","x-ves-oneof-field-hub_full_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.HubFullMeshGroupType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"site_mesh_groupSpokeMeshGroupType":{"type":"object","description":"Details of Spoke Mesh Group Type","title":"Spoke Mesh Group Type","x-displayname":"Spoke","x-ves-oneof-field-spoke_hub_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.SpokeMeshGroupType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"hub_mesh_group":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"topologyAWSNetworkMetaData":{"type":"object","description":"Network attributes specific to AWS.","title":"AWSNetworkMetaData","x-displayname":"AWS Network Meta Data","x-ves-proto-message":"ves.io.schema.topology.AWSNetworkMetaData","properties":{"metadata":{"$ref":"#/components/schemas/topologyMetaType"},"transit_gateway":{"$ref":"#/components/schemas/topologyTransitGatewayType"}}},"topologyAWSRouteAttributes":{"type":"object","description":"Route attributes specific to AWS.","title":"AWSRouteAttributes","x-displayname":"AWS Route Attributes","x-ves-proto-message":"ves.io.schema.topology.AWSRouteAttributes","properties":{"propagated":{"type":"boolean","description":"Is route propagated\n\nExample: ` false`","title":"Propagated","format":"boolean","x-displayname":"Propagated"},"tgw":{"$ref":"#/components/schemas/topologyAWSTgwRouteAttributes"}}},"topologyAWSTGWAttachment":{"type":"object","description":"AWS TGW Attachment","title":"AWSTGWAttachment","x-displayname":"AWS TGW Attachement","x-ves-proto-message":"ves.io.schema.topology.AWSTGWAttachment","properties":{"associated_route_table_id":{"type":"string","description":"Associated Route Table ID","title":"Associated Route Table ID","x-displayname":"Associated Route Table ID"},"association_state":{"type":"string","description":"Association State","title":"Association State","x-displayname":"Association State"},"cidr":{"type":"string","description":"CIDR","title":"CIDR","x-displayname":"CIDR"},"cloud_connect":{"type":"array","description":" Reference to the Cloud Connect","title":"Cloud Connect","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Cloud Connect"},"id":{"type":"string","description":"TGW Attachment ID","title":"ID","x-displayname":"ID"},"name":{"type":"string","description":"TGW Attachment Name","title":"Name","x-displayname":"Name"},"resource_id":{"type":"string","description":"Resource ID","title":"Resource ID","x-displayname":"Resource ID"},"resource_name":{"type":"string","description":"Resource Name","title":"Resource Name","x-displayname":"Resource Name"},"resource_type":{"type":"string","description":"Resource Type","title":"Resource Type","x-displayname":"Resource Type"},"segment":{"type":"array","description":" Reference to the Segment","title":"Segment","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Segment"}}},"topologyAWSTGWAttachmentMetaData":{"type":"object","description":"AWS TGW AWSTGWAttachment MetaData","title":"AWSTGWAttachmentMetaData","x-displayname":"AWS TGW AWSTGWAttachment MetaData","x-ves-proto-message":"ves.io.schema.topology.AWSTGWAttachmentMetaData","properties":{"id":{"type":"string","description":"TGW Attachment ID","title":"Attachment ID","x-displayname":"Attachment ID"},"resource_id":{"type":"string","description":"Resource ID","title":"Resource ID","x-displayname":"Resource ID"},"resource_name":{"type":"string","description":"Resource Name","title":"Resource Name","x-displayname":"Resource Name"},"resource_type":{"type":"string","description":"Resource Type","title":"Resource Type","x-displayname":"Resource Type"},"state":{"type":"string","description":"Association/Propagation State","title":"Association/Propagation State","x-displayname":"Association/Propagation State"}}},"topologyAWSTgwRouteAttributes":{"type":"object","description":"Route attributes specific to AWS TGW.","title":"AWSTgwRouteAttributes","x-displayname":"AWS TGW Route Attributes","x-ves-proto-message":"ves.io.schema.topology.AWSTgwRouteAttributes","properties":{"next_hop_attachment":{"type":"array","description":" Next Hop Attachment\n\nExample: ` next_hop_attachment`","title":"Next Hop Attachment","items":{"$ref":"#/components/schemas/topologyAWSTGWAttachmentMetaData"},"x-displayname":"Next Hop Attachment"},"route_type":{"type":"string","description":" Route Type\n\nExample: ` \"propagated\"`","title":"Route Type","x-displayname":"Route Type","x-ves-example":"propagated"}}},"topologyAddressInfoType":{"type":"object","description":"Address with additional information","title":"Address Info Type","x-displayname":"Address Info Type","x-ves-proto-message":"ves.io.schema.topology.AddressInfoType","properties":{"address":{"type":"string","description":" Address","title":"Address","x-displayname":"Address"},"dns_name":{"type":"string","description":" Address type","title":"DNS Name","x-displayname":"Public Address"},"primary":{"type":"boolean","description":" Indicate this address is primary or not","title":"Primary","format":"boolean","x-displayname":"Primary"}}},"topologyAzureResourceGroupInfo":{"type":"object","description":"x-displayName: \"Azure Resource Group Info\"\nAzure Site and Virtual Network resource group info","title":"AzureResourceGroupInfo","properties":{"site_rg":{"type":"string","description":"x-displayName: \"Site Resource Group\"\nResource group for Site","title":"Site Resource Group"},"virtual_network_rg":{"type":"string","description":"x-displayName: \"Virtual Network Resource Group\"\nResource group for Virtual Network","title":"Virtual Network Resource Group"}}},"topologyCloudNetworkType":{"type":"string","description":"Cloud Network Type.\n\nNetwork None\nNetwork Type Azure Hub VNET\nNetwork Type Spoke VNET\nNetwork Type Service VPC\nNetwork Type Spoke VPC","title":"Cloud NetworkType","enum":["NETWORK_TYPE_NONE","NETWORK_TYPE_HUB_VNET","NETWORK_TYPE_SPOKE_VNET","NETWORK_TYPE_SERVICE_VPC","NETWORK_TYPE_SPOKE_VPC"],"default":"NETWORK_TYPE_NONE","x-displayname":"Cloud Network Type","x-ves-proto-enum":"ves.io.schema.topology.CloudNetworkType"},"topologyDCClusterGroupSummaryInfo":{"type":"object","description":"Summary information related to the DC Cluster Group","title":"DCClusterGroupSummaryInfo","x-displayname":"DC Cluster Group Summary","x-ves-proto-message":"ves.io.schema.topology.DCClusterGroupSummaryInfo","properties":{"sites":{"type":"integer","description":" This field indicates the number of sites that are part of this DC Cluster group.","title":"Sites","format":"int64","x-displayname":"Sites"}}},"topologyDCClusterGroupType":{"type":"object","description":"A canonical form of the DC cluster group.","title":"DC Cluster Group","x-displayname":"DC Cluster Group","x-ves-proto-message":"ves.io.schema.topology.DCClusterGroupType","properties":{"type":{"$ref":"#/components/schemas/dc_cluster_groupDCClusterGroupMeshType"}}},"topologyDCClusterTopologyRequest":{"type":"object","description":"Request to get DC Cluster group topology and the associated metrics.","title":"DC Cluster Group Topology Request","x-displayname":"DC Cluster Group Topology Request","x-ves-proto-message":"ves.io.schema.topology.DCClusterTopologyRequest","properties":{"dc_cluster_group":{"type":"string","description":" Name of the DC Cluster group\n\nExample: ` \"dcg-1\"`","title":"DC Cluster group","x-displayname":"DC Cluster group","x-ves-example":"dcg-1"},"metric_selector":{"$ref":"#/components/schemas/topologyMetricSelector"}}},"topologyEdge":{"type":"object","description":"Canonical representation of Edge in the topology graph.","title":"Edge","x-displayname":"Edge","x-ves-proto-message":"ves.io.schema.topology.Edge","properties":{"links":{"type":"array","description":" An edge may be composed of multiple links.\n For example, there may be multiple tunnels between a transit gateway and a site and each tunnel\n is represented as individual links. In some cases, we may want to show only one link between 2 nodes,\n eventhough there may be multiple connections/tunnels between these nodes.","title":"Links","items":{"$ref":"#/components/schemas/topologyLinkTypeData"},"x-displayname":"Links"},"node_id1":{"type":"string","description":" Node identifier.","title":"Node Id1","x-displayname":"Node Id1"},"node_id2":{"type":"string","description":" Node identifier.","title":"Node Id2","x-displayname":"Node Id2"},"status":{"$ref":"#/components/schemas/topologyLinkStatus"}}},"topologyEdgeInfoSummary":{"type":"object","description":"Summary information for an edge","title":"EdgeInfoSummary","x-displayname":"Edge Info Summary","x-ves-proto-message":"ves.io.schema.topology.EdgeInfoSummary","properties":{"count":{"type":"integer","description":" Links count.","title":"Count","format":"int64","x-displayname":"Count"},"status":{"$ref":"#/components/schemas/topologyLinkStatus"}}},"topologyGCPRouteAttributes":{"type":"object","description":"Route attributes specific to GCP.","title":"GCPRouteAttributes","x-displayname":"GCP Route Attributes","x-ves-proto-message":"ves.io.schema.topology.GCPRouteAttributes","properties":{"ip_version":{"type":"string","description":" Version of IP protocol\n\nExample: ` \"ipv4\"`","title":"IP version","x-displayname":"IP version","x-ves-example":"ipv4"},"priority":{"type":"integer","description":" Route Priority\n\nExample: ` 1`","title":"Priority","format":"int64","x-displayname":"Priority"},"route_name":{"type":"string","description":" GCP Route Name\n\nExample: ` \"default-route\"`","title":"GCP Route Name","x-displayname":"GCP Route Name","x-ves-example":"default-route"},"route_type":{"$ref":"#/components/schemas/topologyGCPRouteType"},"scope_limits":{"type":"array","description":" Limits on the scope of route like network tag\n\nExample: ` \"tag-1, tag-2\"`","title":"Scope Limits","items":{"type":"string"},"x-displayname":"Scope Limits","x-ves-example":"tag-1, tag-2"}}},"topologyGCPRouteType":{"type":"string","description":"GCP Route Type\n\n - GCP_ROUTE_TYPE_NONE: GCP Route Type None\n\nGCP Route Type None\n - GCP_ROUTE_TYPE_TRANSIT: GCP Route Type Transit\n\nGCP Route Type Transit\n - GCP_ROUTE_TYPE_SUBNET: GCP Route Type Subnet\n\nGCP Route Type Subnet\n - GCP_ROUTE_TYPE_STATIC: GCP Route Type Static\n\nGCP Route Type Static\n - GCP_ROUTE_TYPE_BGP: GCP Route Type BGP\n\nGCP Route Type BGP","title":"GCPRouteType","enum":["GCP_ROUTE_TYPE_NONE","GCP_ROUTE_TYPE_TRANSIT","GCP_ROUTE_TYPE_SUBNET","GCP_ROUTE_TYPE_STATIC","GCP_ROUTE_TYPE_BGP"],"default":"GCP_ROUTE_TYPE_NONE","x-displayname":"GCP Route type","x-ves-proto-enum":"ves.io.schema.topology.GCPRouteType"},"topologyGatewayTypeEnum":{"type":"string","description":"Gateway Type\n\n - INGRESS_GATEWAY: Ingress gateway\n\nIngress gateway (single nic)\n - INGRESS_EGRESS_GATEWAY: Ingress and Egress gateway\n\nIngress and Egress gateway (dual nic)","title":"GatewayType","enum":["INGRESS_GATEWAY","INGRESS_EGRESS_GATEWAY"],"default":"INGRESS_GATEWAY","x-displayname":"Gateway type","x-ves-proto-enum":"ves.io.schema.topology.GatewayTypeEnum"},"topologyInstanceType":{"type":"object","description":"A canonical form of the instance.","title":"Instance","x-displayname":"instance","x-ves-proto-message":"ves.io.schema.topology.InstanceType","properties":{"architecture":{"type":"string","description":" Architecture","title":"Architecture","x-displayname":"Architecture"},"availability_zone":{"type":"string","description":" Availability Zone","title":"Availability Zone","x-displayname":"Availability Zone"},"cpu":{"type":"integer","description":" CPU Count","title":"CPU","format":"int64","x-displayname":"CPU Count"},"f5xc_node_name":{"type":"string","description":" F5XC node name","title":"F5XC Node name","x-displayname":"F5XC Node Name"},"instance_type":{"type":"string","description":" Instance type","title":"Instance type","x-displayname":"Instance type"},"interfaces":{"type":"array","description":" A list of network interfaces","title":"Interfaces","items":{"$ref":"#/components/schemas/topologyNetworkInterfaceType"},"x-displayname":"Network Interfaces"},"platform":{"type":"string","description":" Platform","title":"Platform","x-displayname":"Platform"},"private_address":{"type":"string","description":" Private Address","title":"Private addresse","x-displayname":"Private Address"},"private_dns_name":{"type":"string","description":" Private DNS Name","title":"Private DNS Name","x-displayname":"Private DNS Name"},"public_address":{"type":"string","description":" Public address","title":"Public address","x-displayname":"Public Address"},"public_dns_name":{"type":"string","description":" Public DNS Name","title":"Public DNS Name","x-displayname":"Public DNS Name"},"security_group":{"type":"array","description":" Security groups","title":"Security Groups","items":{"type":"string"},"x-displayname":"Security Groups"}}},"topologyInterfaceTypeEnum":{"type":"string","description":" - INSIDE: INSIDE Interface\n\n - WORKLOAD: Workload Interface\n\n - NOT_APPLICABLE: NOT_APPLICABLE\n\nEx - When the subnet belongs to a azure spoke vnet","title":"- OUTSIDE: OUTSIDE Interface","enum":["OUTSIDE","INSIDE","WORKLOAD","NOT_APPLICABLE"],"default":"OUTSIDE","x-displayname":"","x-ves-proto-enum":"ves.io.schema.topology.InterfaceTypeEnum"},"topologyLinkInfo":{"type":"object","description":"Information about the link that connects 2 nodes in the topology graph.","title":"LinkInfo","x-displayname":"Link Info","x-ves-proto-message":"ves.io.schema.topology.LinkInfo","properties":{"dst_id":{"type":"string","description":" Endpoint identifier. dst_id is the destination endpoint for the link is between src_id and dst_id.\n\nExample: ` \"master-0\"`","title":"Destination ID","x-displayname":"Destination ID","x-ves-example":"master-0"},"name":{"type":"string","description":" Name of the link.\n Link name may or may not be present depending on the type of link.\n\nExample: ` \"tunnel-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"tunnel-1"},"src_id":{"type":"string","description":" Endpoint identifier. src_id is the source endpoint for the link is between src_id and dst_id.\n\nExample: ` \"master-0\"`","title":"Source ID","x-displayname":"Source ID","x-ves-example":"master-0"},"status":{"$ref":"#/components/schemas/topologyLinkStatus"},"type":{"$ref":"#/components/schemas/schematopologyLinkType"}}},"topologyLinkInfoSummary":{"type":"object","description":"Summary information for a link type","title":"LinkInfoSummary","x-displayname":"Link Info Summary","x-ves-proto-message":"ves.io.schema.topology.LinkInfoSummary","properties":{"count":{"type":"integer","description":" Links count.","title":"Count","format":"int64","x-displayname":"Count"},"status":{"$ref":"#/components/schemas/topologyLinkStatus"},"type":{"$ref":"#/components/schemas/schematopologyLinkType"}}},"topologyLinkStatus":{"type":"string","description":"Enumerates link status.\n\nStatus not applicable for this link\nStatus unknown for this link\nIndicates status up/active\nIndicates status down/inactive\nIndicates status degraded","title":"LinkStatus","enum":["LINK_STATUS_NOT_APPLICABLE","LINK_STATUS_UNKNOWN","LINK_STATUS_UP","LINK_STATUS_DOWN","LINK_STATUS_DEGRADED"],"default":"LINK_STATUS_NOT_APPLICABLE","x-displayname":"Link Status","x-ves-proto-enum":"ves.io.schema.topology.LinkStatus"},"topologyLinkTypeData":{"type":"object","description":"LinkTypeData contains details about the link and the metrics (if requested/available).","title":"LinkTypeData","x-displayname":"Link Type Data","x-ves-proto-message":"ves.io.schema.topology.LinkTypeData","properties":{"info":{"$ref":"#/components/schemas/topologyLinkInfo"},"metric":{"type":"array","description":" Metric data for the link.","title":"Metric","items":{"$ref":"#/components/schemas/topologyMetricData"},"x-displayname":"Metric"}}},"topologyLoadBalancer":{"type":"object","description":"Load Balancer","title":"LB","x-displayname":"Load Balancer","x-ves-proto-message":"ves.io.schema.topology.LoadBalancer","properties":{"id":{"type":"string","description":" Id of the LB","title":"Id","x-displayname":"Id"},"name":{"type":"string","description":" Name of the LB","title":"Name","x-displayname":"Name"}}},"topologyMetaType":{"type":"object","description":"A metadata for topology objects.","title":"Metadata","x-displayname":"MetaType","x-ves-proto-message":"ves.io.schema.topology.MetaType","properties":{"creds":{"type":"array","description":" Reference to cloud credentials to fetch cloud resources.","title":"Cloud Credentials","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Cloud Credentials"},"id":{"type":"string","description":" ID in the external system (such as cloud specific ID).","title":"ID","x-displayname":"ID"},"name":{"type":"string","description":" Name in the external system.","title":"Name","x-displayname":"Name"},"owner_id":{"type":"string","description":" owner id in the cloud side.","title":"OwnerID","x-displayname":"Owner ID"},"provider_type":{"$ref":"#/components/schemas/topologyProviderType"},"raw_json":{"type":"string","description":" raw json string","title":"Raw JSON","x-displayname":"Raw JSON"},"status":{"type":"string","description":" status of topology node","title":"Status","x-displayname":"Status"},"tags":{"type":"object","description":" Map of string keys and values that annotated in the topology node.\n\nExample: ` \"value\"`","title":"tags","x-displayname":"Tags","x-ves-example":"value"}}},"topologyMetricData":{"type":"object","description":"Metric Data contains the metric type and the metric data.","title":"Metric Data","x-displayname":"Metric Data","x-ves-proto-message":"ves.io.schema.topology.MetricData","properties":{"data":{"type":"array","description":" Metric Data","title":"Data","items":{"$ref":"#/components/schemas/schematopologyMetricTypeData"},"x-displayname":"Data"},"type":{"$ref":"#/components/schemas/schematopologyMetricType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"}}},"topologyMetricSelector":{"type":"object","description":"MetricSelector is used to specify the list of metrics to be returned in the response.","title":"Metric Selector","x-displayname":"Metric Selector","x-ves-proto-message":"ves.io.schema.topology.MetricSelector","properties":{"edge":{"type":"array","description":" List of metrics to be returned for the edges\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Edge Metric Types","items":{"$ref":"#/components/schemas/schematopologyMetricType"},"x-displayname":"Edge Metric Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"end_time":{"type":"string","description":" End time of metric data. This field is applicable only if \"include_metrics\" is set to true.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"node":{"type":"array","description":" List of metrics to be returned for the nodes\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Node Metric Types","items":{"$ref":"#/components/schemas/schematopologyMetricType"},"x-displayname":"Node Metric Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"start_time":{"type":"string","description":" Start time of metric data. This field is applicable only if \"include_metrics\" is set to true.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"topologyNetworkInterfaceType":{"type":"object","description":"A canonical form of the network interface.","title":"Network Interface","x-displayname":"Network Interface","x-ves-proto-message":"ves.io.schema.topology.NetworkInterfaceType","properties":{"f5xc_status":{"$ref":"#/components/schemas/siteInterfaceStatus"},"name":{"type":"string","description":" Name of this interface","title":"Name","x-displayname":"Name"},"private_addresses":{"type":"array","description":" Private Address","title":"Private addresses","items":{"$ref":"#/components/schemas/topologyAddressInfoType"},"x-displayname":"Private Addresses"},"public_address":{"type":"array","description":" Public address","title":"Public address","items":{"$ref":"#/components/schemas/topologyAddressInfoType"},"x-displayname":"Public Address"},"security_group":{"type":"array","description":" Security groups","title":"Security Groups","items":{"type":"string"},"x-displayname":"Security Groups"},"status":{"type":"string","description":" Status","title":"Status","x-displayname":"Status"},"subnet":{"type":"array","description":" Reference to the subnets connected","title":"Subnets","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Subnets"}}},"topologyNetworkRouteTableData":{"type":"object","description":"Data associated with the  network route tables","title":"NetworkRouteTableData","x-displayname":"Network Route Data","x-ves-proto-message":"ves.io.schema.topology.NetworkRouteTableData","properties":{"route_table_data":{"$ref":"#/components/schemas/topologyRouteTableData"},"subnet_data":{"type":"array","description":" Subnet Data","title":"Subnet Data","items":{"$ref":"#/components/schemas/topologySubnetData"},"x-displayname":"Subnet Data"}}},"topologyNetworkRouteTableMetaData":{"type":"object","description":"Metadata associated with the network route tables","title":"NetworkRouteTableMetaData","x-displayname":"Network RouteTable Metadata","x-ves-proto-message":"ves.io.schema.topology.NetworkRouteTableMetaData","properties":{"route_table_metadata":{"$ref":"#/components/schemas/topologyRouteTableMetaData"},"subnet_metadata":{"type":"array","description":" Subnet Metadata","title":"Subnet Metadata","items":{"$ref":"#/components/schemas/topologySubnetMetaData"},"x-displayname":"Subnet Metadata"}}},"topologyNetworkRouteTablesResponse":{"type":"object","description":"List of RouteTables Associated in the Network","title":"Network Route Tables Response","x-displayname":"Network Route Tables Response","x-ves-proto-message":"ves.io.schema.topology.NetworkRouteTablesResponse","properties":{"routes_data":{"type":"array","description":" Network Routes Data","title":"Network Routes Data","items":{"$ref":"#/components/schemas/topologyNetworkRoutesData"},"x-displayname":"Network Routes Data"}}},"topologyNetworkRoutesData":{"type":"object","description":"Data associated with the network routes","title":"NetworkRoutesData","x-displayname":"Network Routes Data","x-ves-proto-message":"ves.io.schema.topology.NetworkRoutesData","properties":{"network_id":{"type":"string","description":" Network Id","title":"Network Id","x-displayname":"Network Id"},"route_tables_data":{"type":"array","description":" Network Route Tables Data","title":"Network Routes Data","items":{"$ref":"#/components/schemas/topologyNetworkRouteTableData"},"x-displayname":"Network Route Tables Data"}}},"topologyNetworkRoutesMetaData":{"type":"object","description":"Metadata associated with the network routes","title":"NetworkRoutesMetaData","x-displayname":"Network RouteTable Metadata","x-ves-proto-message":"ves.io.schema.topology.NetworkRoutesMetaData","properties":{"cloud_resource_id":{"type":"string","description":" Cloud Resource Id","title":"Cloud Resource Id","x-displayname":"Cloud Resource Id"},"id":{"type":"string","description":" Network Id","title":"Network Id","x-displayname":"Id"},"name":{"type":"string","description":" Network Name","title":"Network Name","x-displayname":"Name"},"network_type":{"$ref":"#/components/schemas/topologyCloudNetworkType"},"regions":{"type":"array","description":" Regions in Network","title":"Regions","items":{"type":"string"},"x-displayname":"Regions"},"route_tables_metadata":{"type":"array","description":" Network Route Tables Metadata","title":"Network Route Tables Metadata","items":{"$ref":"#/components/schemas/topologyNetworkRouteTableMetaData"},"x-displayname":"Network Route Tables Metadata"}}},"topologyNetworkSummaryInfo":{"type":"object","description":"Summary information related to the network","title":"NetworkSummaryInfo","x-displayname":"Network Summary","x-ves-proto-message":"ves.io.schema.topology.NetworkSummaryInfo","properties":{"route_tables":{"type":"array","description":" List of route tables associated with the network","title":"Route Tables","items":{"$ref":"#/components/schemas/topologyRouteTableMetaData"},"x-displayname":"Route Tables"}}},"topologyNetworkType":{"type":"object","description":"A canonical form of the network.","title":"Network","x-displayname":"network","x-ves-proto-message":"ves.io.schema.topology.NetworkType","properties":{"cidr_v4":{"type":"array","description":" IPv4 Cidr","title":"IPv4 Cidr","items":{"type":"string"},"x-displayname":"IPv4 Cidr"},"cidr_v6":{"type":"array","description":" IPv6 Cidr","title":"IPv6 Cidr","items":{"type":"string"},"x-displayname":"IPv6 Cidr"},"load_balancer":{"type":"array","description":" Load Balancer Present in this Network","title":"Load Balancer","items":{"$ref":"#/components/schemas/topologyLoadBalancer"},"x-displayname":"Load Balancer"},"network_peers":{"type":"array","description":" Reference to the network peers","title":"Network peers","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Network Peers"},"region":{"type":"array","description":" Reference to the regions","title":"Region","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Region"}}},"topologyNodeMetaData":{"type":"object","description":"Metadata for node","title":"Node Metadata","x-displayname":"Node Metadata","x-ves-proto-message":"ves.io.schema.topology.NodeMetaData","properties":{"cloud_resource_id":{"type":"string","description":" Cloud Resource Identifier for the node. This is only used for node which represent the cloud resource","title":"Cloud Resource Id","x-displayname":"Cloud Resource Id"},"description":{"type":"string","description":" Description of the node.\n This field may or may not be populated depending on the node type and if the user provided description\n while creating the resource.","title":"Description","x-displayname":"Description"},"level":{"type":"integer","description":" Level indicates the distance of the node from the root node. A value of 0 indicates the root node.\n\nExample: ` \"1\"`","title":"Level","format":"int64","x-displayname":"Level","x-ves-example":"1"},"name":{"type":"string","description":" Name of the node.\n\nExample: ` \"site-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"site-1"},"owner_id":{"type":"string","description":" Owner id\n\nExample: ` \"owner-1\"`","title":"Owner Id","x-displayname":"Owner Id","x-ves-example":"owner-1"},"provider_type":{"$ref":"#/components/schemas/topologyProviderType"},"status":{"type":"string","description":" status in the node","title":"Status","x-displayname":"Status"},"tags":{"type":"object","description":" List of key/value pairs associated with the node","title":"Tags","x-displayname":"Tags"}}},"topologyNodeTypeDCClusterGroup":{"type":"object","description":"DC Cluster group is represented as a node in the site topology graph.\nIn the DCClusterTopology API, dc_cluster_group is represented as a node and all the sites\nthat are part of the DC Cluster group are represented as edges (site -> dc_cluster_group) in\naddition to the edges between the sites (site <-> site).","title":"NodeTypeDCClusterGroup","x-displayname":"DC Cluster Group","x-ves-proto-message":"ves.io.schema.topology.NodeTypeDCClusterGroup","properties":{"info":{"$ref":"#/components/schemas/topologyDCClusterGroupType"},"summary":{"$ref":"#/components/schemas/topologyDCClusterGroupSummaryInfo"}}},"topologyNodeTypeInstance":{"type":"object","description":"NodeTypeInstance contains details about the instance and the metrics (if requested/available).","title":"NodeTypeInstance","x-displayname":"Instance","x-ves-proto-message":"ves.io.schema.topology.NodeTypeInstance","properties":{"info":{"$ref":"#/components/schemas/topologyInstanceType"},"metric":{"type":"array","description":" Metric data for the Instance.","title":"Metric","items":{"$ref":"#/components/schemas/topologyMetricData"},"x-displayname":"Metric"}}},"topologyNodeTypeNetwork":{"type":"object","description":"NodeTypeNetwork contains details about the network and the metrics (if requested/available).","title":"NodeTypeNetwork","x-displayname":"Network","x-ves-proto-message":"ves.io.schema.topology.NodeTypeNetwork","properties":{"info":{"$ref":"#/components/schemas/topologyNetworkType"},"metric":{"type":"array","description":" Metric data for the Network.","title":"Metric","items":{"$ref":"#/components/schemas/topologyMetricData"},"x-displayname":"Metric"},"summary":{"$ref":"#/components/schemas/topologyNetworkSummaryInfo"}}},"topologyNodeTypeSite":{"type":"object","description":"NodeTypeSite contains details about the site and the metrics (if requested/available).","title":"NodeTypeSite","x-displayname":"Site","x-ves-proto-message":"ves.io.schema.topology.NodeTypeSite","properties":{"info":{"$ref":"#/components/schemas/schematopologySiteType"},"metric":{"type":"array","description":" Metric data for the Site.","title":"Metric","items":{"$ref":"#/components/schemas/topologyMetricData"},"x-displayname":"Metric"},"summary":{"$ref":"#/components/schemas/topologySiteSummaryInfo"}}},"topologyNodeTypeSiteMeshGroup":{"type":"object","description":"Site mesh group is represented as a node in the site topology graph.\nIn the SiteMeshTopology API, site_mesh_group is represented as a node and all the sites\nthat are part of the site mesh group are represented as edges (site -> site_mesh_group) in\naddition to the edges between the sites (site <-> site). If the site_mesh_group is of type \"Spoke\",\nthen the node representing the site_mesh_group will have an edge with another site_mesh_group node\nthat represents the \"Hub\" and vice-versa.","title":"NodeTypeSiteMeshGroup","x-displayname":"Site Mesh Group","x-ves-proto-message":"ves.io.schema.topology.NodeTypeSiteMeshGroup","properties":{"info":{"$ref":"#/components/schemas/schematopologySiteMeshGroupType"},"summary":{"$ref":"#/components/schemas/topologySiteMeshGroupSummaryInfo"}}},"topologyNodeTypeSubnet":{"type":"object","description":"NodeTypeSubnet contains details about the subnet and the metrics (if requested/available).","title":"NodeTypeSubnet","x-displayname":"Subnet","x-ves-proto-message":"ves.io.schema.topology.NodeTypeSubnet","properties":{"info":{"$ref":"#/components/schemas/topologySubnetType"},"metric":{"type":"array","description":" Metric data for the Subnet.","title":"Metric","items":{"$ref":"#/components/schemas/topologyMetricData"},"x-displayname":"Metric"},"summary":{"$ref":"#/components/schemas/topologySubnetSummaryInfo"}}},"topologyNodeTypeTransitGateway":{"type":"object","description":"NodeTypeTransitGateway contains details about the transit gateway and the metrics (if requested/available).","title":"NodeTypeTransitGateway","x-displayname":"Transit Gateway","x-ves-proto-message":"ves.io.schema.topology.NodeTypeTransitGateway","properties":{"info":{"$ref":"#/components/schemas/topologyTransitGatewayType"},"metric":{"type":"array","description":" Metric data for the Transit Gateway.","title":"Metric","items":{"$ref":"#/components/schemas/topologyMetricData"},"x-displayname":"Metric"}}},"topologyOrchestrationMode":{"type":"string","description":"Orchestration mode of a given site\n\n - NOT_MANAGED: Unmanaged mode\n\nUnmanaged mode\n - MANAGED: Managed mode\n\nManaged mode","title":"Orchestration Mode","enum":["NOT_MANAGED","MANAGED"],"default":"NOT_MANAGED","x-displayname":"Orchestration Mode","x-ves-proto-enum":"ves.io.schema.topology.OrchestrationMode"},"topologyProviderInfo":{"type":"object","description":"x-displayName: \"Provider Info\"\nCloud provider information","title":"ProviderInfo","properties":{"azure_rg_info":{"$ref":"#/components/schemas/topologyAzureResourceGroupInfo"},"cloud_link":{"type":"array","description":"x-displayName: \"Cloud Link\"\nReference to cloud link","title":"Cloud Link","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"}},"gcp_zones":{"type":"array","description":"x-displayName: \"GCP Zones\"\nGCP Zones for the resource","title":"GCP Zones","items":{"type":"string"}},"region":{"type":"string","description":"x-displayName: \"Region\"\nRegion in which the resource exists","title":"Region"}}},"topologyProviderType":{"type":"string","description":"provider type\n\nProviderType unspecified\nAWS backend\nGCP backend\nAzure backend\nF5XC backend\nVMware backend\nKVM backend\nOCI backend\nBaremetal backend\nF5 rSeries backend\nCE on k8s backend","title":"ProviderType","enum":["PROVIDER_TYPE_UNSPECIFIED","PROVIDER_TYPE_AWS","PROVIDER_TYPE_GCP","PROVIDER_TYPE_AZURE","PROVIDER_TYPE_VOLTERRA","PROVIDER_TYPE_VMWARE","PROVIDER_TYPE_KVM","PROVIDER_TYPE_OCI","PROVIDER_TYPE_BAREMETAL","PROVIDER_TYPE_F5RSERIES","PROVIDER_TYPE_K8S"],"default":"PROVIDER_TYPE_UNSPECIFIED","x-displayname":"Provider Type","x-ves-proto-enum":"ves.io.schema.topology.ProviderType"},"topologyRouteNextHopTypeEnum":{"type":"string","description":"RouteNextHopTypeEnum\n\n - VIRTUAL_NETWORK_GATEWAY: VIRTUAL NETWORK GATEWAY\n\nVIRTUAL NETWORK GATEWAY\n - VNET_LOCAL: VNET LOCAL\n\nVNET LOCAL\n - INTERNET: INTERNET\n\nINTERNET\n - VIRTUAL_APPLIANCE: VIRTUAL APPLIANCE\n\nVIRTUAL APPLIANCE\n - NONE: NONE\n\nNONE\n - VNET_PEERING: VNET PEERING\n\nVNET PEERING\n - VIRTUAL_NETWORK_SERVICE_ENDPOINT: VIRTUAL NETWORK SERVICE ENDPOINT\n\nVIRTUAL NETWORK SERVICE ENDPOINT\n - NEXT_HOP_TYPE_NOT_APPLICABLE: NEXT_HOP_TYPE_NOT_APPLICABLE\n\nNEXT_HOP_TYPE_NOT_APPLICABLE should be used when the cloud provider doesn't support this.\n - LOADBALANCER: LOAD BALANCER\n\nLOAD BALANCER\n - VPC_NETWORK: VPC NETWORK\n\nVPC NETWORK\n - VPC_PEERING: VPC PEERING\n\nVPC PEERING\n - INTERNAL_LOAD_BALANCER: INTERNAL LOAD BALANCER\n\nINTERNAL LOAD BALANCER\n - INSTANCE: INSTANCE\n\nINSTANCE\n - INTERCONNECT: INTERCONNECT\n\nINTERCONNECT\n - INTERNET_GATEWAY: INTERNET GATEWAY\n\nINTERNET GATEWAY\n - IP: IP\n\nIP\n - VPN_TUNNEL: VPN TUNNEL\n\nVPN TUNNEL\n - TGW_ATTACHMENT: TGW ATTACHMENT\n\nTGW ATTACHMENT","title":"RouteNextHopTypeEnum","enum":["VIRTUAL_NETWORK_GATEWAY","VNET_LOCAL","INTERNET","VIRTUAL_APPLIANCE","NONE","VNET_PEERING","VIRTUAL_NETWORK_SERVICE_ENDPOINT","NEXT_HOP_TYPE_NOT_APPLICABLE","LOADBALANCER","VPC_NETWORK","VPC_PEERING","INTERNAL_LOAD_BALANCER","INSTANCE","INTERCONNECT","INTERNET_GATEWAY","IP","VPN_TUNNEL","TGW_ATTACHMENT"],"default":"VIRTUAL_NETWORK_GATEWAY","x-displayname":"RouteNextHopTypeEnum","x-ves-proto-enum":"ves.io.schema.topology.RouteNextHopTypeEnum"},"topologyRouteSourceTypeEnum":{"type":"string","description":"RouteSourceTypeEnum\n\n - INVALID_SOURCE: INVALID_SOURCE\n\nINVALID_SOURCE\n - DEFAULT: DEFAULT\n\nDEFAULT\n - USER: USER\n\nUSER\n - UNKNOWN: UNKNOWN\n\nUNKNOWN\n - VIRTUAL_NETWORK_GATEWAY_SOURCE: VIRTUAL_NETWORK_GATEWAY_SOURCE\n\nVIRTUAL_NETWORK_GATEWAY_SOURCE\n - SOURCE_NOT_APPLICABLE: SOURCE_NOT_APPLICABLE\n\nSOURCE_NOT_APPLICABLE should be used when the cloud provider does not supports this.","title":"RouteSourceTypeEnum","enum":["INVALID_SOURCE","DEFAULT","USER","UNKNOWN","VIRTUAL_NETWORK_GATEWAY_SOURCE","SOURCE_NOT_APPLICABLE"],"default":"INVALID_SOURCE","x-displayname":"RouteSourceTypeEnum","x-ves-proto-enum":"ves.io.schema.topology.RouteSourceTypeEnum"},"topologyRouteStateTypeEnum":{"type":"string","description":"RouteStateTypeEnum\n\n - ACTIVE_STATE: ACTIVE_STATE\n\nACTIVE_STATE\n - INVALID_STATE: INVALID_STATE\n\nINVALID_STATE\n - STATE_NOT_APPLICABLE: STATE_NOT_APPLICABLE\n\nSTATE_NOT_APPLICABLE should be used when the cloud provider doesn't supports this\n - STATE_BLACKHOLE: STATE_BLACKHOLE\n\nSTATE_BLACKHOLE\n - STATE_UNAVAILABLE: STATE_UNAVAILABLE\n\nSTATE_UNAVAILABLE\n - STATE_PENDING: STATE_PENDING\n\nSTATE_PENDING\n - STATE_DELETING: STATE_DELETING\n\nSTATE_DELETING\n - STATE_DELETED: STATE_DELETING\n\nSTATE_DELETED","title":"RouteStateTypeEnum","enum":["ACTIVE_STATE","INVALID_STATE","STATE_NOT_APPLICABLE","STATE_BLACKHOLE","STATE_UNAVAILABLE","STATE_PENDING","STATE_DELETING","STATE_DELETED"],"default":"ACTIVE_STATE","x-displayname":"RouteStateTypeEnum","x-ves-proto-enum":"ves.io.schema.topology.RouteStateTypeEnum"},"topologyRouteTableData":{"type":"object","description":"Data associated with the route table","title":"RouteTableData","x-displayname":"Route Table Data","x-ves-proto-message":"ves.io.schema.topology.RouteTableData","properties":{"metadata":{"$ref":"#/components/schemas/topologyRouteTableMetaData"},"route_table":{"$ref":"#/components/schemas/topologyRouteTableType"}}},"topologyRouteTableMetaData":{"type":"object","description":"Metadata associated with the route table","title":"RouteTableMetaData","x-displayname":"Route Table Metadata","x-ves-proto-message":"ves.io.schema.topology.RouteTableMetaData","properties":{"cloud_resource_id":{"type":"string","description":" Cloud Resource Identifier this route table","title":"Cloud Resource Id","x-displayname":"Cloud Resource Id"},"name":{"type":"string","description":" Name of the route table\n\nExample: ` \"rt-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"rt-1"},"tags":{"type":"object","description":" Map of string keys and values that annotated in the topology node.\n\nExample: ` \"value\"`","title":"tags","x-displayname":"Tags","x-ves-example":"value"}}},"topologyRouteTableResponse":{"type":"object","description":"Route table","title":"Route Table Response","x-displayname":"Route Table Response","x-ves-proto-message":"ves.io.schema.topology.RouteTableResponse","properties":{"metadata":{"$ref":"#/components/schemas/topologyRouteTableMetaData"},"route_table":{"$ref":"#/components/schemas/topologyRouteTableType"}}},"topologyRouteTableStateEnum":{"type":"string","description":"Route table state\n\nRoute table state None\nRoute table state Pending\nRoute table state Availble\nRoute table state Deleting\nRoute table state Deleted","title":"RouteTableStateEnum","enum":["ROUTE_TABLE_STATE_NONE","ROUTE_TABLE_STATE_PENDING","ROUTE_TABLE_STATE_AVAILABLE","ROUTE_TABLE_STATE_DELETING","ROUTE_TABLE_STATE_DELETED"],"default":"ROUTE_TABLE_STATE_NONE","x-displayname":"Route Table State","x-ves-proto-enum":"ves.io.schema.topology.RouteTableStateEnum"},"topologyRouteTableType":{"type":"object","description":"A canonical form of the route table.","title":"RouteTableType","x-displayname":"Route Table","x-ves-proto-message":"ves.io.schema.topology.RouteTableType","properties":{"associations":{"type":"array","description":" list of associations","title":"Associations","items":{"$ref":"#/components/schemas/topologyAWSTGWAttachmentMetaData"},"x-displayname":"Associations"},"explicit_subnet":{"type":"array","description":" Reference to the subnet explicitly accociated.","title":"Explicit Subnet Association","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Explicit Subnet Association"},"implicit_subnet":{"type":"array","description":" Reference to the subnet implicitly accociated.","title":"Implicit Subnet Association","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Implicit Subnet Association"},"network":{"type":"array","description":" Reference to the network.","title":"Network","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Network"},"propagations":{"type":"array","description":" list of propagations","title":"Propagations","items":{"$ref":"#/components/schemas/topologyAWSTGWAttachmentMetaData"},"x-displayname":"Propagations"},"route_table_state":{"$ref":"#/components/schemas/topologyRouteTableStateEnum"},"route_table_type":{"$ref":"#/components/schemas/topologyRouteTableTypeEnum"},"routes":{"type":"array","description":" list of routes","title":"Routes","items":{"$ref":"#/components/schemas/topologyRouteType"},"x-displayname":"Routes"},"subnet":{"type":"array","description":" Reference to the subnet.","title":"Subnet","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Subnet"},"transit_gateway":{"type":"array","description":" Reference to the transit gateway if a transit gateway owns this resource.","title":"Transit Gateway","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Transit Gateway"}}},"topologyRouteTableTypeEnum":{"type":"string","description":"Route table backend.\n\nRoute table for network\nRoute Table for transit gateway","title":"RouteTableTypeEnum","enum":["ROUTE_TABLE_NETWORK","ROUTE_TABLE_TGW"],"default":"ROUTE_TABLE_NETWORK","x-displayname":"Route Table Type","x-ves-proto-enum":"ves.io.schema.topology.RouteTableTypeEnum"},"topologyRouteType":{"type":"object","description":"A canonical form of the route.","title":"RouteType","x-displayname":"Route Type","x-ves-oneof-field-cloud_route_attributes":"[\"aws\",\"gcp\"]","x-ves-proto-message":"ves.io.schema.topology.RouteType","properties":{"aws":{"$ref":"#/components/schemas/topologyAWSRouteAttributes"},"destination":{"type":"string","description":" Destination","title":"Destination","x-displayname":"Destination"},"gcp":{"$ref":"#/components/schemas/topologyGCPRouteAttributes"},"next_hop_type":{"$ref":"#/components/schemas/topologyRouteNextHopTypeEnum"},"nexthop":{"type":"string","description":" Nexthop (IP subnet or gateway ID)","title":"Nexthop","x-displayname":"Nexthop"},"source":{"$ref":"#/components/schemas/topologyRouteSourceTypeEnum"},"state":{"$ref":"#/components/schemas/topologyRouteStateTypeEnum"},"user_defined_route_name":{"type":"string","description":" User Defined Route Name","title":"User Defined Route Name","x-displayname":"User Defined Route Name"}}},"topologySiteAppTypeEnum":{"type":"string","description":"Site App Type\n\n - SITE_APPTYPE_NONE: Not applicable \n\nNot applicable\n - SITE_APPTYPE_APPSTACK: AppStack Site\n\nAppStack Site\n - SITE_APPTYPE_MESH: Mesh site \n\nMesh site","title":"Site App Type","enum":["SITE_APPTYPE_NONE","SITE_APPTYPE_APPSTACK","SITE_APPTYPE_MESH"],"default":"SITE_APPTYPE_NONE","x-displayname":"Site App type","x-ves-proto-enum":"ves.io.schema.topology.SiteAppTypeEnum"},"topologySiteMeshGroupSummaryInfo":{"type":"object","description":"Summary information related to the site mesh group","title":"SiteMeshGroupSummaryInfo","x-displayname":"Site Mesh Group Summary","x-ves-proto-message":"ves.io.schema.topology.SiteMeshGroupSummaryInfo","properties":{"edge_status_summary":{"type":"array","description":" Summary of the edges status between the sites in the site mesh group.","title":"Edge Summary","items":{"$ref":"#/components/schemas/topologyEdgeInfoSummary"},"x-displayname":"Edge Summary"},"link_status_summary":{"type":"array","description":" Summary of the link status between the sites in the site mesh group.","title":"Link Status Summary","items":{"$ref":"#/components/schemas/topologyLinkInfoSummary"},"x-displayname":"Link Status Summary"},"other_connected_site_mesh_group_sites":{"type":"integer","description":" If the site mesh group is of type \"Hub\", this field indicates the number of sites in all the spoke mesh groups\n that are connected to this site mesh group.\n If the site mesh group is of type \"Spoke\", this field indicates the number of sites in the hub as well as the sites\n in other spoke groups that are attached to this hub.","title":"Other Connected Site Mesh Group Sites","format":"int64","x-displayname":"Other Connected Site Mesh Group Sites"},"sites":{"type":"integer","description":" This field indicates the number of sites that are part of this site mesh group.","title":"Sites","format":"int64","x-displayname":"Sites"}}},"topologySiteMeshTopologyRequest":{"type":"object","description":"Request to get site mesh group topology and the associated metrics.","title":"Site Mesh Group Topology Request","x-displayname":"Site Mesh Group Topology Request","x-ves-proto-message":"ves.io.schema.topology.SiteMeshTopologyRequest","properties":{"metric_selector":{"$ref":"#/components/schemas/topologyMetricSelector"},"site_mesh_group":{"type":"string","description":"\n Name of the site mesh group\n\nExample: ` \"smg-1\"`","title":"Site Mesh Group","x-displayname":"Site Mesh Group","x-ves-example":"smg-1"}}},"topologySiteNetworksResponse":{"type":"object","description":"List of Networks Associated to Site","title":"Site Networks Response","x-displayname":"Site Networks Response","x-ves-oneof-field-cloud_network_meta_data":"[\"aws\"]","x-ves-proto-message":"ves.io.schema.topology.SiteNetworksResponse","properties":{"aws":{"$ref":"#/components/schemas/topologyAWSNetworkMetaData"},"routes_metadata":{"type":"array","description":" Network Routes Meta Data","title":"Network Routes Meta Data","items":{"$ref":"#/components/schemas/topologyNetworkRoutesMetaData"},"x-displayname":"Network Routes Meta Data"}}},"topologySiteSummaryInfo":{"type":"object","description":"Summary information related to the site","title":"SiteSummaryInfo","x-displayname":"Site Summary","x-ves-proto-message":"ves.io.schema.topology.SiteSummaryInfo","properties":{"availability_zone":{"type":"array","description":" Availability zone","title":"Availability Zone","items":{"type":"string"},"x-displayname":"Availability Zone"},"node_count":{"type":"integer","description":" Site Node Count.","title":"Node Count","format":"int64","x-displayname":"Node Count"},"node_info":{"type":"array","description":" Provides mapping for node, private ip and public ip","title":"node_info","items":{"$ref":"#/components/schemas/schemasiteNode"},"x-displayname":"Node info"}}},"topologySiteTopologyRequest":{"type":"object","description":"Request to get site topology and the associated metrics.","title":"Site Topology Request","x-displayname":"Site Topology Request","x-ves-proto-message":"ves.io.schema.topology.SiteTopologyRequest","properties":{"group_dc_cluster_nodes":{"type":"boolean","description":" Option to enable or disable grouping of sites in a DC Cluster group.\n If enabled, then all the sites in a DC Cluster group are returned as a single node in the response.","title":"Group DC Cluster nodes","format":"boolean","x-displayname":"Group DC Cluster nodes"},"group_site_mesh_nodes":{"type":"boolean","description":" Option to enable or disable grouping of sites in a site mesh group.\n If enabled, then all the sites in a site mesh group are returned as a single node in the response.","title":"Group Site Mesh nodes","format":"boolean","x-displayname":"Group Site Mesh nodes"},"level":{"type":"integer","description":" Level determines the nodes and the corresponding edges to be returned in the response based on its distance from the root node.\n If the level specified in the request is 1, then the response contains the root node (level:0) and all its immediate neighbors (level:1).\n If the level is set to -1, then all the nodes and edges in the topology graph will be returned in the response.\n\nExample: ` \"2\"`","title":"Level","format":"int32","x-displayname":"Level","x-ves-example":"2"},"metric_selector":{"$ref":"#/components/schemas/topologyMetricSelector"},"node_id":{"type":"string","description":" Specifies the node in the topology graph to start the graph traversal.\n\nExample: ` \"site:site-1\"`","title":"Node Id","x-displayname":"Node Id","x-ves-example":"site:site-1"},"site":{"type":"string","description":"\n Name of the site\n\nExample: ` \"ce01\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce01"}}},"topologySubnetData":{"type":"object","description":"Data associated with the subnets","title":"SubnetData","x-displayname":"Subnet Data","x-ves-proto-message":"ves.io.schema.topology.SubnetData","properties":{"metadata":{"$ref":"#/components/schemas/topologySubnetMetaData"},"subnet":{"$ref":"#/components/schemas/topologySubnetType"}}},"topologySubnetMetaData":{"type":"object","description":"Metadata associated with the subnets","title":"SubnetMetaData","x-displayname":"Subnet MetaData","x-ves-proto-message":"ves.io.schema.topology.SubnetMetaData","properties":{"cidr_v4":{"type":"array","description":" IPv4 Cidr","title":"IPv4 Cidr","items":{"type":"string"},"x-displayname":"IPv4 Cidr"},"cidr_v6":{"type":"array","description":" IPv6 Cidr","title":"IPv6 Cidr","items":{"type":"string"},"x-displayname":"IPv6 Cidr"},"cloud_resource_id":{"type":"string","description":" Cloud Resource Identifier the subnet","title":"Cloud Resource Id","x-displayname":"Cloud Resource Id"},"name":{"type":"string","description":" Name of the subnet","title":"Name","x-displayname":"Name"}}},"topologySubnetSummaryInfo":{"type":"object","description":"Summary information related to the subnet","title":"SubnetSummaryInfo","x-displayname":"Subnet Summary","x-ves-proto-message":"ves.io.schema.topology.SubnetSummaryInfo","properties":{"route_tables":{"type":"array","description":" List of route tables associated with the subnet","title":"Route Tables","items":{"$ref":"#/components/schemas/topologyRouteTableMetaData"},"x-displayname":"Route Tables"}}},"topologySubnetType":{"type":"object","description":"A canonical form of the subnet.","title":"Subnet","x-displayname":"subnet","x-ves-proto-message":"ves.io.schema.topology.SubnetType","properties":{"availability_zone":{"type":"string","description":" Availability zone","title":"Availability Zone","x-displayname":"Availability Zone"},"cidr_v4":{"type":"array","description":" IPv4 Cidr","title":"IPv4 Cidr","items":{"type":"string"},"x-displayname":"IPv4 Cidr"},"cidr_v6":{"type":"array","description":" IPv6 Cidr","title":"IPv6 Cidr","items":{"type":"string"},"x-displayname":"IPv6 Cidr"},"interface_type":{"$ref":"#/components/schemas/topologyInterfaceTypeEnum"},"network":{"type":"array","description":" Reference to the network","title":"Network","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Network"},"region":{"type":"array","description":" Reference to the regions. (Used for GCP)","title":"Region","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Region"}}},"topologyTGWRouteTablesResponse":{"type":"object","description":"List of RouteTables Associated with TGW","title":"TGW Route Tables Response","x-displayname":"TGW Route Tables Response","x-ves-proto-message":"ves.io.schema.topology.TGWRouteTablesResponse","properties":{"routes_data":{"type":"array","description":" TGW Routes Data","title":"TGW Routes Data","items":{"$ref":"#/components/schemas/topologyRouteTableData"},"x-displayname":"TGW Routes Data"}}},"topologyTopologyResponse":{"type":"object","description":"Relationship between the resources associated with a site is represented as a graph, where each resource/entity is\nrepresented as a node (example: Site (CE, RE), Network (VPC, Virtual Network), Subnet, etc.,) and their association is\nrepresented as edges (example: Site (CE) - Site (CE, RE), Network (VPC) - Subnets, etc.,). All edges are directed.\nHowever if 2 nodes have bidirectional connection, (example: Site - Site), there may be 2 edges in the response for the same\npair of nodes.","title":"Topology Response","x-displayname":"Topology Response","x-ves-proto-message":"ves.io.schema.topology.TopologyResponse","properties":{"edges":{"type":"array","description":" List of edges in the topology graph","title":"Edges","items":{"$ref":"#/components/schemas/topologyEdge"},"x-displayname":"Edges"},"nodes":{"type":"array","description":" List of nodes in the topology graph","title":"Nodes","items":{"$ref":"#/components/schemas/schematopologyNode"},"x-displayname":"Nodes"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"topologyTransitGatewayType":{"type":"object","description":"A canonical form of the transit gateway.","title":"TransitGateway","x-displayname":"transit gateway","x-ves-proto-message":"ves.io.schema.topology.TransitGatewayType","properties":{"attachments":{"type":"array","description":"TGW Attachements","title":"Attachments","items":{"$ref":"#/components/schemas/topologyAWSTGWAttachment"},"x-displayname":"Attachments"},"auto_accept_shared_attachments":{"type":"boolean","description":" Auto accept shared attachment","title":"Auto accept shared attachment","format":"boolean","x-displayname":"Auto accept shared attachment"},"dns_support":{"type":"boolean","description":" DNS support","title":"DNS support","format":"boolean","x-displayname":"DNS Support"},"network":{"type":"array","description":" Reference to the network","title":"Network","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Network"},"vpn_ecmp_support":{"type":"boolean","description":" vpn ecmp support","title":"vpn ecmp support","format":"boolean","x-displayname":"VpnEcmpSupport Support"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0241.public.ves.io.schema.operate.traceroute.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.operate.traceroute","description":"Proto definitions for traceroute diagnostic","version":""},"paths":{"/api/operate/namespaces/{namespace}/sites/{site}/ver/traceroute":{"post":{"summary":"Traceroute","description":"Run traceroute to a destination","operationId":"ves.io.schema.operate.traceroute.CustomPublicAPI.Traceroute","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tracerouteTracerouteResponse"}}}},"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: \"system\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site from which traceroute is initiated","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tracerouteTracerouteRequest"}}},"required":true},"x-ves-proto-rpc":"ves.io.schema.operate.traceroute.CustomPublicAPI.Traceroute"},"x-displayname":"Traceroute","x-ves-proto-service":"ves.io.schema.operate.traceroute.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Traceroute","x-ves-proto-package":"ves.io.schema.operate.traceroute","components":{"schemas":{"schemaEmpty":{"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"},"schemaHostIdentifier":{"type":"object","description":"Host Identifier identifies a host, either by its DNS name (hostname) or by its IP address.","title":"Host Identifier","x-displayname":"Host Identifier","x-ves-oneof-field-hostname_or_ip":"[\"hostname\",\"ip\"]","x-ves-proto-message":"ves.io.schema.HostIdentifier","properties":{"hostname":{"type":"string","description":"Exclusive with [ip]\n DNS name of the host\n\nExample: ` \"myhost.volterra.io\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"Hostname","maxLength":256,"x-displayname":"Hostname","x-ves-example":"myhost.volterra.io","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256"}},"ip":{"type":"string","description":"Exclusive with [hostname]\n IP address of the host\n\nExample: ` \"192.168.1.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n","title":"IP","x-displayname":"IP","x-ves-example":"192.168.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true"}}}},"schemaInterfaceIdentifier":{"type":"object","description":"Interface Identifier identifies one or all interfaces on a node","title":"Interface Identifier","x-displayname":"Interface Identifier","x-ves-oneof-field-interface_choice":"[\"any_intf\",\"intf\"]","x-ves-proto-message":"ves.io.schema.InterfaceIdentifier","properties":{"any_intf":{"$ref":"#/components/schemas/schemaEmpty"},"intf":{"type":"string","description":"Exclusive with [any_intf]\n Name of the chosen interface on the node\n\nExample: ` \"eth0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Interface Name","minLength":1,"maxLength":256,"x-displayname":"Interface Name","x-ves-example":"eth0","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"tracerouteHop":{"type":"object","description":"Hop info for each Traceroute response","title":"Hop","x-displayname":"Hop","x-ves-displayorder":"1,2,3,5","x-ves-proto-message":"ves.io.schema.operate.traceroute.Hop","properties":{"addr":{"type":"string","description":" Address of the hop\n\nExample: ` \"192.168.10.25\"`","title":"Address","x-displayname":"Address","x-ves-example":"192.168.10.25"},"elapsed_time_ms":{"type":"integer","description":" Time taken to receive traceroute response (milli seconds)","title":"Elapsed Time","format":"int64","x-displayname":"Elapsed Time"},"host":{"type":"string","description":" Host name of the hop, if available","title":"Host","x-displayname":"Host"},"ttl":{"type":"integer","description":" TTL of the hop\n\nExample: ` \"1\"`","title":"TTL","format":"int64","x-displayname":"TTL","x-ves-example":"1"}}},"tracerouteTracerouteRequest":{"type":"object","description":"Request to run traceroute to a destination","title":"Traceroute Request","x-displayname":"Traceroute Request","x-ves-proto-message":"ves.io.schema.operate.traceroute.TracerouteRequest","properties":{"dest":{"$ref":"#/components/schemas/schemaHostIdentifier"},"hops":{"type":"integer","description":" Maximum number of hops (TTL) for probe packets\n\nExample: ` \"16\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 64\n","title":"Hops","format":"int64","x-displayname":"Hops","x-ves-example":"16","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"64"}},"intf":{"$ref":"#/components/schemas/schemaInterfaceIdentifier"},"namespace":{"type":"string","description":" Namespace for which the request is sent (system)\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"node":{"type":"string","description":" Name of the node from which traceroute is initiated\n\nExample: ` \"master-0\"`\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":"Node Name","minLength":1,"maxLength":64,"x-displayname":"Node Name","x-ves-example":"master-0","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"}},"retries":{"type":"integer","description":" Number of probes for each hop\n\nExample: ` \"3\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 8\n","title":"Retries","format":"int64","x-displayname":"Retries","x-ves-example":"3","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"8"}},"site":{"type":"string","description":" Name of the site from which traceroute is initiated\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"tracerouteTracerouteResponse":{"type":"object","description":"Response to Traceroute request","title":"Traceroute Response","x-displayname":"Traceroute Response","x-ves-displayorder":"1","x-ves-proto-message":"ves.io.schema.operate.traceroute.TracerouteResponse","properties":{"hops":{"type":"array","description":" All the hops in traceroute response","title":"Hops","items":{"$ref":"#/components/schemas/tracerouteHop"},"x-displayname":"Hops"}}}}}}