@robinmordasiewicz/f5xc-terraform-mcp 3.5.0 → 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/README.md +283 -104
- 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,15 +32,15 @@ resource "f5xc_advertise_policy" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# Optional. Public VIP to advertise This field is mutually ...
|
|
36
36
|
public_ip {
|
|
37
37
|
# Configure public_ip settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# TLS configuration for downstream connections.
|
|
40
40
|
tls_parameters {
|
|
41
41
|
# Configure tls_parameters settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
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>• [`address`](#address) - Optional String<br>
|
|
69
|
+
<a id="address"></a>• [`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
|
-
• <a id="port"></a>[`port`](#port) - Optional Number<br>
|
|
73
|
-
<br><br>• <a id="port-ranges"></a>[`port_ranges`](#port-ranges) - Optional String<br>
|
|
72
|
+
• <a id="port"></a>[`port`](#port) - Optional Number<br>Port to advertise
|
|
73
|
+
<br><br>• <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>• [`protocol`](#protocol) - Optional String<br>Protocol. Protocol to advertise
|
|
76
76
|
|
|
77
|
-
<a id="public-ip"></a>• [`public_ip`](#public-ip) - Optional Block<br>
|
|
77
|
+
<a id="public-ip"></a>• [`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>• [`skip_xff_append`](#skip-xff-append) - Optional Bool<br>
|
|
79
|
+
<a id="skip-xff-append"></a>• [`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>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
82
82
|
|
|
83
|
-
<a id="tls-parameters"></a>• [`tls_parameters`](#tls-parameters) - Optional Block<br>
|
|
83
|
+
<a id="tls-parameters"></a>• [`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>• [`where`](#where) - Optional Block<br>
|
|
85
|
+
<a id="where"></a>• [`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>• [`kind`](#public-ip-kind) - Optional String<br>
|
|
99
|
+
<a id="public-ip-kind"></a>• [`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>• [`name`](#public-ip-name) - Optional String<br>
|
|
101
|
+
<a id="public-ip-name"></a>• [`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>• [`namespace`](#public-ip-namespace) - Optional String<br>
|
|
103
|
+
<a id="public-ip-namespace"></a>• [`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>• [`tenant`](#public-ip-tenant) - Optional String<br>
|
|
105
|
+
<a id="public-ip-tenant"></a>• [`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>• [`uid`](#public-ip-uid) - Optional String<br>
|
|
107
|
+
<a id="public-ip-uid"></a>• [`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>• [`client_certificate_optional`](#optional-56d793) - Optional Block<br>
|
|
125
|
+
<a id="optional-56d793"></a>• [`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>• [`client_certificate_required`](#required-544cf5) - Optional Block<br>
|
|
127
|
+
<a id="required-544cf5"></a>• [`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>• [`common_params`](#tls-parameters-common-params) - Optional Block<br>
|
|
129
|
+
<a id="tls-parameters-common-params"></a>• [`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>• [`no_client_certificate`](#tls-parameters-no-client-certificate) - Optional Block<br>
|
|
131
|
+
<a id="tls-parameters-no-client-certificate"></a>• [`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>• [`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]
|
|
133
|
+
<a id="tls-parameters-xfcc-header-elements"></a>• [`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>• [`cipher_suites`](#suites-f69d86) - Optional List<br>
|
|
139
|
+
<a id="suites-f69d86"></a>• [`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>• [`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]
|
|
141
|
+
<a id="version-e7c6f2"></a>• [`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>• [`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]
|
|
143
|
+
<a id="version-7d1460"></a>• [`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>• [`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>• [`validation_params`](#params-6e95a6) - Optional Block<br>
|
|
147
|
+
<a id="params-6e95a6"></a>• [`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>• [`certificate_url`](#url-323181) - Optional String<br>
|
|
153
|
+
<a id="url-323181"></a>• [`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>• [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>
|
|
155
|
+
<a id="algorithms-eb62be"></a>• [`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>• [`description_spec`](#spec-5af02c) - Optional String<br>Description. Description for the certificate
|
|
158
158
|
|
|
159
|
-
<a id="stapling-c091fa"></a>• [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>
|
|
159
|
+
<a id="stapling-c091fa"></a>• [`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>• [`private_key`](#key-da7979) - Optional Block<br>
|
|
161
|
+
<a id="key-da7979"></a>• [`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>• [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>
|
|
163
|
+
<a id="defaults-f58bc7"></a>• [`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>• [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>
|
|
185
|
+
<a id="verification-30d13d"></a>• [`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>• [`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>• [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
|
|
189
|
+
<a id="url-910417"></a>• [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
|
|
190
190
|
|
|
191
|
-
<a id="names-1c97ed"></a>• [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>List of
|
|
191
|
+
<a id="names-1c97ed"></a>• [`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>• [`site`](#where-site) - Optional Block<br>
|
|
205
|
+
<a id="where-site"></a>• [`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>• [`virtual_network`](#where-virtual-network) - Optional Block<br>
|
|
207
|
+
<a id="where-virtual-network"></a>• [`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>• [`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>• [`disable_internet_vip`](#where-site-disable-internet-vip) - Optional Block<br>
|
|
215
|
+
<a id="where-site-disable-internet-vip"></a>• [`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>• [`enable_internet_vip`](#where-site-enable-internet-vip) - Optional Block<br>
|
|
217
|
+
<a id="where-site-enable-internet-vip"></a>• [`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>• [`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]
|
|
219
|
+
<a id="where-site-network-type"></a>• [`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>• [`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>• [`kind`](#where-site-ref-kind) - Optional String<br>
|
|
227
|
+
<a id="where-site-ref-kind"></a>• [`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>• [`name`](#where-site-ref-name) - Optional String<br>
|
|
229
|
+
<a id="where-site-ref-name"></a>• [`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>• [`namespace`](#where-site-ref-namespace) - Optional String<br>
|
|
231
|
+
<a id="where-site-ref-namespace"></a>• [`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>• [`tenant`](#where-site-ref-tenant) - Optional String<br>
|
|
233
|
+
<a id="where-site-ref-tenant"></a>• [`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>• [`uid`](#where-site-ref-uid) - Optional String<br>
|
|
235
|
+
<a id="where-site-ref-uid"></a>• [`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>• [`ref`](#where-virtual-network-ref) - Optional Block<br>
|
|
241
|
+
<a id="where-virtual-network-ref"></a>• [`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>• [`kind`](#where-virtual-network-ref-kind) - Optional String<br>
|
|
247
|
+
<a id="where-virtual-network-ref-kind"></a>• [`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>• [`name`](#where-virtual-network-ref-name) - Optional String<br>
|
|
249
|
+
<a id="where-virtual-network-ref-name"></a>• [`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>• [`namespace`](#where-virtual-network-ref-namespace) - Optional String<br>
|
|
251
|
+
<a id="where-virtual-network-ref-namespace"></a>• [`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>• [`tenant`](#where-virtual-network-ref-tenant) - Optional String<br>
|
|
253
|
+
<a id="where-virtual-network-ref-tenant"></a>• [`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>• [`uid`](#where-virtual-network-ref-uid) - Optional String<br>
|
|
255
|
+
<a id="where-virtual-network-ref-uid"></a>• [`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>• [`disable_internet_vip`](#where-virtual-site-disable-internet-vip) - Optional Block<br>
|
|
261
|
+
<a id="where-virtual-site-disable-internet-vip"></a>• [`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>• [`enable_internet_vip`](#where-virtual-site-enable-internet-vip) - Optional Block<br>
|
|
263
|
+
<a id="where-virtual-site-enable-internet-vip"></a>• [`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>• [`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]
|
|
265
|
+
<a id="where-virtual-site-network-type"></a>• [`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>• [`ref`](#where-virtual-site-ref) - Optional Block<br>
|
|
267
|
+
<a id="where-virtual-site-ref"></a>• [`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>• [`kind`](#where-virtual-site-ref-kind) - Optional String<br>
|
|
273
|
+
<a id="where-virtual-site-ref-kind"></a>• [`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>• [`name`](#where-virtual-site-ref-name) - Optional String<br>
|
|
275
|
+
<a id="where-virtual-site-ref-name"></a>• [`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>• [`namespace`](#where-virtual-site-ref-namespace) - Optional String<br>
|
|
277
|
+
<a id="where-virtual-site-ref-namespace"></a>• [`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>• [`tenant`](#where-virtual-site-ref-tenant) - Optional String<br>
|
|
279
|
+
<a id="where-virtual-site-ref-tenant"></a>• [`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>• [`uid`](#where-virtual-site-ref-uid) - Optional String<br>
|
|
281
|
+
<a id="where-virtual-site-ref-uid"></a>• [`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
|
|
|
@@ -72,11 +72,11 @@ resource "f5xc_alert_policy" "example" {
|
|
|
72
72
|
|
|
73
73
|
### Spec Argument Reference
|
|
74
74
|
|
|
75
|
-
<a id="notification-parameters"></a>• [`notification_parameters`](#notification-parameters) - Optional Block Defaults to `null`<br>
|
|
75
|
+
<a id="notification-parameters"></a>• [`notification_parameters`](#notification-parameters) - Optional Block Defaults to `null`<br>Set of notification parameters to decide how and when the alert notifications should be sent to the receivers<br>See [Notification Parameters](#notification-parameters) below for details.
|
|
76
76
|
|
|
77
|
-
<a id="receivers"></a>• [`receivers`](#receivers) - Optional Block<br>
|
|
77
|
+
<a id="receivers"></a>• [`receivers`](#receivers) - Optional Block<br>List of Alert Receivers where the alerts will be sent<br>See [Receivers](#receivers) below for details.
|
|
78
78
|
|
|
79
|
-
<a id="routes"></a>• [`routes`](#routes) - Optional Block<br>
|
|
79
|
+
<a id="routes"></a>• [`routes`](#routes) - Optional Block<br>Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match<br>See [Routes](#routes) below for details.
|
|
80
80
|
|
|
81
81
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
82
82
|
|
|
@@ -92,67 +92,67 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
92
92
|
|
|
93
93
|
A [`notification_parameters`](#notification-parameters) block supports the following:
|
|
94
94
|
|
|
95
|
-
<a id="notification-parameters-custom"></a>• [`custom`](#notification-parameters-custom) - Optional Block<br>
|
|
95
|
+
<a id="notification-parameters-custom"></a>• [`custom`](#notification-parameters-custom) - Optional Block<br>Specify list of custom labels to group/aggregate the alerts<br>See [Custom](#notification-parameters-custom) below.
|
|
96
96
|
|
|
97
|
-
<a id="notification-parameters-default"></a>• [`default`](#notification-parameters-default) - Optional Block<br>
|
|
97
|
+
<a id="notification-parameters-default"></a>• [`default`](#notification-parameters-default) - Optional Block<br>Can be used for messages where no values are needed
|
|
98
98
|
|
|
99
|
-
<a id="notification-parameters-group-interval"></a>• [`group_interval`](#notification-parameters-group-interval) - Optional String<br>
|
|
99
|
+
<a id="notification-parameters-group-interval"></a>• [`group_interval`](#notification-parameters-group-interval) - Optional String<br>Group Interval is used to specify how long to wait before sending a notification about new alerts that are added to the group for which an initial notification has already been sent. Format: [0-9]\[smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_interval
|
|
100
100
|
|
|
101
|
-
<a id="notification-parameters-group-wait"></a>• [`group_wait`](#notification-parameters-group-wait) - Optional String<br>
|
|
101
|
+
<a id="notification-parameters-group-wait"></a>• [`group_wait`](#notification-parameters-group-wait) - Optional String<br>Time value used to specify how long to initially wait for an inhibiting alert to arrive or collect more alerts for the same group. Format: [0-9]\[smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_wait defaults to '30s'
|
|
102
102
|
|
|
103
|
-
<a id="notification-parameters-individual"></a>• [`individual`](#notification-parameters-individual) - Optional Block<br>
|
|
103
|
+
<a id="notification-parameters-individual"></a>• [`individual`](#notification-parameters-individual) - Optional Block<br>Can be used for messages where no values are needed
|
|
104
104
|
|
|
105
|
-
<a id="notification-parameters-repeat-interval"></a>• [`repeat_interval`](#notification-parameters-repeat-interval) - Optional String<br>
|
|
105
|
+
<a id="notification-parameters-repeat-interval"></a>• [`repeat_interval`](#notification-parameters-repeat-interval) - Optional String<br>Repeat Interval is used to specify how long to wait before sending a notification again if it has already been sent successfully. Format: [0-9]\[smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_interval defaults to '4h'
|
|
106
106
|
|
|
107
|
-
<a id="notification-parameters-ves-io-group"></a>• [`ves_io_group`](#notification-parameters-ves-io-group) - Optional Block<br>
|
|
107
|
+
<a id="notification-parameters-ves-io-group"></a>• [`ves_io_group`](#notification-parameters-ves-io-group) - Optional Block<br>Can be used for messages where no values are needed
|
|
108
108
|
|
|
109
109
|
#### Notification Parameters Custom
|
|
110
110
|
|
|
111
111
|
A [`custom`](#notification-parameters-custom) block (within [`notification_parameters`](#notification-parameters)) supports the following:
|
|
112
112
|
|
|
113
|
-
<a id="notification-parameters-custom-labels"></a>• [`labels`](#notification-parameters-custom-labels) - Optional List<br>
|
|
113
|
+
<a id="notification-parameters-custom-labels"></a>• [`labels`](#notification-parameters-custom-labels) - Optional List<br>Name of labels to group/aggregate the alerts
|
|
114
114
|
|
|
115
115
|
#### Receivers
|
|
116
116
|
|
|
117
117
|
A [`receivers`](#receivers) block supports the following:
|
|
118
118
|
|
|
119
|
-
<a id="receivers-kind"></a>• [`kind`](#receivers-kind) - Optional String<br>
|
|
119
|
+
<a id="receivers-kind"></a>• [`kind`](#receivers-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')
|
|
120
120
|
|
|
121
|
-
<a id="receivers-name"></a>• [`name`](#receivers-name) - Optional String<br>
|
|
121
|
+
<a id="receivers-name"></a>• [`name`](#receivers-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
|
|
122
122
|
|
|
123
|
-
<a id="receivers-namespace"></a>• [`namespace`](#receivers-namespace) - Optional String<br>
|
|
123
|
+
<a id="receivers-namespace"></a>• [`namespace`](#receivers-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
|
|
124
124
|
|
|
125
|
-
<a id="receivers-tenant"></a>• [`tenant`](#receivers-tenant) - Optional String<br>
|
|
125
|
+
<a id="receivers-tenant"></a>• [`tenant`](#receivers-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
|
|
126
126
|
|
|
127
|
-
<a id="receivers-uid"></a>• [`uid`](#receivers-uid) - Optional String<br>
|
|
127
|
+
<a id="receivers-uid"></a>• [`uid`](#receivers-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
|
|
128
128
|
|
|
129
129
|
#### Routes
|
|
130
130
|
|
|
131
131
|
A [`routes`](#routes) block supports the following:
|
|
132
132
|
|
|
133
|
-
<a id="routes-alertname"></a>• [`alertname`](#routes-alertname) - Optional String Defaults to `SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN`<br>Possible values are `SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN`, `SITE_PHYSICAL_INTERFACE_DOWN`, `TUNNELS_TO_CUSTOMER_SITE_DOWN`, `SERVICE_SERVER_ERROR`, `SERVICE_CLIENT_ERROR`, `SERVICE_HEALTH_LOW`, `SERVICE_UNAVAILABLE`, `SERVICE_SERVER_ERROR_PER_SOURCE_SITE`, `SERVICE_CLIENT_ERROR_PER_SOURCE_SITE`, `SERVICE_ENDPOINT_HEALTHCHECK_FAILURE`, `SYNTHETIC_MONITOR_HEALTH_CRITICAL`, `MALICIOUS_USER_DETECTED`, `WAF_TOO_MANY_ATTACKS`, `API_SECURITY_TOO_MANY_ATTACKS`, `SERVICE_POLICY_TOO_MANY_ATTACKS`, `WAF_TOO_MANY_MALICIOUS_BOTS`, `BOT_DEFENSE_TOO_MANY_SECURITY_EVENTS`, `THREAT_CAMPAIGN`, `VES_CLIENT_SIDE_DEFENSE_SUSPICIOUS_DOMAIN`, `VES_CLIENT_SIDE_DEFENSE_SENSITIVE_FIELD_READ`, `ERROR_RATE_ANOMALY`, `REQUEST_RATE_ANOMALY`, `REQUEST_THROUGHPUT_ANOMALY`, `RESPONSE_LATENCY_ANOMALY`, `RESPONSE_THROUGHPUT_ANOMALY`, `TLS_AUTOMATIC_CERTIFICATE_RENEWAL_FAILURE`, `TLS_AUTOMATIC_CERTIFICATE_RENEWAL_STILL_FAILING`, `TLS_AUTOMATIC_CERTIFICATE_EXPIRED`, `TLS_CUSTOM_CERTIFICATE_EXPIRING`, `TLS_CUSTOM_CERTIFICATE_EXPIRING_SOON`, `TLS_CUSTOM_CERTIFICATE_EXPIRED`, `L7DDOS`, `DNS_ZONE_IGNORED_DUPLICATE_RECORD`, `API_SECURITY_UNUSED_API_DETECTED`, `API_SECURITY_SHADOW_API_DETECTED`, `API_SECURITY_SENSITIVE_DATA_IN_RESPONSE_DETECTED`, `API_SECURITY_RISK_SCORE_HIGH_DETECTED`, `ROUTED_DDOS_ALERT_NOTIFICATION`, `ROUTED_DDOS_MITIGATION_NOTIFICATION`<br>[Enum: SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN|SITE_PHYSICAL_INTERFACE_DOWN|TUNNELS_TO_CUSTOMER_SITE_DOWN|SERVICE_SERVER_ERROR|SERVICE_CLIENT_ERROR|SERVICE_HEALTH_LOW|SERVICE_UNAVAILABLE|SERVICE_SERVER_ERROR_PER_SOURCE_SITE|SERVICE_CLIENT_ERROR_PER_SOURCE_SITE|SERVICE_ENDPOINT_HEALTHCHECK_FAILURE|SYNTHETIC_MONITOR_HEALTH_CRITICAL|MALICIOUS_USER_DETECTED|WAF_TOO_MANY_ATTACKS|API_SECURITY_TOO_MANY_ATTACKS|SERVICE_POLICY_TOO_MANY_ATTACKS|WAF_TOO_MANY_MALICIOUS_BOTS|BOT_DEFENSE_TOO_MANY_SECURITY_EVENTS|THREAT_CAMPAIGN|VES_CLIENT_SIDE_DEFENSE_SUSPICIOUS_DOMAIN|VES_CLIENT_SIDE_DEFENSE_SENSITIVE_FIELD_READ|ERROR_RATE_ANOMALY|REQUEST_RATE_ANOMALY|REQUEST_THROUGHPUT_ANOMALY|RESPONSE_LATENCY_ANOMALY|RESPONSE_THROUGHPUT_ANOMALY|TLS_AUTOMATIC_CERTIFICATE_RENEWAL_FAILURE|TLS_AUTOMATIC_CERTIFICATE_RENEWAL_STILL_FAILING|TLS_AUTOMATIC_CERTIFICATE_EXPIRED|TLS_CUSTOM_CERTIFICATE_EXPIRING|TLS_CUSTOM_CERTIFICATE_EXPIRING_SOON|TLS_CUSTOM_CERTIFICATE_EXPIRED|L7DDOS|DNS_ZONE_IGNORED_DUPLICATE_RECORD|API_SECURITY_UNUSED_API_DETECTED|API_SECURITY_SHADOW_API_DETECTED|API_SECURITY_SENSITIVE_DATA_IN_RESPONSE_DETECTED|API_SECURITY_RISK_SCORE_HIGH_DETECTED|ROUTED_DDOS_ALERT_NOTIFICATION|ROUTED_DDOS_MITIGATION_NOTIFICATION]
|
|
133
|
+
<a id="routes-alertname"></a>• [`alertname`](#routes-alertname) - Optional String Defaults to `SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN`<br>Possible values are `SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN`, `SITE_PHYSICAL_INTERFACE_DOWN`, `TUNNELS_TO_CUSTOMER_SITE_DOWN`, `SERVICE_SERVER_ERROR`, `SERVICE_CLIENT_ERROR`, `SERVICE_HEALTH_LOW`, `SERVICE_UNAVAILABLE`, `SERVICE_SERVER_ERROR_PER_SOURCE_SITE`, `SERVICE_CLIENT_ERROR_PER_SOURCE_SITE`, `SERVICE_ENDPOINT_HEALTHCHECK_FAILURE`, `SYNTHETIC_MONITOR_HEALTH_CRITICAL`, `MALICIOUS_USER_DETECTED`, `WAF_TOO_MANY_ATTACKS`, `API_SECURITY_TOO_MANY_ATTACKS`, `SERVICE_POLICY_TOO_MANY_ATTACKS`, `WAF_TOO_MANY_MALICIOUS_BOTS`, `BOT_DEFENSE_TOO_MANY_SECURITY_EVENTS`, `THREAT_CAMPAIGN`, `VES_CLIENT_SIDE_DEFENSE_SUSPICIOUS_DOMAIN`, `VES_CLIENT_SIDE_DEFENSE_SENSITIVE_FIELD_READ`, `ERROR_RATE_ANOMALY`, `REQUEST_RATE_ANOMALY`, `REQUEST_THROUGHPUT_ANOMALY`, `RESPONSE_LATENCY_ANOMALY`, `RESPONSE_THROUGHPUT_ANOMALY`, `TLS_AUTOMATIC_CERTIFICATE_RENEWAL_FAILURE`, `TLS_AUTOMATIC_CERTIFICATE_RENEWAL_STILL_FAILING`, `TLS_AUTOMATIC_CERTIFICATE_EXPIRED`, `TLS_CUSTOM_CERTIFICATE_EXPIRING`, `TLS_CUSTOM_CERTIFICATE_EXPIRING_SOON`, `TLS_CUSTOM_CERTIFICATE_EXPIRED`, `L7DDOS`, `DNS_ZONE_IGNORED_DUPLICATE_RECORD`, `API_SECURITY_UNUSED_API_DETECTED`, `API_SECURITY_SHADOW_API_DETECTED`, `API_SECURITY_SENSITIVE_DATA_IN_RESPONSE_DETECTED`, `API_SECURITY_RISK_SCORE_HIGH_DETECTED`, `ROUTED_DDOS_ALERT_NOTIFICATION`, `ROUTED_DDOS_MITIGATION_NOTIFICATION`<br>[Enum: SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN|SITE_PHYSICAL_INTERFACE_DOWN|TUNNELS_TO_CUSTOMER_SITE_DOWN|SERVICE_SERVER_ERROR|SERVICE_CLIENT_ERROR|SERVICE_HEALTH_LOW|SERVICE_UNAVAILABLE|SERVICE_SERVER_ERROR_PER_SOURCE_SITE|SERVICE_CLIENT_ERROR_PER_SOURCE_SITE|SERVICE_ENDPOINT_HEALTHCHECK_FAILURE|SYNTHETIC_MONITOR_HEALTH_CRITICAL|MALICIOUS_USER_DETECTED|WAF_TOO_MANY_ATTACKS|API_SECURITY_TOO_MANY_ATTACKS|SERVICE_POLICY_TOO_MANY_ATTACKS|WAF_TOO_MANY_MALICIOUS_BOTS|BOT_DEFENSE_TOO_MANY_SECURITY_EVENTS|THREAT_CAMPAIGN|VES_CLIENT_SIDE_DEFENSE_SUSPICIOUS_DOMAIN|VES_CLIENT_SIDE_DEFENSE_SENSITIVE_FIELD_READ|ERROR_RATE_ANOMALY|REQUEST_RATE_ANOMALY|REQUEST_THROUGHPUT_ANOMALY|RESPONSE_LATENCY_ANOMALY|RESPONSE_THROUGHPUT_ANOMALY|TLS_AUTOMATIC_CERTIFICATE_RENEWAL_FAILURE|TLS_AUTOMATIC_CERTIFICATE_RENEWAL_STILL_FAILING|TLS_AUTOMATIC_CERTIFICATE_EXPIRED|TLS_CUSTOM_CERTIFICATE_EXPIRING|TLS_CUSTOM_CERTIFICATE_EXPIRING_SOON|TLS_CUSTOM_CERTIFICATE_EXPIRED|L7DDOS|DNS_ZONE_IGNORED_DUPLICATE_RECORD|API_SECURITY_UNUSED_API_DETECTED|API_SECURITY_SHADOW_API_DETECTED|API_SECURITY_SENSITIVE_DATA_IN_RESPONSE_DETECTED|API_SECURITY_RISK_SCORE_HIGH_DETECTED|ROUTED_DDOS_ALERT_NOTIFICATION|ROUTED_DDOS_MITIGATION_NOTIFICATION] List of Alert Names Customer tunnel interface down Physical Interface down Tunnel Interfaces to Customer Site Down Virutal Host server error Virtual Host client error Service Health Low Service Unavailable Virtual Host server error Virtual Host client error Endpoint Healthcheck failure Synthetic
|
|
134
134
|
|
|
135
|
-
<a id="routes-alertname-regex"></a>• [`alertname_regex`](#routes-alertname-regex) - Optional String<br>
|
|
135
|
+
<a id="routes-alertname-regex"></a>• [`alertname_regex`](#routes-alertname-regex) - Optional String<br>Regular Expression match for the alertname
|
|
136
136
|
|
|
137
|
-
<a id="routes-any"></a>• [`any`](#routes-any) - Optional Block<br>
|
|
137
|
+
<a id="routes-any"></a>• [`any`](#routes-any) - Optional Block<br>Can be used for messages where no values are needed
|
|
138
138
|
|
|
139
|
-
<a id="routes-custom"></a>• [`custom`](#routes-custom) - Optional Block<br>
|
|
139
|
+
<a id="routes-custom"></a>• [`custom`](#routes-custom) - Optional Block<br>Set of matchers an alert has to fulfill to match the route<br>See [Custom](#routes-custom) below.
|
|
140
140
|
|
|
141
|
-
<a id="routes-dont-send"></a>• [`dont_send`](#routes-dont-send) - Optional Block<br>
|
|
141
|
+
<a id="routes-dont-send"></a>• [`dont_send`](#routes-dont-send) - Optional Block<br>Can be used for messages where no values are needed
|
|
142
142
|
|
|
143
|
-
<a id="routes-group"></a>• [`group`](#routes-group) - Optional Block<br>
|
|
143
|
+
<a id="routes-group"></a>• [`group`](#routes-group) - Optional Block<br>Select one or more known group names to match the incoming alert<br>See [Group](#routes-group) below.
|
|
144
144
|
|
|
145
|
-
<a id="routes-notification-parameters"></a>• [`notification_parameters`](#routes-notification-parameters) - Optional Block<br>
|
|
145
|
+
<a id="routes-notification-parameters"></a>• [`notification_parameters`](#routes-notification-parameters) - Optional Block<br>Set of notification parameters to decide how and when the alert notifications should be sent to the receivers<br>See [Notification Parameters](#routes-notification-parameters) below.
|
|
146
146
|
|
|
147
|
-
<a id="routes-send"></a>• [`send`](#routes-send) - Optional Block<br>
|
|
147
|
+
<a id="routes-send"></a>• [`send`](#routes-send) - Optional Block<br>Can be used for messages where no values are needed
|
|
148
148
|
|
|
149
|
-
<a id="routes-severity"></a>• [`severity`](#routes-severity) - Optional Block<br>
|
|
149
|
+
<a id="routes-severity"></a>• [`severity`](#routes-severity) - Optional Block<br>Select one or more severity levels to match the incoming alert<br>See [Severity](#routes-severity) below.
|
|
150
150
|
|
|
151
151
|
#### Routes Custom
|
|
152
152
|
|
|
153
153
|
A [`custom`](#routes-custom) block (within [`routes`](#routes)) supports the following:
|
|
154
154
|
|
|
155
|
-
<a id="routes-custom-alertlabel"></a>• [`alertlabel`](#routes-custom-alertlabel) - Optional Block<br>AlertLabel
|
|
155
|
+
<a id="routes-custom-alertlabel"></a>• [`alertlabel`](#routes-custom-alertlabel) - Optional Block<br>AlertLabel to configure the alert policy rule
|
|
156
156
|
|
|
157
157
|
<a id="routes-custom-alertname"></a>• [`alertname`](#routes-custom-alertname) - Optional Block<br>Label Matcher<br>See [Alertname](#routes-custom-alertname) below.
|
|
158
158
|
|
|
@@ -164,25 +164,25 @@ A [`custom`](#routes-custom) block (within [`routes`](#routes)) supports the fol
|
|
|
164
164
|
|
|
165
165
|
An [`alertname`](#routes-custom-alertname) block (within [`routes.custom`](#routes-custom)) supports the following:
|
|
166
166
|
|
|
167
|
-
<a id="routes-custom-alertname-exact-match"></a>• [`exact_match`](#routes-custom-alertname-exact-match) - Optional String<br>
|
|
167
|
+
<a id="routes-custom-alertname-exact-match"></a>• [`exact_match`](#routes-custom-alertname-exact-match) - Optional String<br>Equality match value for the label
|
|
168
168
|
|
|
169
|
-
<a id="routes-custom-alertname-regex-match"></a>• [`regex_match`](#routes-custom-alertname-regex-match) - Optional String<br>
|
|
169
|
+
<a id="routes-custom-alertname-regex-match"></a>• [`regex_match`](#routes-custom-alertname-regex-match) - Optional String<br>Regular expression match value for the label
|
|
170
170
|
|
|
171
171
|
#### Routes Custom Group
|
|
172
172
|
|
|
173
173
|
A [`group`](#routes-custom-group) block (within [`routes.custom`](#routes-custom)) supports the following:
|
|
174
174
|
|
|
175
|
-
<a id="routes-custom-group-exact-match"></a>• [`exact_match`](#routes-custom-group-exact-match) - Optional String<br>
|
|
175
|
+
<a id="routes-custom-group-exact-match"></a>• [`exact_match`](#routes-custom-group-exact-match) - Optional String<br>Equality match value for the label
|
|
176
176
|
|
|
177
|
-
<a id="routes-custom-group-regex-match"></a>• [`regex_match`](#routes-custom-group-regex-match) - Optional String<br>
|
|
177
|
+
<a id="routes-custom-group-regex-match"></a>• [`regex_match`](#routes-custom-group-regex-match) - Optional String<br>Regular expression match value for the label
|
|
178
178
|
|
|
179
179
|
#### Routes Custom Severity
|
|
180
180
|
|
|
181
181
|
A [`severity`](#routes-custom-severity) block (within [`routes.custom`](#routes-custom)) supports the following:
|
|
182
182
|
|
|
183
|
-
<a id="routes-custom-severity-exact-match"></a>• [`exact_match`](#routes-custom-severity-exact-match) - Optional String<br>
|
|
183
|
+
<a id="routes-custom-severity-exact-match"></a>• [`exact_match`](#routes-custom-severity-exact-match) - Optional String<br>Equality match value for the label
|
|
184
184
|
|
|
185
|
-
<a id="routes-custom-severity-regex-match"></a>• [`regex_match`](#routes-custom-severity-regex-match) - Optional String<br>
|
|
185
|
+
<a id="routes-custom-severity-regex-match"></a>• [`regex_match`](#routes-custom-severity-regex-match) - Optional String<br>Regular expression match value for the label
|
|
186
186
|
|
|
187
187
|
#### Routes Group
|
|
188
188
|
|
|
@@ -194,25 +194,25 @@ A [`group`](#routes-group) block (within [`routes`](#routes)) supports the follo
|
|
|
194
194
|
|
|
195
195
|
A [`notification_parameters`](#routes-notification-parameters) block (within [`routes`](#routes)) supports the following:
|
|
196
196
|
|
|
197
|
-
<a id="routes-notification-parameters-custom"></a>• [`custom`](#routes-notification-parameters-custom) - Optional Block<br>
|
|
197
|
+
<a id="routes-notification-parameters-custom"></a>• [`custom`](#routes-notification-parameters-custom) - Optional Block<br>Specify list of custom labels to group/aggregate the alerts<br>See [Custom](#routes-notification-parameters-custom) below.
|
|
198
198
|
|
|
199
|
-
<a id="routes-notification-parameters-default"></a>• [`default`](#routes-notification-parameters-default) - Optional Block<br>
|
|
199
|
+
<a id="routes-notification-parameters-default"></a>• [`default`](#routes-notification-parameters-default) - Optional Block<br>Can be used for messages where no values are needed
|
|
200
200
|
|
|
201
|
-
<a id="interval-b0bcc1"></a>• [`group_interval`](#interval-b0bcc1) - Optional String<br>
|
|
201
|
+
<a id="interval-b0bcc1"></a>• [`group_interval`](#interval-b0bcc1) - Optional String<br>Group Interval is used to specify how long to wait before sending a notification about new alerts that are added to the group for which an initial notification has already been sent. Format: [0-9]\[smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_interval
|
|
202
202
|
|
|
203
|
-
<a id="wait-34a75e"></a>• [`group_wait`](#wait-34a75e) - Optional String<br>
|
|
203
|
+
<a id="wait-34a75e"></a>• [`group_wait`](#wait-34a75e) - Optional String<br>Time value used to specify how long to initially wait for an inhibiting alert to arrive or collect more alerts for the same group. Format: [0-9]\[smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_wait defaults to '30s'
|
|
204
204
|
|
|
205
|
-
<a id="individual-096c32"></a>• [`individual`](#individual-096c32) - Optional Block<br>
|
|
205
|
+
<a id="individual-096c32"></a>• [`individual`](#individual-096c32) - Optional Block<br>Can be used for messages where no values are needed
|
|
206
206
|
|
|
207
|
-
<a id="interval-4b248a"></a>• [`repeat_interval`](#interval-4b248a) - Optional String<br>
|
|
207
|
+
<a id="interval-4b248a"></a>• [`repeat_interval`](#interval-4b248a) - Optional String<br>Repeat Interval is used to specify how long to wait before sending a notification again if it has already been sent successfully. Format: [0-9]\[smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_interval defaults to '4h'
|
|
208
208
|
|
|
209
|
-
<a id="group-12b5ad"></a>• [`ves_io_group`](#group-12b5ad) - Optional Block<br>
|
|
209
|
+
<a id="group-12b5ad"></a>• [`ves_io_group`](#group-12b5ad) - Optional Block<br>Can be used for messages where no values are needed
|
|
210
210
|
|
|
211
211
|
#### Routes Notification Parameters Custom
|
|
212
212
|
|
|
213
213
|
A [`custom`](#routes-notification-parameters-custom) block (within [`routes.notification_parameters`](#routes-notification-parameters)) supports the following:
|
|
214
214
|
|
|
215
|
-
<a id="labels-bf3226"></a>• [`labels`](#labels-bf3226) - Optional List<br>
|
|
215
|
+
<a id="labels-bf3226"></a>• [`labels`](#labels-bf3226) - Optional List<br>Name of labels to group/aggregate the alerts
|
|
216
216
|
|
|
217
217
|
#### Routes Severity
|
|
218
218
|
|