b9284f7758
* docs: add examples and recreate TF documentation * update readme * add information about experimental support of firewall zones
62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "unifi_firewall_zone Resource - terraform-provider-unifi"
|
|
subcategory: ""
|
|
description: |-
|
|
The unifi_firewall_zone resource manages firewall zones in the UniFi controller.
|
|
Firewall zones allow you to group networks together for firewall rule application. This resource allows you to create, update, and delete firewall zones.
|
|
!> This is experimental feature, that requires UniFi OS 9.0.0 or later and Zone Based Firewall feature enabled. Check official documentation https://help.ui.com/hc/en-us/articles/28223082254743-Migrating-to-Zone-Based-Firewalls-in-UniFi how to migate to Zone-Based firewalls.
|
|
---
|
|
|
|
# unifi_firewall_zone (Resource)
|
|
|
|
The `unifi_firewall_zone` resource manages firewall zones in the UniFi controller.
|
|
|
|
Firewall zones allow you to group networks together for firewall rule application. This resource allows you to create, update, and delete firewall zones.
|
|
|
|
!> This is experimental feature, that requires UniFi OS 9.0.0 or later and Zone Based Firewall feature enabled. Check [official documentation](https://help.ui.com/hc/en-us/articles/28223082254743-Migrating-to-Zone-Based-Firewalls-in-UniFi) how to migate to Zone-Based firewalls.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "unifi_network" "network" {
|
|
name = "my-network"
|
|
purpose = "corporate"
|
|
subnet = "10.0.10.0/24"
|
|
vlan_id = "400"
|
|
}
|
|
|
|
resource "unifi_firewall_zone" "zone" {
|
|
name = "my-zone"
|
|
networks = [unifi_network.network.id]
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `name` (String) The name of the firewall zone.
|
|
|
|
### Optional
|
|
|
|
- `networks` (List of String) List of network IDs to include in this firewall zone.
|
|
- `site` (String) The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) The unique identifier of this resource.
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
```shell
|
|
# import from provider configured site
|
|
terraform import unifi_firewall_zone.myzone 5dc28e5e9106d105bdc87217
|
|
|
|
# import from another site
|
|
terraform import unifi_firewall_zone.myzone another-site:5dc28e5e9106d105bdc87217
|
|
```
|