@robinmordasiewicz/f5xc-terraform-mcp 3.10.3 → 3.10.5
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/fast_acl.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/policer.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/data-sources/workload.md +2 -2
- package/dist/docs/resources/bgp.md +205 -37
- package/dist/docs/resources/cloud_connect.md +2 -2
- package/dist/docs/resources/fast_acl.md +166 -60
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +44 -825
- package/dist/docs/resources/network_policy.md +125 -119
- package/dist/docs/resources/policer.md +10 -50
- package/dist/docs/resources/securemesh_site.md +253 -1614
- package/dist/docs/resources/site.md +527 -233
- package/dist/docs/resources/workload.md +2951 -9
- package/dist/metadata/resource-metadata.json +301 -621
- package/dist/services/addons.js +2 -2
- package/dist/services/addons.js.map +1 -1
- package/dist/services/api-specs.js.map +1 -1
- package/dist/services/documentation.js +1 -1
- package/dist/services/documentation.js.map +1 -1
- package/dist/services/metadata.js +1 -1
- package/dist/services/metadata.js.map +1 -1
- package/dist/tools/auth.js +2 -2
- package/dist/tools/auth.js.map +1 -1
- package/dist/tools/metadata.js +4 -4
- package/dist/tools/metadata.js.map +1 -1
- package/package.json +7 -2
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_network_policy Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Security"
|
|
4
4
|
description: |-
|
|
5
|
-
Manages
|
|
5
|
+
Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_network_policy (Resource)
|
|
9
9
|
|
|
10
|
-
Manages
|
|
10
|
+
Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
|
|
11
11
|
|
|
12
12
|
~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Manages a Network Policy resource in F5 Distributed Cloud for network policy vie
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Network Policy Resource Example
|
|
18
|
-
# Manages
|
|
18
|
+
# Manages new network policy with configured parameters in specified namespace. in F5 Distributed Cloud.
|
|
19
19
|
|
|
20
20
|
# Basic Network Policy configuration
|
|
21
21
|
resource "f5xc_network_policy" "example" {
|
|
@@ -77,11 +77,9 @@ resource "f5xc_network_policy" "example" {
|
|
|
77
77
|
|
|
78
78
|
### Spec Argument Reference
|
|
79
79
|
|
|
80
|
-
<a id="egress-rules"></a>• [`egress_rules`](#egress-rules) - Optional Block<br>Ordered list of rules applied to connections from policy endpoints<br>See [Egress Rules](#egress-rules) below for details.
|
|
81
|
-
|
|
82
80
|
<a id="endpoint"></a>• [`endpoint`](#endpoint) - Optional Block<br>Shape of the endpoint choices for a view<br>See [Endpoint](#endpoint) below for details.
|
|
83
81
|
|
|
84
|
-
<a id="
|
|
82
|
+
<a id="rules"></a>• [`rules`](#rules) - Optional Block<br>Rule Choice. Shape of Rule Choice<br>See [Rules](#rules) below for details.
|
|
85
83
|
|
|
86
84
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
87
85
|
|
|
@@ -93,231 +91,239 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
93
91
|
|
|
94
92
|
---
|
|
95
93
|
|
|
96
|
-
####
|
|
94
|
+
#### Endpoint
|
|
97
95
|
|
|
98
|
-
An [`
|
|
96
|
+
An [`endpoint`](#endpoint) block supports the following:
|
|
99
97
|
|
|
100
|
-
<a id="
|
|
98
|
+
<a id="endpoint-any"></a>• [`any`](#endpoint-any) - Optional Block<br>Enable this option
|
|
101
99
|
|
|
102
|
-
<a id="
|
|
100
|
+
<a id="endpoint-inside-endpoints"></a>• [`inside_endpoints`](#endpoint-inside-endpoints) - Optional Block<br>Enable this option
|
|
103
101
|
|
|
104
|
-
<a id="
|
|
102
|
+
<a id="endpoint-label-selector"></a>• [`label_selector`](#endpoint-label-selector) - Optional Block<br>Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects<br>See [Label Selector](#endpoint-label-selector) below.
|
|
105
103
|
|
|
106
|
-
<a id="
|
|
104
|
+
<a id="endpoint-outside-endpoints"></a>• [`outside_endpoints`](#endpoint-outside-endpoints) - Optional Block<br>Enable this option
|
|
107
105
|
|
|
108
|
-
<a id="
|
|
106
|
+
<a id="endpoint-prefix-list"></a>• [`prefix_list`](#endpoint-prefix-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Prefix List](#endpoint-prefix-list) below.
|
|
109
107
|
|
|
110
|
-
|
|
108
|
+
#### Endpoint Label Selector
|
|
111
109
|
|
|
112
|
-
|
|
110
|
+
A [`label_selector`](#endpoint-label-selector) block (within [`endpoint`](#endpoint)) supports the following:
|
|
113
111
|
|
|
114
|
-
<a id="
|
|
112
|
+
<a id="endpoint-label-selector-expressions"></a>• [`expressions`](#endpoint-label-selector-expressions) - Optional List<br>Expressions contains the Kubernetes style label expression for selections
|
|
115
113
|
|
|
116
|
-
|
|
114
|
+
#### Endpoint Prefix List
|
|
117
115
|
|
|
118
|
-
|
|
116
|
+
A [`prefix_list`](#endpoint-prefix-list) block (within [`endpoint`](#endpoint)) supports the following:
|
|
119
117
|
|
|
120
|
-
<a id="
|
|
118
|
+
<a id="endpoint-prefix-list-prefixes"></a>• [`prefixes`](#endpoint-prefix-list-prefixes) - Optional List<br>List of IPv4 prefixes that represent an endpoint
|
|
121
119
|
|
|
122
|
-
|
|
120
|
+
#### Rules
|
|
123
121
|
|
|
124
|
-
|
|
122
|
+
A [`rules`](#rules) block supports the following:
|
|
125
123
|
|
|
126
|
-
<a id="egress-rules
|
|
124
|
+
<a id="rules-egress-rules"></a>• [`egress_rules`](#rules-egress-rules) - Optional Block<br>Ordered list of rules applied to connections from policy endpoints<br>See [Egress Rules](#rules-egress-rules) below.
|
|
127
125
|
|
|
128
|
-
<a id="
|
|
126
|
+
<a id="rules-ingress-rules"></a>• [`ingress_rules`](#rules-ingress-rules) - Optional Block<br>Ordered list of rules applied to connections to policy endpoints<br>See [Ingress Rules](#rules-ingress-rules) below.
|
|
129
127
|
|
|
130
|
-
#### Egress Rules
|
|
128
|
+
#### Rules Egress Rules
|
|
131
129
|
|
|
132
|
-
An [`
|
|
130
|
+
An [`egress_rules`](#rules-egress-rules) block (within [`rules`](#rules)) supports the following:
|
|
133
131
|
|
|
134
|
-
<a id="egress-rules-
|
|
132
|
+
<a id="rules-egress-rules-action"></a>• [`action`](#rules-egress-rules-action) - Optional String Defaults to `DENY`<br>Possible values are `DENY`, `ALLOW`<br>[Enum: DENY|ALLOW] Network policy rule action configures the action to be taken on rule match Apply deny action on rule match Apply allow action on rule match
|
|
135
133
|
|
|
136
|
-
|
|
134
|
+
<a id="rules-egress-rules-adv-action"></a>• [`adv_action`](#rules-egress-rules-adv-action) - Optional Block<br>Network Policy Rule Advanced Action provides additional OPTIONS along with RuleAction and PBRRuleAction<br>See [Adv Action](#rules-egress-rules-adv-action) below.
|
|
137
135
|
|
|
138
|
-
|
|
136
|
+
<a id="rules-egress-rules-all-tcp-traffic"></a>• [`all_tcp_traffic`](#rules-egress-rules-all-tcp-traffic) - Optional Block<br>Enable this option
|
|
139
137
|
|
|
140
|
-
<a id="egress-rules-
|
|
138
|
+
<a id="rules-egress-rules-all-traffic"></a>• [`all_traffic`](#rules-egress-rules-all-traffic) - Optional Block<br>Enable this option
|
|
141
139
|
|
|
142
|
-
|
|
140
|
+
<a id="rules-egress-rules-all-udp-traffic"></a>• [`all_udp_traffic`](#rules-egress-rules-all-udp-traffic) - Optional Block<br>Enable this option
|
|
143
141
|
|
|
144
|
-
|
|
142
|
+
<a id="rules-egress-rules-any"></a>• [`any`](#rules-egress-rules-any) - Optional Block<br>Enable this option
|
|
145
143
|
|
|
146
|
-
<a id="egress-rules-
|
|
144
|
+
<a id="rules-egress-rules-applications"></a>• [`applications`](#rules-egress-rules-applications) - Optional Block<br>Applications. Application protocols like HTTP, SNMP<br>See [Applications](#rules-egress-rules-applications) below.
|
|
147
145
|
|
|
148
|
-
|
|
146
|
+
<a id="rules-egress-rules-inside-endpoints"></a>• [`inside_endpoints`](#rules-egress-rules-inside-endpoints) - Optional Block<br>Enable this option
|
|
149
147
|
|
|
150
|
-
|
|
148
|
+
<a id="rules-egress-rules-ip-prefix-set"></a>• [`ip_prefix_set`](#rules-egress-rules-ip-prefix-set) - Optional Block<br>List of references to ip_prefix_set objects<br>See [IP Prefix Set](#rules-egress-rules-ip-prefix-set) below.
|
|
151
149
|
|
|
152
|
-
<a id="egress-rules-
|
|
150
|
+
<a id="rules-egress-rules-label-matcher"></a>• [`label_matcher`](#rules-egress-rules-label-matcher) - Optional Block<br>Label matcher specifies a list of label keys whose values need to match for source/client and destination/server. Note that the actual label values are not specified and do not matter. This allows an ability to scope grouping by the label key name<br>See [Label Matcher](#rules-egress-rules-label-matcher) below.
|
|
153
151
|
|
|
154
|
-
<a id="egress-rules-
|
|
152
|
+
<a id="rules-egress-rules-label-selector"></a>• [`label_selector`](#rules-egress-rules-label-selector) - Optional Block<br>Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects<br>See [Label Selector](#rules-egress-rules-label-selector) below.
|
|
155
153
|
|
|
156
|
-
<a id="
|
|
154
|
+
<a id="rules-egress-rules-metadata"></a>• [`metadata`](#rules-egress-rules-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#rules-egress-rules-metadata) below.
|
|
157
155
|
|
|
158
|
-
<a id="egress-rules-
|
|
156
|
+
<a id="rules-egress-rules-outside-endpoints"></a>• [`outside_endpoints`](#rules-egress-rules-outside-endpoints) - Optional Block<br>Enable this option
|
|
159
157
|
|
|
160
|
-
<a id="egress-rules-
|
|
158
|
+
<a id="rules-egress-rules-prefix-list"></a>• [`prefix_list`](#rules-egress-rules-prefix-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Prefix List](#rules-egress-rules-prefix-list) below.
|
|
161
159
|
|
|
162
|
-
|
|
160
|
+
<a id="rules-egress-rules-protocol-port-range"></a>• [`protocol_port_range`](#rules-egress-rules-protocol-port-range) - Optional Block<br>Protocol and Port. Protocol and Port ranges<br>See [Protocol Port Range](#rules-egress-rules-protocol-port-range) below.
|
|
163
161
|
|
|
164
|
-
|
|
162
|
+
#### Rules Egress Rules Adv Action
|
|
165
163
|
|
|
166
|
-
|
|
164
|
+
An [`adv_action`](#rules-egress-rules-adv-action) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
167
165
|
|
|
168
|
-
|
|
166
|
+
<a id="rules-egress-rules-adv-action-action"></a>• [`action`](#rules-egress-rules-adv-action-action) - Optional String Defaults to `NOLOG`<br>Possible values are `NOLOG`, `LOG`<br>[Enum: NOLOG|LOG] Choice to choose logging or no logging This works together with option selected via NetworkPolicyRuleAction or any other action specified x-
|
|
169
167
|
|
|
170
|
-
|
|
168
|
+
#### Rules Egress Rules Applications
|
|
171
169
|
|
|
172
|
-
|
|
170
|
+
An [`applications`](#rules-egress-rules-applications) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
173
171
|
|
|
174
|
-
|
|
172
|
+
<a id="applications-f7c65d"></a>• [`applications`](#applications-f7c65d) - Optional List Defaults to `APPLICATION_HTTP`<br>Possible values are `APPLICATION_HTTP`, `APPLICATION_HTTPS`, `APPLICATION_SNMP`, `APPLICATION_DNS`<br>[Enum: APPLICATION_HTTP|APPLICATION_HTTPS|APPLICATION_SNMP|APPLICATION_DNS] Application Protocols. Application protocols like HTTP, SNMP
|
|
175
173
|
|
|
176
|
-
|
|
174
|
+
#### Rules Egress Rules IP Prefix Set
|
|
177
175
|
|
|
178
|
-
|
|
176
|
+
An [`ip_prefix_set`](#rules-egress-rules-ip-prefix-set) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
179
177
|
|
|
180
|
-
<a id="egress-rules-
|
|
178
|
+
<a id="rules-egress-rules-ip-prefix-set-ref"></a>• [`ref`](#rules-egress-rules-ip-prefix-set-ref) - Optional Block<br>List of references to ip_prefix_set objects<br>See [Ref](#rules-egress-rules-ip-prefix-set-ref) below.
|
|
181
179
|
|
|
182
|
-
#### Egress Rules Prefix
|
|
180
|
+
#### Rules Egress Rules IP Prefix Set Ref
|
|
183
181
|
|
|
184
|
-
A [`
|
|
182
|
+
A [`ref`](#rules-egress-rules-ip-prefix-set-ref) block (within [`rules.egress_rules.ip_prefix_set`](#rules-egress-rules-ip-prefix-set)) supports the following:
|
|
185
183
|
|
|
186
|
-
<a id="
|
|
184
|
+
<a id="kind-6153e0"></a>• [`kind`](#kind-6153e0) - 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')
|
|
187
185
|
|
|
188
|
-
|
|
186
|
+
<a id="name-3c4742"></a>• [`name`](#name-3c4742) - 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
|
|
189
187
|
|
|
190
|
-
|
|
188
|
+
<a id="namespace-f39f97"></a>• [`namespace`](#namespace-f39f97) - 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
|
|
191
189
|
|
|
192
|
-
<a id="
|
|
190
|
+
<a id="tenant-5557c0"></a>• [`tenant`](#tenant-5557c0) - 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
|
|
193
191
|
|
|
194
|
-
<a id="
|
|
192
|
+
<a id="uid-b4cc26"></a>• [`uid`](#uid-b4cc26) - 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
|
|
195
193
|
|
|
196
|
-
####
|
|
194
|
+
#### Rules Egress Rules Label Matcher
|
|
197
195
|
|
|
198
|
-
|
|
196
|
+
A [`label_matcher`](#rules-egress-rules-label-matcher) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
199
197
|
|
|
200
|
-
<a id="
|
|
198
|
+
<a id="rules-egress-rules-label-matcher-keys"></a>• [`keys`](#rules-egress-rules-label-matcher-keys) - Optional List<br>The list of label key names that have to match
|
|
201
199
|
|
|
202
|
-
|
|
200
|
+
#### Rules Egress Rules Label Selector
|
|
203
201
|
|
|
204
|
-
|
|
202
|
+
A [`label_selector`](#rules-egress-rules-label-selector) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
205
203
|
|
|
206
|
-
<a id="
|
|
204
|
+
<a id="expressions-d57cba"></a>• [`expressions`](#expressions-d57cba) - Optional List<br>Expressions contains the Kubernetes style label expression for selections
|
|
207
205
|
|
|
208
|
-
|
|
206
|
+
#### Rules Egress Rules Metadata
|
|
209
207
|
|
|
210
|
-
|
|
208
|
+
A [`metadata`](#rules-egress-rules-metadata) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
211
209
|
|
|
212
|
-
|
|
210
|
+
<a id="spec-6fe394"></a>• [`description_spec`](#spec-6fe394) - Optional String<br>Description. Human readable description
|
|
213
211
|
|
|
214
|
-
<a id="
|
|
212
|
+
<a id="rules-egress-rules-metadata-name"></a>• [`name`](#rules-egress-rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
215
213
|
|
|
216
|
-
####
|
|
214
|
+
#### Rules Egress Rules Prefix List
|
|
217
215
|
|
|
218
|
-
A [`prefix_list`](#
|
|
216
|
+
A [`prefix_list`](#rules-egress-rules-prefix-list) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
219
217
|
|
|
220
|
-
<a id="
|
|
218
|
+
<a id="rules-egress-rules-prefix-list-prefixes"></a>• [`prefixes`](#rules-egress-rules-prefix-list-prefixes) - Optional List<br>List of IPv4 prefixes that represent an endpoint
|
|
219
|
+
|
|
220
|
+
#### Rules Egress Rules Protocol Port Range
|
|
221
|
+
|
|
222
|
+
A [`protocol_port_range`](#rules-egress-rules-protocol-port-range) block (within [`rules.egress_rules`](#rules-egress-rules)) supports the following:
|
|
223
|
+
|
|
224
|
+
<a id="ranges-ffb05a"></a>• [`port_ranges`](#ranges-ffb05a) - Optional List<br>List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192
|
|
225
|
+
|
|
226
|
+
<a id="protocol-77c4d7"></a>• [`protocol`](#protocol-77c4d7) - Optional String<br>Protocol in IP packet to be used as match criteria Values are TCP, UDP, and ICMP
|
|
221
227
|
|
|
222
|
-
#### Ingress Rules
|
|
228
|
+
#### Rules Ingress Rules
|
|
223
229
|
|
|
224
|
-
An [`ingress_rules`](#ingress-rules) block supports the following:
|
|
230
|
+
An [`ingress_rules`](#rules-ingress-rules) block (within [`rules`](#rules)) supports the following:
|
|
225
231
|
|
|
226
|
-
<a id="ingress-rules-action"></a>• [`action`](#ingress-rules-action) - Optional String Defaults to `DENY`<br>Possible values are `DENY`, `ALLOW`<br>[Enum: DENY|ALLOW] Network policy rule action configures the action to be taken on rule match Apply deny action on rule match Apply allow action on rule match
|
|
232
|
+
<a id="rules-ingress-rules-action"></a>• [`action`](#rules-ingress-rules-action) - Optional String Defaults to `DENY`<br>Possible values are `DENY`, `ALLOW`<br>[Enum: DENY|ALLOW] Network policy rule action configures the action to be taken on rule match Apply deny action on rule match Apply allow action on rule match
|
|
227
233
|
|
|
228
|
-
<a id="ingress-rules-adv-action"></a>• [`adv_action`](#ingress-rules-adv-action) - Optional Block<br>Network Policy Rule Advanced Action provides additional OPTIONS along with RuleAction and PBRRuleAction<br>See [Adv Action](#ingress-rules-adv-action) below.
|
|
234
|
+
<a id="rules-ingress-rules-adv-action"></a>• [`adv_action`](#rules-ingress-rules-adv-action) - Optional Block<br>Network Policy Rule Advanced Action provides additional OPTIONS along with RuleAction and PBRRuleAction<br>See [Adv Action](#rules-ingress-rules-adv-action) below.
|
|
229
235
|
|
|
230
|
-
<a id="ingress-rules-all-tcp-traffic"></a>• [`all_tcp_traffic`](#ingress-rules-all-tcp-traffic) - Optional Block<br>Enable this option
|
|
236
|
+
<a id="rules-ingress-rules-all-tcp-traffic"></a>• [`all_tcp_traffic`](#rules-ingress-rules-all-tcp-traffic) - Optional Block<br>Enable this option
|
|
231
237
|
|
|
232
|
-
<a id="ingress-rules-all-traffic"></a>• [`all_traffic`](#ingress-rules-all-traffic) - Optional Block<br>Enable this option
|
|
238
|
+
<a id="rules-ingress-rules-all-traffic"></a>• [`all_traffic`](#rules-ingress-rules-all-traffic) - Optional Block<br>Enable this option
|
|
233
239
|
|
|
234
|
-
<a id="ingress-rules-all-udp-traffic"></a>• [`all_udp_traffic`](#ingress-rules-all-udp-traffic) - Optional Block<br>Enable this option
|
|
240
|
+
<a id="rules-ingress-rules-all-udp-traffic"></a>• [`all_udp_traffic`](#rules-ingress-rules-all-udp-traffic) - Optional Block<br>Enable this option
|
|
235
241
|
|
|
236
|
-
<a id="ingress-rules-any"></a>• [`any`](#ingress-rules-any) - Optional Block<br>Enable this option
|
|
242
|
+
<a id="rules-ingress-rules-any"></a>• [`any`](#rules-ingress-rules-any) - Optional Block<br>Enable this option
|
|
237
243
|
|
|
238
|
-
<a id="ingress-rules-applications"></a>• [`applications`](#ingress-rules-applications) - Optional Block<br>Applications. Application protocols like HTTP, SNMP<br>See [Applications](#ingress-rules-applications) below.
|
|
244
|
+
<a id="rules-ingress-rules-applications"></a>• [`applications`](#rules-ingress-rules-applications) - Optional Block<br>Applications. Application protocols like HTTP, SNMP<br>See [Applications](#rules-ingress-rules-applications) below.
|
|
239
245
|
|
|
240
|
-
<a id="ingress-rules-inside-endpoints"></a>• [`inside_endpoints`](#ingress-rules-inside-endpoints) - Optional Block<br>Enable this option
|
|
246
|
+
<a id="rules-ingress-rules-inside-endpoints"></a>• [`inside_endpoints`](#rules-ingress-rules-inside-endpoints) - Optional Block<br>Enable this option
|
|
241
247
|
|
|
242
|
-
<a id="ingress-rules-ip-prefix-set"></a>• [`ip_prefix_set`](#ingress-rules-ip-prefix-set) - Optional Block<br>List of references to ip_prefix_set objects<br>See [IP Prefix Set](#ingress-rules-ip-prefix-set) below.
|
|
248
|
+
<a id="rules-ingress-rules-ip-prefix-set"></a>• [`ip_prefix_set`](#rules-ingress-rules-ip-prefix-set) - Optional Block<br>List of references to ip_prefix_set objects<br>See [IP Prefix Set](#rules-ingress-rules-ip-prefix-set) below.
|
|
243
249
|
|
|
244
|
-
<a id="ingress-rules-label-matcher"></a>• [`label_matcher`](#ingress-rules-label-matcher) - Optional Block<br>Label matcher specifies a list of label keys whose values need to match for source/client and destination/server. Note that the actual label values are not specified and do not matter. This allows an ability to scope grouping by the label key name<br>See [Label Matcher](#ingress-rules-label-matcher) below.
|
|
250
|
+
<a id="rules-ingress-rules-label-matcher"></a>• [`label_matcher`](#rules-ingress-rules-label-matcher) - Optional Block<br>Label matcher specifies a list of label keys whose values need to match for source/client and destination/server. Note that the actual label values are not specified and do not matter. This allows an ability to scope grouping by the label key name<br>See [Label Matcher](#rules-ingress-rules-label-matcher) below.
|
|
245
251
|
|
|
246
|
-
<a id="ingress-rules-label-selector"></a>• [`label_selector`](#ingress-rules-label-selector) - Optional Block<br>Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects<br>See [Label Selector](#ingress-rules-label-selector) below.
|
|
252
|
+
<a id="rules-ingress-rules-label-selector"></a>• [`label_selector`](#rules-ingress-rules-label-selector) - Optional Block<br>Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects<br>See [Label Selector](#rules-ingress-rules-label-selector) below.
|
|
247
253
|
|
|
248
|
-
<a id="ingress-rules-metadata"></a>• [`metadata`](#ingress-rules-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#ingress-rules-metadata) below.
|
|
254
|
+
<a id="rules-ingress-rules-metadata"></a>• [`metadata`](#rules-ingress-rules-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#rules-ingress-rules-metadata) below.
|
|
249
255
|
|
|
250
|
-
<a id="ingress-rules-outside-endpoints"></a>• [`outside_endpoints`](#ingress-rules-outside-endpoints) - Optional Block<br>Enable this option
|
|
256
|
+
<a id="rules-ingress-rules-outside-endpoints"></a>• [`outside_endpoints`](#rules-ingress-rules-outside-endpoints) - Optional Block<br>Enable this option
|
|
251
257
|
|
|
252
|
-
<a id="ingress-rules-prefix-list"></a>• [`prefix_list`](#ingress-rules-prefix-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Prefix List](#ingress-rules-prefix-list) below.
|
|
258
|
+
<a id="rules-ingress-rules-prefix-list"></a>• [`prefix_list`](#rules-ingress-rules-prefix-list) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Prefix List](#rules-ingress-rules-prefix-list) below.
|
|
253
259
|
|
|
254
|
-
<a id="ingress-rules-protocol-port-range"></a>• [`protocol_port_range`](#ingress-rules-protocol-port-range) - Optional Block<br>Protocol and Port. Protocol and Port ranges<br>See [Protocol Port Range](#ingress-rules-protocol-port-range) below.
|
|
260
|
+
<a id="rules-ingress-rules-protocol-port-range"></a>• [`protocol_port_range`](#rules-ingress-rules-protocol-port-range) - Optional Block<br>Protocol and Port. Protocol and Port ranges<br>See [Protocol Port Range](#rules-ingress-rules-protocol-port-range) below.
|
|
255
261
|
|
|
256
|
-
#### Ingress Rules Adv Action
|
|
262
|
+
#### Rules Ingress Rules Adv Action
|
|
257
263
|
|
|
258
|
-
An [`adv_action`](#ingress-rules-adv-action) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
264
|
+
An [`adv_action`](#rules-ingress-rules-adv-action) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
259
265
|
|
|
260
|
-
<a id="ingress-rules-adv-action-action"></a>• [`action`](#ingress-rules-adv-action-action) - Optional String Defaults to `NOLOG`<br>Possible values are `NOLOG`, `LOG`<br>[Enum: NOLOG|LOG] Choice to choose logging or no logging This works together with option selected via NetworkPolicyRuleAction or any other action specified x-
|
|
266
|
+
<a id="rules-ingress-rules-adv-action-action"></a>• [`action`](#rules-ingress-rules-adv-action-action) - Optional String Defaults to `NOLOG`<br>Possible values are `NOLOG`, `LOG`<br>[Enum: NOLOG|LOG] Choice to choose logging or no logging This works together with option selected via NetworkPolicyRuleAction or any other action specified x-
|
|
261
267
|
|
|
262
|
-
#### Ingress Rules Applications
|
|
268
|
+
#### Rules Ingress Rules Applications
|
|
263
269
|
|
|
264
|
-
An [`applications`](#ingress-rules-applications) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
270
|
+
An [`applications`](#rules-ingress-rules-applications) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
265
271
|
|
|
266
|
-
<a id="
|
|
272
|
+
<a id="applications-ada048"></a>• [`applications`](#applications-ada048) - Optional List Defaults to `APPLICATION_HTTP`<br>Possible values are `APPLICATION_HTTP`, `APPLICATION_HTTPS`, `APPLICATION_SNMP`, `APPLICATION_DNS`<br>[Enum: APPLICATION_HTTP|APPLICATION_HTTPS|APPLICATION_SNMP|APPLICATION_DNS] Application Protocols. Application protocols like HTTP, SNMP
|
|
267
273
|
|
|
268
|
-
#### Ingress Rules IP Prefix Set
|
|
274
|
+
#### Rules Ingress Rules IP Prefix Set
|
|
269
275
|
|
|
270
|
-
An [`ip_prefix_set`](#ingress-rules-ip-prefix-set) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
276
|
+
An [`ip_prefix_set`](#rules-ingress-rules-ip-prefix-set) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
271
277
|
|
|
272
|
-
<a id="ingress-rules-ip-prefix-set-ref"></a>• [`ref`](#ingress-rules-ip-prefix-set-ref) - Optional Block<br>List of references to ip_prefix_set objects<br>See [Ref](#ingress-rules-ip-prefix-set-ref) below.
|
|
278
|
+
<a id="rules-ingress-rules-ip-prefix-set-ref"></a>• [`ref`](#rules-ingress-rules-ip-prefix-set-ref) - Optional Block<br>List of references to ip_prefix_set objects<br>See [Ref](#rules-ingress-rules-ip-prefix-set-ref) below.
|
|
273
279
|
|
|
274
|
-
#### Ingress Rules IP Prefix Set Ref
|
|
280
|
+
#### Rules Ingress Rules IP Prefix Set Ref
|
|
275
281
|
|
|
276
|
-
A [`ref`](#ingress-rules-ip-prefix-set-ref) block (within [`ingress_rules.ip_prefix_set`](#ingress-rules-ip-prefix-set)) supports the following:
|
|
282
|
+
A [`ref`](#rules-ingress-rules-ip-prefix-set-ref) block (within [`rules.ingress_rules.ip_prefix_set`](#rules-ingress-rules-ip-prefix-set)) supports the following:
|
|
277
283
|
|
|
278
|
-
<a id="
|
|
284
|
+
<a id="kind-3a83c1"></a>• [`kind`](#kind-3a83c1) - 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')
|
|
279
285
|
|
|
280
|
-
<a id="
|
|
286
|
+
<a id="name-c9035f"></a>• [`name`](#name-c9035f) - 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
|
|
281
287
|
|
|
282
|
-
<a id="namespace-
|
|
288
|
+
<a id="namespace-0b6e5e"></a>• [`namespace`](#namespace-0b6e5e) - 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
|
|
283
289
|
|
|
284
|
-
<a id="
|
|
290
|
+
<a id="tenant-b81c73"></a>• [`tenant`](#tenant-b81c73) - 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
|
|
285
291
|
|
|
286
|
-
<a id="
|
|
292
|
+
<a id="uid-0be2c4"></a>• [`uid`](#uid-0be2c4) - 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
|
|
287
293
|
|
|
288
|
-
#### Ingress Rules Label Matcher
|
|
294
|
+
#### Rules Ingress Rules Label Matcher
|
|
289
295
|
|
|
290
|
-
A [`label_matcher`](#ingress-rules-label-matcher) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
296
|
+
A [`label_matcher`](#rules-ingress-rules-label-matcher) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
291
297
|
|
|
292
|
-
<a id="ingress-rules-label-matcher-keys"></a>• [`keys`](#ingress-rules-label-matcher-keys) - Optional List<br>The list of label key names that have to match
|
|
298
|
+
<a id="rules-ingress-rules-label-matcher-keys"></a>• [`keys`](#rules-ingress-rules-label-matcher-keys) - Optional List<br>The list of label key names that have to match
|
|
293
299
|
|
|
294
|
-
#### Ingress Rules Label Selector
|
|
300
|
+
#### Rules Ingress Rules Label Selector
|
|
295
301
|
|
|
296
|
-
A [`label_selector`](#ingress-rules-label-selector) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
302
|
+
A [`label_selector`](#rules-ingress-rules-label-selector) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
297
303
|
|
|
298
|
-
<a id="expressions-
|
|
304
|
+
<a id="expressions-151d69"></a>• [`expressions`](#expressions-151d69) - Optional List<br>Expressions contains the Kubernetes style label expression for selections
|
|
299
305
|
|
|
300
|
-
#### Ingress Rules Metadata
|
|
306
|
+
#### Rules Ingress Rules Metadata
|
|
301
307
|
|
|
302
|
-
A [`metadata`](#ingress-rules-metadata) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
308
|
+
A [`metadata`](#rules-ingress-rules-metadata) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
303
309
|
|
|
304
|
-
<a id="
|
|
310
|
+
<a id="spec-3d4978"></a>• [`description_spec`](#spec-3d4978) - Optional String<br>Description. Human readable description
|
|
305
311
|
|
|
306
|
-
<a id="ingress-rules-metadata-name"></a>• [`name`](#ingress-rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
312
|
+
<a id="rules-ingress-rules-metadata-name"></a>• [`name`](#rules-ingress-rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
307
313
|
|
|
308
|
-
#### Ingress Rules Prefix List
|
|
314
|
+
#### Rules Ingress Rules Prefix List
|
|
309
315
|
|
|
310
|
-
A [`prefix_list`](#ingress-rules-prefix-list) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
316
|
+
A [`prefix_list`](#rules-ingress-rules-prefix-list) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
311
317
|
|
|
312
|
-
<a id="
|
|
318
|
+
<a id="prefixes-89e9a7"></a>• [`prefixes`](#prefixes-89e9a7) - Optional List<br>List of IPv4 prefixes that represent an endpoint
|
|
313
319
|
|
|
314
|
-
#### Ingress Rules Protocol Port Range
|
|
320
|
+
#### Rules Ingress Rules Protocol Port Range
|
|
315
321
|
|
|
316
|
-
A [`protocol_port_range`](#ingress-rules-protocol-port-range) block (within [`ingress_rules`](#ingress-rules)) supports the following:
|
|
322
|
+
A [`protocol_port_range`](#rules-ingress-rules-protocol-port-range) block (within [`rules.ingress_rules`](#rules-ingress-rules)) supports the following:
|
|
317
323
|
|
|
318
|
-
<a id="ranges-
|
|
324
|
+
<a id="ranges-86d162"></a>• [`port_ranges`](#ranges-86d162) - Optional List<br>List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192
|
|
319
325
|
|
|
320
|
-
<a id="protocol-
|
|
326
|
+
<a id="protocol-a45394"></a>• [`protocol`](#protocol-a45394) - Optional String<br>Protocol in IP packet to be used as match criteria Values are TCP, UDP, and ICMP
|
|
321
327
|
|
|
322
328
|
#### Timeouts
|
|
323
329
|
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_policer Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Service Mesh"
|
|
4
4
|
description: |-
|
|
5
|
-
Manages
|
|
5
|
+
Manages new policer with traffic rate limits. in F5 Distributed Cloud.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_policer (Resource)
|
|
9
9
|
|
|
10
|
-
Manages
|
|
10
|
+
Manages new policer with traffic rate limits. in F5 Distributed Cloud.
|
|
11
11
|
|
|
12
12
|
~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Manages protocol_policer object, protocol_policer object contains list of L4 pro
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Policer Resource Example
|
|
18
|
-
# Manages
|
|
18
|
+
# Manages new policer with traffic rate limits. in F5 Distributed Cloud.
|
|
19
19
|
|
|
20
20
|
# Basic Policer configuration
|
|
21
21
|
resource "f5xc_policer" "example" {
|
|
@@ -57,7 +57,13 @@ resource "f5xc_policer" "example" {
|
|
|
57
57
|
|
|
58
58
|
### Spec Argument Reference
|
|
59
59
|
|
|
60
|
-
<a id="
|
|
60
|
+
<a id="burst-size"></a>• [`burst_size`](#burst-size) - Optional Number<br>The maximum size permitted for bursts of data. E.g. 10000 pps burst
|
|
61
|
+
|
|
62
|
+
<a id="committed-information-rate"></a>• [`committed_information_rate`](#committed-information-rate) - Optional Number<br>The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions. E.g. 10000 pps
|
|
63
|
+
|
|
64
|
+
<a id="policer-mode"></a>• [`policer_mode`](#policer-mode) - Optional String Defaults to `POLICER_MODE_NOT_SHARED`<br>Possible values are `POLICER_MODE_NOT_SHARED`, `POLICER_MODE_SHARED`<br>[Enum: POLICER_MODE_NOT_SHARED|POLICER_MODE_SHARED] - POLICER_MODE_NOT_SHARED: Not Shared A separate policer instance is created for each reference to the policer - POLICER_MODE_SHARED: Shared A common policer instance is used for for all references to the policer
|
|
65
|
+
|
|
66
|
+
<a id="policer-type"></a>• [`policer_type`](#policer-type) - Optional String Defaults to `POLICER_SINGLE_RATE_TWO_COLOR`<br>[Enum: POLICER_SINGLE_RATE_TWO_COLOR] Specifies the type of Policer Basic Single-Rate Two-Color Policer. The only possible value is `POLICER_SINGLE_RATE_TWO_COLOR`
|
|
61
67
|
|
|
62
68
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
63
69
|
|
|
@@ -69,52 +75,6 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
69
75
|
|
|
70
76
|
---
|
|
71
77
|
|
|
72
|
-
#### Protocol Policer
|
|
73
|
-
|
|
74
|
-
A [`protocol_policer`](#protocol-policer) block supports the following:
|
|
75
|
-
|
|
76
|
-
<a id="protocol-policer-policer"></a>• [`policer`](#protocol-policer-policer) - Optional Block<br>Reference to policer object to apply traffic rate limits<br>See [Policer](#protocol-policer-policer) below.
|
|
77
|
-
|
|
78
|
-
<a id="protocol-policer-protocol"></a>• [`protocol`](#protocol-policer-protocol) - Optional Block<br>Protocol and protocol specific flags to be matched in packet<br>See [Protocol](#protocol-policer-protocol) below.
|
|
79
|
-
|
|
80
|
-
#### Protocol Policer Policer
|
|
81
|
-
|
|
82
|
-
A [`policer`](#protocol-policer-policer) block (within [`protocol_policer`](#protocol-policer)) supports the following:
|
|
83
|
-
|
|
84
|
-
<a id="protocol-policer-policer-kind"></a>• [`kind`](#protocol-policer-policer-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')
|
|
85
|
-
|
|
86
|
-
<a id="protocol-policer-policer-name"></a>• [`name`](#protocol-policer-policer-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
|
|
87
|
-
|
|
88
|
-
<a id="protocol-policer-policer-namespace"></a>• [`namespace`](#protocol-policer-policer-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
|
|
89
|
-
|
|
90
|
-
<a id="protocol-policer-policer-tenant"></a>• [`tenant`](#protocol-policer-policer-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
|
|
91
|
-
|
|
92
|
-
<a id="protocol-policer-policer-uid"></a>• [`uid`](#protocol-policer-policer-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
|
|
93
|
-
|
|
94
|
-
#### Protocol Policer Protocol
|
|
95
|
-
|
|
96
|
-
A [`protocol`](#protocol-policer-protocol) block (within [`protocol_policer`](#protocol-policer)) supports the following:
|
|
97
|
-
|
|
98
|
-
<a id="protocol-policer-protocol-dns"></a>• [`dns`](#protocol-policer-protocol-dns) - Optional Block<br>Match all DNS packets inclusing UDP and TCP
|
|
99
|
-
|
|
100
|
-
<a id="protocol-policer-protocol-icmp"></a>• [`icmp`](#protocol-policer-protocol-icmp) - Optional Block<br>ICMP Packet Type. ICMP message type to match in packet<br>See [ICMP](#protocol-policer-protocol-icmp) below.
|
|
101
|
-
|
|
102
|
-
<a id="protocol-policer-protocol-tcp"></a>• [`tcp`](#protocol-policer-protocol-tcp) - Optional Block<br>Specification of TCP flag to be matched in a TCP packet<br>See [TCP](#protocol-policer-protocol-tcp) below.
|
|
103
|
-
|
|
104
|
-
<a id="protocol-policer-protocol-udp"></a>• [`udp`](#protocol-policer-protocol-udp) - Optional Block<br>UDP Packets. Match all UDP packets
|
|
105
|
-
|
|
106
|
-
#### Protocol Policer Protocol ICMP
|
|
107
|
-
|
|
108
|
-
An [`icmp`](#protocol-policer-protocol-icmp) block (within [`protocol_policer.protocol`](#protocol-policer-protocol)) supports the following:
|
|
109
|
-
|
|
110
|
-
<a id="protocol-policer-protocol-icmp-type"></a>• [`type`](#protocol-policer-protocol-icmp-type) - Optional List Defaults to `ECHO_REPLY`<br>Possible values are `ECHO_REPLY`, `ECHO_REQUEST`, `ALL_ICMP_MSG`<br>[Enum: ECHO_REPLY|ECHO_REQUEST|ALL_ICMP_MSG] ICMP message type to be matched in packet
|
|
111
|
-
|
|
112
|
-
#### Protocol Policer Protocol TCP
|
|
113
|
-
|
|
114
|
-
A [`tcp`](#protocol-policer-protocol-tcp) block (within [`protocol_policer.protocol`](#protocol-policer-protocol)) supports the following:
|
|
115
|
-
|
|
116
|
-
<a id="protocol-policer-protocol-tcp-flags"></a>• [`flags`](#protocol-policer-protocol-tcp-flags) - Optional List Defaults to `FIN`<br>Possible values are `FIN`, `SYN`, `RST`, `PSH`, `ACK`, `URG`, `ALL_TCP_FLAGS`, `KEEPALIVE`<br>[Enum: FIN|SYN|RST|PSH|ACK|URG|ALL_TCP_FLAGS|KEEPALIVE] TCP flags. TCP flag to be matched in a TCP packet
|
|
117
|
-
|
|
118
78
|
#### Timeouts
|
|
119
79
|
|
|
120
80
|
A [`timeouts`](#timeouts) block supports the following:
|