Skip to content

Commit

Permalink
Update descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
rchrabas committed Jan 8, 2025
1 parent 884061e commit 86968a2
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 111 deletions.
44 changes: 22 additions & 22 deletions docs/data-sources/prefilter_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ data "fmc_prefilter_policy" "example" {

- `domain` (String) The name of the FMC domain
- `id` (String) The id of the object
- `name` (String) The name of the prefilter policy.
- `name` (String) Name of the prefilter policy.

### Read-Only

- `default_action` (String) Specifies the default action to take when none of the rules meet the conditions.
- `default_action_id` (String) Default action ID
- `default_action_log_begin` (Boolean) Indicating whether the device will log events at the beginning of the connection.
- `default_action_log_end` (Boolean) Indicating whether the device will log events at the end of the connection.
- `default_action_send_events_to_fmc` (Boolean) Indicating whether the device will send events to the Firepower Management Center event viewer.
- `default_action_log_begin` (Boolean) Log events at the beginning of the connection.
- `default_action_log_end` (Boolean) Log events at the end of the connection.
- `default_action_send_events_to_fmc` (Boolean) Send events to the Firepower Management Center event viewer.
- `default_action_snmp_config_id` (String) UUID of the SNMP alert. Can be set only when either default_action_log_begin or default_action_log_end is true.
- `default_action_syslog_config_id` (String) UUID of the syslog config. Can be set only when either default_action_log_begin or default_action_log_end is true.
- `description` (String) Policy description.
Expand All @@ -49,30 +49,30 @@ Read-Only:
- `bidirectional` (Boolean) Indicates whether the rule is bidirectional. Can be true only for TUNNEL rules. Default is false.
- `destination_interfaces` (Attributes Set) Set of objects that represent destination interfaces. (see [below for nested schema](#nestedatt--rules--destination_interfaces))
- `destination_network_literals` (Attributes Set) Set of objects that represent destinations of traffic (literally specified). (see [below for nested schema](#nestedatt--rules--destination_network_literals))
- `destination_network_objects` (Attributes Set) Set of objects that represent destinations of traffic (fmc_network, fmc_host, ...). (see [below for nested schema](#nestedatt--rules--destination_network_objects))
- `destination_network_objects` (Attributes Set) Set of objects that represent destinations of traffic (Networks, Hosts, Ranges or Network Groups). (see [below for nested schema](#nestedatt--rules--destination_network_objects))
- `destination_port_literals` (Attributes Set) Set of objects that represent protocol/port (literally specified). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--destination_port_literals))
- `destination_port_objects` (Attributes Set) Set of objects representing destination ports associated with the rule (fmc_port or fmc_port_group). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--destination_port_objects))
- `destination_port_objects` (Attributes Set) Set of objects representing destination ports associated with the rule (Port or Port Groups). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--destination_port_objects))
- `enabled` (Boolean) Indicates whether the prefilter rule is in effect (true) or not (false). Default is true.
- `encapsulation_ports` (Set of String) List of encapsulation ports to be used.
- `id` (String) The id of the prefilter rule.
- `log_begin` (Boolean) Indicates whether the device will log events at the beginning of the connection. Default is false.
- `log_end` (Boolean) Indicates whether the device will log events at the end of the connection. Default is false.
- `id` (String) Id of the prefilter rule.
- `log_begin` (Boolean) Log events at the beginning of the connection. Default is false.
- `log_end` (Boolean) Log events at the end of the connection. Default is false.
- `name` (String) Name of the rule.
- `rule_type` (String) Indicates whether the rule is PREFILTER rule or TUNNEL rule. At least one Encapsulation Port Object (encapsulation_ports) is mandatory to be specified for TUNNEL Rules.
- `send_events_to_fmc` (Boolean) Indicates whether the device will send events to the Firepower Management Center event viewer. Default is false.
- `send_syslog` (Boolean) Indicates whether the alerts associated with the prefilter rule are sent to default syslog configuration in Prefilter Logging. Default is false.
- `rule_type` (String) Type of the rule. At least one Encapsulation Port Object (encapsulation_ports) is mandatory to be specified for TUNNEL Rules.
- `send_events_to_fmc` (Boolean) Send events to the Firepower Management Center event viewer. Default is false.
- `send_syslog` (Boolean) Send alerts associated with the prefilter rule to default syslog configuration in Prefilter Logging. Default is false.
- `snmp_config_id` (String) UUID of the SNMP alert associated with the prefilter rule. Can be set only when either log_begin or log_end is true.
- `source_interfaces` (Attributes Set) Set of objects that represent source interfaces. (see [below for nested schema](#nestedatt--rules--source_interfaces))
- `source_network_literals` (Attributes Set) Set of objects that represent sources of traffic (literally specified). (see [below for nested schema](#nestedatt--rules--source_network_literals))
- `source_network_objects` (Attributes Set) Set of objects that represent sources of traffic (fmc_network, fmc_host, ...). (see [below for nested schema](#nestedatt--rules--source_network_objects))
- `source_network_objects` (Attributes Set) Set of objects that represent sources of traffic (Networks, Hosts, Ranges or Network Groups). (see [below for nested schema](#nestedatt--rules--source_network_objects))
- `source_port_literals` (Attributes Set) Set of objects that represent protocol/port (literally specified). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--source_port_literals))
- `source_port_objects` (Attributes Set) Set of objects representing source ports associated with the rule (fmc_port or fmc_port_group). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--source_port_objects))
- `source_port_objects` (Attributes Set) Set of objects representing source ports associated with the rule (Port or Port Groups). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--source_port_objects))
- `syslog_config_id` (String) UUID of the syslog config. Can be set only when send_syslog is true and either log_begin or log_end is true. If not set, the default policy syslog configuration in Access Control Logging applies.
- `syslog_severity` (String) Override the Severity of syslog alerts.
- `time_range_id` (String) UUID of Time Range.
- `time_range_id` (String) UUID of Time Range object applied to the rule.
- `tunnel_zone_id` (String) UUID of Tunnel Zone. Can be only set for TUNNEL rules with ANALYZE action.
- `vlan_tag_literals` (Attributes Set) Set of objects that represent vlan tags (literally specified). (see [below for nested schema](#nestedatt--rules--vlan_tag_literals))
- `vlan_tag_objects` (Attributes Set) Set of objects representing vlan tags (fmc_vlan_tag, fmc_vlan_tag_group, ...). (see [below for nested schema](#nestedatt--rules--vlan_tag_objects))
- `vlan_tag_objects` (Attributes Set) Set of objects representing vlan tags or vlan tag groups (see [below for nested schema](#nestedatt--rules--vlan_tag_objects))

<a id="nestedatt--rules--destination_interfaces"></a>
### Nested Schema for `rules.destination_interfaces`
Expand All @@ -96,8 +96,8 @@ Read-Only:

Read-Only:

- `id` (String) UUID of the object (such as fmc_network.example.id, etc.).
- `type` (String) Type of the object (such as fmc_network.example.type, etc.).
- `id` (String) UUID of the object.
- `type` (String) Type of the object


<a id="nestedatt--rules--destination_port_literals"></a>
Expand All @@ -114,7 +114,7 @@ Read-Only:

Read-Only:

- `id` (String) UUID of the object (such as fmc_port.example.id, fmc_port_group.example.id, ...).
- `id` (String) UUID of the object.


<a id="nestedatt--rules--source_interfaces"></a>
Expand All @@ -139,8 +139,8 @@ Read-Only:

Read-Only:

- `id` (String) UUID of the object (such as fmc_network.example.id, etc.).
- `type` (String) Type of the object (such as fmc_network.example.type, etc.).
- `id` (String) UUID of the object
- `type` (String) Type of the object


<a id="nestedatt--rules--source_port_literals"></a>
Expand All @@ -157,7 +157,7 @@ Read-Only:

Read-Only:

- `id` (String) UUID of the object (such as fmc_port.example.id, fmc_port_group.example.id, ...).
- `id` (String) UUID of the object.


<a id="nestedatt--rules--vlan_tag_literals"></a>
Expand Down
44 changes: 22 additions & 22 deletions docs/resources/prefilter_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,13 @@ resource "fmc_prefilter_policy" "example" {

- `default_action` (String) Specifies the default action to take when none of the rules meet the conditions.
- Choices: `BLOCK_TUNNELS`, `ANALYZE_TUNNELS`
- `name` (String) The name of the prefilter policy.
- `name` (String) Name of the prefilter policy.

### Optional

- `default_action_log_begin` (Boolean) Indicating whether the device will log events at the beginning of the connection.
- `default_action_log_end` (Boolean) Indicating whether the device will log events at the end of the connection.
- `default_action_send_events_to_fmc` (Boolean) Indicating whether the device will send events to the Firepower Management Center event viewer.
- `default_action_log_begin` (Boolean) Log events at the beginning of the connection.
- `default_action_log_end` (Boolean) Log events at the end of the connection.
- `default_action_send_events_to_fmc` (Boolean) Send events to the Firepower Management Center event viewer.
- `default_action_snmp_config_id` (String) UUID of the SNMP alert. Can be set only when either default_action_log_begin or default_action_log_end is true.
- `default_action_syslog_config_id` (String) UUID of the syslog config. Can be set only when either default_action_log_begin or default_action_log_end is true.
- `description` (String) Policy description.
Expand All @@ -144,42 +144,42 @@ Required:
- `action` (String) What to do when the conditions defined by the rule are met.
- Choices: `FASTPATH`, `ANALYZE`, `BLOCK`
- `name` (String) Name of the rule.
- `rule_type` (String) Indicates whether the rule is PREFILTER rule or TUNNEL rule. At least one Encapsulation Port Object (encapsulation_ports) is mandatory to be specified for TUNNEL Rules.
- `rule_type` (String) Type of the rule. At least one Encapsulation Port Object (encapsulation_ports) is mandatory to be specified for TUNNEL Rules.
- Choices: `PREFILTER`, `TUNNEL`

Optional:

- `bidirectional` (Boolean) Indicates whether the rule is bidirectional. Can be true only for TUNNEL rules. Default is false.
- `destination_interfaces` (Attributes Set) Set of objects that represent destination interfaces. (see [below for nested schema](#nestedatt--rules--destination_interfaces))
- `destination_network_literals` (Attributes Set) Set of objects that represent destinations of traffic (literally specified). (see [below for nested schema](#nestedatt--rules--destination_network_literals))
- `destination_network_objects` (Attributes Set) Set of objects that represent destinations of traffic (fmc_network, fmc_host, ...). (see [below for nested schema](#nestedatt--rules--destination_network_objects))
- `destination_network_objects` (Attributes Set) Set of objects that represent destinations of traffic (Networks, Hosts, Ranges or Network Groups). (see [below for nested schema](#nestedatt--rules--destination_network_objects))
- `destination_port_literals` (Attributes Set) Set of objects that represent protocol/port (literally specified). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--destination_port_literals))
- `destination_port_objects` (Attributes Set) Set of objects representing destination ports associated with the rule (fmc_port or fmc_port_group). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--destination_port_objects))
- `destination_port_objects` (Attributes Set) Set of objects representing destination ports associated with the rule (Port or Port Groups). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--destination_port_objects))
- `enabled` (Boolean) Indicates whether the prefilter rule is in effect (true) or not (false). Default is true.
- Default value: `true`
- `encapsulation_ports` (Set of String) List of encapsulation ports to be used.
- Choices: `GRE`, `IP_IN_IP`, `IPV6_IN_IP`, `TEREDO`
- `log_begin` (Boolean) Indicates whether the device will log events at the beginning of the connection. Default is false.
- `log_end` (Boolean) Indicates whether the device will log events at the end of the connection. Default is false.
- `send_events_to_fmc` (Boolean) Indicates whether the device will send events to the Firepower Management Center event viewer. Default is false.
- `send_syslog` (Boolean) Indicates whether the alerts associated with the prefilter rule are sent to default syslog configuration in Prefilter Logging. Default is false.
- `log_begin` (Boolean) Log events at the beginning of the connection. Default is false.
- `log_end` (Boolean) Log events at the end of the connection. Default is false.
- `send_events_to_fmc` (Boolean) Send events to the Firepower Management Center event viewer. Default is false.
- `send_syslog` (Boolean) Send alerts associated with the prefilter rule to default syslog configuration in Prefilter Logging. Default is false.
- `snmp_config_id` (String) UUID of the SNMP alert associated with the prefilter rule. Can be set only when either log_begin or log_end is true.
- `source_interfaces` (Attributes Set) Set of objects that represent source interfaces. (see [below for nested schema](#nestedatt--rules--source_interfaces))
- `source_network_literals` (Attributes Set) Set of objects that represent sources of traffic (literally specified). (see [below for nested schema](#nestedatt--rules--source_network_literals))
- `source_network_objects` (Attributes Set) Set of objects that represent sources of traffic (fmc_network, fmc_host, ...). (see [below for nested schema](#nestedatt--rules--source_network_objects))
- `source_network_objects` (Attributes Set) Set of objects that represent sources of traffic (Networks, Hosts, Ranges or Network Groups). (see [below for nested schema](#nestedatt--rules--source_network_objects))
- `source_port_literals` (Attributes Set) Set of objects that represent protocol/port (literally specified). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--source_port_literals))
- `source_port_objects` (Attributes Set) Set of objects representing source ports associated with the rule (fmc_port or fmc_port_group). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--source_port_objects))
- `source_port_objects` (Attributes Set) Set of objects representing source ports associated with the rule (Port or Port Groups). Can be only set for PREFILTER rules. (see [below for nested schema](#nestedatt--rules--source_port_objects))
- `syslog_config_id` (String) UUID of the syslog config. Can be set only when send_syslog is true and either log_begin or log_end is true. If not set, the default policy syslog configuration in Access Control Logging applies.
- `syslog_severity` (String) Override the Severity of syslog alerts.
- Choices: `ALERT`, `CRIT`, `DEBUG`, `EMERG`, `ERR`, `INFO`, `NOTICE`, `WARNING`
- `time_range_id` (String) UUID of Time Range.
- `time_range_id` (String) UUID of Time Range object applied to the rule.
- `tunnel_zone_id` (String) UUID of Tunnel Zone. Can be only set for TUNNEL rules with ANALYZE action.
- `vlan_tag_literals` (Attributes Set) Set of objects that represent vlan tags (literally specified). (see [below for nested schema](#nestedatt--rules--vlan_tag_literals))
- `vlan_tag_objects` (Attributes Set) Set of objects representing vlan tags (fmc_vlan_tag, fmc_vlan_tag_group, ...). (see [below for nested schema](#nestedatt--rules--vlan_tag_objects))
- `vlan_tag_objects` (Attributes Set) Set of objects representing vlan tags or vlan tag groups (see [below for nested schema](#nestedatt--rules--vlan_tag_objects))

Read-Only:

- `id` (String) The id of the prefilter rule.
- `id` (String) Id of the prefilter rule.

<a id="nestedatt--rules--destination_interfaces"></a>
### Nested Schema for `rules.destination_interfaces`
Expand All @@ -203,8 +203,8 @@ Optional:

Required:

- `id` (String) UUID of the object (such as fmc_network.example.id, etc.).
- `type` (String) Type of the object (such as fmc_network.example.type, etc.).
- `id` (String) UUID of the object.
- `type` (String) Type of the object


<a id="nestedatt--rules--destination_port_literals"></a>
Expand All @@ -224,7 +224,7 @@ Optional:

Optional:

- `id` (String) UUID of the object (such as fmc_port.example.id, fmc_port_group.example.id, ...).
- `id` (String) UUID of the object.


<a id="nestedatt--rules--source_interfaces"></a>
Expand All @@ -249,8 +249,8 @@ Optional:

Required:

- `id` (String) UUID of the object (such as fmc_network.example.id, etc.).
- `type` (String) Type of the object (such as fmc_network.example.type, etc.).
- `id` (String) UUID of the object
- `type` (String) Type of the object


<a id="nestedatt--rules--source_port_literals"></a>
Expand All @@ -270,7 +270,7 @@ Optional:

Optional:

- `id` (String) UUID of the object (such as fmc_port.example.id, fmc_port_group.example.id, ...).
- `id` (String) UUID of the object.


<a id="nestedatt--rules--vlan_tag_literals"></a>
Expand Down
Loading

0 comments on commit 86968a2

Please sign in to comment.