@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.
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -32,7 +32,7 @@ resource "f5xc_api_crawler" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
# API Crawler
|
|
35
|
+
# API Crawler Configuration .
|
|
36
36
|
domains {
|
|
37
37
|
# Configure domains settings
|
|
38
38
|
}
|
|
@@ -40,7 +40,7 @@ resource "f5xc_api_crawler" "example" {
|
|
|
40
40
|
simple_login {
|
|
41
41
|
# Configure simple_login settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# SecretType is used in an object to indicate a sensitive/c...
|
|
44
44
|
password {
|
|
45
45
|
# Configure password settings
|
|
46
46
|
}
|
|
@@ -66,7 +66,7 @@ resource "f5xc_api_crawler" "example" {
|
|
|
66
66
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
|
-
<a id="domains"></a>• [`domains`](#domains) - Optional Block<br>API Crawler
|
|
69
|
+
<a id="domains"></a>• [`domains`](#domains) - Optional Block<br>API Crawler Configuration<br>See [Domains](#domains) below for details.
|
|
70
70
|
|
|
71
71
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
72
72
|
|
|
@@ -82,7 +82,7 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
82
82
|
|
|
83
83
|
A [`domains`](#domains) block supports the following:
|
|
84
84
|
|
|
85
|
-
<a id="domains-domain"></a>• [`domain`](#domains-domain) - Optional String<br>
|
|
85
|
+
<a id="domains-domain"></a>• [`domain`](#domains-domain) - Optional String<br>Select the domain to execute API Crawling with given credentials
|
|
86
86
|
|
|
87
87
|
<a id="domains-simple-login"></a>• [`simple_login`](#domains-simple-login) - Optional Block<br>Simple Login<br>See [Simple Login](#domains-simple-login) below.
|
|
88
88
|
|
|
@@ -90,35 +90,35 @@ A [`domains`](#domains) block supports the following:
|
|
|
90
90
|
|
|
91
91
|
A [`simple_login`](#domains-simple-login) block (within [`domains`](#domains)) supports the following:
|
|
92
92
|
|
|
93
|
-
<a id="domains-simple-login-password"></a>• [`password`](#domains-simple-login-password) - Optional Block<br>
|
|
93
|
+
<a id="domains-simple-login-password"></a>• [`password`](#domains-simple-login-password) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#domains-simple-login-password) below.
|
|
94
94
|
|
|
95
|
-
<a id="domains-simple-login-user"></a>• [`user`](#domains-simple-login-user) - Optional String<br>
|
|
95
|
+
<a id="domains-simple-login-user"></a>• [`user`](#domains-simple-login-user) - Optional String<br>Enter the username to assign credentials for the selected domain to crawl
|
|
96
96
|
|
|
97
97
|
#### Domains Simple Login Password
|
|
98
98
|
|
|
99
99
|
A [`password`](#domains-simple-login-password) block (within [`domains.simple_login`](#domains-simple-login)) supports the following:
|
|
100
100
|
|
|
101
|
-
<a id="info-e14daf"></a>• [`blindfold_secret_info`](#info-e14daf) - Optional Block<br>
|
|
101
|
+
<a id="info-e14daf"></a>• [`blindfold_secret_info`](#info-e14daf) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-e14daf) below.
|
|
102
102
|
|
|
103
|
-
<a id="info-ec3463"></a>• [`clear_secret_info`](#info-ec3463) - Optional Block<br>
|
|
103
|
+
<a id="info-ec3463"></a>• [`clear_secret_info`](#info-ec3463) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-ec3463) below.
|
|
104
104
|
|
|
105
105
|
#### Domains Simple Login Password Blindfold Secret Info
|
|
106
106
|
|
|
107
107
|
A [`blindfold_secret_info`](#info-e14daf) block (within [`domains.simple_login.password`](#domains-simple-login-password)) supports the following:
|
|
108
108
|
|
|
109
|
-
<a id="provider-bdecf7"></a>• [`decryption_provider`](#provider-bdecf7) - Optional String<br>
|
|
109
|
+
<a id="provider-bdecf7"></a>• [`decryption_provider`](#provider-bdecf7) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
110
110
|
|
|
111
|
-
<a id="location-cdab6e"></a>• [`location`](#location-cdab6e) - Optional String<br>Location
|
|
111
|
+
<a id="location-cdab6e"></a>• [`location`](#location-cdab6e) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
112
112
|
|
|
113
|
-
<a id="provider-8d2611"></a>• [`store_provider`](#provider-8d2611) - Optional String<br>
|
|
113
|
+
<a id="provider-8d2611"></a>• [`store_provider`](#provider-8d2611) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
114
114
|
|
|
115
115
|
#### Domains Simple Login Password Clear Secret Info
|
|
116
116
|
|
|
117
117
|
A [`clear_secret_info`](#info-ec3463) block (within [`domains.simple_login.password`](#domains-simple-login-password)) supports the following:
|
|
118
118
|
|
|
119
|
-
<a id="ref-32ac85"></a>• [`provider_ref`](#ref-32ac85) - Optional String<br>
|
|
119
|
+
<a id="ref-32ac85"></a>• [`provider_ref`](#ref-32ac85) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
120
120
|
|
|
121
|
-
<a id="url-e5dfac"></a>• [`url`](#url-e5dfac) - Optional String<br>URL
|
|
121
|
+
<a id="url-e5dfac"></a>• [`url`](#url-e5dfac) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
122
122
|
|
|
123
123
|
#### Timeouts
|
|
124
124
|
|
|
@@ -59,17 +59,17 @@ resource "f5xc_api_definition" "example" {
|
|
|
59
59
|
|
|
60
60
|
### Spec Argument Reference
|
|
61
61
|
|
|
62
|
-
<a id="api-inventory-exclusion-list"></a>• [`api_inventory_exclusion_list`](#api-inventory-exclusion-list) - Optional Block<br>
|
|
62
|
+
<a id="api-inventory-exclusion-list"></a>• [`api_inventory_exclusion_list`](#api-inventory-exclusion-list) - Optional Block<br>List of API Endpoints excluded from the API Inventory<br>See [API Inventory Exclusion List](#api-inventory-exclusion-list) below for details.
|
|
63
63
|
|
|
64
|
-
<a id="api-inventory-inclusion-list"></a>• [`api_inventory_inclusion_list`](#api-inventory-inclusion-list) - Optional Block<br>
|
|
64
|
+
<a id="api-inventory-inclusion-list"></a>• [`api_inventory_inclusion_list`](#api-inventory-inclusion-list) - Optional Block<br>List of API Endpoints included in the API Inventory. Typically, discovered API endpoints are added to the API Inventory using this list<br>See [API Inventory Inclusion List](#api-inventory-inclusion-list) below for details.
|
|
65
65
|
|
|
66
66
|
-> **One of the following:**
|
|
67
|
-
• <a id="mixed-schema-origin"></a>[`mixed_schema_origin`](#mixed-schema-origin) - Optional Block<br>
|
|
68
|
-
<br><br>• <a id="strict-schema-origin"></a>[`strict_schema_origin`](#strict-schema-origin) - Optional Block<br>
|
|
67
|
+
• <a id="mixed-schema-origin"></a>[`mixed_schema_origin`](#mixed-schema-origin) - Optional Block<br>Can be used for messages where no values are needed
|
|
68
|
+
<br><br>• <a id="strict-schema-origin"></a>[`strict_schema_origin`](#strict-schema-origin) - Optional Block<br>Can be used for messages where no values are needed
|
|
69
69
|
|
|
70
70
|
<a id="non-api-endpoints"></a>• [`non_api_endpoints`](#non-api-endpoints) - Optional Block<br>API Discovery Exclusion List. List of Non-API Endpoints<br>See [Non API Endpoints](#non-api-endpoints) below for details.
|
|
71
71
|
|
|
72
|
-
<a id="swagger-specs"></a>• [`swagger_specs`](#swagger-specs) - Optional List<br>
|
|
72
|
+
<a id="swagger-specs"></a>• [`swagger_specs`](#swagger-specs) - Optional List<br>Define your application API by single or multiple OpenAPI files. 1. Upload your OpenAPI files via Web App & API Protection-> Files-> Swagger Files. 2. Select from the list of uploaded files
|
|
73
73
|
|
|
74
74
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
75
75
|
|
|
@@ -85,25 +85,25 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
85
85
|
|
|
86
86
|
An [`api_inventory_exclusion_list`](#api-inventory-exclusion-list) block supports the following:
|
|
87
87
|
|
|
88
|
-
<a id="api-inventory-exclusion-list-method"></a>• [`method`](#api-inventory-exclusion-list-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
88
|
+
<a id="api-inventory-exclusion-list-method"></a>• [`method`](#api-inventory-exclusion-list-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Specifies the HTTP method used to access a resource. Any HTTP Method
|
|
89
89
|
|
|
90
|
-
<a id="api-inventory-exclusion-list-path"></a>• [`path`](#api-inventory-exclusion-list-path) - Optional String<br>
|
|
90
|
+
<a id="api-inventory-exclusion-list-path"></a>• [`path`](#api-inventory-exclusion-list-path) - Optional String<br>Endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification
|
|
91
91
|
|
|
92
92
|
#### API Inventory Inclusion List
|
|
93
93
|
|
|
94
94
|
An [`api_inventory_inclusion_list`](#api-inventory-inclusion-list) block supports the following:
|
|
95
95
|
|
|
96
|
-
<a id="api-inventory-inclusion-list-method"></a>• [`method`](#api-inventory-inclusion-list-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
96
|
+
<a id="api-inventory-inclusion-list-method"></a>• [`method`](#api-inventory-inclusion-list-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Specifies the HTTP method used to access a resource. Any HTTP Method
|
|
97
97
|
|
|
98
|
-
<a id="api-inventory-inclusion-list-path"></a>• [`path`](#api-inventory-inclusion-list-path) - Optional String<br>
|
|
98
|
+
<a id="api-inventory-inclusion-list-path"></a>• [`path`](#api-inventory-inclusion-list-path) - Optional String<br>Endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification
|
|
99
99
|
|
|
100
100
|
#### Non API Endpoints
|
|
101
101
|
|
|
102
102
|
A [`non_api_endpoints`](#non-api-endpoints) block supports the following:
|
|
103
103
|
|
|
104
|
-
<a id="non-api-endpoints-method"></a>• [`method`](#non-api-endpoints-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
104
|
+
<a id="non-api-endpoints-method"></a>• [`method`](#non-api-endpoints-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Specifies the HTTP method used to access a resource. Any HTTP Method
|
|
105
105
|
|
|
106
|
-
<a id="non-api-endpoints-path"></a>• [`path`](#non-api-endpoints-path) - Optional String<br>
|
|
106
|
+
<a id="non-api-endpoints-path"></a>• [`path`](#non-api-endpoints-path) - Optional String<br>Endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification
|
|
107
107
|
|
|
108
108
|
#### Timeouts
|
|
109
109
|
|
|
@@ -32,7 +32,7 @@ resource "f5xc_api_discovery" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# Select your custom authentication types to be detected in...
|
|
36
36
|
custom_auth_types {
|
|
37
37
|
# Configure custom_auth_types settings
|
|
38
38
|
}
|
|
@@ -58,7 +58,7 @@ resource "f5xc_api_discovery" "example" {
|
|
|
58
58
|
|
|
59
59
|
### Spec Argument Reference
|
|
60
60
|
|
|
61
|
-
<a id="custom-auth-types"></a>• [`custom_auth_types`](#custom-auth-types) - Optional Block<br>
|
|
61
|
+
<a id="custom-auth-types"></a>• [`custom_auth_types`](#custom-auth-types) - Optional Block<br>Select your custom authentication types to be detected in the API discovery<br>See [Custom Auth Types](#custom-auth-types) below for details.
|
|
62
62
|
|
|
63
63
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
64
64
|
|
|
@@ -74,9 +74,9 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
74
74
|
|
|
75
75
|
A [`custom_auth_types`](#custom-auth-types) block supports the following:
|
|
76
76
|
|
|
77
|
-
<a id="custom-auth-types-parameter-name"></a>• [`parameter_name`](#custom-auth-types-parameter-name) - Optional String<br>
|
|
77
|
+
<a id="custom-auth-types-parameter-name"></a>• [`parameter_name`](#custom-auth-types-parameter-name) - Optional String<br>The authentication parameter name
|
|
78
78
|
|
|
79
|
-
<a id="custom-auth-types-parameter-type"></a>• [`parameter_type`](#custom-auth-types-parameter-type) - Optional String Defaults to `QUERY_PARAMETER`<br>Possible values are `QUERY_PARAMETER`, `HEADER`, `COOKIE`<br>[Enum: QUERY_PARAMETER|HEADER|COOKIE]
|
|
79
|
+
<a id="custom-auth-types-parameter-type"></a>• [`parameter_type`](#custom-auth-types-parameter-type) - Optional String Defaults to `QUERY_PARAMETER`<br>Possible values are `QUERY_PARAMETER`, `HEADER`, `COOKIE`<br>[Enum: QUERY_PARAMETER|HEADER|COOKIE] Enumeration for authentication parameter types
|
|
80
80
|
|
|
81
81
|
#### Timeouts
|
|
82
82
|
|
|
@@ -32,15 +32,15 @@ resource "f5xc_api_testing" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# Add and configure testing domains and credentials .
|
|
36
36
|
domains {
|
|
37
37
|
# Configure domains settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# Add credentials for API testing to use in the selected en...
|
|
40
40
|
credentials {
|
|
41
41
|
# Configure credentials settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# Can be used for messages where no values are needed.
|
|
44
44
|
admin {
|
|
45
45
|
# Configure admin settings
|
|
46
46
|
}
|
|
@@ -66,14 +66,14 @@ resource "f5xc_api_testing" "example" {
|
|
|
66
66
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
|
-
<a id="custom-header-value"></a>• [`custom_header_value`](#custom-header-value) - Optional String<br>
|
|
69
|
+
<a id="custom-header-value"></a>• [`custom_header_value`](#custom-header-value) - Optional String<br>Add x-F5-API-testing-identifier header value to prevent security flags on API testing traffic
|
|
70
70
|
|
|
71
|
-
<a id="domains"></a>• [`domains`](#domains) - Optional Block<br>
|
|
71
|
+
<a id="domains"></a>• [`domains`](#domains) - Optional Block<br>Add and configure testing domains and credentials<br>See [Domains](#domains) below for details.
|
|
72
72
|
|
|
73
73
|
-> **One of the following:**
|
|
74
|
-
• <a id="every-day"></a>[`every_day`](#every-day) - Optional Block<br>
|
|
75
|
-
<br><br>• <a id="every-month"></a>[`every_month`](#every-month) - Optional Block<br>
|
|
76
|
-
<br><br>• <a id="every-week"></a>[`every_week`](#every-week) - Optional Block<br>
|
|
74
|
+
• <a id="every-day"></a>[`every_day`](#every-day) - Optional Block<br>Can be used for messages where no values are needed
|
|
75
|
+
<br><br>• <a id="every-month"></a>[`every_month`](#every-month) - Optional Block<br>Can be used for messages where no values are needed
|
|
76
|
+
<br><br>• <a id="every-week"></a>[`every_week`](#every-week) - Optional Block<br>Can be used for messages where no values are needed
|
|
77
77
|
|
|
78
78
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
79
79
|
|
|
@@ -89,17 +89,17 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
89
89
|
|
|
90
90
|
A [`domains`](#domains) block supports the following:
|
|
91
91
|
|
|
92
|
-
<a id="domains-allow-destructive-methods"></a>• [`allow_destructive_methods`](#domains-allow-destructive-methods) - Optional Bool<br>
|
|
92
|
+
<a id="domains-allow-destructive-methods"></a>• [`allow_destructive_methods`](#domains-allow-destructive-methods) - Optional Bool<br>Enable to allow API test to execute destructive methods. Be cautious as these can alter or DELETE data
|
|
93
93
|
|
|
94
|
-
<a id="domains-credentials"></a>• [`credentials`](#domains-credentials) - Optional Block<br>
|
|
94
|
+
<a id="domains-credentials"></a>• [`credentials`](#domains-credentials) - Optional Block<br>Add credentials for API testing to use in the selected environment<br>See [Credentials](#domains-credentials) below.
|
|
95
95
|
|
|
96
|
-
<a id="domains-domain"></a>• [`domain`](#domains-domain) - Optional String<br>
|
|
96
|
+
<a id="domains-domain"></a>• [`domain`](#domains-domain) - Optional String<br>Add your testing environment domain. Be aware that running tests on a production domain can impact live applications, as API testing cannot distinguish between production and testing environments
|
|
97
97
|
|
|
98
98
|
#### Domains Credentials
|
|
99
99
|
|
|
100
100
|
A [`credentials`](#domains-credentials) block (within [`domains`](#domains)) supports the following:
|
|
101
101
|
|
|
102
|
-
<a id="domains-credentials-admin"></a>• [`admin`](#domains-credentials-admin) - Optional Block<br>
|
|
102
|
+
<a id="domains-credentials-admin"></a>• [`admin`](#domains-credentials-admin) - Optional Block<br>Can be used for messages where no values are needed
|
|
103
103
|
|
|
104
104
|
<a id="domains-credentials-api-key"></a>• [`api_key`](#domains-credentials-api-key) - Optional Block<br>API Key<br>See [API Key](#domains-credentials-api-key) below.
|
|
105
105
|
|
|
@@ -107,11 +107,11 @@ A [`credentials`](#domains-credentials) block (within [`domains`](#domains)) sup
|
|
|
107
107
|
|
|
108
108
|
<a id="domains-credentials-bearer-token"></a>• [`bearer_token`](#domains-credentials-bearer-token) - Optional Block<br>Bearer<br>See [Bearer Token](#domains-credentials-bearer-token) below.
|
|
109
109
|
|
|
110
|
-
<a id="domains-credentials-credential-name"></a>• [`credential_name`](#domains-credentials-credential-name) - Optional String<br>
|
|
110
|
+
<a id="domains-credentials-credential-name"></a>• [`credential_name`](#domains-credentials-credential-name) - Optional String<br>Enter a unique name for the credentials used in API testing
|
|
111
111
|
|
|
112
112
|
<a id="domains-credentials-login-endpoint"></a>• [`login_endpoint`](#domains-credentials-login-endpoint) - Optional Block<br>Login Endpoint<br>See [Login Endpoint](#domains-credentials-login-endpoint) below.
|
|
113
113
|
|
|
114
|
-
<a id="domains-credentials-standard"></a>• [`standard`](#domains-credentials-standard) - Optional Block<br>
|
|
114
|
+
<a id="domains-credentials-standard"></a>• [`standard`](#domains-credentials-standard) - Optional Block<br>Can be used for messages where no values are needed
|
|
115
115
|
|
|
116
116
|
#### Domains Credentials API Key
|
|
117
117
|
|
|
@@ -119,15 +119,15 @@ An [`api_key`](#domains-credentials-api-key) block (within [`domains.credentials
|
|
|
119
119
|
|
|
120
120
|
<a id="domains-credentials-api-key-key"></a>• [`key`](#domains-credentials-api-key-key) - Optional String<br>Key
|
|
121
121
|
|
|
122
|
-
<a id="domains-credentials-api-key-value"></a>• [`value`](#domains-credentials-api-key-value) - Optional Block<br>
|
|
122
|
+
<a id="domains-credentials-api-key-value"></a>• [`value`](#domains-credentials-api-key-value) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Value](#domains-credentials-api-key-value) below.
|
|
123
123
|
|
|
124
124
|
#### Domains Credentials API Key Value
|
|
125
125
|
|
|
126
126
|
A [`value`](#domains-credentials-api-key-value) block (within [`domains.credentials.api_key`](#domains-credentials-api-key)) supports the following:
|
|
127
127
|
|
|
128
|
-
<a id="info-bf6763"></a>• [`blindfold_secret_info`](#info-bf6763) - Optional Block<br>
|
|
128
|
+
<a id="info-bf6763"></a>• [`blindfold_secret_info`](#info-bf6763) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-bf6763) below.
|
|
129
129
|
|
|
130
|
-
<a id="info-b50323"></a>• [`clear_secret_info`](#info-b50323) - Optional Block<br>
|
|
130
|
+
<a id="info-b50323"></a>• [`clear_secret_info`](#info-b50323) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-b50323) below.
|
|
131
131
|
|
|
132
132
|
#### Domains Credentials API Key Value Blindfold Secret Info
|
|
133
133
|
|
|
@@ -141,7 +141,7 @@ A [`value`](#domains-credentials-api-key-value) block (within [`domains.credenti
|
|
|
141
141
|
|
|
142
142
|
A [`basic_auth`](#domains-credentials-basic-auth) block (within [`domains.credentials`](#domains-credentials)) supports the following:
|
|
143
143
|
|
|
144
|
-
<a id="domains-credentials-basic-auth-password"></a>• [`password`](#domains-credentials-basic-auth-password) - Optional Block<br>
|
|
144
|
+
<a id="domains-credentials-basic-auth-password"></a>• [`password`](#domains-credentials-basic-auth-password) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#domains-credentials-basic-auth-password) below.
|
|
145
145
|
|
|
146
146
|
<a id="domains-credentials-basic-auth-user"></a>• [`user`](#domains-credentials-basic-auth-user) - Optional String<br>User
|
|
147
147
|
|
|
@@ -149,9 +149,9 @@ A [`basic_auth`](#domains-credentials-basic-auth) block (within [`domains.creden
|
|
|
149
149
|
|
|
150
150
|
A [`password`](#domains-credentials-basic-auth-password) block (within [`domains.credentials.basic_auth`](#domains-credentials-basic-auth)) supports the following:
|
|
151
151
|
|
|
152
|
-
<a id="info-8ba200"></a>• [`blindfold_secret_info`](#info-8ba200) - Optional Block<br>
|
|
152
|
+
<a id="info-8ba200"></a>• [`blindfold_secret_info`](#info-8ba200) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-8ba200) below.
|
|
153
153
|
|
|
154
|
-
<a id="info-1c1b32"></a>• [`clear_secret_info`](#info-1c1b32) - Optional Block<br>
|
|
154
|
+
<a id="info-1c1b32"></a>• [`clear_secret_info`](#info-1c1b32) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-1c1b32) below.
|
|
155
155
|
|
|
156
156
|
#### Domains Credentials Basic Auth Password Blindfold Secret Info
|
|
157
157
|
|
|
@@ -165,15 +165,15 @@ A [`password`](#domains-credentials-basic-auth-password) block (within [`domains
|
|
|
165
165
|
|
|
166
166
|
A [`bearer_token`](#domains-credentials-bearer-token) block (within [`domains.credentials`](#domains-credentials)) supports the following:
|
|
167
167
|
|
|
168
|
-
<a id="domains-credentials-bearer-token-token"></a>• [`token`](#domains-credentials-bearer-token-token) - Optional Block<br>
|
|
168
|
+
<a id="domains-credentials-bearer-token-token"></a>• [`token`](#domains-credentials-bearer-token-token) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Token](#domains-credentials-bearer-token-token) below.
|
|
169
169
|
|
|
170
170
|
#### Domains Credentials Bearer Token Token
|
|
171
171
|
|
|
172
172
|
A [`token`](#domains-credentials-bearer-token-token) block (within [`domains.credentials.bearer_token`](#domains-credentials-bearer-token)) supports the following:
|
|
173
173
|
|
|
174
|
-
<a id="info-961400"></a>• [`blindfold_secret_info`](#info-961400) - Optional Block<br>
|
|
174
|
+
<a id="info-961400"></a>• [`blindfold_secret_info`](#info-961400) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-961400) below.
|
|
175
175
|
|
|
176
|
-
<a id="info-35b8eb"></a>• [`clear_secret_info`](#info-35b8eb) - Optional Block<br>
|
|
176
|
+
<a id="info-35b8eb"></a>• [`clear_secret_info`](#info-35b8eb) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-35b8eb) below.
|
|
177
177
|
|
|
178
178
|
#### Domains Credentials Bearer Token Token Blindfold Secret Info
|
|
179
179
|
|
|
@@ -187,9 +187,9 @@ A [`token`](#domains-credentials-bearer-token-token) block (within [`domains.cre
|
|
|
187
187
|
|
|
188
188
|
A [`login_endpoint`](#domains-credentials-login-endpoint) block (within [`domains.credentials`](#domains-credentials)) supports the following:
|
|
189
189
|
|
|
190
|
-
<a id="payload-c266f9"></a>• [`json_payload`](#payload-c266f9) - Optional Block<br>
|
|
190
|
+
<a id="payload-c266f9"></a>• [`json_payload`](#payload-c266f9) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [JSON Payload](#payload-c266f9) below.
|
|
191
191
|
|
|
192
|
-
<a id="method-967184"></a>• [`method`](#method-967184) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
192
|
+
<a id="method-967184"></a>• [`method`](#method-967184) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Specifies the HTTP method used to access a resource. Any HTTP Method
|
|
193
193
|
|
|
194
194
|
<a id="domains-credentials-login-endpoint-path"></a>• [`path`](#domains-credentials-login-endpoint-path) - Optional String<br>Path
|
|
195
195
|
|
|
@@ -199,9 +199,9 @@ A [`login_endpoint`](#domains-credentials-login-endpoint) block (within [`domain
|
|
|
199
199
|
|
|
200
200
|
A [`json_payload`](#payload-c266f9) block (within [`domains.credentials.login_endpoint`](#domains-credentials-login-endpoint)) supports the following:
|
|
201
201
|
|
|
202
|
-
<a id="info-a09a15"></a>• [`blindfold_secret_info`](#info-a09a15) - Optional Block<br>
|
|
202
|
+
<a id="info-a09a15"></a>• [`blindfold_secret_info`](#info-a09a15) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-a09a15) below.
|
|
203
203
|
|
|
204
|
-
<a id="info-cd9709"></a>• [`clear_secret_info`](#info-cd9709) - Optional Block<br>
|
|
204
|
+
<a id="info-cd9709"></a>• [`clear_secret_info`](#info-cd9709) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-cd9709) below.
|
|
205
205
|
|
|
206
206
|
#### Domains Credentials Login Endpoint JSON Payload Blindfold Secret Info
|
|
207
207
|
|
|
@@ -36,11 +36,11 @@ resource "f5xc_apm" "example" {
|
|
|
36
36
|
aws_site_type_choice {
|
|
37
37
|
# Configure aws_site_type_choice settings
|
|
38
38
|
}
|
|
39
|
-
# Virtual F5 BIG-IP
|
|
39
|
+
# Virtual F5 BIG-IP configuration for AWS TGW Site using BI...
|
|
40
40
|
apm_aws_site {
|
|
41
41
|
# Configure apm_aws_site settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# SecretType is used in an object to indicate a sensitive/c...
|
|
44
44
|
admin_password {
|
|
45
45
|
# Configure admin_password settings
|
|
46
46
|
}
|
|
@@ -67,8 +67,8 @@ resource "f5xc_apm" "example" {
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
69
|
-> **One of the following:**
|
|
70
|
-
• <a id="aws-site-type-choice"></a>[`aws_site_type_choice`](#aws-site-type-choice) - Optional Block<br>
|
|
71
|
-
<br><br>• <a id="baremetal-site-type-choice"></a>[`baremetal_site_type_choice`](#baremetal-site-type-choice) - Optional Block<br>Virtual BIG-IP
|
|
70
|
+
• <a id="aws-site-type-choice"></a>[`aws_site_type_choice`](#aws-site-type-choice) - Optional Block<br>Virtual F5 BIG-IP APM service to be deployed as external service on AWS Transit Gateway Site<br>See [AWS Site Type Choice](#aws-site-type-choice) below for details.
|
|
71
|
+
<br><br>• <a id="baremetal-site-type-choice"></a>[`baremetal_site_type_choice`](#baremetal-site-type-choice) - Optional Block<br>Virtual BIG-IP specification for App Stack Bare Metal Site<br>See [Baremetal Site Type Choice](#baremetal-site-type-choice) below for details.
|
|
72
72
|
|
|
73
73
|
<a id="https-management"></a>• [`https_management`](#https-management) - Optional Block<br>HTTPS based management. HTTPS based configuration<br>See [HTTPS Management](#https-management) below for details.
|
|
74
74
|
|
|
@@ -86,27 +86,27 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
86
86
|
|
|
87
87
|
An [`aws_site_type_choice`](#aws-site-type-choice) block supports the following:
|
|
88
88
|
|
|
89
|
-
<a id="aws-site-type-choice-apm-aws-site"></a>• [`apm_aws_site`](#aws-site-type-choice-apm-aws-site) - Optional Block<br>Virtual F5 BIG-IP
|
|
89
|
+
<a id="aws-site-type-choice-apm-aws-site"></a>• [`apm_aws_site`](#aws-site-type-choice-apm-aws-site) - Optional Block<br>Virtual F5 BIG-IP configuration for AWS TGW Site using BIG-IP APM service<br>See [APM AWS Site](#aws-site-type-choice-apm-aws-site) below.
|
|
90
90
|
|
|
91
|
-
<a id="aws-site-type-choice-market-place-image"></a>• [`market_place_image`](#aws-site-type-choice-market-place-image) - Optional Block<br>
|
|
91
|
+
<a id="aws-site-type-choice-market-place-image"></a>• [`market_place_image`](#aws-site-type-choice-market-place-image) - Optional Block<br>Select the flavor of BIG-IP AWS Marketplace to launch the instance on AWS TGW Site<br>See [Market Place Image](#aws-site-type-choice-market-place-image) below.
|
|
92
92
|
|
|
93
93
|
#### AWS Site Type Choice APM AWS Site
|
|
94
94
|
|
|
95
95
|
An [`apm_aws_site`](#aws-site-type-choice-apm-aws-site) block (within [`aws_site_type_choice`](#aws-site-type-choice)) supports the following:
|
|
96
96
|
|
|
97
|
-
<a id="password-cf5632"></a>• [`admin_password`](#password-cf5632) - Optional Block<br>
|
|
97
|
+
<a id="password-cf5632"></a>• [`admin_password`](#password-cf5632) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Admin Password](#password-cf5632) below.
|
|
98
98
|
|
|
99
|
-
<a id="username-360b70"></a>• [`admin_username`](#username-360b70) - Optional String<br>Admin Username
|
|
99
|
+
<a id="username-360b70"></a>• [`admin_username`](#username-360b70) - Optional String<br>Admin Username for BIG-IP
|
|
100
100
|
|
|
101
101
|
<a id="site-bbb128"></a>• [`aws_tgw_site`](#site-bbb128) - Optional Block<br>BIG-IP AWS TGW Site. BIG-IP AWS TGW site specification<br>See [AWS TGW Site](#site-bbb128) below.
|
|
102
102
|
|
|
103
|
-
<a id="service-8fe23c"></a>• [`endpoint_service`](#service-8fe23c) - Optional Block<br>Endpoint Service
|
|
103
|
+
<a id="service-8fe23c"></a>• [`endpoint_service`](#service-8fe23c) - Optional Block<br>Endpoint Service is a type of service where the packets are destined to BIG-IP APM device and service modifies the destination with a new destination address<br>See [Endpoint Service](#service-8fe23c) below.
|
|
104
104
|
|
|
105
|
-
<a id="aws-site-type-choice-apm-aws-site-nodes"></a>• [`nodes`](#aws-site-type-choice-apm-aws-site-nodes) - Optional Block<br>
|
|
105
|
+
<a id="aws-site-type-choice-apm-aws-site-nodes"></a>• [`nodes`](#aws-site-type-choice-apm-aws-site-nodes) - Optional Block<br>Specify how and where the service nodes are spawned<br>See [Nodes](#aws-site-type-choice-apm-aws-site-nodes) below.
|
|
106
106
|
|
|
107
|
-
<a id="key-4e6dae"></a>• [`ssh_key`](#key-4e6dae) - Optional String<br>Public SSH key
|
|
107
|
+
<a id="key-4e6dae"></a>• [`ssh_key`](#key-4e6dae) - Optional String<br>Public SSH key for accessing the BIG-IP nodes
|
|
108
108
|
|
|
109
|
-
<a id="aws-site-type-choice-apm-aws-site-tags"></a>• [`tags`](#aws-site-type-choice-apm-aws-site-tags) - Optional Block<br>AWS Tags
|
|
109
|
+
<a id="aws-site-type-choice-apm-aws-site-tags"></a>• [`tags`](#aws-site-type-choice-apm-aws-site-tags) - Optional Block<br>AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console
|
|
110
110
|
|
|
111
111
|
#### AWS Site Type Choice APM AWS Site Admin Password
|
|
112
112
|
|
|
@@ -156,15 +156,15 @@ An [`apm_aws_site`](#aws-site-type-choice-apm-aws-site) block (within [`aws_site
|
|
|
156
156
|
|
|
157
157
|
A [`market_place_image`](#aws-site-type-choice-market-place-image) block (within [`aws_site_type_choice`](#aws-site-type-choice)) supports the following:
|
|
158
158
|
|
|
159
|
-
<a id="mbps-34ab41"></a>• [`best_plus_pay_g200_mbps`](#mbps-34ab41) - Optional Block<br>
|
|
159
|
+
<a id="mbps-34ab41"></a>• [`best_plus_pay_g200_mbps`](#mbps-34ab41) - Optional Block<br>Can be used for messages where no values are needed
|
|
160
160
|
|
|
161
|
-
<a id="1gbps-f0a9c0"></a>• [`best_plus_payg_1gbps`](#1gbps-f0a9c0) - Optional Block<br>
|
|
161
|
+
<a id="1gbps-f0a9c0"></a>• [`best_plus_payg_1gbps`](#1gbps-f0a9c0) - Optional Block<br>Can be used for messages where no values are needed
|
|
162
162
|
|
|
163
163
|
#### Baremetal Site Type Choice
|
|
164
164
|
|
|
165
165
|
A [`baremetal_site_type_choice`](#baremetal-site-type-choice) block supports the following:
|
|
166
166
|
|
|
167
|
-
<a id="site-61bcd2"></a>• [`f5_bare_metal_site`](#site-61bcd2) - Optional Block<br>Virtual BIG-IP
|
|
167
|
+
<a id="site-61bcd2"></a>• [`f5_bare_metal_site`](#site-61bcd2) - Optional Block<br>Virtual BIG-IP specification for App Stack bare metal<br>See [F5 Bare Metal Site](#site-61bcd2) below.
|
|
168
168
|
|
|
169
169
|
#### Baremetal Site Type Choice F5 Bare Metal Site
|
|
170
170
|
|
|
@@ -226,9 +226,9 @@ A [`baremetal_site_type_choice`](#baremetal-site-type-choice) block supports the
|
|
|
226
226
|
|
|
227
227
|
A [`https_management`](#https-management) block supports the following:
|
|
228
228
|
|
|
229
|
-
<a id="https-management-advertise-on-internet"></a>• [`advertise_on_internet`](#https-management-advertise-on-internet) - Optional Block<br>
|
|
229
|
+
<a id="https-management-advertise-on-internet"></a>• [`advertise_on_internet`](#https-management-advertise-on-internet) - Optional Block<br>Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available<br>See [Advertise On Internet](#https-management-advertise-on-internet) below.
|
|
230
230
|
|
|
231
|
-
<a id="vip-00de2c"></a>• [`advertise_on_internet_default_vip`](#vip-00de2c) - Optional Block<br>
|
|
231
|
+
<a id="vip-00de2c"></a>• [`advertise_on_internet_default_vip`](#vip-00de2c) - Optional Block<br>Can be used for messages where no values are needed
|
|
232
232
|
|
|
233
233
|
<a id="https-management-advertise-on-sli-vip"></a>• [`advertise_on_sli_vip`](#https-management-advertise-on-sli-vip) - Optional Block<br>Inline TLS Parameters. Inline TLS parameters<br>See [Advertise On SLI VIP](#https-management-advertise-on-sli-vip) below.
|
|
234
234
|
|
|
@@ -238,39 +238,39 @@ A [`https_management`](#https-management) block supports the following:
|
|
|
238
238
|
|
|
239
239
|
<a id="https-management-advertise-on-slo-vip"></a>• [`advertise_on_slo_vip`](#https-management-advertise-on-slo-vip) - Optional Block<br>Inline TLS Parameters. Inline TLS parameters<br>See [Advertise On Slo VIP](#https-management-advertise-on-slo-vip) below.
|
|
240
240
|
|
|
241
|
-
<a id="https-management-default-https-port"></a>• [`default_https_port`](#https-management-default-https-port) - Optional Block<br>
|
|
241
|
+
<a id="https-management-default-https-port"></a>• [`default_https_port`](#https-management-default-https-port) - Optional Block<br>Can be used for messages where no values are needed
|
|
242
242
|
|
|
243
|
-
<a id="https-management-domain-suffix"></a>• [`domain_suffix`](#https-management-domain-suffix) - Optional String<br>Domain
|
|
243
|
+
<a id="https-management-domain-suffix"></a>• [`domain_suffix`](#https-management-domain-suffix) - Optional String<br>Domain suffix will be used along with node name to form URL to access node management
|
|
244
244
|
|
|
245
|
-
<a id="https-management-https-port"></a>• [`https_port`](#https-management-https-port) - Optional Number<br>
|
|
245
|
+
<a id="https-management-https-port"></a>• [`https_port`](#https-management-https-port) - Optional Number<br>Enter TCP port number
|
|
246
246
|
|
|
247
247
|
#### HTTPS Management Advertise On Internet
|
|
248
248
|
|
|
249
249
|
An [`advertise_on_internet`](#https-management-advertise-on-internet) block (within [`https_management`](#https-management)) supports the following:
|
|
250
250
|
|
|
251
|
-
<a id="public-ip-e501cc"></a>• [`public_ip`](#public-ip-e501cc) - Optional Block<br>
|
|
251
|
+
<a id="public-ip-e501cc"></a>• [`public_ip`](#public-ip-e501cc) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Public IP](#public-ip-e501cc) below.
|
|
252
252
|
|
|
253
253
|
#### HTTPS Management Advertise On Internet Public IP
|
|
254
254
|
|
|
255
255
|
A [`public_ip`](#public-ip-e501cc) block (within [`https_management.advertise_on_internet`](#https-management-advertise-on-internet)) supports the following:
|
|
256
256
|
|
|
257
|
-
<a id="name-c549a1"></a>• [`name`](#name-c549a1) - Optional String<br>
|
|
257
|
+
<a id="name-c549a1"></a>• [`name`](#name-c549a1) - 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
|
|
258
258
|
|
|
259
|
-
<a id="namespace-8fcb5e"></a>• [`namespace`](#namespace-8fcb5e) - Optional String<br>
|
|
259
|
+
<a id="namespace-8fcb5e"></a>• [`namespace`](#namespace-8fcb5e) - 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
|
|
260
260
|
|
|
261
|
-
<a id="tenant-5cb820"></a>• [`tenant`](#tenant-5cb820) - Optional String<br>
|
|
261
|
+
<a id="tenant-5cb820"></a>• [`tenant`](#tenant-5cb820) - 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
|
|
262
262
|
|
|
263
263
|
#### HTTPS Management Advertise On SLI VIP
|
|
264
264
|
|
|
265
265
|
An [`advertise_on_sli_vip`](#https-management-advertise-on-sli-vip) block (within [`https_management`](#https-management)) supports the following:
|
|
266
266
|
|
|
267
|
-
<a id="mtls-1bd8e3"></a>• [`no_mtls`](#mtls-1bd8e3) - Optional Block<br>
|
|
267
|
+
<a id="mtls-1bd8e3"></a>• [`no_mtls`](#mtls-1bd8e3) - Optional Block<br>Can be used for messages where no values are needed
|
|
268
268
|
|
|
269
|
-
<a id="certificates-5355d7"></a>• [`tls_certificates`](#certificates-5355d7) - Optional Block<br>
|
|
269
|
+
<a id="certificates-5355d7"></a>• [`tls_certificates`](#certificates-5355d7) - Optional Block<br>Users can add one or more certificates that share the same set of domains. For example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#certificates-5355d7) below.
|
|
270
270
|
|
|
271
|
-
<a id="config-9f094b"></a>• [`tls_config`](#config-9f094b) - Optional Block<br>
|
|
271
|
+
<a id="config-9f094b"></a>• [`tls_config`](#config-9f094b) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-9f094b) below.
|
|
272
272
|
|
|
273
|
-
<a id="mtls-c1dce4"></a>• [`use_mtls`](#mtls-c1dce4) - Optional Block<br>
|
|
273
|
+
<a id="mtls-c1dce4"></a>• [`use_mtls`](#mtls-c1dce4) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-c1dce4) below.
|
|
274
274
|
|
|
275
275
|
#### HTTPS Management Advertise On SLI VIP TLS Certificates
|
|
276
276
|
|
|
@@ -320,13 +320,13 @@ An [`advertise_on_sli_vip`](#https-management-advertise-on-sli-vip) block (withi
|
|
|
320
320
|
|
|
321
321
|
An [`advertise_on_slo_internet_vip`](#vip-6dd6e5) block (within [`https_management`](#https-management)) supports the following:
|
|
322
322
|
|
|
323
|
-
<a id="mtls-65c4ed"></a>• [`no_mtls`](#mtls-65c4ed) - Optional Block<br>
|
|
323
|
+
<a id="mtls-65c4ed"></a>• [`no_mtls`](#mtls-65c4ed) - Optional Block<br>Can be used for messages where no values are needed
|
|
324
324
|
|
|
325
|
-
<a id="certificates-748bff"></a>• [`tls_certificates`](#certificates-748bff) - Optional Block<br>
|
|
325
|
+
<a id="certificates-748bff"></a>• [`tls_certificates`](#certificates-748bff) - Optional Block<br>Users can add one or more certificates that share the same set of domains. For example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#certificates-748bff) below.
|
|
326
326
|
|
|
327
|
-
<a id="config-3dcb79"></a>• [`tls_config`](#config-3dcb79) - Optional Block<br>
|
|
327
|
+
<a id="config-3dcb79"></a>• [`tls_config`](#config-3dcb79) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-3dcb79) below.
|
|
328
328
|
|
|
329
|
-
<a id="mtls-2fcd89"></a>• [`use_mtls`](#mtls-2fcd89) - Optional Block<br>
|
|
329
|
+
<a id="mtls-2fcd89"></a>• [`use_mtls`](#mtls-2fcd89) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-2fcd89) below.
|
|
330
330
|
|
|
331
331
|
#### HTTPS Management Advertise On Slo Internet VIP TLS Certificates
|
|
332
332
|
|
|
@@ -376,13 +376,13 @@ An [`advertise_on_slo_internet_vip`](#vip-6dd6e5) block (within [`https_manageme
|
|
|
376
376
|
|
|
377
377
|
An [`advertise_on_slo_sli`](#https-management-advertise-on-slo-sli) block (within [`https_management`](#https-management)) supports the following:
|
|
378
378
|
|
|
379
|
-
<a id="mtls-e2f684"></a>• [`no_mtls`](#mtls-e2f684) - Optional Block<br>
|
|
379
|
+
<a id="mtls-e2f684"></a>• [`no_mtls`](#mtls-e2f684) - Optional Block<br>Can be used for messages where no values are needed
|
|
380
380
|
|
|
381
|
-
<a id="certificates-b923c1"></a>• [`tls_certificates`](#certificates-b923c1) - Optional Block<br>
|
|
381
|
+
<a id="certificates-b923c1"></a>• [`tls_certificates`](#certificates-b923c1) - Optional Block<br>Users can add one or more certificates that share the same set of domains. For example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#certificates-b923c1) below.
|
|
382
382
|
|
|
383
|
-
<a id="config-2cd93f"></a>• [`tls_config`](#config-2cd93f) - Optional Block<br>
|
|
383
|
+
<a id="config-2cd93f"></a>• [`tls_config`](#config-2cd93f) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-2cd93f) below.
|
|
384
384
|
|
|
385
|
-
<a id="mtls-b8036a"></a>• [`use_mtls`](#mtls-b8036a) - Optional Block<br>
|
|
385
|
+
<a id="mtls-b8036a"></a>• [`use_mtls`](#mtls-b8036a) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-b8036a) below.
|
|
386
386
|
|
|
387
387
|
#### HTTPS Management Advertise On Slo SLI TLS Certificates
|
|
388
388
|
|
|
@@ -432,13 +432,13 @@ An [`advertise_on_slo_sli`](#https-management-advertise-on-slo-sli) block (withi
|
|
|
432
432
|
|
|
433
433
|
An [`advertise_on_slo_vip`](#https-management-advertise-on-slo-vip) block (within [`https_management`](#https-management)) supports the following:
|
|
434
434
|
|
|
435
|
-
<a id="mtls-476751"></a>• [`no_mtls`](#mtls-476751) - Optional Block<br>
|
|
435
|
+
<a id="mtls-476751"></a>• [`no_mtls`](#mtls-476751) - Optional Block<br>Can be used for messages where no values are needed
|
|
436
436
|
|
|
437
|
-
<a id="certificates-49cf23"></a>• [`tls_certificates`](#certificates-49cf23) - Optional Block<br>
|
|
437
|
+
<a id="certificates-49cf23"></a>• [`tls_certificates`](#certificates-49cf23) - Optional Block<br>Users can add one or more certificates that share the same set of domains. For example, domain.com and \*.domain.com - but use different signature algorithms<br>See [TLS Certificates](#certificates-49cf23) below.
|
|
438
438
|
|
|
439
|
-
<a id="config-eb7c38"></a>• [`tls_config`](#config-eb7c38) - Optional Block<br>
|
|
439
|
+
<a id="config-eb7c38"></a>• [`tls_config`](#config-eb7c38) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#config-eb7c38) below.
|
|
440
440
|
|
|
441
|
-
<a id="mtls-85e7e5"></a>• [`use_mtls`](#mtls-85e7e5) - Optional Block<br>
|
|
441
|
+
<a id="mtls-85e7e5"></a>• [`use_mtls`](#mtls-85e7e5) - Optional Block<br>Validation context for downstream client TLS connections<br>See [Use mTLS](#mtls-85e7e5) below.
|
|
442
442
|
|
|
443
443
|
#### HTTPS Management Advertise On Slo VIP TLS Certificates
|
|
444
444
|
|