* docs: add examples and recreate TF documentation * update readme * add information about experimental support of firewall zones
67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "unifi_setting_rsyslogd Resource - terraform-provider-unifi"
|
|
subcategory: ""
|
|
description: |-
|
|
Manages Remote Syslog (rsyslogd) settings for UniFi devices. Controller version 8.5 or later is required.
|
|
---
|
|
|
|
# unifi_setting_rsyslogd (Resource)
|
|
|
|
Manages Remote Syslog (rsyslogd) settings for UniFi devices. Controller version 8.5 or later is required.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "unifi_setting_rsyslogd" "example" {
|
|
# Enable remote syslog functionality
|
|
enabled = true
|
|
|
|
# Remote syslog server IP address
|
|
ip = "192.168.1.200"
|
|
|
|
# Remote syslog server port
|
|
port = 514
|
|
|
|
# Types of log content to send
|
|
# Valid options: "device", "client", "admin_activity"
|
|
contents = ["device", "client", "admin_activity"]
|
|
|
|
# Enable debug logging
|
|
debug = true
|
|
|
|
# Netconsole configuration (optional)
|
|
netconsole_enabled = true
|
|
netconsole_host = "192.168.1.150"
|
|
netconsole_port = 1514
|
|
|
|
# Specify the site (optional, defaults to site configured in provider, otherwise "default")
|
|
# site = "default"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `enabled` (Boolean) Whether remote syslog is enabled.
|
|
|
|
### Optional
|
|
|
|
- `contents` (List of String) List of log types to include in the remote syslog. Valid values: device, client, firewall_default_policy, triggers, updates, admin_activity, critical, security_detections, vpn.
|
|
- `debug` (Boolean) Whether debug logging is enabled.
|
|
- `ip` (String) IP address of the remote syslog server.
|
|
- `log_all_contents` (Boolean) Whether to log all content types.
|
|
- `netconsole_enabled` (Boolean) Whether netconsole logging is enabled.
|
|
- `netconsole_host` (String) Hostname or IP address of the netconsole server.
|
|
- `netconsole_port` (Number) Port number for the netconsole server. Valid values: 1-65535.
|
|
- `port` (Number) Port number for the remote syslog server. Valid values: 1-65535.
|
|
- `site` (String) The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
|
|
- `this_controller` (Boolean) Whether to use this controller as the syslog server.
|
|
- `this_controller_encrypted_only` (Boolean) Whether to only use encrypted connections to this controller for syslog.
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) The unique identifier of this resource.
|