Skip to content

Commit

Permalink
Regenerate data-source docs
Browse files Browse the repository at this point in the history
  • Loading branch information
browningluke committed Jul 29, 2023
1 parent 9d16857 commit 7e153df
Show file tree
Hide file tree
Showing 6 changed files with 148 additions and 19 deletions.
25 changes: 21 additions & 4 deletions docs/data-sources/interfaces_vlan.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opnsense_interfaces_vlan Data Source - terraform-provider-opnsense"
subcategory: ""
subcategory: Interfaces
description: |-
VLANs (Virtual LANs) can be used to segment a single physical network into multiple virtual networks.
---
Expand All @@ -10,7 +9,26 @@ description: |-

VLANs (Virtual LANs) can be used to segment a single physical network into multiple virtual networks.


## Example Usage

```terraform
// OPNsense generates a device name
resource "opnsense_interfaces_vlan" "vlan" {
description = "Example vlan"
tag = 10
priority = 0
parent = "vtnet0"
}
// Manually configure a device name
resource "opnsense_interfaces_vlan" "vlan04" {
description = "Example vlan 4"
tag = 50
priority = 5
parent = "vtnet0"
device = "vlan04"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -27,4 +45,3 @@ VLANs (Virtual LANs) can be used to segment a single physical network into multi
- `priority` (Number) 802.1Q VLAN PCP (priority code point).
- `tag` (Number) 802.1Q VLAN tag.


21 changes: 18 additions & 3 deletions docs/data-sources/route.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opnsense_route Data Source - terraform-provider-opnsense"
subcategory: ""
subcategory: Routes
description: |-
Routes can be used to teach your firewall which path it should take when forwarding packets to a specific network.
---
Expand All @@ -10,7 +9,24 @@ description: |-

Routes can be used to teach your firewall which path it should take when forwarding packets to a specific network.

## Example Usage

```terraform
// Enabled with description
resource "opnsense_route" "one_route" {
description = "Example route"
gateway = "LAN_DHCP"
network = "10.9.0.0/24"
}
// Disabled without description
resource "opnsense_route" "two_route" {
enabled = false
gateway = "LAN"
network = "10.10.0.0/24"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -26,4 +42,3 @@ Routes can be used to teach your firewall which path it should take when forward
- `gateway` (String) Which gateway this route applies, e.g. `WAN`.
- `network` (String) Destination network for this static route.


23 changes: 20 additions & 3 deletions docs/data-sources/unbound_domain_override.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opnsense_unbound_domain_override Data Source - terraform-provider-opnsense"
subcategory: ""
subcategory: Unbound
description: |-
Domain overrides can be used to forward queries for specific domains (and subsequent subdomains) to local or remote DNS servers.
---
Expand All @@ -10,7 +9,26 @@ description: |-

Domain overrides can be used to forward queries for specific domains (and subsequent subdomains) to local or remote DNS servers.

## Example Usage

```terraform
// Enabled with description
resource "opnsense_unbound_domain_override" "one_override" {
enabled = true
description = "Example override"
domain = "example.lan"
server = "192.168.1.1"
}
// Disabled without description
resource "opnsense_unbound_domain_override" "two_override" {
enabled = false
domain = "example.arpa"
server = "192.168.1.100"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -26,4 +44,3 @@ Domain overrides can be used to forward queries for specific domains (and subseq
- `enabled` (Boolean) Whether this route is enabled.
- `server` (String) IP address of the authoritative DNS server for this domain, e.g. `192.168.100.100`.


24 changes: 21 additions & 3 deletions docs/data-sources/unbound_forward.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opnsense_unbound_forward Data Source - terraform-provider-opnsense"
subcategory: ""
subcategory: Unbound
description: |-
Query Forwarding section allows for entering arbitrary nameservers to forward queries to. Can forward queries normally, or over TLS.
---
Expand All @@ -10,7 +9,27 @@ description: |-

Query Forwarding section allows for entering arbitrary nameservers to forward queries to. Can forward queries normally, or over TLS.

## Example Usage

```terraform
// Query Forward
resource "opnsense_unbound_forward" "query" {
domain = "example.lan"
server_ip = "192.168.1.2"
server_port = 853
}
// DoT forward
resource "opnsense_unbound_forward" "dot" {
enabled = false
type = "dot"
domain = "example.dev"
server_ip = "192.168.1.1"
server_port = 53
verify_cn = "example.dev"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -27,4 +46,3 @@ Query Forwarding section allows for entering arbitrary nameservers to forward qu
- `server_port` (Number) Port of DNS server, for usual DNS use `53`, if you use DoT set it to `853`.
- `verify_cn` (String) The Common Name of the DNS server (e.g. `dns.example.com`). This field is required to verify its TLS certificate. DNS-over-TLS is susceptible to man-in-the-middle attacks unless certificates can be verified.


35 changes: 32 additions & 3 deletions docs/data-sources/unbound_host_alias.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opnsense_unbound_host_alias Data Source - terraform-provider-opnsense"
subcategory: ""
subcategory: Unbound
description: |-
Host aliases can be used to create alternative names for a Host.
---
Expand All @@ -10,7 +9,38 @@ description: |-

Host aliases can be used to create alternative names for a Host.

## Example Usage

```terraform
// 'A' record
resource "opnsense_unbound_host_override" "a_override" {
enabled = true
description = "A record override"
hostname = "*"
domain = "example.com"
server = "192.168.1.1"
}
// Enabled alias with description
resource "opnsense_unbound_host_alias" "one_alias" {
override = opnsense_unbound_host_override.a_override.id
enabled = true
hostname = "*"
domain = "1.example.com"
description = "Example 1"
}
// Disabled alias without description
resource "opnsense_unbound_host_alias" "two_alias" {
override = opnsense_unbound_host_override.a_override.id
enabled = false
hostname = "*"
domain = "2.example.com"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -27,4 +57,3 @@ Host aliases can be used to create alternative names for a Host.
- `hostname` (String) Name of the host, without the domain part.
- `override` (String) The associated host override to apply this alias on.


39 changes: 36 additions & 3 deletions docs/data-sources/unbound_host_override.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opnsense_unbound_host_override Data Source - terraform-provider-opnsense"
subcategory: ""
subcategory: Unbound
description: |-
Host overrides can be used to change DNS results from client queries or to add custom DNS records.
---
Expand All @@ -10,7 +9,42 @@ description: |-

Host overrides can be used to change DNS results from client queries or to add custom DNS records.

## Example Usage

```terraform
// 'A' record
resource "opnsense_unbound_host_override" "a_override" {
enabled = true
description = "A record override"
hostname = "*"
domain = "example.com"
server = "192.168.1.1"
}
// 'AAAA' record
resource "opnsense_unbound_host_override" "aaaa_override" {
enabled = true
type = "AAAA"
hostname = "*"
domain = "example.com"
server = "fd00:abcd::1"
}
// 'MX' record
resource "opnsense_unbound_host_override" "mx_override" {
enabled = false
description = "MX record override"
type = "MX"
hostname = "*"
domain = "example.com"
mx_priority = 10
mx_host = "mail.example.dev"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand All @@ -30,4 +64,3 @@ Host overrides can be used to change DNS results from client queries or to add c
- `server` (String) IP address of the host, e.g. 192.168.100.100 or fd00:abcd::1.
- `type` (String) Type of resource record. Available values: `A`, `AAAA`, `MX`.


0 comments on commit 7e153df

Please sign in to comment.