Skip to content

Commit bf37245

Browse files
danischmdanischm
committed
Doc category updates
1 parent 4ac7603 commit bf37245

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+121
-136
lines changed

‎docs/data-sources/access_control_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_access_control_policy Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Access Control Policy.
77
---

‎docs/data-sources/device_bfd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_bfd Data Source - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This data source reads the Device BFD.
77
The following restrictions apply:

‎docs/data-sources/device_cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_cluster Data Source - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This data source reads the Device Cluster.
77
---

‎docs/data-sources/device_ha_pair.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_ha_pair Data Source - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This data source reads the Device HA Pair.
77
---

‎docs/data-sources/device_ha_pair_monitoring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_ha_pair_monitoring Data Source - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This data source reads the Device HA Pair Monitoring.
77
---

‎docs/data-sources/file_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_file_policy Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the File Policy.
77
---

‎docs/data-sources/ftd_nat_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_ftd_nat_policy Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the FTD NAT Policy.
77
---

‎docs/data-sources/intrusion_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_intrusion_policy Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Intrusion Policy.
77
---

‎docs/data-sources/network_analysis_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_network_analysis_policy Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Network Analysis Policy.
77
---

‎docs/data-sources/policy_assignment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_policy_assignment Data Source - terraform-provider-fmc"
4-
subcategory: "Policy Assignments"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Policy Assignment.
77
---

‎docs/data-sources/prefilter_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_prefilter_policy Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Prefilter Policy.
77
---

‎docs/data-sources/snmp_alert.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_snmp_alert Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the SNMP Alert.
77
---

‎docs/data-sources/snmp_alerts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_snmp_alerts Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the SNMP Alerts.
77
---

‎docs/data-sources/syslog_alert.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_syslog_alert Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Syslog Alert.
77
---

‎docs/data-sources/syslog_alerts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_syslog_alerts Data Source - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This data source reads the Syslog Alerts.
77
---

‎docs/resources/access_control_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_access_control_policy Resource - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages Access Control Policy (ACP) with corresponding Access Rules and Categories.
77
---

‎docs/resources/device_bfd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_bfd Resource - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This resource manages a Device BFD.
77
The following restrictions apply:

‎docs/resources/device_cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_cluster Resource - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This device manages FTD Device Cluster configuration. This is resource may be re-designed in future releases.
77
---

‎docs/resources/device_ha_pair.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_ha_pair Resource - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This device manages FTD HA Pair configuration. This is resource may be re-designed in future releases.
77
---

‎docs/resources/device_ha_pair_monitoring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_device_ha_pair_monitoring Resource - terraform-provider-fmc"
4-
subcategory: "Device"
4+
subcategory: "Devices"
55
description: |-
66
This resource manages a Device HA Pair Monitoring.
77
---

‎docs/resources/file_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_file_policy Resource - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages File Policy with corresponding rules.
77
The following restrictions apply:

‎docs/resources/ftd_nat_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_ftd_nat_policy Resource - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages FTD Network Address Translation (NAT) policy with corresponding Manual and Auto NAT rules.
77
---

‎docs/resources/intrusion_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_intrusion_policy Resource - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages an Intrusion Policy.
77
---

‎docs/resources/network_analysis_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_network_analysis_policy Resource - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages a Network Analysis Policy.
77
---

‎docs/resources/policy_assignment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_policy_assignment Resource - terraform-provider-fmc"
4-
subcategory: "Policy Assignments"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages a Policy Assignment.
77
---

‎docs/resources/prefilter_policy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_prefilter_policy Resource - terraform-provider-fmc"
4-
subcategory: "Policy"
4+
subcategory: "Policies"
55
description: |-
66
This resource manages Prefilter Policy with corresponding rules.
77
---

‎docs/resources/smart_license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "fmc_smart_license Resource - terraform-provider-fmc"
4-
subcategory: "License"
4+
subcategory: "Licenses"
55
description: |-
66
This resource manages a Smart License.
77
---

‎gen/definitions/access_control_policy.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Access Control Policy
33
rest_endpoint: /api/fmc_config/v1/domain/{DOMAIN_UUID}/policy/accesspolicies
4-
doc_category: Policy
4+
doc_category: Policies
55
res_description: This resource manages Access Control Policy (ACP) with corresponding Access Rules and Categories.
66
attributes:
77
- model_name: name
@@ -71,9 +71,9 @@ attributes:
7171
tf_name: prefilter_policy_id
7272
type: String
7373
description: >-
74-
Id of the Prefilter Policy.
74+
Id of the Prefilter Policy.
7575
example: 35e197ca-33a8-11ef-b2d1-d98ae17766e7
76-
exclude_test: true
76+
exclude_test: true
7777
- model_name: syslogSeverity
7878
data_path: [defaultAction]
7979
tf_name: default_action_syslog_severity
@@ -627,7 +627,7 @@ attributes:
627627
type: String
628628
description: Id of Time Range object applied to the rule.
629629
example: 0050568A-7F57-0ed3-0000-004294975576
630-
exclude_test: true
630+
exclude_test: true
631631
- model_name: id
632632
data_path: [variableSet]
633633
tf_name: variable_set_id

‎gen/definitions/device_bfd.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Device BFD
33
rest_endpoint: /api/fmc_config/v1/domain/{DOMAIN_UUID}/devices/devicerecords/%v/routing/bfdpolicies
4-
doc_category: Device
5-
test_tags: [TF_VAR_device_id,TF_VAR_interface_name]
4+
doc_category: Devices
5+
test_tags: [TF_VAR_device_id, TF_VAR_interface_name]
66
minimum_version: "7.4"
77
skip_minimum_test: true
88
attributes:
@@ -16,11 +16,11 @@ attributes:
1616
type: String
1717
computed: true
1818
description: Type of the object; this value is always 'BFDPolicy'
19-
# General
19+
# General
2020
- model_name: hopType
2121
description: BFD Hop type.
2222
mandatory: true
23-
enum_values: [ SINGLE_HOP, MULTI_HOP ]
23+
enum_values: [SINGLE_HOP, MULTI_HOP]
2424
type: String
2525
example: SINGLE_HOP
2626
- model_name: id

‎gen/definitions/device_cluster.yaml

+25-25
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Device Cluster
33
rest_endpoint: /api/fmc_config/v1/domain/{DOMAIN_UUID}/deviceclusters/ftddevicecluster
4-
doc_category: Device
4+
doc_category: Devices
55
res_description: This device manages FTD Device Cluster configuration. This is resource may be re-designed in future releases.
66
test_tags: [TF_VAR_device_id, TF_VAR_device_interface_name]
77
attributes:
@@ -87,34 +87,34 @@ attributes:
8787
type: List
8888
description: List of data nodes where hardware needs to match the control node hardware.
8989
attributes:
90-
- model_name: id
91-
tf_name: data_node_device_id
92-
data_path: [deviceDetails]
93-
type: String
94-
mandatory: true
95-
description: Cluster Data Node device ID.
96-
example: 76d24097-41c4-4558-a4d0-a8c07ac08470
97-
- model_name: cclIp
98-
tf_name: data_node_ccl_ipv4_address
99-
data_path: [clusterNodeBootstrap]
100-
type: String
101-
mandatory: true
102-
description: Cluster Data Node link IPv4 address / VTEP IPv4 address.
103-
example: 10.10.4.2
104-
- model_name: priority
105-
tf_name: data_node_priority
106-
data_path: [clusterNodeBootstrap]
107-
type: Int64
108-
mandatory: true
109-
min_int: 1
110-
max_int: 255
111-
example: 2
112-
description: Priority of cluster data node.
90+
- model_name: id
91+
tf_name: data_node_device_id
92+
data_path: [deviceDetails]
93+
type: String
94+
mandatory: true
95+
description: Cluster Data Node device ID.
96+
example: 76d24097-41c4-4558-a4d0-a8c07ac08470
97+
- model_name: cclIp
98+
tf_name: data_node_ccl_ipv4_address
99+
data_path: [clusterNodeBootstrap]
100+
type: String
101+
mandatory: true
102+
description: Cluster Data Node link IPv4 address / VTEP IPv4 address.
103+
example: 10.10.4.2
104+
- model_name: priority
105+
tf_name: data_node_priority
106+
data_path: [clusterNodeBootstrap]
107+
type: Int64
108+
mandatory: true
109+
min_int: 1
110+
max_int: 255
111+
example: 2
112+
description: Priority of cluster data node.
113113

114114
test_prerequisites: |-
115115
data "fmc_device_physical_interface" "test" {
116116
device_id = var.device_id
117117
id = var.device_interface_name
118118
}
119119
variable "device_id" { default = null } // tests will set $TF_VAR_device_id
120-
variable "device_interface_name" { default = null } // tests will set $TF_VAR_device_interface_name
120+
variable "device_interface_name" { default = null } // tests will set $TF_VAR_device_interface_name

0 commit comments

Comments
 (0)