npm - @robinmordasiewicz/f5xc-terraform-mcp - Versions diffs - 2.3.0 → 2.4.3 - Mend

@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (572) hide show

package/dist/docs/specifications/api/docs-cloud-f5-com.0065.public.ves.io.schema.views.aws_tgw_site.ves-swagger.json ADDED Viewed

@@ -0,0 +1 @@

+ {"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.aws_tgw_site","description":"AWS TGW site view defines a required parameters that can be used in CRUD, to create and manage a volterra site in AWS VPC.\nIt can be used to automatically site creation in the AWS TGW.\n\nView will create following child objects.\n\n* Site","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/aws_tgw_sites":{"post":{"summary":"Create AWS TGW site","description":"Shape of the AWS TGW site specification","operationId":"ves.io.schema.views.aws_tgw_site.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-api-create"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.API.Create"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/aws_tgw_sites/{metadata.name}":{"put":{"summary":"Replace AWS TGW site","description":"Shape of the AWS TGW site replace specification","operationId":"ves.io.schema.views.aws_tgw_site.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-api-replace"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.API.Replace"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_tgw_info":{"post":{"summary":"Configure TGW Information","description":"Configure TGW Information like tgw-id, volterra site's vpc-id","operationId":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetTGWInfo","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetTGWInfoResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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: \"default\"\nNamespace for the object to be configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"aws-tgw-site-1\"\nName of the object to be configured","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetTGWInfoRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-customapi-settgwinfo"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetTGWInfo"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vip_info":{"post":{"summary":"Configure AWS TGW Site VIP Information","description":"Configure AWS TGW Site VIP Information","operationId":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetVIPInfo","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetVIPInfoResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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: \"default\"\nNamespace for the object to be configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"aws-tgw-site-1\"\nName of the object to be configured","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetVIPInfoRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-customapi-setvipinfo"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetVIPInfo"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpc_ip_prefixes":{"post":{"summary":"Configure VPC IP prefixes","description":"Configure VPC IP prefix set","operationId":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPCIpPrefixes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetVPCIpPrefixesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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: \"default\"\nNamespace for the object to be configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"aws-tgw-site-1\"\nName of the object to be configured","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetVPCIpPrefixesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-customapi-setvpcipprefixes"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPCIpPrefixes"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpn_tunnels":{"post":{"summary":"Configure VPN Tunnels","description":"Configure VPC IP prefix set","operationId":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPNTunnels","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetVPNTunnelsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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: \"default\"\nNamespace for the object to be configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"aws-tgw-site-1\"\nName of the object to be configured","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteSetVPNTunnelsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-customapi-setvpntunnels"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.CustomAPI.SetVPNTunnels"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_site/{name}/validate_config":{"post":{"summary":"Validate AWS TGW Config","description":"Validate AWS TGW Config","operationId":"ves.io.schema.views.aws_tgw_site.CustomAPI.ValidateConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewsValidateConfigResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"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: \"default\"\nNamespace for the object to be configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"aws-vpc-site-1\"\nName of the object to be configured","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/viewsValidateConfigRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-customapi-validateconfig"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.CustomAPI.ValidateConfig"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_sites":{"get":{"summary":"List Configure AWS TGW Site","description":"List the set of aws_tgw_site in a namespace","operationId":"ves.io.schema.views.aws_tgw_site.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of aws_tgw_site","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-api-list"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.API.List"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/aws_tgw_sites/{name}":{"get":{"summary":"Get AWS TGW site","description":"Shape of the AWS TGW site specification","operationId":"ves.io.schema.views.aws_tgw_site.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-api-get"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.API.Get"},"delete":{"summary":"Delete Configure AWS TGW Site","description":"Delete the specified aws_tgw_site","operationId":"ves.io.schema.views.aws_tgw_site.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aws_tgw_siteDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-aws_tgw_site-api-delete"},"x-ves-proto-rpc":"ves.io.schema.views.aws_tgw_site.API.Delete"},"x-displayname":"Configure AWS TGW Site","x-ves-proto-service":"ves.io.schema.views.aws_tgw_site.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Configure AWS TGW Site","x-ves-proto-package":"ves.io.schema.views.aws_tgw_site","components":{"schemas":{"aws_tgw_siteAWSTGWInfoConfigType":{"type":"object","description":"AWS tgw information like tgw-id and site's vpc-id","title":"AWS TGW Information Config","x-displayname":"AWS TGW Information Config","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.AWSTGWInfoConfigType","properties":{"private_ips":{"type":"array","description":" AWS Private IPs used by the nodes\n\nExample: ` \"10.0.0.1, 10.0.0.2, 10.0.0.3\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.items.string.ip: true\n ves.io.schema.rules.repeated.num_items: 0,1,3\n ves.io.schema.rules.repeated.unique: true\n","title":"AWS Node Private IPs","items":{"type":"string"},"x-displayname":"AWS Node Private IPs","x-ves-example":"10.0.0.1, 10.0.0.2, 10.0.0.3","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ip":"true","ves.io.schema.rules.repeated.num_items":"0,1,3","ves.io.schema.rules.repeated.unique":"true"}},"public_ips":{"type":"array","description":" AWS Elastic IPs used by the nodes\n\nExample: ` \"1.1.1.1, 2.2.2.2, 3.3.3.3\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.items.string.ip: true\n ves.io.schema.rules.repeated.num_items: 0,1,3\n ves.io.schema.rules.repeated.unique: true\n","title":"AWS Node Elastic IPs","items":{"type":"string"},"x-displayname":"AWS Node Elastic IPs","x-ves-example":"1.1.1.1, 2.2.2.2, 3.3.3.3","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ip":"true","ves.io.schema.rules.repeated.num_items":"0,1,3","ves.io.schema.rules.repeated.unique":"true"}},"subnet_ids":{"type":"array","description":" AWS Subnet Ids used by volterra site\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.num_items: 0,1,3\n","title":"AWS Subnet Ids Info","items":{"$ref":"#/components/schemas/viewsAWSSubnetIdsType"},"x-displayname":"AWS Subnet Ids","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.num_items":"0,1,3"}},"tgw_id":{"type":"string","description":" TGW ID populated by AWS\n\nExample: ` \"tgw-12345678\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.pattern: ^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"TGW ID","x-displayname":"TGW ID","x-ves-example":"tgw-12345678","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"vpc_id":{"type":"string","description":" VPC ID where the volterra site exists\n\nExample: ` \"vpc-12345678\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.pattern: ^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"VPC ID","x-displayname":"VPC ID","x-ves-example":"vpc-12345678","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"vpc_name":{"type":"string","description":" VPC Name where the volterra site exists","title":"VPC Name","x-displayname":"VPC Name"}}},"aws_tgw_siteAWSTGWResourceShareType":{"type":"object","description":"AWS Resource Share Status Type","title":"AWS Resource Share Status Type","x-displayname":"AWS Resource Share Status","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.AWSTGWResourceShareType","properties":{"allow_external_principles":{"type":"boolean","description":" Manage Sharing Outside AWS Organization","title":"Allow External Principles","format":"boolean","x-displayname":"Allow External Principles"},"creation_time":{"type":"string","description":" Resource Share Creation Time","title":"Resource Share Creation Time","format":"date-time","x-displayname":"Resource Share Creation Time"},"deployment_status":{"type":"string","description":" Attachment Deployment Status","title":"Attachment Deployment Status","x-displayname":"Attachment Deployment Status"},"invitation_status":{"type":"string","description":" Resource Share Invitation State","title":"Resource Share Invitation State","x-displayname":"Resource Share Invitation State"},"last_updated_time":{"type":"string","description":" Resource Share Last Update Time","title":"Resource Share Last Update Time","format":"date-time","x-displayname":"Resource Share Last Update Time"},"owner_account_id":{"type":"string","description":" Resource Share Owner Account ID","title":"Resource Share Owner Account ID","x-displayname":"Resource Share Owner Account ID"},"receiver_account_id":{"type":"array","description":" Resource Share Acceptor Account ID","title":"Resource Share Acceptor Account ID","items":{"type":"string"},"x-displayname":"Resource Share Acceptor Account ID"},"resource_share_arn":{"type":"string","description":" Resource Share ARN","title":"Resource Share ARN","x-displayname":"Resource Share ARN"},"resource_share_invitation_arn":{"type":"string","description":" Resource Share Invititation ARN","title":"Resource Share Invititation ARN","x-displayname":"Resource Share Invititation ARN"},"resource_share_name":{"type":"string","description":" Resource Share Name","title":"Resource Share Name","x-displayname":"Resource Share Name"},"status":{"type":"string","description":" Resource Share State","title":"Resource Share State","x-displayname":"Resource Share State"},"tags":{"type":"object","description":" Resource Share Tags","title":"Resource Share Tags","x-displayname":"Resource Share Tags"}}},"aws_tgw_siteAWSTGWStatusType":{"type":"object","description":"AWS Transit Gateway Status Type","title":"AWS Transit Gateway Status Type","x-displayname":"AWS TGW Status","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.AWSTGWStatusType","properties":{"status_msg":{"type":"string","description":" x-displayName \"TGW Deployment Status\"\n TGW Deployment Status","title":"TGW Deployment Status"},"tags":{"type":"object","description":" TGW Tags","title":"TGW Tags","x-displayname":"TGW Tags"},"tgw_amazon_asn":{"type":"string","description":" AWS Side ASN of TGW","title":"AWS Side ASN of TGW","format":"int64","x-displayname":"AWS Side ASN of TGW"},"tgw_arn":{"type":"string","description":" TGW ARN","title":"TGW ARN","x-displayname":"TGW ARN"},"tgw_cidrs":{"type":"array","description":" x-displayName \"TGW CIDRs\"\n TGW CIDRs","title":"TGW CIDRs","items":{"type":"string"}},"tgw_creation_time":{"type":"string","description":" TGW Creation Time","title":"TGW creation time","format":"date-time","x-displayname":"TGW Creation Time"},"tgw_id":{"type":"string","description":" TGW ID","title":"TGW ID","x-displayname":"TGW ID"},"tgw_owner_account":{"type":"string","description":" TGW Owner Account","title":"TGW Owner","x-displayname":"TGW Owner Account"},"tgw_region":{"type":"string","description":" TGW Region","title":"TGW Region","x-displayname":"TGW Region"},"tgw_state":{"type":"string","description":" TGW State","title":"TGW State","x-displayname":"TGW State"}}},"aws_tgw_siteAWSVPNTunnelConfigType":{"type":"object","description":"x-displayName: \"AWS VPN Tunnel Config\"\nRemote IP for VPN tunnels of a node","title":"AWS VPN Tunnel Config","properties":{"node_id":{"type":"string","description":"x-displayName: \"F5XC Node ID\"\nx-example: \"ves-node-id-xxxxxx\"\nx-required\nF5XC Node ID for which this tunnel is configured","title":"F5XC Node ID"},"node_name":{"type":"string","description":"x-displayName: \"Name of the Node\"\nx-example: \"master-0\"\nx-required\nName of the node for which this tunnel is configured","title":"Name of the Node"},"tunnel_remote_ip":{"type":"array","description":"x-displayName: \"Remote IP(s)\"\nx-example: \"3.4.5.6\"\nx-required\nRemote IP(s) for up to two tunnels","title":"Remote IP(s)","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/aws_tgw_siteVPNTunnelType"}}},"aws_tgw_siteCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of aws_tgw_site","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/viewsaws_tgw_siteCreateSpecType"}}},"aws_tgw_siteCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/viewsaws_tgw_siteGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"aws_tgw_siteDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a aws_tgw_site","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"aws_tgw_siteGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read aws_tgw_site","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/aws_tgw_siteCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/aws_tgw_siteReplaceRequest"},"spec":{"$ref":"#/components/schemas/viewsaws_tgw_siteGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/aws_tgw_siteStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"aws_tgw_siteGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"aws_tgw_siteListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of aws_tgw_site","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/aws_tgw_siteListResponseItem"},"x-displayname":"Items"}}},"aws_tgw_siteListResponseItem":{"type":"object","description":"By default a summary of aws_tgw_site is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of aws_tgw_site","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this aws_tgw_site","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this aws_tgw_site","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates aws_tgw_site is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/viewsaws_tgw_siteGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this aws_tgw_site","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this aws_tgw_site\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/aws_tgw_siteStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this aws_tgw_site\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"aws_tgw_siteReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a aws_tgw_site","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/viewsaws_tgw_siteReplaceSpecType"}}},"aws_tgw_siteReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ReplaceResponse"},"aws_tgw_siteSecurityConfigType":{"type":"object","description":"Security Configuration for transit gateway","title":"TGW Security Configuration","x-displayname":"TGW Security Configuration","x-ves-oneof-field-east_west_service_policy_choice":"[\"active_east_west_service_policies\",\"east_west_service_policy_allow_all\",\"no_east_west_policy\"]","x-ves-oneof-field-forward_proxy_choice":"[\"active_forward_proxy_policies\",\"forward_proxy_allow_all\",\"no_forward_proxy\"]","x-ves-oneof-field-network_policy_choice":"[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"no_network_policy\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SecurityConfigType","properties":{"active_east_west_service_policies":{"$ref":"#/components/schemas/viewsaws_tgw_siteActiveServicePoliciesType"},"active_enhanced_firewall_policies":{"$ref":"#/components/schemas/schemanetwork_firewallActiveEnhancedFirewallPoliciesType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/schemanetwork_firewallActiveForwardProxyPoliciesType"},"active_network_policies":{"$ref":"#/components/schemas/network_firewallActiveNetworkPoliciesType"},"east_west_service_policy_allow_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"forward_proxy_allow_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_east_west_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_forward_proxy":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"aws_tgw_siteServicesVPCReplaceType":{"type":"object","description":"AWS Services VPC Replace config","title":"AWS Services VPC Config","x-displayname":"AWS Services VPC Config","x-ves-oneof-field-deployment":"[\"aws_cred\"]","x-ves-oneof-field-internet_vip_choice":"[\"disable_internet_vip\",\"enable_internet_vip\"]","x-ves-oneof-field-security_group_choice":"[\"custom_security_group\",\"f5xc_security_group\"]","x-ves-oneof-field-service_vpc_choice":"[\"new_vpc\",\"vpc_id\"]","x-ves-oneof-field-tgw_choice":"[\"existing_tgw\",\"new_tgw\"]","x-ves-oneof-field-worker_nodes":"[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ServicesVPCReplaceType","properties":{"aws_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"aws_region":{"type":"string","description":" AWS Region of your services vpc, where F5XC site will be deployed.\n\nExample: ` \"us-east-1\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"AWS Region","x-displayname":"AWS Region","x-ves-example":"us-east-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"az_nodes":{"type":"array","description":" Only Single AZ or Three AZ(s) nodes are supported currently.\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.num_items: 1,3\n","items":{"$ref":"#/components/schemas/viewsAWSVPCTwoInterfaceNodeType"},"x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.num_items":"1,3"}},"custom_security_group":{"$ref":"#/components/schemas/viewsSecurityGroupType"},"disable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"disk_size":{"type":"integer","description":" Node disk size for all node in the F5XC site. Unit is GiB\n\nExample: ` \"80\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.lte: 64000\n","title":"Node Disk size","format":"int64","x-displayname":"Node Disk Size","x-ves-example":"80","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"64000"}},"enable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"existing_tgw":{"$ref":"#/components/schemas/viewsExistingTGWType"},"f5xc_security_group":{"$ref":"#/components/schemas/ioschemaEmpty"},"instance_type":{"type":"string","description":" Instance size based on the performance.\n\nExample: ` \"a1.xlarge\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_len: 64\n","maxLength":64,"x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64"}},"new_tgw":{"$ref":"#/components/schemas/viewsTGWParamsType"},"new_vpc":{"$ref":"#/components/schemas/viewsAWSVPCParamsType"},"no_worker_nodes":{"$ref":"#/components/schemas/ioschemaEmpty"},"nodes_per_az":{"type":"integer","description":"Exclusive with [no_worker_nodes total_nodes]\n Desired Worker Nodes Per AZ. Max limit is up to 21\n\nExample: ` \"2\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 0\n ves.io.schema.rules.uint32.lte: 21\n","title":"Desired Worker Nodes Per AZ","format":"int64","x-displayname":"Desired Worker Nodes Per AZ","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"21"}},"ssh_key":{"type":"string","description":" Public SSH key for accessing nodes of the site.\n\nExample: ` \"ssh-rsa AAAAB...\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_len: 8192\n ves.io.schema.rules.string.min_len: 1\n","title":"Public SSH key","minLength":1,"maxLength":8192,"x-displayname":"Public SSH key","x-ves-example":"ssh-rsa AAAAB...","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"8192","ves.io.schema.rules.string.min_len":"1"}},"total_nodes":{"type":"integer","description":"Exclusive with [no_worker_nodes nodes_per_az]\n Total number of worker nodes to be deployed across all AZ's used in the Site\n\nExample: ` \"1\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 0\n ves.io.schema.rules.uint32.lte: 61\n","title":"Total Number of Worker Nodes for a Site","format":"int64","x-displayname":"Total Number of Worker Nodes for a Site","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"61"}},"vpc_id":{"type":"string","description":"Exclusive with [new_vpc]\n Existing VPC ID\n\nExample: ` \"vpc-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Existing VPC ID","maxLength":64,"x-displayname":"Existing VPC ID","x-ves-example":"vpc-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$"}}}},"aws_tgw_siteServicesVPCType":{"type":"object","description":"Setup AWS services VPC, transit gateway and site","title":"AWS Service VPC and TGW","x-displayname":"AWS Service VPC and TGW","x-ves-oneof-field-deployment":"[\"aws_cred\"]","x-ves-oneof-field-internet_vip_choice":"[\"disable_internet_vip\",\"enable_internet_vip\"]","x-ves-oneof-field-security_group_choice":"[\"custom_security_group\",\"f5xc_security_group\"]","x-ves-oneof-field-service_vpc_choice":"[\"new_vpc\",\"vpc_id\"]","x-ves-oneof-field-tgw_choice":"[\"existing_tgw\",\"new_tgw\"]","x-ves-oneof-field-tgw_cidr_choice":"[\"reserved_tgw_cidr\",\"tgw_cidr\"]","x-ves-oneof-field-worker_nodes":"[\"no_worker_nodes\",\"nodes_per_az\",\"total_nodes\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ServicesVPCType","properties":{"admin_password":{"$ref":"#/components/schemas/schemaSecretType"},"aws_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"aws_region":{"type":"string","description":" AWS Region of your services vpc, where F5XC site will be deployed.\n\nExample: ` \"us-east-1\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"AWS Region","x-displayname":"AWS Region","x-ves-example":"us-east-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"az_nodes":{"type":"array","description":" Only Single AZ or Three AZ(s) nodes are supported currently.\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.num_items: 1,3\n","title":"Nodes","items":{"$ref":"#/components/schemas/viewsAWSVPCTwoInterfaceNodeType"},"x-displayname":"Ingress/Egress Gateway (two Interface) Nodes in AZ","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.num_items":"1,3"}},"custom_security_group":{"$ref":"#/components/schemas/viewsSecurityGroupType"},"disable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"disk_size":{"type":"integer","description":" Node disk size for all node in the F5XC site. Unit is GiB\n\nExample: ` \"80\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.lte: 64000\n","title":"Node Disk size","format":"int64","x-displayname":"Node Disk Size","x-ves-example":"80","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"64000"}},"enable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"existing_tgw":{"$ref":"#/components/schemas/viewsExistingTGWType"},"f5xc_security_group":{"$ref":"#/components/schemas/ioschemaEmpty"},"instance_type":{"type":"string","description":" Instance size based on the performance.\n\nExample: ` \"a1.xlarge\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_len: 64\n","title":"AWS Instance Type","maxLength":64,"x-displayname":"AWS Instance Type for Node","x-ves-example":"a1.xlarge","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64"}},"new_tgw":{"$ref":"#/components/schemas/viewsTGWParamsType"},"new_vpc":{"$ref":"#/components/schemas/viewsAWSVPCParamsType"},"no_worker_nodes":{"$ref":"#/components/schemas/ioschemaEmpty"},"nodes_per_az":{"type":"integer","description":"Exclusive with [no_worker_nodes total_nodes]\n Desired Worker Nodes Per AZ. Max limit is up to 21\n\nExample: ` \"2\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 0\n ves.io.schema.rules.uint32.lte: 21\n","title":"Desired Worker Nodes Per AZ","format":"int64","x-displayname":"Desired Worker Nodes Per AZ","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"21"}},"reserved_tgw_cidr":{"$ref":"#/components/schemas/ioschemaEmpty"},"ssh_key":{"type":"string","description":" Public SSH key for accessing nodes of the site.\n\nExample: ` \"ssh-rsa AAAAB...\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_len: 8192\n ves.io.schema.rules.string.min_len: 1\n","title":"Public SSH key","minLength":1,"maxLength":8192,"x-displayname":"Public SSH key","x-ves-example":"ssh-rsa AAAAB...","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"8192","ves.io.schema.rules.string.min_len":"1"}},"tgw_cidr":{"$ref":"#/components/schemas/viewsCloudSubnetParamType"},"total_nodes":{"type":"integer","description":"Exclusive with [no_worker_nodes nodes_per_az]\n Total number of worker nodes to be deployed across all AZ's used in the Site\n\nExample: ` \"1\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 0\n ves.io.schema.rules.uint32.lte: 61\n","title":"Total Number of Worker Nodes for a Site","format":"int64","x-displayname":"Total Number of Worker Nodes for a Site","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"61"}},"vpc_id":{"type":"string","description":"Exclusive with [new_vpc]\n Existing VPC ID\n\nExample: ` \"vpc-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Existing VPC ID","maxLength":64,"x-displayname":"Existing VPC ID","x-ves-example":"vpc-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$"}}}},"aws_tgw_siteSetTGWInfoRequest":{"type":"object","description":"Request to configure TGW Information","title":"Request to configure TGW Information","x-displayname":"Request to configure TGW Information","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetTGWInfoRequest","properties":{"direct_connect_info":{"$ref":"#/components/schemas/viewsDirectConnectInfo"},"name":{"type":"string","description":" Name of the object to be configured\n\nExample: ` \"aws-tgw-site-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"aws-tgw-site-1"},"namespace":{"type":"string","description":" Namespace for the object to be configured\n\nExample: ` \"default\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"default"},"tgw_info":{"$ref":"#/components/schemas/aws_tgw_siteAWSTGWInfoConfigType"}}},"aws_tgw_siteSetTGWInfoResponse":{"type":"object","description":"Response to configure TGW info","title":"Response to configure TGW info","x-displayname":"Response to configure TGW info","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetTGWInfoResponse"},"aws_tgw_siteSetVIPInfoRequest":{"type":"object","description":"Request to configure AWS TGW Site VIP information","title":"Request to configure AWS TGW Site VIP information","x-displayname":"Request to configure AWS TGW Site VIP information","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetVIPInfoRequest","properties":{"name":{"type":"string","description":" Name of the object to be configured\n\nExample: ` \"aws-tgw-site-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"aws-tgw-site-1"},"namespace":{"type":"string","description":" Namespace for the object to be configured\n\nExample: ` \"default\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"default"},"vip_params_per_az":{"type":"array","description":" VIP Parameters per AZ\n\nExample: ` \"master-0\"`\n\nValidation Rules:\n ves.io.schema.rules.repeated.num_items: 1,2,3\n","title":"VIP Params Per AZ","items":{"$ref":"#/components/schemas/sitePublishVIPParamsPerAz"},"x-displayname":"VIP Params Per AZ","x-ves-example":"master-0","x-ves-validation-rules":{"ves.io.schema.rules.repeated.num_items":"1,2,3"}}}},"aws_tgw_siteSetVIPInfoResponse":{"type":"object","title":"Response to configure AWS TGW Site VIP Information","x-displayname":"Response to configure AWS TGW Site VIP Information","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetVIPInfoResponse"},"aws_tgw_siteSetVPCIpPrefixesRequest":{"type":"object","description":"Request to configure VPC IP prefix set","title":"Request to configure VPC IP prefix set","x-displayname":"Request to configure VPC IP prefix set","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetVPCIpPrefixesRequest","properties":{"name":{"type":"string","description":" Name of the object to be configured\n\nExample: ` \"aws-tgw-site-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"aws-tgw-site-1"},"namespace":{"type":"string","description":" Namespace for the object to be configured\n\nExample: ` \"default\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"default"},"vpc_ip_prefixes":{"type":"object","description":" IP prefixes of subnets in the VPC.","title":"VPC IP Prefixes","x-displayname":"VPC IP Prefixes"}}},"aws_tgw_siteSetVPCIpPrefixesResponse":{"type":"object","description":"Response to configure VPC IP prefix set","title":"Response to configure VPC IP prefix set","x-displayname":"Response to configure VPC IP prefix set","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetVPCIpPrefixesResponse"},"aws_tgw_siteSetVPNTunnelsRequest":{"type":"object","description":"Request to configure VPN Tunnels","title":"Request to configure VPN Tunnels","x-displayname":"Request to configure VPN Tunnels","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetVPNTunnelsRequest","properties":{"name":{"type":"string","description":" Name of the object to be configured\n\nExample: ` \"aws-tgw-site-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"aws-tgw-site-1"},"namespace":{"type":"string","description":" Namespace for the object to be configured\n\nExample: ` \"default\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"default"}}},"aws_tgw_siteSetVPNTunnelsResponse":{"type":"object","description":"Response to configure VPN Tunnels","title":"Response to configure VPN Tunnels","x-displayname":"Response to configure VPN Tunnels","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.SetVPNTunnelsResponse"},"aws_tgw_siteStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions represent the normalized status values for configuration object","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"deployment":{"$ref":"#/components/schemas/terraform_parametersDeploymentStatusType"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" AWS TGW view object direct reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"resource_share_status":{"$ref":"#/components/schemas/aws_tgw_siteAWSTGWResourceShareType"},"tgw":{"$ref":"#/components/schemas/aws_tgw_siteAWSTGWStatusType"},"vpc_attachments":{"$ref":"#/components/schemas/cloud_connectAWSAttachmentsListStatusType"}}},"aws_tgw_siteTunnelType":{"type":"string","description":"This defines Tunnel type towards TGW Site\n\nTUNNEL_IPSEC\nTUNNEL_GRE","title":"Tunnel Type","enum":["TUNNEL_IPSEC","TUNNEL_GRE"],"default":"TUNNEL_IPSEC","x-displayname":"Tunnel Type","x-ves-proto-enum":"ves.io.schema.views.aws_tgw_site.TunnelType"},"aws_tgw_siteVPCAttachmentListType":{"type":"object","description":"Spoke VPCs to be attached to the AWS TGW Site","title":"Spoke VPCs","x-displayname":"Spoke VPCs","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.VPCAttachmentListType","properties":{"vpc_list":{"type":"array","description":" List of VPC attachments to transit gateway\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 128\n","title":"vpc_list","maxItems":128,"items":{"$ref":"#/components/schemas/aws_tgw_siteVPCAttachmentType"},"x-displayname":"VPC List","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128"}}}},"aws_tgw_siteVPCAttachmentType":{"type":"object","description":"VPC attachments to transit gateway","title":"VPC attachment","x-displayname":"VPC","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.VPCAttachmentType","properties":{"labels":{"type":"object","description":" Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.\n\nExample: ` \"value\"`","title":"Labels","x-displayname":"Labels","x-ves-example":"value"},"vpc_id":{"type":"string","description":" Information about existing VPC\n\nExample: ` \"vpc-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"VPC ID","maxLength":64,"x-displayname":"VPC ID","x-ves-example":"vpc-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$"}}}},"aws_tgw_siteVPCIpPrefixesType":{"type":"object","description":"x-displayName: \"VPC IP prefixes\"\nVPC IP prefixes","title":"VPC IP prefixes","properties":{"prefixes":{"type":"array","description":"x-displayName: \"Prefixes\"\nx-required\nx-example: \"['10.2.1.0/24', '192.168.8.0/29', '10.7.64.160/27']\"\nAn unordered list of IP prefixes.","title":"IP prefixes","items":{"type":"string"}}}},"aws_tgw_siteVPNTunnelType":{"type":"string","description":"x-displayName: \"VPN Tunnel Type\"\nThis defines VPN Tunnel type for which the config exists\n\n - HUB: x-displayName: \"VPN Tunnel Hub\"\nVPN Tunnel Type - HUB\n - SERVICES: x-displayName: \"VPN Tunnel Services\"\nVPN Tunnel Type - Services","title":"VPN Tunnel Type","enum":["HUB","SERVICES"],"default":"HUB"},"aws_tgw_siteVnConfiguration":{"type":"object","description":"Virtual Network Configuration","title":"Virtual Network Configuration","x-displayname":"Virtual Network Configuration","x-ves-oneof-field-dc_cluster_group_choice":"[\"dc_cluster_group_inside_vn\",\"dc_cluster_group_outside_vn\",\"no_dc_cluster_group\"]","x-ves-oneof-field-global_network_choice":"[\"global_network_list\",\"no_global_network\"]","x-ves-oneof-field-inside_static_route_choice":"[\"inside_static_routes\",\"no_inside_static_routes\"]","x-ves-oneof-field-outside_static_route_choice":"[\"no_outside_static_routes\",\"outside_static_routes\"]","x-ves-oneof-field-site_mesh_group_choice":"[\"sm_connection_public_ip\",\"sm_connection_pvt_ip\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.VnConfiguration","properties":{"allowed_vip_port":{"$ref":"#/components/schemas/viewsAllowedVIPPorts"},"allowed_vip_port_sli":{"$ref":"#/components/schemas/viewsAllowedVIPPorts"},"dc_cluster_group_inside_vn":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"dc_cluster_group_outside_vn":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"global_network_list":{"$ref":"#/components/schemas/viewsGlobalNetworkConnectionListType"},"inside_static_routes":{"$ref":"#/components/schemas/viewsSiteStaticRoutesListType"},"no_dc_cluster_group":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_global_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_inside_static_routes":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_outside_static_routes":{"$ref":"#/components/schemas/ioschemaEmpty"},"outside_static_routes":{"$ref":"#/components/schemas/viewsSiteStaticRoutesListType"},"sm_connection_public_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"sm_connection_pvt_ip":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"cloud_connectAWSAttachmentsListStatusType":{"type":"object","description":"AWS VPC Attachment List Status Type","title":"AWS VPC Attachment List Status Type","x-displayname":"AWS VPC Attachment List Status Type","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSAttachmentsListStatusType","properties":{"attachment_status":{"type":"array","description":" AWS Attachment Status Type","title":"AWS VPC Attachment Status Type","items":{"$ref":"#/components/schemas/cloud_connectAWSAttachmentsStatusType"},"x-displayname":"AWS VPC Attachment Status"},"connect_attachment_status":{"type":"array","description":" AWS Connect Attachment Status Type\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 1\n","title":"AWS Connect Attachment Status Type","maxItems":1,"items":{"$ref":"#/components/schemas/cloud_connectAWSConnectAttachmentStatusType"},"x-displayname":"AWS Connect Attachment Status","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"tgw_route_table_status":{"type":"array","description":" AWS Transit Gateway Route Table Status Type\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 2\n","title":"AWS Transit Gateway Route Table Status Type","maxItems":2,"items":{"$ref":"#/components/schemas/cloud_connectAWSTGWRouteTableStatusType"},"x-displayname":"AWS Transit Gateway Route Table Status","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"2"}}}},"cloud_connectAWSAttachmentsStatusType":{"type":"object","description":"AWS Attachment Status Type","title":"AWS VPC Attachment Status Type","x-displayname":"AWS Attachment Status Type","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSAttachmentsStatusType","properties":{"association_route_table_id":{"type":"string","description":" Association route table ID","title":"Association route table ID","x-displayname":"Associated Transit Gateway route table ID"},"association_state":{"type":"string","description":" Transit Gateway route table association state","title":"Association state","x-displayname":"Transit Gateway route table association state"},"creation_time":{"type":"string","description":" Attachment Creation Time","title":"Attachment Creation Time","format":"date-time","x-displayname":"Attachment Creation Time"},"deployment_status":{"type":"string","description":" Additional VPC attachment deployment status","title":"Additional VPC attachment deployment status","x-displayname":"VPC attachment deployment status"},"installed_routes":{"$ref":"#/components/schemas/cloud_connectAWSRouteTableListType"},"subnets":{"type":"array","description":" Network Interfaces created along with the attachment","title":"Subnets","items":{"$ref":"#/components/schemas/cloud_connectSubnetStatusType"},"x-displayname":"Network Interfaces"},"tags":{"type":"object","description":" Attachment Tags\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 127\n ves.io.schema.rules.map.max_pairs: 20\n ves.io.schema.rules.map.values.string.max_len: 255\n","title":"Attachment Tags","x-displayname":"Attachment Tags","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"20","ves.io.schema.rules.map.values.string.max_len":"255"}},"tgw_attachment_id":{"type":"string","description":" TGW Attachment ID","title":"TGW Attachment ID","x-displayname":"TGW Attachment ID"},"tgw_attachment_name":{"type":"string","description":" TGW Attachment Name","title":"TGW Attachment Name","x-displayname":"TGW Attachment Name"},"vpc_cidr":{"type":"string","description":" VPC CIDR","title":"VPC CIDR","x-displayname":"VPC CIDR"},"vpc_deployment_state":{"$ref":"#/components/schemas/cloud_connectCloudConnectVPCStateType"},"vpc_id":{"type":"string","description":" VPC ID","title":"VPC ID","x-displayname":"VPC ID"},"vpc_name":{"type":"string","description":" VPC Name","title":"VPC Name","x-displayname":"VPC Name"},"vpc_owner_id":{"type":"string","description":" VPC Owner Account","title":"VPC Owner Account","x-displayname":"VPC Owner Account"}}},"cloud_connectAWSConnectAttachmentStatusType":{"type":"object","description":"AWS Connect Attachment Status Type","title":"AWS Connect Attachment Status Type","x-displayname":"AWS Connect Attachment Type Status","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSConnectAttachmentStatusType","properties":{"association_route_table_id":{"type":"string","description":" Association route table ID","title":"Association route table ID","x-displayname":"Association route table ID"},"association_state":{"type":"string","description":" Transit Gateway route table association state","title":"Association state","x-displayname":"Transit Gateway route table association state"},"connect_deployment_state":{"$ref":"#/components/schemas/cloud_connectCloudConnectVPCStateType"},"deployment_status":{"type":"string","description":" Additional information related to the connect attachment deployment.","title":"Deployment Status","x-displayname":"Deployment Status"},"peers":{"type":"array","description":" Connect Peers","title":"Connect Peers","items":{"$ref":"#/components/schemas/cloud_connectAWSConnectPeerStatusType"},"x-displayname":"Connect Peers"},"protocol":{"type":"string","description":" Connect protocol","title":"Connect protocol","x-displayname":"Connect protocol"},"tags":{"type":"object","description":" Attachment Tags\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 127\n ves.io.schema.rules.map.max_pairs: 20\n ves.io.schema.rules.map.values.string.max_len: 255\n","title":"Attachment Tags","x-displayname":"Attachment Tags","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"20","ves.io.schema.rules.map.values.string.max_len":"255"}},"transit_gateway_asn":{"type":"string","description":" Transit Gateway ASN","title":"Transit Gateway ASN","x-displayname":"Transit Gateway ASN"},"transit_gateway_attachment_id":{"type":"string","description":" Transit Gateway Attachment ID","title":"Transit Gateway Attachment ID","x-displayname":"Transit Gateway Attachment ID"},"transit_gateway_attachment_name":{"type":"string","description":" Transit Gateway Attachment Name","title":"Transit Gateway Attachment Name","x-displayname":"Transit Gateway Attachment Name"},"transit_gateway_id":{"type":"string","description":" Transit Gateway ID","title":"Transit Gateway ID","x-displayname":"Transit Gateway ID"},"transport_attachment_id":{"type":"string","description":" Transport attachment ID","title":"Transport attachment ID","x-displayname":"Transport attachment ID"}}},"cloud_connectAWSConnectPeerStatusType":{"type":"object","description":"AWS Connect Peer Status Type","title":"AWS Connect Peer Status Type","x-displayname":"AWS Connect Peer Status Type","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSConnectPeerStatusType","properties":{"connect_attachment_id":{"type":"string","description":" Connect attachment ID","title":"Connect attachment ID","x-displayname":"Connect attachment ID"},"connect_peer_deployment_state":{"$ref":"#/components/schemas/cloud_connectCloudConnectVPCStateType"},"connect_peer_id":{"type":"string","description":" Connect Peer ID","title":"Connect Peer ID","x-displayname":"Connect Peer ID"},"deployment_status":{"type":"string","description":" Additional information related to the connect peer attachment deployment.","title":"Deployment Status","x-displayname":"Deployment Status"},"name":{"type":"string","description":" Connect Peer Name","title":"Connect Peer Name","x-displayname":"Connect Peer Name"},"tags":{"type":"object","description":" Connect Peer Tags\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 127\n ves.io.schema.rules.map.max_pairs: 20\n ves.io.schema.rules.map.values.string.max_len: 255\n","title":"Connect Peer Tags","x-displayname":"Connect Peer Tags","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"20","ves.io.schema.rules.map.values.string.max_len":"255"}}}},"cloud_connectAWSRouteTableListType":{"type":"object","description":"AWS Route Table List","title":"AWS Route Table List","x-displayname":"AWS Route Table List","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSRouteTableListType","properties":{"route_tables":{"type":"array","description":" Route Tables\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 200\n ves.io.schema.rules.repeated.min_items: 1\n ves.io.schema.rules.repeated.unique: true\n","title":"List of route tables","minItems":1,"maxItems":200,"items":{"$ref":"#/components/schemas/cloud_connectAWSRouteTableType"},"x-displayname":"List of route tables","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"200","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"cloud_connectAWSRouteTableType":{"type":"object","description":"AWS Route Table","title":"AWS Route Table","x-displayname":"AWS Route Table","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSRouteTableType","properties":{"route_table_id":{"type":"string","description":" Route table ID\n\nExample: ` \"rtb-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Route table ID","maxLength":64,"x-displayname":"Route table ID","x-ves-example":"rtb-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"static_routes":{"type":"array","description":" List of Static Routes\n\nExample: ` \"10.1.1.0/24\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.items.string.ipv4_prefix: true\n ves.io.schema.rules.repeated.max_items: 50\n ves.io.schema.rules.repeated.min_items: 1\n ves.io.schema.rules.repeated.unique: true\n","title":"static_routes","minItems":1,"maxItems":50,"items":{"type":"string"},"x-displayname":"Static Routes","x-ves-example":"10.1.1.0/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ipv4_prefix":"true","ves.io.schema.rules.repeated.max_items":"50","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"cloud_connectAWSTGWResourceReference":{"type":"object","description":"AWS Transit Gateway Route Table Associations","title":"AWS Transit Gateway Route Table Associations","x-displayname":"AWS Transit Gateway Route Table Associations","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSTGWResourceReference","properties":{"attachment_id":{"type":"string","description":" Attachment ID","title":"Attachment ID","x-displayname":"Attachment ID"},"deployment_status":{"type":"string","description":" Additional information related to the TGW routing.","title":"Deployment Status","x-displayname":"Deployment Status"},"resource_id":{"type":"string","description":" Resource ID","title":"Resource ID","x-displayname":"Resource ID"},"resource_type":{"type":"string","description":" Resource type","title":"Resource type","x-displayname":"Resource type"},"state":{"$ref":"#/components/schemas/cloud_connectCloudConnectVPCStateType"}}},"cloud_connectAWSTGWRouteTableStatusType":{"type":"object","description":"AWS Transit Gateway Route Table Status Type","title":"AWS Transit Gateway Route Table Status Type","x-displayname":"AWS Transit Gateway Route Table Status Type","x-ves-proto-message":"ves.io.schema.cloud_connect.AWSTGWRouteTableStatusType","properties":{"associations":{"type":"array","description":" Associations","title":"Assciations","items":{"$ref":"#/components/schemas/cloud_connectAWSTGWResourceReference"},"x-displayname":"Associations"},"deployment_status":{"type":"string","description":" Additional information related to the TGW routing.","title":"Deployment Status","x-displayname":"Deployment Status"},"propagations":{"type":"array","description":" Propagations","title":"Propagations","items":{"$ref":"#/components/schemas/cloud_connectAWSTGWResourceReference"},"x-displayname":"Propagations"},"tags":{"type":"object","description":" Attachment Tags\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 127\n ves.io.schema.rules.map.max_pairs: 20\n ves.io.schema.rules.map.values.string.max_len: 255\n","title":"Attachment Tags","x-displayname":"Attachment Tags","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"20","ves.io.schema.rules.map.values.string.max_len":"255"}},"tgw_rt_deployment_state":{"$ref":"#/components/schemas/cloud_connectCloudConnectVPCStateType"},"transit_gateway_id":{"type":"string","description":" Transit Gateway ID","title":"Transit Gateway ID","x-displayname":"Transit Gateway ID"},"transit_gateway_route_table_id":{"type":"string","description":" Transit gateway route table ID","title":"Transit gateway route table ID","x-displayname":"Transit gateway route table ID"},"transit_gateway_route_table_name":{"type":"string","description":" Transit gateway route table Name","title":"Transit gateway route table Name","x-displayname":"Transit gateway route table Name"}}},"cloud_connectCloudConnectVPCStateType":{"type":"string","description":"Cloud Connect VPC State Type\n\n - AVAILABLE: Available\n\nCloud Connect vpc attachment is in available state.\n - PENDING: Pending\n\nCloud Connect vpc attachment is in flight.\n - FAILED: Failed\n\nCloud Connect vpc attachment has failed.\n - DELETED: Deleted\n\nCloud Connect vpc attachment has been deleted.\n - DELETING: Deleting\n\nCloud Connect vpc attachment is being deleted.\n - INITIATED: Initiated\n\nCloud Connect vpc attachment process has been initiated.","title":"Cloud Connect VPC State","enum":["AVAILABLE","PENDING","FAILED","DELETED","DELETING","INITIATED"],"default":"AVAILABLE","x-displayname":"Cloud Connect VPC State","x-ves-proto-enum":"ves.io.schema.cloud_connect.CloudConnectVPCStateType"},"cloud_connectSubnetStatusType":{"type":"object","description":"Network Interface Status","title":"SubnetStatusType for AWS VPC Attachment","x-displayname":"Network Interface Status","x-ves-proto-message":"ves.io.schema.cloud_connect.SubnetStatusType","properties":{"availability_zone":{"type":"string","description":"\n Availability Zone","title":"Availability Zone\nx-displayName: \"Availability Zone\"","x-displayname":"Availability Zone"},"interface_type":{"type":"string","description":"\n Interface Type","title":"Interface Type\nx-displayName: \"Interface Type\"","x-displayname":"Interface Type"},"network_interface_id":{"type":"string","description":" Network Interface ID","title":"Network Interface ID","x-displayname":"Network Interface ID"},"private_ipv4_address":{"type":"string","description":"\n Private IPV4 Address","title":"Private IPV4 Address\nx-displayName: \"Private IPV4 Address\"","x-displayname":"Private IPV4 Address"},"status":{"type":"string","description":"\n Status","title":"Status\nx-displayName: \"Status\"","x-displayname":"Status"},"subnet_id":{"type":"string","description":"\n Subnet ID","title":"Subnet ID\nx-displayName: \"Subnet ID\"","x-displayname":"Subnet ID"}}},"fleetBlockedServices":{"type":"object","description":"Disable a node local service on this site.","title":"Disable Node Local Service","x-displayname":"Disable Node Local Service","x-ves-oneof-field-blocked_services_value_type_choice":"[\"dns\",\"ssh\",\"web_user_interface\"]","x-ves-proto-message":"ves.io.schema.fleet.BlockedServices","properties":{"dns":{"$ref":"#/components/schemas/ioschemaEmpty"},"network_type":{"$ref":"#/components/schemas/schemaVirtualNetworkType"},"ssh":{"$ref":"#/components/schemas/ioschemaEmpty"},"web_user_interface":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"fleetBlockedServicesListType":{"type":"object","description":"Disable node local services on this site. Note: The chosen services will get disabled on all nodes in the site.","title":"Disable Node Local Services","x-displayname":"Disable Node Local Services","x-ves-proto-message":"ves.io.schema.fleet.BlockedServicesListType","properties":{"blocked_sevice":{"type":"array","description":"\n\nValidation Rules:\n ves.io.schema.rules.repeated.unique: true\n","title":"Disable Node Local Services","items":{"$ref":"#/components/schemas/fleetBlockedServices"},"x-displayname":"Disable Node Local Services","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"network_firewallActiveNetworkPoliciesType":{"type":"object","description":"List of firewall policy views.","title":"Active Firewall Policies Type","x-displayname":"Active Firewall Policies Type","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveNetworkPoliciesType","properties":{"network_policies":{"type":"array","description":" Ordered List of Firewall Policies active for this network firewall\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 128\n ves.io.schema.rules.repeated.min_items: 1\n","title":"Firewall Policy","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Firewall Policy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_bytes: 131072\n ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\" Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaDomainType":{"type":"object","description":"x-displayName: \"Domains\"\nDomains names","title":"Domains","properties":{"exact_value":{"type":"string","description":"x-displayName: \"Exact Value\"\nx-example: \"abc.zyz.com\"\nExact domain name.","title":"exact value"},"regex_value":{"type":"string","description":"x-displayName: \"Regex Values of Domains\"\nx-example: \"([a-z]([-a-z0-9]*[a-z0-9])?)\\.com$'\"\nRegular Expression value for the domain name","title":"regex values of Domains"},"suffix_value":{"type":"string","description":"x-displayName: \"Suffix Value\"\nx-example: \"xyz.com\"\nSuffix of domain name e.g \"xyz.com\" will match \"*.xyz.com\" and \"xyz.com\"","title":"suffix value"}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaForwardProxyConfigType":{"type":"object","description":"x-displayName: \"Forward Proxy Configuration\"\nFine tune forward proxy behavior\n\nFew configurations allowed are\n\n White listed ports and ip prefixes:\n Forward proxy does application protocol detection and server name(SNI) detection by peeking into\n the traffic on the incoming downstream connection. Few protocols doesn't have client sending\n the first data. In such cases, protocol and SNI detection fails. This configuration allows,\n skipping protocol and SNI detection for whitelisted ip-prefix-list and ports\n connection_timeout:\n The timeout for new network connections to upstream server.\n max_connect_attempts:\n Maximum number of attempts made to make new network connection to upstream server.","title":"ForwardProxyConfigType","properties":{"connection_timeout":{"type":"integer","description":"x-displayName: \"Connection Timeout\"\nx-example: \"4000\"\nThe timeout for new network connections to upstream server.\nThis is specified in milliseconds. The default value is 2000 (2 seconds)","title":"connection_timeout","format":"int64"},"max_connect_attempts":{"type":"integer","description":"x-displayName: \"Number of connect attempts\"\nx-example: \"3\"\nSpecifies the allowed number of retries on connect failure to upstream server. Defaults to 1.","title":"max_connect_attempts","format":"int64"},"no_interception":{"$ref":"#/components/schemas/ioschemaEmpty"},"tls_intercept":{"$ref":"#/components/schemas/schemaTlsInterceptionType"},"white_listed_ports":{"type":"array","description":"x-displayName: \"TCP Ports to Skip Protocol Parsing\"\nx-example: \"[22, 9400]\"\nTraffic to these destination TCP ports is not subjected to protocol parsing\nExample \"tmate\" server port","title":"Port list","items":{"type":"integer","format":"int64"}},"white_listed_prefixes":{"type":"array","description":"x-displayName: \"IP Prefixes to Skip Protocol Parsing\"\nx-example: \"['10.2.1.0/24', '192.168.8.0/29', '10.7.64.160/27']\"\nTraffic to these destination ip prefixes is not subjected to protocol parsing\nExample \"tmate\" server ip","title":"IP prefix list","items":{"type":"string"}}}},"schemaHashAlgorithm":{"type":"string","description":"x-displayName: \"Hash Algorithm\"\nSpecifies the Hash Algorithm to be used\n\n - INVALID_HASH_ALGORITHM: x-displayName: \"INVALID\"\nInvalid hash algorithm\n - SHA256: x-displayName: \"SHA256\"\nsha256 hash algorithm\n - SHA1: x-displayName: \"SHA1\"\nsha1 hash algorithm","title":"HashAlgoritm","enum":["INVALID_HASH_ALGORITHM","SHA256","SHA1"],"default":"INVALID_HASH_ALGORITHM"},"schemaHashAlgorithms":{"type":"object","description":"x-displayName: \"Hash Algorithms\"\nSpecifies the hash algorithms to be used","title":"HashAlgorithms","properties":{"hash_algorithms":{"type":"array","description":"x-displayName: \"Hash Algorithms\"\nx-required\nOrdered list of hash algorithms to be used.","title":"Hash Algorithms","items":{"$ref":"#/components/schemas/schemaHashAlgorithm"}}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaIpAddressType":{"type":"object","description":"IP Address used to specify an IPv4 or IPv6 address","title":"IP Address","x-displayname":"IP Address","x-ves-displayorder":"3","x-ves-oneof-field-ver":"[\"ipv4\",\"ipv6\"]","x-ves-proto-message":"ves.io.schema.IpAddressType","properties":{"ipv4":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"ipv6":{"$ref":"#/components/schemas/schemaIpv6AddressType"}}},"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"}}},"schemaIpv4AddressType":{"type":"object","description":"IPv4 Address in dot-decimal notation","title":"IPv4 Address","x-displayname":"IPv4 Address","x-ves-proto-message":"ves.io.schema.Ipv4AddressType","properties":{"addr":{"type":"string","description":" IPv4 Address in string form with dot-decimal notation\n\nExample: ` \"192.168.1.1\"`\n\nValidation Rules:\n ves.io.schema.rules.string.ipv4: true\n","title":"IPv4 Address","x-displayname":"IPv4 Address","x-ves-example":"192.168.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"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"}}}},"schemaIpv6AddressType":{"type":"object","description":"IPv6 Address specified as hexadecimal numbers separated by ':'","title":"IPv6 Address","x-displayname":"IPv6 Address","x-ves-proto-message":"ves.io.schema.Ipv6AddressType","properties":{"addr":{"type":"string","description":" IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':'\n The address can be compacted by suppressing zeros\n e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'\n\nExample: ` \"2001:db8:0:0:0:0:2:1\"`\n\nValidation Rules:\n ves.io.schema.rules.string.ipv6: true\n","title":"IPv6 Address","x-displayname":"IPv6 Address","x-ves-example":"2001:db8:0:0:0:0:2:1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}}}},"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"}}}},"schemaNextHopType":{"type":"object","description":"Identifies the next-hop for a route","title":"Nexthop","x-displayname":"Nexthop","x-ves-proto-message":"ves.io.schema.NextHopType","properties":{"interface":{"type":"array","description":" Nexthop is network interface when type is \"Network-Interface\"\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 1\n","title":"Network Interface","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Network Interface","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"nexthop_address":{"$ref":"#/components/schemas/schemaIpAddressType"},"type":{"$ref":"#/components/schemas/schemaNextHopTypes"}}},"schemaNextHopTypes":{"type":"string","description":"Defines types of next-hop\n\nUse default gateway on the local interface as gateway for route.\nAssumes there is only one local interface on the virtual network.\nUse the specified address as nexthop\nUse the network interface as nexthop\nDiscard nexthop, used when attr type is Advertise\nUsed in VoltADN private virtual network.","title":"Nexthop Types","enum":["NEXT_HOP_DEFAULT_GATEWAY","NEXT_HOP_USE_CONFIGURED","NEXT_HOP_NETWORK_INTERFACE"],"default":"NEXT_HOP_DEFAULT_GATEWAY","x-displayname":"Nexthop Types","x-ves-proto-enum":"ves.io.schema.NextHopTypes"},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 64\n ves.io.schema.rules.map.keys.string.min_len: 1\n ves.io.schema.rules.map.values.string.max_len: 1024\n ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 64\n ves.io.schema.rules.map.keys.string.min_len: 1\n ves.io.schema.rules.map.values.string.max_len: 1024\n ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 64\n ves.io.schema.rules.map.keys.string.min_len: 1\n ves.io.schema.rules.map.values.string.max_len: 1024\n ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaRouteAttrType":{"type":"string","description":"Defines attributes associated with route\n\nIgnore attribute\nAdvertise route in all supported routing protocols\nAdd route into host OS - route in host OS will point to interface corresponding to the virtual network.\nHost OS must have an interface in the virtual network.\nUse the route for forwarding decision - adds route into data plane\nmodules with configured next-hop\nMerge Route if they already exist","title":"Route Attribute","enum":["ROUTE_ATTR_NO_OP","ROUTE_ATTR_ADVERTISE","ROUTE_ATTR_INSTALL_HOST","ROUTE_ATTR_INSTALL_FORWARDING","ROUTE_ATTR_MERGE_ONLY"],"default":"ROUTE_ATTR_NO_OP","x-displayname":"Route Attribute","x-ves-proto-enum":"ves.io.schema.RouteAttrType"},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaStaticRouteType":{"type":"object","description":"Defines a static route, configuring a list of prefixes and a next-hop to be used for them","title":"Static Route","x-displayname":"Static Route","x-ves-displayorder":"2,10,11,1","x-ves-proto-message":"ves.io.schema.StaticRouteType","properties":{"attrs":{"type":"array","description":" List of route attributes associated with the static route\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 4\n","title":"Attributes","maxItems":4,"items":{"$ref":"#/components/schemas/schemaRouteAttrType"},"x-displayname":"Attributes","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"4"}},"labels":{"type":"object","description":" Add Labels for this Static Route, these labels can be used in network policy\n\nExample: ` \"value\"`","title":"Static Route labels","x-displayname":"Static Route Labels","x-ves-example":"value"},"nexthop":{"$ref":"#/components/schemas/schemaNextHopType"},"subnets":{"type":"array","description":" List of route prefixes\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 256\n","title":"Subnets","maxItems":256,"items":{"$ref":"#/components/schemas/schemaIpSubnetType"},"x-displayname":"Subnets","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"256"}}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaTlsCertificateType":{"type":"object","description":"x-displayName: \"TLS Certificate\"\nHandle to fetch certificate and key","title":"TlsCertificateType","properties":{"certificate_url":{"type":"string","description":"x-displayName: \"Certificate\"\nx-example: \"value\"\nx-required\nTLS certificate.\nCertificate or certificate chain in PEM format including the PEM headers.","title":"certificate_url"},"custom_hash_algorithms":{"$ref":"#/components/schemas/schemaHashAlgorithms"},"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Certificate used in production environment\"\nDescription for the certificate","title":"description"},"disable_ocsp_stapling":{"$ref":"#/components/schemas/ioschemaEmpty"},"private_key":{"$ref":"#/components/schemas/schemaSecretType"},"use_system_defaults":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaTlsInterceptionPolicy":{"type":"object","description":"x-displayName: \"TLS Interception Policy\"\nPolicy to enable or disable TLS interception.","title":"TlsInterceptionPolicy","properties":{"interception_rules":{"type":"array","description":"x-displayName: \"TLS Interception Rules\"\nx-required\nList of ordered rules to enable or disable for TLS interception","title":"Interception Rules","items":{"$ref":"#/components/schemas/schemaTlsInterceptionRule"}}}},"schemaTlsInterceptionRule":{"type":"object","description":"x-displayName: \"TLS Interception Rule\"\nx-required\nRule to enable or disable TLS interception based on domain match","title":"TlsInterceptionRule","properties":{"disable_interception":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain_match":{"$ref":"#/components/schemas/schemaDomainType"},"enable_interception":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaTlsInterceptionType":{"type":"object","description":"x-displayName: \"Configuration for TLS interception\"\nConfiguration to enable TLS interception","title":"TlsInterceptionType","properties":{"custom_certificate":{"$ref":"#/components/schemas/schemaTlsCertificateType"},"enable_for_all_domains":{"$ref":"#/components/schemas/ioschemaEmpty"},"policy":{"$ref":"#/components/schemas/schemaTlsInterceptionPolicy"},"trusted_ca_url":{"type":"string","description":"x-displayName: \"Custom Root CA Certificate\"\nCustom Root CA Certificate for validating upstream server certificate","title":"Custom Root CA Certificate"},"volterra_certificate":{"$ref":"#/components/schemas/ioschemaEmpty"},"volterra_trusted_ca":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaVirtualNetworkType":{"type":"string","description":"Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Neworks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nfor volterra fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nvK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on volterra RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user","title":"VirtualNetworkType","enum":["VIRTUAL_NETWORK_SITE_LOCAL","VIRTUAL_NETWORK_SITE_LOCAL_INSIDE","VIRTUAL_NETWORK_PER_SITE","VIRTUAL_NETWORK_PUBLIC","VIRTUAL_NETWORK_GLOBAL","VIRTUAL_NETWORK_SITE_SERVICE","VIRTUAL_NETWORK_VER_INTERNAL","VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE","VIRTUAL_NETWORK_IP_AUTO","VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK","VIRTUAL_NETWORK_SRV6_NETWORK","VIRTUAL_NETWORK_IP_FABRIC","VIRTUAL_NETWORK_SEGMENT"],"default":"VIRTUAL_NETWORK_SITE_LOCAL","x-displayname":"Virtual Network Type","x-ves-proto-enum":"ves.io.schema.VirtualNetworkType"},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemanetwork_firewallActiveEnhancedFirewallPoliciesType":{"type":"object","description":"List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all options available under firewall policies\nwith an additional option for service insertion.","title":"Active Enhanced Firewall Policies Type","x-displayname":"Active Enhanced Network Policies Type","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveEnhancedFirewallPoliciesType","properties":{"enhanced_firewall_policies":{"type":"array","description":" Ordered List of Enhanced Firewall Policies active\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 128\n ves.io.schema.rules.repeated.min_items: 1\n","title":"Enhanced Firewall Policy","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Enhanced Firewall Policy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"schemanetwork_firewallActiveForwardProxyPoliciesType":{"type":"object","description":"Ordered List of Forward Proxy Policies active","title":"Active Forward Proxy Policies Type","x-displayname":"Active Forward Proxy Policies Type","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveForwardProxyPoliciesType","properties":{"forward_proxy_policies":{"type":"array","description":" Ordered List of Forward Proxy Policies active\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 128\n ves.io.schema.rules.repeated.min_items: 1\n","title":"Forward Proxy Policies","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Forward Proxy Policies","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"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"}}}},"siteCoordinates":{"type":"object","description":"Coordinates of the site which provides the site physical location","title":"Site Coordinates","x-displayname":"Site Coordinates","x-ves-proto-message":"ves.io.schema.site.Coordinates","properties":{"latitude":{"type":"number","description":" Latitude of the site location\n\nExample: ` \"10.0\"`\n\nValidation Rules:\n ves.io.schema.rules.float.gte: -90.0\n ves.io.schema.rules.float.lte: 90.0\n","title":"latitude","format":"float","x-displayname":"Latitude","x-ves-example":"10.0","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"-90.0","ves.io.schema.rules.float.lte":"90.0"}},"longitude":{"type":"number","description":" longitude of site location\n\nExample: ` \"20.0\"`\n\nValidation Rules:\n ves.io.schema.rules.float.gte: -180.0\n ves.io.schema.rules.float.lte: 180.0\n","title":"longitude","format":"float","x-displayname":"Longitude","x-ves-example":"20.0","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"-180.0","ves.io.schema.rules.float.lte":"180.0"}}}},"sitePublishVIPParamsPerAz":{"type":"object","description":"Per AZ parameters needed to publish VIP for public cloud sites","title":"Publish VIP Params Per AZ","x-displayname":"Publish VIP Params Per AZ","x-ves-proto-message":"ves.io.schema.site.PublishVIPParamsPerAz","properties":{"az_name":{"type":"string","description":" Name of the Availability zone\n\nExample: ` \"us-east-2a\"`\n\nValidation Rules:\n ves.io.schema.rules.string.pattern: ^[1-5]{1}$|^AzureAlternateRegion$|^[a-z]{2}-(?:gov-)?[a-z0-9]{4,20}-[a-z0-9]{2}$|^[a-z]{4,15}-[a-z0-9]{4,20}-[a-z]{1}$\n","title":"AZ Name","x-displayname":"AZ Name","x-ves-example":"us-east-2a","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^[1-5]{1}$|^AzureAlternateRegion$|^[a-z]{2}-(?:gov-)?[a-z0-9]{4,20}-[a-z0-9]{2}$|^[a-z]{4,15}-[a-z0-9]{4,20}-[a-z]{1}$"}},"inside_vip":{"type":"array","description":" List of Inside VIPs for an AZ\n\nExample: ` \"192.168.0.156\"`\n\nValidation Rules:\n ves.io.schema.rules.repeated.items.string.ipv4: true\n ves.io.schema.rules.repeated.max_items: 3\n ves.io.schema.rules.repeated.unique: true\n","title":"Inside VIP(s)","maxItems":3,"items":{"type":"string"},"x-displayname":"Inside VIP(s)","x-ves-example":"192.168.0.156","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.ipv4":"true","ves.io.schema.rules.repeated.max_items":"3","ves.io.schema.rules.repeated.unique":"true"}},"inside_vip_cname":{"type":"string","description":" CNAME value for the inside VIP,\n These are usually public cloud generated CNAME\n\nExample: ` \"test.56670-387196482.useast2.ves.io\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 256\n","title":"Inside VIP CNAME","maxLength":256,"x-displayname":"Inside VIP CNAME","x-ves-example":"test.56670-387196482.useast2.ves.io","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"inside_vip_v6":{"type":"array","description":" Optional list of Inside IPv6 VIPs for an AZ\n\nExample: ` \"2001::1\"`\n\nValidation Rules:\n ves.io.schema.rules.repeated.items.string.ipv6: true\n ves.io.schema.rules.repeated.max_items: 3\n ves.io.schema.rules.repeated.unique: true\n","title":"Inside IPv6 VIP(s)","maxItems":3,"items":{"type":"string"},"x-displayname":"Inside IPv6 VIP(s)","x-ves-example":"2001::1","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.ipv6":"true","ves.io.schema.rules.repeated.max_items":"3","ves.io.schema.rules.repeated.unique":"true"}},"outside_vip":{"type":"array","description":" List of Outside VIPs for an AZ\n\nExample: ` \"192.168.0.156\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.items.string.ipv4: true\n ves.io.schema.rules.repeated.max_items: 3\n ves.io.schema.rules.repeated.min_items: 1\n ves.io.schema.rules.repeated.unique: true\n","title":"Outside VIP(s)","minItems":1,"maxItems":3,"items":{"type":"string"},"x-displayname":"Outside VIP(s)","x-ves-example":"192.168.0.156","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ipv4":"true","ves.io.schema.rules.repeated.max_items":"3","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"outside_vip_cname":{"type":"string","description":" CNAME value for the outside VIP\n These are usually public cloud generated CNAME\n\nExample: ` \"test.56670-387196482.useast2.ves.io\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 256\n","title":"Outside VIP CNAME","maxLength":256,"x-displayname":"Outside VIP CNAME","x-ves-example":"test.56670-387196482.useast2.ves.io","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"outside_vip_v6":{"type":"array","description":" Optional list of Outside IPv6 VIPs for an AZ\n\nExample: ` \"2001::1\"`\n\nValidation Rules:\n ves.io.schema.rules.repeated.items.string.ipv6: true\n ves.io.schema.rules.repeated.max_items: 3\n ves.io.schema.rules.repeated.unique: true\n","title":"Outside IPv6 VIP(s)","maxItems":3,"items":{"type":"string"},"x-displayname":"Outside IPv6 VIP(s)","x-ves-example":"2001::1","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.ipv6":"true","ves.io.schema.rules.repeated.max_items":"3","ves.io.schema.rules.repeated.unique":"true"}}}},"siteSiteState":{"type":"string","description":"State of Site defines in which operational state site itself is.\n\nSite is online and operational.\nSite is in provisioning state. For instance during site deployment or switching to different connected Regional Edge.\nSite is in process of upgrade. It transition to ONLINE or FAILED state.\nSite is in Standby before goes to ONLINE. This is mainly for Regional Edge sites to do their verification before they go to ONLINE state.\nSite is in failed state. It failed during provisioning or upgrade phase. Site Status Objects contain more details.\nReregistration was requested\nReregistration is in progress and maurice is waiting for nodes\nSite deletion is in progress\nSite is waiting for registration\nSite resources are waiting to be orchestrated for F5XC managed site. Check Status objects for more details\nSite resources are orchestrated for F5XC managed site.\nAn Error occurred while site resource orchestration for F5XC managed site. Check Status objects for more details.\nSite resources are waiting to be orchestrated for F5XC managed site. Check Status objects for more details\nSite resources orchestrated for F5XC managed site are deleted.\nAn Error occurred while site resource delete operation for F5XC managed site. Check Status objects for more details.\nValidation for F5XC managed site is in progress. Check Status objects for more details.\nValidation for F5XC managed site succeeded. Orchestration will start for Site resources\nValidation for F5XC managed site failed. Check Status objects for more details.","title":"SiteState","enum":["ONLINE","PROVISIONING","UPGRADING","STANDBY","FAILED","REREGISTRATION","WAITINGNODES","DECOMMISSIONING","WAITING_FOR_REGISTRATION","ORCHESTRATION_IN_PROGRESS","ORCHESTRATION_COMPLETE","ERROR_IN_ORCHESTRATION","DELETING_CLOUD_RESOURCES","DELETED_CLOUD_RESOURCES","ERROR_DELETING_CLOUD_RESOURCES","VALIDATION_IN_PROGRESS","VALIDATION_SUCCESS","VALIDATION_FAILED"],"default":"ONLINE","x-displayname":"Site State","x-ves-proto-enum":"ves.io.schema.site.SiteState"},"terraform_parametersApplyStageState":{"type":"string","title":"- APPLIED: x-displayName: \"Applied\"\n - APPLY_ERRORED: x-displayName: \"Apply errored\"\n - APPLY_INIT_ERRORED: x-displayName: \"Apply init errored\"\n - APPLYING: x-displayName: \"Applying\"\n - APPLY_PLANNING: x-displayName: \"Apply planning\"\n - APPLY_PLAN_ERRORED: x-displayName: \"Apply plan errored\"\n - APPLY_QUEUED: x-displayName: \"Apply queued\"","enum":["APPLIED","APPLY_ERRORED","APPLY_INIT_ERRORED","APPLYING","APPLY_PLANNING","APPLY_PLAN_ERRORED","APPLY_QUEUED"],"default":"APPLIED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.ApplyStageState"},"terraform_parametersApplyStatus":{"type":"object","x-ves-oneof-field-state":"[\"apply_state\",\"destroy_state\",\"infra_state\"]","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.ApplyStatus","properties":{"apply_state":{"$ref":"#/components/schemas/terraform_parametersApplyStageState"},"container_version":{"type":"string","description":" Container image version","title":"container_version","x-displayname":"Container image version"},"destroy_state":{"$ref":"#/components/schemas/terraform_parametersDestroyStageState"},"error_output":{"type":"string","description":" Error output of terraform run\n\nExample: ` \"value\"`","title":"error_output","x-displayname":"Error Output","x-ves-example":"value"},"infra_state":{"$ref":"#/components/schemas/terraform_parametersInfraState"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this status was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","title":"suggested_action","x-displayname":"Suggested Action","x-ves-example":"value"},"tf_output":{"type":"string","description":" The value of an \"output\" variable from the terraform state file.\n\nExample: ` \"value\"`","title":"tf_output","x-displayname":"Terraform Output","x-ves-example":"value"},"tf_stdout":{"type":"string","description":" The stdout of terraform apply command.","title":"tf_stdout","x-displayname":"Terraform Standard Output"}}},"terraform_parametersDeploymentStatusType":{"type":"object","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.DeploymentStatusType","properties":{"apply_status":{"$ref":"#/components/schemas/terraform_parametersApplyStatus"},"expected_container_version":{"type":"string","description":" Container version expected","title":"Expected container version","x-displayname":"Expected container version"},"plan_status":{"$ref":"#/components/schemas/terraform_parametersPlanStatus"}}},"terraform_parametersDestroyStageState":{"type":"string","title":"- DESTROYED: x-displayName: \"Destroyed\"\n - DESTROY_ERRORED: x-displayName: \"Destroy errored\"\n - DESTROYING: x-displayName: \"Destroying\"\n - DESTROY_QUEUED: x-displayName: \"Destroy Queued\"","enum":["DESTROYED","DESTROY_ERRORED","DESTROYING","DESTROY_QUEUED"],"default":"DESTROYED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.DestroyStageState"},"terraform_parametersInfraState":{"type":"string","title":"- PROVISIONED: x-displayName: \"Provisioned\"\n - TIMED_OUT: x-displayName: \"Timed out\"\n - ERRORED: x-displayName: \"Errored\"\n - PROVISIONING: x-displayName: \"Provisioning\"","enum":["PROVISIONED","TIMED_OUT","ERRORED","PROVISIONING"],"default":"PROVISIONED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.InfraState"},"terraform_parametersPlanStageState":{"type":"string","description":"Terraform state during plan stage\n","title":"Plan Stage State","enum":["PLANNING","PLAN_ERRORED","NO_CHANGES","HAS_CHANGES","DISCARDED","PLAN_INIT_ERRORED","PLAN_QUEUED"],"default":"PLANNING","x-displayname":"Plan Stage State","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.PlanStageState"},"terraform_parametersPlanStatus":{"type":"object","x-ves-oneof-field-state":"[\"infra_state\",\"plan_state\"]","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.PlanStatus","properties":{"error_output":{"type":"string","description":" Error output of terraform run\n\nExample: ` \"value\"`","title":"error_output","x-displayname":"Error Output","x-ves-example":"value"},"infra_state":{"$ref":"#/components/schemas/terraform_parametersInfraState"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this status was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"plan_state":{"$ref":"#/components/schemas/terraform_parametersPlanStageState"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","title":"suggested_action","x-displayname":"Suggested Action","x-ves-example":"value"},"tf_plan_output":{"type":"string","description":" Terraform \"plan\" command output. Terraform performs a refresh, unless explicitly disabled, and then\n determines what actions are necessary to achieve the desired state specified in the configuration files.\n\nExample: ` \"value\"`","title":"tf_plan_output","x-displayname":"Terraform Plan Output","x-ves-example":"value"}}},"terraform_parametersRollbackState":{"type":"string","title":"- ROLLBACK_SUCCESSFUL: x-displayName: \"Rollback successful\"\n - ROLLBACK_ERRORED: x-displayName: \"Rollback errored\"\n - ROLLBACK_NOT_REQUIRED: x-displayName: \"Rollback not required\"","enum":["ROLLBACK_SUCCESSFUL","ROLLBACK_ERRORED","ROLLBACK_NOT_REQUIRED"],"default":"ROLLBACK_SUCCESSFUL"},"terraform_parametersUpgradeState":{"type":"string","description":"x-displayName: \"Upgrade State\"\nTerraform State after version Upgrade\n\n - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\"\n - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\"\n - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\"","title":"Upgrade State","enum":["UPGRADE_SUCCESSFUL","UPGRADE_ERRORED","UPGRADE_NOT_REQUIRED"],"default":"UPGRADE_SUCCESSFUL"},"viewsAWSSubnetIdsType":{"type":"object","description":"AWS Subnet Ids used by volterra site","title":"AWS Subnets Ids","x-displayname":"AWS Subnets Ids","x-ves-proto-message":"ves.io.schema.views.AWSSubnetIdsType","properties":{"az_name":{"type":"string","description":" AWS availability zone, must be consistent with the selected AWS region.\n\nExample: ` \"us-west-2a\"`","title":"AZ Name","x-displayname":"AZ Name","x-ves-example":"us-west-2a"},"inside_subnet":{"$ref":"#/components/schemas/viewsAWSSubnetInfoType"},"inside_subnet_id":{"type":"string","description":" Inside subnet ID used by volterra site\n\nExample: ` \"subnet-12345678901234567\"`","title":"Inside Subnet ID","x-displayname":"Inside Subnet ID","x-ves-example":"subnet-12345678901234567"},"outside_subnet":{"$ref":"#/components/schemas/viewsAWSSubnetInfoType"},"outside_subnet_id":{"type":"string","description":" Outside subnet ID used by volterra site\n\nExample: ` \"subnet-12345678901234567\"`","title":"Outside Subnet ID","x-displayname":"Outside Subnet ID","x-ves-example":"subnet-12345678901234567"},"workload_subnet":{"$ref":"#/components/schemas/viewsAWSSubnetInfoType"},"workload_subnet_id":{"type":"string","description":" Workload subnet ID used by volterra site\n\nExample: ` \"subnet-12345678901234567\"`","title":"Workload Subnet ID","x-displayname":"Workload Subnet ID","x-ves-example":"subnet-12345678901234567"}}},"viewsAWSSubnetInfoType":{"type":"object","description":"AWS Subnets Info Type","title":"AWS Subnets Info Type","x-displayname":"AWS Subnets Info Type","x-ves-proto-message":"ves.io.schema.views.AWSSubnetInfoType","properties":{"az_name":{"type":"string","description":" AWS availability zone, must be consistent with the selected AWS region.\n\nExample: ` \"us-west-2a\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.pattern: ^([a-z]{2})-?(gov-)?([a-z0-9]{4,20})-([a-z0-9]{2})$\n","title":"AZ Name","x-displayname":"AZ Name","x-ves-example":"us-west-2a","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^([a-z]{2})-?(gov-)?([a-z0-9]{4,20})-([a-z0-9]{2})$"}},"id":{"type":"string","description":" Subnet ID\n\nExample: ` \"subnet-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Subnet ID","maxLength":64,"x-displayname":"Subnet ID","x-ves-example":"subnet-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"ipv4_prefix":{"type":"string","description":" Subnet CIDR block. It has to be private address space.\n\nExample: ` \"10.1.0.0/16\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.ipv4_prefix: true\n ves.io.schema.rules.string.max_ip_prefix_length: 28\n ves.io.schema.rules.string.min_ip_prefix_length: 8\n","title":"Subnet CIDR block","x-displayname":"Subnet CIDR block","x-ves-example":"10.1.0.0/16","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true","ves.io.schema.rules.string.max_ip_prefix_length":"28","ves.io.schema.rules.string.min_ip_prefix_length":"8"}}}},"viewsAWSVPCParamsType":{"type":"object","description":"Parameters to create new AWS VPC","title":"AWS VPC Parameters","x-displayname":"AWS VPC Parameters","x-ves-displayorder":"7,3,6","x-ves-oneof-field-name_choice":"[\"autogenerate\",\"name_tag\"]","x-ves-proto-message":"ves.io.schema.views.AWSVPCParamsType","properties":{"autogenerate":{"$ref":"#/components/schemas/ioschemaEmpty"},"name_tag":{"type":"string","description":"Exclusive with [autogenerate]\n Specify the VPC Name\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n","title":"name_tag","maxLength":64,"x-displayname":"Choose VPC Name","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}},"primary_ipv4":{"type":"string","description":" IPv4 CIDR block for this VPC. It has to be private address space.\n The Primary IPv4 block cannot be modified. All subnets prefixes in this VPC must be part of this CIDR block.\n\nExample: ` \"10.1.0.0/16\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.ipv4_prefix: true\n ves.io.schema.rules.string.max_ip_prefix_length: 28\n ves.io.schema.rules.string.min_ip_prefix_length: 16\n","title":"Primary IPv4 CIDR block","x-displayname":"Primary IPv4 CIDR block","x-ves-example":"10.1.0.0/16","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true","ves.io.schema.rules.string.max_ip_prefix_length":"28","ves.io.schema.rules.string.min_ip_prefix_length":"16"}}}},"viewsAWSVPCTwoInterfaceNodeType":{"type":"object","description":"Parameters for creating two interface Node in one AZ","title":"Two Interface Node","x-displayname":"Two Interface Node","x-ves-displayorder":"1,7,3,5","x-ves-oneof-field-choice":"[\"inside_subnet\",\"reserved_inside_subnet\"]","x-ves-proto-message":"ves.io.schema.views.AWSVPCTwoInterfaceNodeType","properties":{"aws_az_name":{"type":"string","description":" AWS availability zone, must be consistent with the selected AWS region.\n\nExample: ` \"us-west-2a\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"AWS AZ","x-displayname":"AWS AZ Name","x-ves-example":"us-west-2a","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"inside_subnet":{"$ref":"#/components/schemas/viewsCloudSubnetType"},"outside_subnet":{"$ref":"#/components/schemas/viewsCloudSubnetType"},"reserved_inside_subnet":{"$ref":"#/components/schemas/ioschemaEmpty"},"workload_subnet":{"$ref":"#/components/schemas/viewsCloudSubnetType"}}},"viewsAllowedVIPPorts":{"type":"object","description":"This defines the TCP port(s) which will be opened on the cloud loadbalancer.\nSuch that the client can use the cloud VIP IP and port combination\nto reach TCP/HTTP lb configured on the F5XC Site","title":"Allowed VIP Ports","x-displayname":"Allowed VIP Ports","x-ves-oneof-field-port_choice":"[\"custom_ports\",\"disable_allowed_vip_port\",\"use_http_https_port\",\"use_http_port\",\"use_https_port\"]","x-ves-proto-message":"ves.io.schema.views.AllowedVIPPorts","properties":{"custom_ports":{"$ref":"#/components/schemas/viewsCustomPorts"},"disable_allowed_vip_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_http_https_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_http_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_https_port":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsCloudLinkADNType":{"type":"object","title":"CloudLink ADN Network Config","x-displayname":"CloudLink ADN Network Config","x-ves-proto-message":"ves.io.schema.views.CloudLinkADNType","properties":{"cloudlink_network_name":{"type":"string","description":" Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support.\n\nExample: ` \"private-cloud-ntw\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_bytes: 64\n","title":"Private ADN Network","maxLength":64,"x-displayname":"Private ADN Network","x-ves-example":"private-cloud-ntw","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"64"}}}},"viewsCloudSubnetParamType":{"type":"object","description":"Parameters for creating a new cloud subnet","title":"Cloud Subnet Param","x-displayname":"New Cloud Subnet Parameters","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.views.CloudSubnetParamType","properties":{"ipv4":{"type":"string","description":" IPv4 subnet prefix for this subnet\n\nExample: ` \"10.1.2.0/24\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.ipv4_prefix: true\n ves.io.schema.rules.string.max_ip_prefix_length: 28\n","title":"IPv4 Subnet","x-displayname":"IPv4 Subnet","x-ves-example":"10.1.2.0/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true","ves.io.schema.rules.string.max_ip_prefix_length":"28"}}}},"viewsCloudSubnetType":{"type":"object","description":"Parameters for AWS subnet","title":"Cloud Subnet","x-displayname":"AWS Subnet","x-ves-oneof-field-choice":"[\"existing_subnet_id\",\"subnet_param\"]","x-ves-proto-message":"ves.io.schema.views.CloudSubnetType","properties":{"existing_subnet_id":{"type":"string","description":"Exclusive with [subnet_param]\n Information about existing subnet ID\n\nExample: ` \"subnet-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Existing Subnet ID","maxLength":64,"x-displayname":"Existing Subnet ID","x-ves-example":"subnet-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"subnet_param":{"$ref":"#/components/schemas/viewsCloudSubnetParamType"}}},"viewsConfigValidationState":{"type":"string","description":"The state of Site Config Validation\n\n - VALIDATION_STATE_NONE: None\n\nConfig validation state is none\n - VALIDATION_IN_PROGRESS: In Progress\n\nConfig validation state is In Progress\n - VALIDATION_FAILED: Failed\n\nConfig validation state is Failed\n - VALIDATION_SUCCEEDED: Succeeded\n\nConfig validation state is Succeeded","title":"Config Validation State","enum":["VALIDATION_STATE_NONE","VALIDATION_IN_PROGRESS","VALIDATION_FAILED","VALIDATION_SUCCEEDED"],"default":"VALIDATION_STATE_NONE","x-displayname":"Site Config Validation State","x-ves-proto-enum":"ves.io.schema.views.ConfigValidationState"},"viewsCustomDNS":{"type":"object","description":"Custom DNS is the configured for specify CE site","title":"Custom DNS","x-displayname":"Custom DNS","x-ves-proto-message":"ves.io.schema.views.CustomDNS","properties":{"inside_nameserver":{"type":"string","description":" Optional DNS server IP to be used for name resolution in inside network\n\nExample: ` \"10.1.1.1\"`\n\nValidation Rules:\n ves.io.schema.rules.string.ipv4: true\n","title":"inside_nameserver","x-displayname":"DNS Server for Inside Network","x-ves-example":"10.1.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"outside_nameserver":{"type":"string","description":" Optional DNS server IP to be used for name resolution in outside network\n\nExample: ` \"10.1.1.1\"`\n\nValidation Rules:\n ves.io.schema.rules.string.ipv4: true\n","title":"outside_nameserver","x-displayname":"DNS Server for Outside Network","x-ves-example":"10.1.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"viewsCustomPorts":{"type":"object","description":"List of Custom port","title":"Custom Ports","x-displayname":"Custom Ports","x-ves-proto-message":"ves.io.schema.views.CustomPorts","properties":{"port_ranges":{"type":"string","description":" Port Ranges\n\nExample: ` \"80, 8080-8085\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.max_len: 512\n ves.io.schema.rules.string.min_len: 1\n ves.io.schema.rules.string.port_range_list: true\n","title":"Port Ranges","minLength":1,"maxLength":512,"x-displayname":"Port Ranges","x-ves-example":"80, 8080-8085","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.port_range_list":"true"}}}},"viewsDirectConnectConfigType":{"type":"object","description":"Direct Connect Configuration","title":"DirectConnectConfigType","x-displayname":"Direct Connect Configuration","x-ves-oneof-field-asn_choice":"[\"auto_asn\",\"custom_asn\"]","x-ves-oneof-field-vif_choice":"[\"hosted_vifs\",\"standard_vifs\"]","x-ves-proto-message":"ves.io.schema.views.DirectConnectConfigType","properties":{"auto_asn":{"$ref":"#/components/schemas/ioschemaEmpty"},"custom_asn":{"type":"integer","description":"Exclusive with [auto_asn]\n Custom Autonomous System Number\n\nExample: ` \"64512\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 1\n","title":"Custom ASN","format":"int64","x-displayname":"Custom ASN","x-ves-example":"64512","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1"}},"hosted_vifs":{"$ref":"#/components/schemas/viewsHostedVIFConfigType"},"standard_vifs":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsDirectConnectInfo":{"type":"object","description":"DirectConnect Info","title":"DirectConnect Info","x-displayname":"DirectConnect Info","x-ves-proto-message":"ves.io.schema.views.DirectConnectInfo","properties":{"asn":{"type":"integer","description":" The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration\n\nExample: ` \"\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 1\n ves.io.schema.rules.uint32.lte: 4294967294\n","title":"AWS Side ASN","format":"int64","x-displayname":"AWS Side ASN","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"4294967294"}},"direct_connect_gateway_id":{"type":"string","description":" DirectConnect Gateway ID\n\nExample: ` \"f2a50c04-xxxx-yyyy-zzzz-00000000a043\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n","title":"DirectConnect Gateway ID","x-displayname":"DirectConnect Gateway ID","x-ves-example":"f2a50c04-xxxx-yyyy-zzzz-00000000a043","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"vgw_id":{"type":"string","description":" Virtual Private Gateway ID\n\nExample: ` \"vgw-12345678\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.pattern: ^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Virtual Private Gateway ID","x-displayname":"Virtual Private Gateway ID","x-ves-example":"vgw-12345678","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^(vgw-)([a-z0-9]{8}|[a-z0-9]{17})$"}}}},"viewsExistingTGWType":{"type":"object","description":"Information needed for existing TGW","title":"Existing TGW Type","x-displayname":"Existing TGW Type","x-ves-proto-message":"ves.io.schema.views.ExistingTGWType","properties":{"tgw_asn":{"type":"integer","description":" TGW ASN.\n\nExample: ` \"64500\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gt: 0\n ves.io.schema.rules.uint32.lte: 65535\n","title":"TGW ASN","format":"int64","x-displayname":"Enter TGW ASN","x-ves-example":"64500","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"65535"}},"tgw_id":{"type":"string","description":" Existing TGW ID\n\nExample: ` \"tgw-12345678901234567\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 64\n ves.io.schema.rules.string.pattern: ^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Existing TGW ID","maxLength":64,"x-displayname":"Existing TGW ID","x-ves-example":"tgw-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(tgw-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"volterra_site_asn":{"type":"integer","description":" F5XC Site ASN.\n\nExample: ` \"64501\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gt: 0\n ves.io.schema.rules.uint32.lte: 65535\n","title":"F5XC Site ASN","format":"int64","x-displayname":"Enter F5XC Site ASN","x-ves-example":"64501","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"65535"}}}},"viewsGlobalConnectorType":{"type":"object","description":"Global network reference for direct connection","title":"Global Network","x-displayname":"Global Network","x-ves-proto-message":"ves.io.schema.views.GlobalConnectorType","properties":{"global_vn":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsGlobalNetworkConnectionListType":{"type":"object","description":"List of global network connections","title":"Global Network Connection List","x-displayname":"Global Network Connection List","x-ves-proto-message":"ves.io.schema.views.GlobalNetworkConnectionListType","properties":{"global_network_connections":{"type":"array","description":" Global network connections\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 8\n ves.io.schema.rules.repeated.min_items: 1\n","title":"Global Network Connections","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/viewsGlobalNetworkConnectionType"},"x-displayname":"Global Network Connections","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1"}}}},"viewsGlobalNetworkConnectionType":{"type":"object","description":"Global network connection","title":"Global Network Connection","x-displayname":"Global Network Connection","x-ves-oneof-field-connection_choice":"[\"sli_to_global_dr\",\"slo_to_global_dr\"]","x-ves-oneof-field-forward_proxy_choice":"[]","x-ves-proto-message":"ves.io.schema.views.GlobalNetworkConnectionType","properties":{"sli_to_global_dr":{"$ref":"#/components/schemas/viewsGlobalConnectorType"},"slo_to_global_dr":{"$ref":"#/components/schemas/viewsGlobalConnectorType"}}},"viewsHostedVIFConfigType":{"type":"object","description":"x-example: \"value\"\nAWS Direct Connect Hosted VIF Configuration","title":"AWS Direct Connect Hosted VIF Config","x-displayname":"AWS Direct Connect Hosted VIF Config","x-ves-oneof-field-connectivity_options":"[\"site_registration_over_direct_connect\",\"site_registration_over_internet\"]","x-ves-proto-message":"ves.io.schema.views.HostedVIFConfigType","properties":{"site_registration_over_direct_connect":{"$ref":"#/components/schemas/viewsCloudLinkADNType"},"site_registration_over_internet":{"$ref":"#/components/schemas/ioschemaEmpty"},"vif_list":{"type":"array","description":" List of Hosted VIF Config\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 30\n ves.io.schema.rules.repeated.unique: true\n","title":"List of Hosted VIF Config","maxItems":30,"items":{"$ref":"#/components/schemas/viewsVifRegionConfig"},"x-displayname":"List of Hosted VIF Config","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"30","ves.io.schema.rules.repeated.unique":"true"}}}},"viewsKubernetesUpgradeDrain":{"type":"object","description":"Specify how worker nodes within a site will be upgraded.","title":"Node by Node Upgrade","x-displayname":"Node by Node Upgrade","x-ves-displayorder":"1","x-ves-oneof-field-kubernetes_upgrade_drain_enable_choice":"[\"disable_upgrade_drain\",\"enable_upgrade_drain\"]","x-ves-proto-message":"ves.io.schema.views.KubernetesUpgradeDrain","properties":{"disable_upgrade_drain":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_upgrade_drain":{"$ref":"#/components/schemas/viewsKubernetesUpgradeDrainConfig"}}},"viewsKubernetesUpgradeDrainConfig":{"type":"object","description":"Specify batch upgrade settings for worker nodes within a site.","title":"Enable Node by Node Upgrade","x-displayname":"Enable Node by Node Upgrade","x-ves-oneof-field-drain_max_unavailable_choice":"[\"drain_max_unavailable_node_count\"]","x-ves-oneof-field-vega_upgrade_mode_toggle_choice":"[\"disable_vega_upgrade_mode\",\"enable_vega_upgrade_mode\"]","x-ves-proto-message":"ves.io.schema.views.KubernetesUpgradeDrainConfig","properties":{"disable_vega_upgrade_mode":{"$ref":"#/components/schemas/ioschemaEmpty"},"drain_max_unavailable_node_count":{"type":"integer","description":"Exclusive with []\n\n\nExample: ` \"1\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gte: 1\n ves.io.schema.rules.uint32.lte: 5000\n","title":"Node Batch Size Count","format":"int64","x-displayname":"Node Batch Size Count","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"5000"}},"drain_node_timeout":{"type":"integer","description":" Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes.\n (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.uint32.gte: 0\n ves.io.schema.rules.uint32.lte: 900\n","title":"Upgrade Wait Time","format":"int64","x-displayname":"Upgrade Wait Time","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"900"}},"enable_vega_upgrade_mode":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsL3PerformanceEnhancementType":{"type":"object","description":"x-required\nL3 enhanced performance mode options","title":"L3 Mode Enhanced Performance options","x-displayname":"L3 Mode Enhanced Performance","x-ves-displayorder":"1","x-ves-oneof-field-perf_mode_choice":"[\"jumbo\",\"no_jumbo\"]","x-ves-proto-message":"ves.io.schema.views.L3PerformanceEnhancementType","properties":{"jumbo":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_jumbo":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsOfflineSurvivabilityModeType":{"type":"object","description":"Offline Survivability allows the Site to continue functioning normally without traffic loss during periods of connectivity loss to the Regional Edge (RE) or the Global Controller (GC).\nWhen this feature is enabled, a site can continue to function as is with existing configuration for upto 7 days, even when the site is offline.\nThe certificates needed to keep the services running on this site are signed using a local CA.\nSecrets would also be cached locally to handle the connectivity loss.\nWhen the mode is toggled, services will restart and traffic disruption will be seen.","title":"Offline Survivability Mode","x-displayname":"Offline Survivability Mode","x-ves-oneof-field-offline_survivability_mode_choice":"[\"enable_offline_survivability_mode\",\"no_offline_survivability_mode\"]","x-ves-proto-message":"ves.io.schema.views.OfflineSurvivabilityModeType","properties":{"enable_offline_survivability_mode":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_offline_survivability_mode":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsOperatingSystemType":{"type":"object","description":"Select the F5XC Operating System Version for the site. By default, latest available OS Version will be used.\nRefer to release notes to find required released OS versions.","title":"Operating System Version","x-displayname":"Operating System Version","x-ves-displayorder":"1","x-ves-oneof-field-operating_system_version_choice":"[\"default_os_version\",\"operating_system_version\"]","x-ves-proto-message":"ves.io.schema.views.OperatingSystemType","properties":{"default_os_version":{"$ref":"#/components/schemas/ioschemaEmpty"},"operating_system_version":{"type":"string","description":"Exclusive with [default_os_version]\n Specify a OS version to be used e.g. 9.2024.6.\n\nExample: ` \"9.2024.6\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 20\n","title":"Operating System Version","maxLength":20,"x-displayname":"Operating System Version","x-ves-example":"9.2024.6","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"20"}}}},"viewsPerformanceEnhancementModeType":{"type":"object","description":"x-required\nOptimize the site for L3 or L7 traffic processing. L7 optimized is the default.","title":"Performance Enhancement Choice","x-displayname":"Performance Enhancement Mode","x-ves-displayorder":"1","x-ves-oneof-field-perf_mode_choice":"[\"perf_mode_l3_enhanced\",\"perf_mode_l7_enhanced\"]","x-ves-proto-message":"ves.io.schema.views.PerformanceEnhancementModeType","properties":{"perf_mode_l3_enhanced":{"$ref":"#/components/schemas/viewsL3PerformanceEnhancementType"},"perf_mode_l7_enhanced":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsPrivateConnectConfigType":{"type":"object","description":"Private Connect Configuration","title":"PrivateConnectConfigType","x-displayname":"Private Connect Configuration","x-ves-oneof-field-network_options":"[\"inside\",\"outside\"]","x-ves-proto-message":"ves.io.schema.views.PrivateConnectConfigType","properties":{"cloud_link":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"inside":{"$ref":"#/components/schemas/ioschemaEmpty"},"outside":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsSecurityGroupType":{"type":"object","description":"Enter pre created security groups for slo(Site Local Outside) and sli(Site Local Inside) interface. Supported only for sites deployed on existing VPC","title":"Security Group Parameters","x-displayname":"Security Group IDS","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.views.SecurityGroupType","properties":{"inside_security_group_id":{"type":"string","description":" Security Group ID to be attached to SLI(Site Local Inside) Interface\n\nExample: ` \"sg-0db952838ba829943\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 20\n ves.io.schema.rules.string.pattern: ^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$\n","title":"Inside Security Group ID","maxLength":20,"x-displayname":"Inside Security Group ID","x-ves-example":"sg-0db952838ba829943","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"20","ves.io.schema.rules.string.pattern":"^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$"}},"outside_security_group_id":{"type":"string","description":" Security Group ID to be attached to SLO(Site Local Outside) Interface\n\nExample: ` \"sg-0db952838ba829943\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 20\n ves.io.schema.rules.string.pattern: ^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$\n","title":"Outside Security Group ID","maxLength":20,"x-displayname":"Outside Security Group ID","x-ves-example":"sg-0db952838ba829943","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"20","ves.io.schema.rules.string.pattern":"^(sg-)([a-z0-9]{8}|[a-z0-9]{17})$|^$"}}}},"viewsSiteError":{"type":"object","description":"Site Error","title":"Site Error","x-displayname":"Site Error","x-ves-proto-message":"ves.io.schema.views.SiteError","properties":{"error_description":{"type":"string","description":" Error Description \n\nExample: ` \"invalid VPC ID\"`","title":"Error Description","x-displayname":"Error Description","x-ves-example":"invalid VPC ID"},"suggested_action":{"type":"string","description":" Suggested Action \n\nExample: ` \"update VPC ID\"`","title":"Suggested Action","x-displayname":"Suggested Action","x-ves-example":"update VPC ID"}}},"viewsSiteStaticRoutesListType":{"type":"object","description":"List of static routes","title":"Static Route List Type","x-displayname":"Static Route List Type","x-ves-proto-message":"ves.io.schema.views.SiteStaticRoutesListType","properties":{"static_route_list":{"type":"array","description":" List of Static routes\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.repeated.max_items: 64\n ves.io.schema.rules.repeated.min_items: 1\n","title":"List of Static Routes","minItems":1,"maxItems":64,"items":{"$ref":"#/components/schemas/viewsSiteStaticRoutesType"},"x-displayname":"List of Static Routes","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1"}}}},"viewsSiteStaticRoutesType":{"type":"object","description":"Different ways to configure static routes","title":"Site Static Route Config Modes","x-displayname":"Site Static Route Config Modes","x-ves-oneof-field-config_mode_choice":"[\"custom_static_route\",\"simple_static_route\"]","x-ves-proto-message":"ves.io.schema.views.SiteStaticRoutesType","properties":{"custom_static_route":{"$ref":"#/components/schemas/schemaStaticRouteType"},"simple_static_route":{"type":"string","description":"Exclusive with [custom_static_route]\n Use simple static route for prefix pointing to single interface in the network\n\nExample: ` \"10.5.1.0/24\"`\n\nValidation Rules:\n ves.io.schema.rules.string.ipv4_prefix: true\n","title":"Simple Static Route","x-displayname":"Simple Static Route","x-ves-example":"10.5.1.0/24","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4_prefix":"true"}}}},"viewsTGWAssignedASNType":{"type":"object","description":"Information needed when ASNs are assigned by the user","title":"TGW Assigned ASN Type","x-displayname":"TGW Assigned ASN Type","x-ves-proto-message":"ves.io.schema.views.TGWAssignedASNType","properties":{"tgw_asn":{"type":"integer","description":" TGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.\n\nExample: ` \"64512\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gt: 64512\n ves.io.schema.rules.uint32.lte: 65534\n","title":"TGW ASN","format":"int64","x-displayname":"Enter TGW ASN","x-ves-example":"64512","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"64512","ves.io.schema.rules.uint32.lte":"65534"}},"volterra_site_asn":{"type":"integer","description":" F5XC Site ASN.\n\nExample: ` \"64500\"`\n\nValidation Rules:\n ves.io.schema.rules.uint32.gt: 0\n ves.io.schema.rules.uint32.lte: 65535\n","title":"F5XC Site ASN","format":"int64","x-displayname":"Enter F5XC Site ASN","x-ves-example":"64500","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"65535"}}}},"viewsTGWParamsType":{"type":"object","title":"TGWParamsType","x-displayname":"TGWParamsType","x-ves-oneof-field-asn_choice":"[\"system_generated\",\"user_assigned\"]","x-ves-proto-message":"ves.io.schema.views.TGWParamsType","properties":{"system_generated":{"$ref":"#/components/schemas/ioschemaEmpty"},"user_assigned":{"$ref":"#/components/schemas/viewsTGWAssignedASNType"}}},"viewsValidateConfigRequest":{"type":"object","description":"Request to validate AWS VPC site configuration","title":"Request to validate AWS VPC site configuration","x-displayname":"Request to validate AWS VPC site configuration","x-ves-proto-message":"ves.io.schema.views.ValidateConfigRequest","properties":{"name":{"type":"string","description":" Name of the object to be configured\n\nExample: ` \"aws-vpc-site-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"aws-vpc-site-1"},"namespace":{"type":"string","description":" Namespace for the object to be configured\n\nExample: ` \"default\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"default"}}},"viewsValidateConfigResponse":{"type":"object","title":"Response to validate AWS VPC site configuration","x-displayname":"Response to validate AWS VPC site configuration","x-ves-proto-message":"ves.io.schema.views.ValidateConfigResponse"},"viewsVifRegionConfig":{"type":"object","description":"x-example: \"value\"\nAWS Direct Connect Hosted VIF Config Per Region Object","title":"HostedVIFRegionObject","x-displayname":"Hosted VIF Config Per Region Object","x-ves-displayorder":"5,2","x-ves-oneof-field-vif_region_choice":"[\"other_region\",\"same_as_site_region\"]","x-ves-proto-message":"ves.io.schema.views.VifRegionConfig","properties":{"other_region":{"type":"string","description":"Exclusive with [same_as_site_region]\n Other Region\n\nValidation Rules:\n ves.io.schema.rules.string.in: [\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-northeast-1\\\",\\\"ap-northeast-2\\\",\\\"ap-south-1\\\",\\\"ap-southeast-1\\\",\\\"ap-southeast-2\\\",\\\"ap-southeast-3\\\",\\\"ca-central-1\\\",\\\"eu-central-1\\\",\\\"eu-north-1\\\",\\\"eu-south-1\\\",\\\"eu-west-1\\\",\\\"eu-west-2\\\",\\\"eu-west-3\\\",\\\"me-south-1\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-1\\\",\\\"us-west-2\\\"]\n","title":"Other Region","x-displayname":"Other Region","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-northeast-1\\\",\\\"ap-northeast-2\\\",\\\"ap-south-1\\\",\\\"ap-southeast-1\\\",\\\"ap-southeast-2\\\",\\\"ap-southeast-3\\\",\\\"ca-central-1\\\",\\\"eu-central-1\\\",\\\"eu-north-1\\\",\\\"eu-south-1\\\",\\\"eu-west-1\\\",\\\"eu-west-2\\\",\\\"eu-west-3\\\",\\\"me-south-1\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-1\\\",\\\"us-west-2\\\"]"}},"same_as_site_region":{"$ref":"#/components/schemas/ioschemaEmpty"},"vif_id":{"type":"string","description":" AWS Direct Connect VIF ID that needs to be connected to the site\n\nExample: ` \"dxvif-fgwtckim\"`\n\nRequired: YES\n\nValidation Rules:\n ves.io.schema.rules.message.required: true\n ves.io.schema.rules.string.pattern: ^(dxvif-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"VIF ID","x-displayname":"VIF ID","x-ves-example":"dxvif-fgwtckim","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^(dxvif-)([a-z0-9]{8}|[a-z0-9]{17})$"}}}},"viewsVolterraSoftwareType":{"type":"object","description":"Select the F5XC Software Version for the site. By default, latest available F5XC Software Version will be used.\nRefer to release notes to find required released SW versions.","title":"F5XC Software Version","x-displayname":"F5XC Software Version","x-ves-displayorder":"1","x-ves-oneof-field-volterra_sw_version_choice":"[\"default_sw_version\",\"volterra_software_version\"]","x-ves-proto-message":"ves.io.schema.views.VolterraSoftwareType","properties":{"default_sw_version":{"$ref":"#/components/schemas/ioschemaEmpty"},"volterra_software_version":{"type":"string","description":"Exclusive with [default_sw_version]\n Specify a F5XC Software Version to be used e.g. crt-20210329-1002.\n\nExample: ` \"crt-20210329-1002\"`\n\nValidation Rules:\n ves.io.schema.rules.string.max_len: 20\n","title":"F5XC Software Version","maxLength":20,"x-displayname":"F5XC Software Version","x-ves-example":"crt-20210329-1002","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"20"}}}},"viewsaws_tgw_siteActiveServicePoliciesType":{"type":"object","description":"Active service policies for the east-west proxy","title":"Active Service Policies","x-displayname":"Active Service Policies","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ActiveServicePoliciesType","properties":{"service_policies":{"type":"array","description":" A list of references to service_policy objects.\n\nValidation Rules:\n ves.io.schema.rules.repeated.max_items: 32\n ves.io.schema.rules.repeated.unique: true\n","title":"service_policies","maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Service Policies","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}}}},"viewsaws_tgw_siteCreateSpecType":{"type":"object","description":"Shape of the AWS TGW site specification","title":"CreateSpecType","x-displayname":"Create AWS TGW site","x-ves-oneof-field-blocked_services_choice":"[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]","x-ves-oneof-field-direct_connect_choice":"[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]","x-ves-oneof-field-logs_receiver_choice":"[\"log_receiver\",\"logs_streaming_disabled\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.CreateSpecType","properties":{"aws_parameters":{"$ref":"#/components/schemas/aws_tgw_siteServicesVPCType"},"block_all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocked_services":{"$ref":"#/components/schemas/fleetBlockedServicesListType"},"coordinates":{"$ref":"#/components/schemas/siteCoordinates"},"custom_dns":{"$ref":"#/components/schemas/viewsCustomDNS"},"default_blocked_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"direct_connect_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"direct_connect_enabled":{"$ref":"#/components/schemas/viewsDirectConnectConfigType"},"kubernetes_upgrade_drain":{"$ref":"#/components/schemas/viewsKubernetesUpgradeDrain"},"log_receiver":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"logs_streaming_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"offline_survivability_mode":{"$ref":"#/components/schemas/viewsOfflineSurvivabilityModeType"},"os":{"$ref":"#/components/schemas/viewsOperatingSystemType"},"performance_enhancement_mode":{"$ref":"#/components/schemas/viewsPerformanceEnhancementModeType"},"private_connectivity":{"$ref":"#/components/schemas/viewsPrivateConnectConfigType"},"sw":{"$ref":"#/components/schemas/viewsVolterraSoftwareType"},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 127\n ves.io.schema.rules.map.max_pairs: 40\n ves.io.schema.rules.map.values.string.max_len: 255\n","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"255"}},"tgw_security":{"$ref":"#/components/schemas/aws_tgw_siteSecurityConfigType"},"vn_config":{"$ref":"#/components/schemas/aws_tgw_siteVnConfiguration"},"vpc_attachments":{"$ref":"#/components/schemas/aws_tgw_siteVPCAttachmentListType"}}},"viewsaws_tgw_siteGetSpecType":{"type":"object","description":"Shape of the AWS TGW site specification","title":"GetSpecType","x-displayname":"Get AWS TGW site","x-ves-oneof-field-blocked_services_choice":"[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]","x-ves-oneof-field-direct_connect_choice":"[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]","x-ves-oneof-field-logs_receiver_choice":"[\"log_receiver\",\"logs_streaming_disabled\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.GetSpecType","properties":{"aws_parameters":{"$ref":"#/components/schemas/aws_tgw_siteServicesVPCType"},"block_all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocked_services":{"$ref":"#/components/schemas/fleetBlockedServicesListType"},"coordinates":{"$ref":"#/components/schemas/siteCoordinates"},"custom_dns":{"$ref":"#/components/schemas/viewsCustomDNS"},"default_blocked_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"direct_connect_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"direct_connect_enabled":{"$ref":"#/components/schemas/viewsDirectConnectConfigType"},"direct_connect_info":{"$ref":"#/components/schemas/viewsDirectConnectInfo"},"error_description":{"type":"string","description":" Description of error on site\n\nExample: ` \"value\"`","x-displayname":"Error Description","x-ves-example":"value"},"kubernetes_upgrade_drain":{"$ref":"#/components/schemas/viewsKubernetesUpgradeDrain"},"log_receiver":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"logs_streaming_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"offline_survivability_mode":{"$ref":"#/components/schemas/viewsOfflineSurvivabilityModeType"},"performance_enhancement_mode":{"$ref":"#/components/schemas/viewsPerformanceEnhancementModeType"},"private_connectivity":{"$ref":"#/components/schemas/viewsPrivateConnectConfigType"},"site_errors":{"type":"array","description":" Errors on site including suggested action\n\nExample: ` \"Site Errors\"`","items":{"$ref":"#/components/schemas/viewsSiteError"},"x-displayname":"Site Errors","x-ves-example":"Site Errors"},"site_state":{"$ref":"#/components/schemas/siteSiteState"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","x-displayname":"Suggested Action","x-ves-example":"value"},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n ves.io.schema.rules.map.keys.string.max_len: 127\n ves.io.schema.rules.map.max_pairs: 40\n ves.io.schema.rules.map.values.string.max_len: 255\n","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"255"}},"tgw_info":{"$ref":"#/components/schemas/aws_tgw_siteAWSTGWInfoConfigType"},"tgw_security":{"$ref":"#/components/schemas/aws_tgw_siteSecurityConfigType"},"tunnel_type":{"$ref":"#/components/schemas/aws_tgw_siteTunnelType"},"validation_state":{"$ref":"#/components/schemas/viewsConfigValidationState"},"vip_params_per_az":{"type":"array","description":" VIP Parameters Per AZ.\n\nValidation Rules:\n ves.io.schema.rules.repeated.num_items: 0,1,2,3\n ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/sitePublishVIPParamsPerAz"},"x-displayname":"VIP Params Per AZ","x-ves-validation-rules":{"ves.io.schema.rules.repeated.num_items":"0,1,2,3","ves.io.schema.rules.repeated.unique":"true"}},"vn_config":{"$ref":"#/components/schemas/aws_tgw_siteVnConfiguration"},"vpc_attachments":{"$ref":"#/components/schemas/aws_tgw_siteVPCAttachmentListType"}}},"viewsaws_tgw_siteReplaceSpecType":{"type":"object","description":"Shape of the AWS TGW site replace specification","title":"ReplaceSpecType","x-displayname":"Replace AWS TGW site","x-ves-oneof-field-blocked_services_choice":"[\"block_all_services\",\"blocked_services\",\"default_blocked_services\"]","x-ves-oneof-field-direct_connect_choice":"[\"direct_connect_disabled\",\"direct_connect_enabled\",\"private_connectivity\"]","x-ves-oneof-field-logs_receiver_choice":"[\"log_receiver\",\"logs_streaming_disabled\"]","x-ves-proto-message":"ves.io.schema.views.aws_tgw_site.ReplaceSpecType","properties":{"aws_parameters":{"$ref":"#/components/schemas/aws_tgw_siteServicesVPCReplaceType"},"block_all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocked_services":{"$ref":"#/components/schemas/fleetBlockedServicesListType"},"coordinates":{"$ref":"#/components/schemas/siteCoordinates"},"custom_dns":{"$ref":"#/components/schemas/viewsCustomDNS"},"default_blocked_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"direct_connect_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"direct_connect_enabled":{"$ref":"#/components/schemas/viewsDirectConnectConfigType"},"kubernetes_upgrade_drain":{"$ref":"#/components/schemas/viewsKubernetesUpgradeDrain"},"log_receiver":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"logs_streaming_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"offline_survivability_mode":{"$ref":"#/components/schemas/viewsOfflineSurvivabilityModeType"},"performance_enhancement_mode":{"$ref":"#/components/schemas/viewsPerformanceEnhancementModeType"},"private_connectivity":{"$ref":"#/components/schemas/viewsPrivateConnectConfigType"},"tgw_security":{"$ref":"#/components/schemas/aws_tgw_siteSecurityConfigType"},"vn_config":{"$ref":"#/components/schemas/aws_tgw_siteVnConfiguration"},"vpc_attachments":{"$ref":"#/components/schemas/aws_tgw_siteVPCAttachmentListType"}}}}}}