@robinmordasiewicz/f5xc-terraform-mcp 3.5.1 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (110) hide show
  1. package/dist/docs/data-sources/bgp.md +2 -2
  2. package/dist/docs/data-sources/discovery.md +2 -2
  3. package/dist/docs/data-sources/fast_acl.md +2 -2
  4. package/dist/docs/data-sources/fast_acl_rule.md +2 -2
  5. package/dist/docs/data-sources/irule.md +2 -2
  6. package/dist/docs/data-sources/log_receiver.md +2 -2
  7. package/dist/docs/data-sources/network_policy.md +2 -2
  8. package/dist/docs/data-sources/route.md +2 -2
  9. package/dist/docs/data-sources/site.md +2 -2
  10. package/dist/docs/resources/address_allocator.md +7 -7
  11. package/dist/docs/resources/advertise_policy.md +57 -57
  12. package/dist/docs/resources/alert_policy.md +40 -40
  13. package/dist/docs/resources/alert_receiver.md +57 -57
  14. package/dist/docs/resources/api_crawler.md +13 -13
  15. package/dist/docs/resources/api_definition.md +11 -11
  16. package/dist/docs/resources/api_discovery.md +4 -4
  17. package/dist/docs/resources/api_testing.md +27 -27
  18. package/dist/docs/resources/apm.md +40 -40
  19. package/dist/docs/resources/app_api_group.md +20 -20
  20. package/dist/docs/resources/app_firewall.md +50 -50
  21. package/dist/docs/resources/app_setting.md +19 -19
  22. package/dist/docs/resources/app_type.md +7 -7
  23. package/dist/docs/resources/authentication.md +29 -29
  24. package/dist/docs/resources/aws_tgw_site.md +140 -140
  25. package/dist/docs/resources/aws_vpc_site.md +174 -174
  26. package/dist/docs/resources/azure_vnet_site.md +245 -245
  27. package/dist/docs/resources/bgp.md +37 -205
  28. package/dist/docs/resources/bgp_asn_set.md +1 -1
  29. package/dist/docs/resources/bgp_routing_policy.md +19 -19
  30. package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
  31. package/dist/docs/resources/cdn_cache_rule.md +5 -5
  32. package/dist/docs/resources/cdn_loadbalancer.md +418 -418
  33. package/dist/docs/resources/certificate.md +1 -1
  34. package/dist/docs/resources/certificate_chain.md +1 -1
  35. package/dist/docs/resources/cloud_connect.md +28 -28
  36. package/dist/docs/resources/cloud_credentials.md +35 -35
  37. package/dist/docs/resources/cloud_elastic_ip.md +8 -8
  38. package/dist/docs/resources/cloud_link.md +36 -36
  39. package/dist/docs/resources/cluster.md +86 -86
  40. package/dist/docs/resources/cminstance.md +22 -22
  41. package/dist/docs/resources/code_base_integration.md +24 -24
  42. package/dist/docs/resources/container_registry.md +13 -13
  43. package/dist/docs/resources/crl.md +1 -1
  44. package/dist/docs/resources/data_type.md +16 -16
  45. package/dist/docs/resources/dc_cluster_group.md +4 -4
  46. package/dist/docs/resources/discovery.md +8 -259
  47. package/dist/docs/resources/dns_compliance_checks.md +1 -1
  48. package/dist/docs/resources/dns_domain.md +3 -3
  49. package/dist/docs/resources/endpoint.md +44 -44
  50. package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
  51. package/dist/docs/resources/external_connector.md +42 -42
  52. package/dist/docs/resources/fast_acl.md +60 -166
  53. package/dist/docs/resources/fast_acl_rule.md +28 -28
  54. package/dist/docs/resources/filter_set.md +10 -10
  55. package/dist/docs/resources/fleet.md +160 -160
  56. package/dist/docs/resources/forward_proxy_policy.md +82 -82
  57. package/dist/docs/resources/forwarding_class.md +14 -14
  58. package/dist/docs/resources/gcp_vpc_site.md +152 -152
  59. package/dist/docs/resources/global_log_receiver.md +238 -238
  60. package/dist/docs/resources/healthcheck.md +17 -17
  61. package/dist/docs/resources/http_loadbalancer.md +1003 -1003
  62. package/dist/docs/resources/irule.md +5 -7
  63. package/dist/docs/resources/log_receiver.md +825 -44
  64. package/dist/docs/resources/malicious_user_mitigation.md +10 -10
  65. package/dist/docs/resources/nat_policy.md +86 -86
  66. package/dist/docs/resources/network_connector.md +31 -31
  67. package/dist/docs/resources/network_firewall.md +22 -22
  68. package/dist/docs/resources/network_interface.md +77 -77
  69. package/dist/docs/resources/network_policy.md +38 -217
  70. package/dist/docs/resources/network_policy_rule.md +21 -21
  71. package/dist/docs/resources/network_policy_view.md +65 -65
  72. package/dist/docs/resources/nfv_service.md +76 -76
  73. package/dist/docs/resources/nginx_service_discovery.md +10 -10
  74. package/dist/docs/resources/origin_pool.md +166 -166
  75. package/dist/docs/resources/policer.md +4 -4
  76. package/dist/docs/resources/policy_based_routing.md +28 -28
  77. package/dist/docs/resources/protocol_inspection.md +12 -12
  78. package/dist/docs/resources/protocol_policer.md +14 -14
  79. package/dist/docs/resources/proxy.md +111 -111
  80. package/dist/docs/resources/rate_limiter.md +15 -15
  81. package/dist/docs/resources/rate_limiter_policy.md +56 -56
  82. package/dist/docs/resources/route.md +183 -183
  83. package/dist/docs/resources/secret_management_access.md +68 -68
  84. package/dist/docs/resources/securemesh_site.md +1619 -258
  85. package/dist/docs/resources/segment.md +4 -4
  86. package/dist/docs/resources/sensitive_data_policy.md +9 -9
  87. package/dist/docs/resources/service_policy.md +175 -175
  88. package/dist/docs/resources/service_policy_rule.md +142 -142
  89. package/dist/docs/resources/site.md +381 -303
  90. package/dist/docs/resources/site_mesh_group.md +18 -18
  91. package/dist/docs/resources/subnet.md +17 -17
  92. package/dist/docs/resources/tcp_loadbalancer.md +130 -130
  93. package/dist/docs/resources/tenant_configuration.md +10 -10
  94. package/dist/docs/resources/trusted_ca_list.md +1 -1
  95. package/dist/docs/resources/tunnel.md +36 -36
  96. package/dist/docs/resources/udp_loadbalancer.md +59 -59
  97. package/dist/docs/resources/usb_policy.md +6 -6
  98. package/dist/docs/resources/user_identification.md +16 -16
  99. package/dist/docs/resources/virtual_host.md +225 -225
  100. package/dist/docs/resources/virtual_network.md +14 -14
  101. package/dist/docs/resources/virtual_site.md +3 -3
  102. package/dist/docs/resources/voltstack_site.md +141 -141
  103. package/dist/docs/resources/waf_exclusion_policy.md +17 -17
  104. package/dist/docs/resources/workload.md +327 -327
  105. package/dist/docs/resources/workload_flavor.md +3 -3
  106. package/dist/metadata/resource-metadata.json +1484 -942
  107. package/dist/types.d.ts +11 -0
  108. package/dist/types.d.ts.map +1 -1
  109. package/dist/types.js.map +1 -1
  110. package/package.json +1 -1
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_bgp Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Networking"
4
4
  description: |-
5
- Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.
5
+ Manages a BGP resource in F5 Distributed Cloud for bgp routing policy is a list of rules containing match criteria and action to be applied. these rules help contol routes which are imported or exported to bgp peers. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_bgp (Data Source)
9
9
 
10
- Manages a BGP resource in F5 Distributed Cloud for bgp object is the configuration for peering with external bgp servers. it is created by users in system namespace. configuration.
10
+ Manages a BGP resource in F5 Distributed Cloud for bgp routing policy is a list of rules containing match criteria and action to be applied. these rules help contol routes which are imported or exported to bgp peers. configuration.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_discovery Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Applications"
4
4
  description: |-
5
- Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
5
+ Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_discovery (Data Source)
9
9
 
10
- Manages a Discovery resource in F5 Distributed Cloud for api to create discovery object for a site or virtual site in system namespace. configuration.
10
+ Manages API discovery creates a new object in the storage backend for metadata.namespace. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_fast_acl Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Security"
4
4
  description: |-
5
- Manages fast_acl object, fast_acl object contains rules to protect site from denial of service It has destination{destination IP, destination port) and references to fast_acl_rule in F5 Distributed Cloud.
5
+ Manages new Fast ACL rule, has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_fast_acl (Data Source)
9
9
 
10
- Manages `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service It has destination{destination IP, destination port) and references to `fast_acl_rule` in F5 Distributed Cloud.
10
+ Manages new Fast ACL rule, has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_fast_acl_rule Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Security"
4
4
  description: |-
5
- Manages new Fast ACL rule, fast_acl_rule has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
5
+ Manages new Fast ACL rule, has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_fast_acl_rule (Data Source)
9
9
 
10
- Manages new Fast ACL rule, `fast_acl_rule` has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
10
+ Manages new Fast ACL rule, has specification to match source IP, source port and action to apply. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_irule Data Source - terraform-provider-f5xc"
3
3
  subcategory: "BIG-IP Integration"
4
4
  description: |-
5
- Manages a Irule resource in F5 Distributed Cloud for desired state for big-ip irule service. configuration.
5
+ Manages iRule in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_irule (Data Source)
9
9
 
10
- Manages a Irule resource in F5 Distributed Cloud for desired state for big-ip irule service. configuration.
10
+ Manages iRule in a given namespace. If one already exists it will give an error. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_log_receiver Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Monitoring"
4
4
  description: |-
5
- Manages new Log Receiver object. in F5 Distributed Cloud.
5
+ Manages new Global Log Receiver object. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_log_receiver (Data Source)
9
9
 
10
- Manages new Log Receiver object. in F5 Distributed Cloud.
10
+ Manages new Global Log Receiver object. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_network_policy Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Security"
4
4
  description: |-
5
- Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
5
+ Manages network policy rule with configured parameters in specified namespace. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_network_policy (Data Source)
9
9
 
10
- Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
10
+ Manages network policy rule with configured parameters in specified namespace. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_route Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Load Balancing"
4
4
  description: |-
5
- Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. Virtual host object has reference to route object. in F5 Distributed Cloud.
5
+ Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_route (Data Source)
9
9
 
10
- Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. Virtual host object has reference to route object. in F5 Distributed Cloud.
10
+ Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_site Data Source - terraform-provider-f5xc"
3
3
  subcategory: "Uncategorized"
4
4
  description: |-
5
- Manages a Site resource in F5 Distributed Cloud for gcp vpc site specification. configuration.
5
+ Manages a Site resource in F5 Distributed Cloud for aws vpc site specification. configuration.
6
6
  ---
7
7
 
8
8
  # f5xc_site (Data Source)
9
9
 
10
- Manages a Site resource in F5 Distributed Cloud for gcp vpc site specification. configuration.
10
+ Manages a Site resource in F5 Distributed Cloud for aws vpc site specification. configuration.
11
11
 
12
12
  ~> **Note** For more information about this data source, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -32,7 +32,7 @@ resource "f5xc_address_allocator" "example" {
32
32
  }
33
33
 
34
34
  # Resource-specific configuration
35
- # Address Allocation Scheme. Decides the scheme to be used ...
35
+ # Decides the scheme to be used to allocate addresses from ...
36
36
  address_allocation_scheme {
37
37
  # Configure address_allocation_scheme settings
38
38
  }
@@ -58,11 +58,11 @@ resource "f5xc_address_allocator" "example" {
58
58
 
59
59
  ### Spec Argument Reference
60
60
 
61
- <a id="address-allocation-scheme"></a>&#x2022; [`address_allocation_scheme`](#address-allocation-scheme) - Optional Block<br>Address Allocation Scheme. Decides the scheme to be used to allocate addresses from the configured address pool<br>See [Address Allocation Scheme](#address-allocation-scheme) below for details.
61
+ <a id="address-allocation-scheme"></a>&#x2022; [`address_allocation_scheme`](#address-allocation-scheme) - Optional Block<br>Decides the scheme to be used to allocate addresses from the configured address pool<br>See [Address Allocation Scheme](#address-allocation-scheme) below for details.
62
62
 
63
- <a id="address-pool"></a>&#x2022; [`address_pool`](#address-pool) - Optional List<br>Address Pool. Address pool from which the allocator carves out subnets or addresses to its clients
63
+ <a id="address-pool"></a>&#x2022; [`address_pool`](#address-pool) - Optional List<br>Address pool from which the allocator carves out subnets or addresses to its clients
64
64
 
65
- <a id="mode"></a>&#x2022; [`mode`](#mode) - Optional String Defaults to `LOCAL`<br>Possible values are `LOCAL`, `GLOBAL_PER_SITE_NODE`<br>[Enum: LOCAL|GLOBAL_PER_SITE_NODE] Allocator Mode. Mode of the address allocator Address allocator is for VERs within the local cluster or site Allocation is per site and then per node
65
+ <a id="mode"></a>&#x2022; [`mode`](#mode) - Optional String Defaults to `LOCAL`<br>Possible values are `LOCAL`, `GLOBAL_PER_SITE_NODE`<br>[Enum: LOCAL|GLOBAL_PER_SITE_NODE] Mode of the address allocator Address allocator is for VERs within the local cluster or site Allocation is per site and then per node
66
66
 
67
67
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
68
68
 
@@ -78,11 +78,11 @@ In addition to all arguments above, the following attributes are exported:
78
78
 
79
79
  An [`address_allocation_scheme`](#address-allocation-scheme) block supports the following:
80
80
 
81
- <a id="unit-44a05d"></a>&#x2022; [`allocation_unit`](#unit-44a05d) - Optional Number<br>Allocation Unit. Prefix length indicating the size of each allocated subnet. For example, if this is specified as 30, subnets of /30 will be allocated from the given address pool
81
+ <a id="unit-44a05d"></a>&#x2022; [`allocation_unit`](#unit-44a05d) - Optional Number<br>Prefix length indicating the size of each allocated subnet. For example, if this is specified as 30, subnets of /30 will be allocated from the given address pool
82
82
 
83
- <a id="offset-3d4118"></a>&#x2022; [`local_interface_address_offset`](#offset-3d4118) - Optional Number<br>Local Interface Address Offset. This is used to derive address for the local interface from the allocated subnet. If Local Interface Address Type is set to 'Offset from beginning of Subnet', this offset value is added to the allocated subnet and used as the local interface address. For example, if the allocated subnet is 169.254.0.0/30 and offset is set to 2 with Local Interface Address Type set to 'Offset from beginning of Subnet', local interface address of 169.254.0.2 is used. If Local Interface Address Type is set to 'Offset from end of Subnet', this offset value is subtracted from the end of the allocated subnet and used as the local interface address. For example, if the allocated subnet is 169.254.0.0/30 and offset is set to 1 with Local Interface Address Type set to 'Offset from end of Subnet', local interface address of 169.254.0.2 is used
83
+ <a id="offset-3d4118"></a>&#x2022; [`local_interface_address_offset`](#offset-3d4118) - Optional Number<br>Used to derive address for the local interface from the allocated subnet. If Local Interface Address Type is set to 'Offset from beginning of Subnet', this offset value is added to the allocated subnet and used as the local interface address. For example, if the allocated subnet is
84
84
 
85
- <a id="type-3a6e24"></a>&#x2022; [`local_interface_address_type`](#type-3a6e24) - Optional String Defaults to `LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN`<br>Possible values are `LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN`, `LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_END`, `LOCAL_INTERFACE_ADDRESS_FROM_PREFIX`<br>[Enum: LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN|LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_END|LOCAL_INTERFACE_ADDRESS_FROM_PREFIX] Local Interface Address Type. Dictates how local interface address is derived from the allocated subnet Use Nth address of the allocated subnet as the local interface address, N being the Local Interface Address Offset. For example, if the allocated subnet is 169.254.0.0/30, Local Interface Address Offset is set to 2 and Local Interface Address Type is set to 'Offset from beginning of Subnet', local address of 169.254.0.2 is used. Use Nth last address of the allocated subnet as the local interface address, N being the Local Interface Address Offset. For example, if the allocated subnet is 169.254.0.0/30, Local Interface Address Offset is set to 1 and Local Interface Address Type is set to 'Offset from end of Subnet', local address of 169.254.0.2 is used. This case is used for external_connector
85
+ <a id="type-3a6e24"></a>&#x2022; [`local_interface_address_type`](#type-3a6e24) - Optional String Defaults to `LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN`<br>Possible values are `LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN`, `LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_END`, `LOCAL_INTERFACE_ADDRESS_FROM_PREFIX`<br>[Enum: LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_BEGIN|LOCAL_INTERFACE_ADDRESS_OFFSET_FROM_SUBNET_END|LOCAL_INTERFACE_ADDRESS_FROM_PREFIX] Dictates how local interface address is derived from the allocated subnet Use Nth address of the allocated subnet as the local interface address, N being the Local Interface Address Offset. For example, if the allocated subnet is 169.254.0.0/30, Local Interface Address Offset is set to 2 and
86
86
 
87
87
  #### Timeouts
88
88
 
@@ -32,15 +32,15 @@ resource "f5xc_advertise_policy" "example" {
32
32
  }
33
33
 
34
34
  # Resource-specific configuration
35
- # Public IP. Optional. Public VIP to advertise This field i...
35
+ # Optional. Public VIP to advertise This field is mutually ...
36
36
  public_ip {
37
37
  # Configure public_ip settings
38
38
  }
39
- # Downstream TLS Parameters. TLS configuration for downstre...
39
+ # TLS configuration for downstream connections.
40
40
  tls_parameters {
41
41
  # Configure tls_parameters settings
42
42
  }
43
- # Enable this option
43
+ # Can be used for messages where no values are needed.
44
44
  client_certificate_optional {
45
45
  # Configure client_certificate_optional settings
46
46
  }
@@ -66,23 +66,23 @@ resource "f5xc_advertise_policy" "example" {
66
66
 
67
67
  ### Spec Argument Reference
68
68
 
69
- <a id="address"></a>&#x2022; [`address`](#address) - Optional String<br>VIP. Optional. VIP to advertise. This VIP can be either V4/V6 address You can not specify this if where contains a site or virtual site of type REGIONAL_EDGE or public network If not specified and 'where' is specified with site or virtual site option, inside_vip or outside_vip specified in the site object will be used based on the network type. If inside_vip/outside_vip is not configured in the site object, system use interface IP in the respected networks
69
+ <a id="address"></a>&#x2022; [`address`](#address) - Optional String<br>Optional. VIP to advertise. This VIP can be either V4/V6 address You can not specify this if where contains a site or virtual site of type REGIONAL_EDGE or public network If not specified and 'where' is specified with site or virtual site option, inside_vip or outside_vip specified in the site
70
70
 
71
71
  -> **One of the following:**
72
- &#x2022; <a id="port"></a>[`port`](#port) - Optional Number<br>TCP/UDP Port. Port to advertise
73
- <br><br>&#x2022; <a id="port-ranges"></a>[`port_ranges`](#port-ranges) - Optional String<br>Port Ranges. A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by '-'
72
+ &#x2022; <a id="port"></a>[`port`](#port) - Optional Number<br>Port to advertise
73
+ <br><br>&#x2022; <a id="port-ranges"></a>[`port_ranges`](#port-ranges) - Optional String<br>A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by '-'
74
74
 
75
75
  <a id="protocol"></a>&#x2022; [`protocol`](#protocol) - Optional String<br>Protocol. Protocol to advertise
76
76
 
77
- <a id="public-ip"></a>&#x2022; [`public_ip`](#public-ip) - Optional Block<br>Public IP. Optional. Public VIP to advertise This field is mutually exclusive with where and address fields<br>See [Public IP](#public-ip) below for details.
77
+ <a id="public-ip"></a>&#x2022; [`public_ip`](#public-ip) - Optional Block<br>Optional. Public VIP to advertise This field is mutually exclusive with where and address fields<br>See [Public IP](#public-ip) below for details.
78
78
 
79
- <a id="skip-xff-append"></a>&#x2022; [`skip_xff_append`](#skip-xff-append) - Optional Bool<br>Disable X-Forwarded-For Header. If set, the loadbalancer will not append the remote address to the x-forwarded-for HTTP header
79
+ <a id="skip-xff-append"></a>&#x2022; [`skip_xff_append`](#skip-xff-append) - Optional Bool<br>If set, the loadbalancer will not append the remote address to the x-forwarded-for HTTP header
80
80
 
81
81
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
82
82
 
83
- <a id="tls-parameters"></a>&#x2022; [`tls_parameters`](#tls-parameters) - Optional Block<br>Downstream TLS Parameters. TLS configuration for downstream connections<br>See [TLS Parameters](#tls-parameters) below for details.
83
+ <a id="tls-parameters"></a>&#x2022; [`tls_parameters`](#tls-parameters) - Optional Block<br>TLS configuration for downstream connections<br>See [TLS Parameters](#tls-parameters) below for details.
84
84
 
85
- <a id="where"></a>&#x2022; [`where`](#where) - Optional Block<br>Network or Site Reference. NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine virtual network using following rules \* Direct reference to virtual_network object \* Site local network when refering to site object \* All site local networks for sites selected by refering to virtual_site object<br>See [Where](#where) below for details.
85
+ <a id="where"></a>&#x2022; [`where`](#where) - Optional Block<br>NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine virtual network using following rules \* Direct reference to virtual_network object \* Site local network when refering to site object \* All site local<br>See [Where](#where) below for details.
86
86
 
87
87
  ### Attributes Reference
88
88
 
@@ -96,15 +96,15 @@ In addition to all arguments above, the following attributes are exported:
96
96
 
97
97
  A [`public_ip`](#public-ip) block supports the following:
98
98
 
99
- <a id="public-ip-kind"></a>&#x2022; [`kind`](#public-ip-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
99
+ <a id="public-ip-kind"></a>&#x2022; [`kind`](#public-ip-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
100
100
 
101
- <a id="public-ip-name"></a>&#x2022; [`name`](#public-ip-name) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
101
+ <a id="public-ip-name"></a>&#x2022; [`name`](#public-ip-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
102
102
 
103
- <a id="public-ip-namespace"></a>&#x2022; [`namespace`](#public-ip-namespace) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
103
+ <a id="public-ip-namespace"></a>&#x2022; [`namespace`](#public-ip-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
104
104
 
105
- <a id="public-ip-tenant"></a>&#x2022; [`tenant`](#public-ip-tenant) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
105
+ <a id="public-ip-tenant"></a>&#x2022; [`tenant`](#public-ip-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
106
106
 
107
- <a id="public-ip-uid"></a>&#x2022; [`uid`](#public-ip-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
107
+ <a id="public-ip-uid"></a>&#x2022; [`uid`](#public-ip-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
108
108
 
109
109
  #### Timeouts
110
110
 
@@ -122,45 +122,45 @@ A [`timeouts`](#timeouts) block supports the following:
122
122
 
123
123
  A [`tls_parameters`](#tls-parameters) block supports the following:
124
124
 
125
- <a id="optional-56d793"></a>&#x2022; [`client_certificate_optional`](#optional-56d793) - Optional Block<br>Enable this option
125
+ <a id="optional-56d793"></a>&#x2022; [`client_certificate_optional`](#optional-56d793) - Optional Block<br>Can be used for messages where no values are needed
126
126
 
127
- <a id="required-544cf5"></a>&#x2022; [`client_certificate_required`](#required-544cf5) - Optional Block<br>Enable this option
127
+ <a id="required-544cf5"></a>&#x2022; [`client_certificate_required`](#required-544cf5) - Optional Block<br>Can be used for messages where no values are needed
128
128
 
129
- <a id="tls-parameters-common-params"></a>&#x2022; [`common_params`](#tls-parameters-common-params) - Optional Block<br>TLS Parameters. Information of different aspects for TLS authentication related to ciphers, certificates and trust store<br>See [Common Params](#tls-parameters-common-params) below.
129
+ <a id="tls-parameters-common-params"></a>&#x2022; [`common_params`](#tls-parameters-common-params) - Optional Block<br>Information of different aspects for TLS authentication related to ciphers, certificates and trust store<br>See [Common Params](#tls-parameters-common-params) below.
130
130
 
131
- <a id="tls-parameters-no-client-certificate"></a>&#x2022; [`no_client_certificate`](#tls-parameters-no-client-certificate) - Optional Block<br>Enable this option
131
+ <a id="tls-parameters-no-client-certificate"></a>&#x2022; [`no_client_certificate`](#tls-parameters-no-client-certificate) - Optional Block<br>Can be used for messages where no values are needed
132
132
 
133
- <a id="tls-parameters-xfcc-header-elements"></a>&#x2022; [`xfcc_header_elements`](#tls-parameters-xfcc-header-elements) - Optional List Defaults to `XFCC_NONE`<br>Possible values are `XFCC_NONE`, `XFCC_CERT`, `XFCC_CHAIN`, `XFCC_SUBJECT`, `XFCC_URI`, `XFCC_DNS`<br>[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] XFCC Header. X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections. If none are defined, the header will not be added
133
+ <a id="tls-parameters-xfcc-header-elements"></a>&#x2022; [`xfcc_header_elements`](#tls-parameters-xfcc-header-elements) - Optional List Defaults to `XFCC_NONE`<br>Possible values are `XFCC_NONE`, `XFCC_CERT`, `XFCC_CHAIN`, `XFCC_SUBJECT`, `XFCC_URI`, `XFCC_DNS`<br>[Enum: XFCC_NONE|XFCC_CERT|XFCC_CHAIN|XFCC_SUBJECT|XFCC_URI|XFCC_DNS] X-Forwarded-Client-Cert header elements to be set in an mTLS enabled connections. If none are defined, the header will not be added
134
134
 
135
135
  #### TLS Parameters Common Params
136
136
 
137
137
  A [`common_params`](#tls-parameters-common-params) block (within [`tls_parameters`](#tls-parameters)) supports the following:
138
138
 
139
- <a id="suites-f69d86"></a>&#x2022; [`cipher_suites`](#suites-f69d86) - Optional List<br>Cipher Suites. The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_256_GCM_SHA384 If not specified, the default list: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 will be used
139
+ <a id="suites-f69d86"></a>&#x2022; [`cipher_suites`](#suites-f69d86) - Optional List<br>The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
140
140
 
141
- <a id="version-e7c6f2"></a>&#x2022; [`maximum_protocol_version`](#version-e7c6f2) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
141
+ <a id="version-e7c6f2"></a>&#x2022; [`maximum_protocol_version`](#version-e7c6f2) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
142
142
 
143
- <a id="version-7d1460"></a>&#x2022; [`minimum_protocol_version`](#version-7d1460) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
143
+ <a id="version-7d1460"></a>&#x2022; [`minimum_protocol_version`](#version-7d1460) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
144
144
 
145
145
  <a id="certificates-c9caff"></a>&#x2022; [`tls_certificates`](#certificates-c9caff) - Optional Block<br>TLS Certificates. Set of TLS certificates<br>See [TLS Certificates](#certificates-c9caff) below.
146
146
 
147
- <a id="params-6e95a6"></a>&#x2022; [`validation_params`](#params-6e95a6) - Optional Block<br>TLS Certificate Validation Parameters. This includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-6e95a6) below.
147
+ <a id="params-6e95a6"></a>&#x2022; [`validation_params`](#params-6e95a6) - Optional Block<br>Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-6e95a6) below.
148
148
 
149
149
  #### TLS Parameters Common Params TLS Certificates
150
150
 
151
151
  A [`tls_certificates`](#certificates-c9caff) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
152
152
 
153
- <a id="url-323181"></a>&#x2022; [`certificate_url`](#url-323181) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
153
+ <a id="url-323181"></a>&#x2022; [`certificate_url`](#url-323181) - Optional String<br>TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
154
154
 
155
- <a id="algorithms-eb62be"></a>&#x2022; [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-eb62be) below.
155
+ <a id="algorithms-eb62be"></a>&#x2022; [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-eb62be) below.
156
156
 
157
157
  <a id="spec-5af02c"></a>&#x2022; [`description_spec`](#spec-5af02c) - Optional String<br>Description. Description for the certificate
158
158
 
159
- <a id="stapling-c091fa"></a>&#x2022; [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>Enable this option
159
+ <a id="stapling-c091fa"></a>&#x2022; [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>Can be used for messages where no values are needed
160
160
 
161
- <a id="key-da7979"></a>&#x2022; [`private_key`](#key-da7979) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-da7979) below.
161
+ <a id="key-da7979"></a>&#x2022; [`private_key`](#key-da7979) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-da7979) below.
162
162
 
163
- <a id="defaults-f58bc7"></a>&#x2022; [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>Enable this option
163
+ <a id="defaults-f58bc7"></a>&#x2022; [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>Can be used for messages where no values are needed
164
164
 
165
165
  #### TLS Parameters Common Params TLS Certificates Custom Hash Algorithms
166
166
 
@@ -182,13 +182,13 @@ A [`tls_certificates`](#certificates-c9caff) block (within [`tls_parameters.comm
182
182
 
183
183
  A [`validation_params`](#params-6e95a6) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
184
184
 
185
- <a id="verification-30d13d"></a>&#x2022; [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>Skip verification of hostname. When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
185
+ <a id="verification-30d13d"></a>&#x2022; [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
186
186
 
187
187
  <a id="trusted-ca-39c22f"></a>&#x2022; [`trusted_ca`](#trusted-ca-39c22f) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-39c22f) below.
188
188
 
189
- <a id="url-910417"></a>&#x2022; [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate (legacy). Inline Root CA Certificate
189
+ <a id="url-910417"></a>&#x2022; [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
190
190
 
191
- <a id="names-1c97ed"></a>&#x2022; [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>List of SANs for matching. List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate
191
+ <a id="names-1c97ed"></a>&#x2022; [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate
192
192
 
193
193
  #### TLS Parameters Common Params Validation Params Trusted CA
194
194
 
@@ -202,9 +202,9 @@ A [`validation_params`](#params-6e95a6) block (within [`tls_parameters.common_pa
202
202
 
203
203
  A [`where`](#where) block supports the following:
204
204
 
205
- <a id="where-site"></a>&#x2022; [`site`](#where-site) - Optional Block<br>Site Reference. This specifies a direct reference to a site configuration object<br>See [Site](#where-site) below.
205
+ <a id="where-site"></a>&#x2022; [`site`](#where-site) - Optional Block<br>Specifies a direct reference to a site configuration object<br>See [Site](#where-site) below.
206
206
 
207
- <a id="where-virtual-network"></a>&#x2022; [`virtual_network`](#where-virtual-network) - Optional Block<br>Network Reference. This specifies a direct reference to a network configuration object<br>See [Virtual Network](#where-virtual-network) below.
207
+ <a id="where-virtual-network"></a>&#x2022; [`virtual_network`](#where-virtual-network) - Optional Block<br>Specifies a direct reference to a network configuration object<br>See [Virtual Network](#where-virtual-network) below.
208
208
 
209
209
  <a id="where-virtual-site"></a>&#x2022; [`virtual_site`](#where-virtual-site) - Optional Block<br>Virtual Site. A reference to virtual_site object<br>See [Virtual Site](#where-virtual-site) below.
210
210
 
@@ -212,11 +212,11 @@ A [`where`](#where) block supports the following:
212
212
 
213
213
  A [`site`](#where-site) block (within [`where`](#where)) supports the following:
214
214
 
215
- <a id="where-site-disable-internet-vip"></a>&#x2022; [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>Enable this option
215
+ <a id="where-site-disable-internet-vip"></a>&#x2022; [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>Can be used for messages where no values are needed
216
216
 
217
- <a id="where-site-enable-internet-vip"></a>&#x2022; [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>Enable this option
217
+ <a id="where-site-enable-internet-vip"></a>&#x2022; [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>Can be used for messages where no values are needed
218
218
 
219
- <a id="where-site-network-type"></a>&#x2022; [`network_type`](#where-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `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`<br>[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT] Virtual Network Type. Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created automatically and present on all sites Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site. It is a secure network and is not connected to public network. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created during provisioning of site User defined per-site virtual network. Scope of this virtual network is limited to the site. This is not yet supported Virtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on RE sites only It is an internally created by the system. They must not be created by user Virtual Neworks with global scope across different sites in F5XC domain. An example global virtual-network called 'AIN Network' is created for every tenant. For F5 Distributed Cloud fabric Constraints: It is currently only supported as internally created by the system. VK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant Constraints: It is an internally created by the system. Must not be created by user VER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy Constraints: It is an internally created by the system. Must not be created by user Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both VIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE Constraints: This network type is only meaningful in an advertise policy When virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for an endpoint, VER will try to determine the network based on the provided IP address Constraints: This network type is only meaningful in an endpoint VoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks This network is created by opening a support ticket This network is per site srv6 network VER IP Fabric network for the site. This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network Constraints: It is an internally created by the system. Must not be created by user Network internally created for a segment Constraints: It is an internally created by the system. Must not be created by user
219
+ <a id="where-site-network-type"></a>&#x2022; [`network_type`](#where-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `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`<br>[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] Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to
220
220
 
221
221
  <a id="where-site-ref"></a>&#x2022; [`ref`](#where-site-ref) - Optional Block<br>Reference. A site direct reference<br>See [Ref](#where-site-ref) below.
222
222
 
@@ -224,61 +224,61 @@ A [`site`](#where-site) block (within [`where`](#where)) supports the following:
224
224
 
225
225
  A [`ref`](#where-site-ref) block (within [`where.site`](#where-site)) supports the following:
226
226
 
227
- <a id="where-site-ref-kind"></a>&#x2022; [`kind`](#where-site-ref-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
227
+ <a id="where-site-ref-kind"></a>&#x2022; [`kind`](#where-site-ref-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
228
228
 
229
- <a id="where-site-ref-name"></a>&#x2022; [`name`](#where-site-ref-name) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
229
+ <a id="where-site-ref-name"></a>&#x2022; [`name`](#where-site-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
230
230
 
231
- <a id="where-site-ref-namespace"></a>&#x2022; [`namespace`](#where-site-ref-namespace) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
231
+ <a id="where-site-ref-namespace"></a>&#x2022; [`namespace`](#where-site-ref-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
232
232
 
233
- <a id="where-site-ref-tenant"></a>&#x2022; [`tenant`](#where-site-ref-tenant) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
233
+ <a id="where-site-ref-tenant"></a>&#x2022; [`tenant`](#where-site-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
234
234
 
235
- <a id="where-site-ref-uid"></a>&#x2022; [`uid`](#where-site-ref-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
235
+ <a id="where-site-ref-uid"></a>&#x2022; [`uid`](#where-site-ref-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
236
236
 
237
237
  #### Where Virtual Network
238
238
 
239
239
  A [`virtual_network`](#where-virtual-network) block (within [`where`](#where)) supports the following:
240
240
 
241
- <a id="where-virtual-network-ref"></a>&#x2022; [`ref`](#where-virtual-network-ref) - Optional Block<br>Reference. A virtual network direct reference<br>See [Ref](#where-virtual-network-ref) below.
241
+ <a id="where-virtual-network-ref"></a>&#x2022; [`ref`](#where-virtual-network-ref) - Optional Block<br>Virtual network direct reference<br>See [Ref](#where-virtual-network-ref) below.
242
242
 
243
243
  #### Where Virtual Network Ref
244
244
 
245
245
  A [`ref`](#where-virtual-network-ref) block (within [`where.virtual_network`](#where-virtual-network)) supports the following:
246
246
 
247
- <a id="where-virtual-network-ref-kind"></a>&#x2022; [`kind`](#where-virtual-network-ref-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
247
+ <a id="where-virtual-network-ref-kind"></a>&#x2022; [`kind`](#where-virtual-network-ref-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
248
248
 
249
- <a id="where-virtual-network-ref-name"></a>&#x2022; [`name`](#where-virtual-network-ref-name) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
249
+ <a id="where-virtual-network-ref-name"></a>&#x2022; [`name`](#where-virtual-network-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
250
250
 
251
- <a id="where-virtual-network-ref-namespace"></a>&#x2022; [`namespace`](#where-virtual-network-ref-namespace) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
251
+ <a id="where-virtual-network-ref-namespace"></a>&#x2022; [`namespace`](#where-virtual-network-ref-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
252
252
 
253
- <a id="where-virtual-network-ref-tenant"></a>&#x2022; [`tenant`](#where-virtual-network-ref-tenant) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
253
+ <a id="where-virtual-network-ref-tenant"></a>&#x2022; [`tenant`](#where-virtual-network-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
254
254
 
255
- <a id="where-virtual-network-ref-uid"></a>&#x2022; [`uid`](#where-virtual-network-ref-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
255
+ <a id="where-virtual-network-ref-uid"></a>&#x2022; [`uid`](#where-virtual-network-ref-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
256
256
 
257
257
  #### Where Virtual Site
258
258
 
259
259
  A [`virtual_site`](#where-virtual-site) block (within [`where`](#where)) supports the following:
260
260
 
261
- <a id="where-virtual-site-disable-internet-vip"></a>&#x2022; [`disable_internet_vip`](#where-virtual-site-disable-internet-vip) - Optional Block<br>Enable this option
261
+ <a id="where-virtual-site-disable-internet-vip"></a>&#x2022; [`disable_internet_vip`](#where-virtual-site-disable-internet-vip) - Optional Block<br>Can be used for messages where no values are needed
262
262
 
263
- <a id="where-virtual-site-enable-internet-vip"></a>&#x2022; [`enable_internet_vip`](#where-virtual-site-enable-internet-vip) - Optional Block<br>Enable this option
263
+ <a id="where-virtual-site-enable-internet-vip"></a>&#x2022; [`enable_internet_vip`](#where-virtual-site-enable-internet-vip) - Optional Block<br>Can be used for messages where no values are needed
264
264
 
265
- <a id="where-virtual-site-network-type"></a>&#x2022; [`network_type`](#where-virtual-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `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`<br>[Enum: VIRTUAL_NETWORK_SITE_LOCAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE|VIRTUAL_NETWORK_PER_SITE|VIRTUAL_NETWORK_PUBLIC|VIRTUAL_NETWORK_GLOBAL|VIRTUAL_NETWORK_SITE_SERVICE|VIRTUAL_NETWORK_VER_INTERNAL|VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE|VIRTUAL_NETWORK_IP_AUTO|VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK|VIRTUAL_NETWORK_SRV6_NETWORK|VIRTUAL_NETWORK_IP_FABRIC|VIRTUAL_NETWORK_SEGMENT] Virtual Network Type. Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created automatically and present on all sites Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site. It is a secure network and is not connected to public network. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on CE sites. This network is created during provisioning of site User defined per-site virtual network. Scope of this virtual network is limited to the site. This is not yet supported Virtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet. Virtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected. Constraints: There can be atmost one virtual network of this type in a given site. This network type is supported on RE sites only It is an internally created by the system. They must not be created by user Virtual Neworks with global scope across different sites in F5XC domain. An example global virtual-network called 'AIN Network' is created for every tenant. For F5 Distributed Cloud fabric Constraints: It is currently only supported as internally created by the system. VK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant Constraints: It is an internally created by the system. Must not be created by user VER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy Constraints: It is an internally created by the system. Must not be created by user Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both VIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE Constraints: This network type is only meaningful in an advertise policy When virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for an endpoint, VER will try to determine the network based on the provided IP address Constraints: This network type is only meaningful in an endpoint VoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks This network is created by opening a support ticket This network is per site srv6 network VER IP Fabric network for the site. This Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or for endpoint in IP Fabric network Constraints: It is an internally created by the system. Must not be created by user Network internally created for a segment Constraints: It is an internally created by the system. Must not be created by user
265
+ <a id="where-virtual-site-network-type"></a>&#x2022; [`network_type`](#where-virtual-site-network-type) - Optional String Defaults to `VIRTUAL_NETWORK_SITE_LOCAL`<br>Possible values are `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`<br>[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] Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to
266
266
 
267
- <a id="where-virtual-site-ref"></a>&#x2022; [`ref`](#where-virtual-site-ref) - Optional Block<br>Reference. A virtual_site direct reference<br>See [Ref](#where-virtual-site-ref) below.
267
+ <a id="where-virtual-site-ref"></a>&#x2022; [`ref`](#where-virtual-site-ref) - Optional Block<br>Virtual_site direct reference<br>See [Ref](#where-virtual-site-ref) below.
268
268
 
269
269
  #### Where Virtual Site Ref
270
270
 
271
271
  A [`ref`](#where-virtual-site-ref) block (within [`where.virtual_site`](#where-virtual-site)) supports the following:
272
272
 
273
- <a id="where-virtual-site-ref-kind"></a>&#x2022; [`kind`](#where-virtual-site-ref-kind) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
273
+ <a id="where-virtual-site-ref-kind"></a>&#x2022; [`kind`](#where-virtual-site-ref-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
274
274
 
275
- <a id="where-virtual-site-ref-name"></a>&#x2022; [`name`](#where-virtual-site-ref-name) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
275
+ <a id="where-virtual-site-ref-name"></a>&#x2022; [`name`](#where-virtual-site-ref-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
276
276
 
277
- <a id="where-virtual-site-ref-namespace"></a>&#x2022; [`namespace`](#where-virtual-site-ref-namespace) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
277
+ <a id="where-virtual-site-ref-namespace"></a>&#x2022; [`namespace`](#where-virtual-site-ref-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
278
278
 
279
- <a id="where-virtual-site-ref-tenant"></a>&#x2022; [`tenant`](#where-virtual-site-ref-tenant) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
279
+ <a id="where-virtual-site-ref-tenant"></a>&#x2022; [`tenant`](#where-virtual-site-ref-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
280
280
 
281
- <a id="where-virtual-site-ref-uid"></a>&#x2022; [`uid`](#where-virtual-site-ref-uid) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
281
+ <a id="where-virtual-site-ref-uid"></a>&#x2022; [`uid`](#where-virtual-site-ref-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
282
282
 
283
283
  ---
284
284