1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. Rsyslogd
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
unifi logo
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse

    Manages Remote Syslog (rsyslogd) settings for UniFi devices. Controller version 8.5 or later is required.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as unifi from "@pulumiverse/unifi";
    
    const example = new unifi.setting.Rsyslogd("example", {
        enabled: true,
        ip: "192.168.1.200",
        port: 514,
        contents: [
            "device",
            "client",
            "admin_activity",
        ],
        debug: true,
        netconsoleEnabled: true,
        netconsoleHost: "192.168.1.150",
        netconsolePort: 1514,
    });
    
    import pulumi
    import pulumiverse_unifi as unifi
    
    example = unifi.setting.Rsyslogd("example",
        enabled=True,
        ip="192.168.1.200",
        port=514,
        contents=[
            "device",
            "client",
            "admin_activity",
        ],
        debug=True,
        netconsole_enabled=True,
        netconsole_host="192.168.1.150",
        netconsole_port=1514)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/setting"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := setting.NewRsyslogd(ctx, "example", &setting.RsyslogdArgs{
    			Enabled: pulumi.Bool(true),
    			Ip:      pulumi.String("192.168.1.200"),
    			Port:    pulumi.Int(514),
    			Contents: pulumi.StringArray{
    				pulumi.String("device"),
    				pulumi.String("client"),
    				pulumi.String("admin_activity"),
    			},
    			Debug:             pulumi.Bool(true),
    			NetconsoleEnabled: pulumi.Bool(true),
    			NetconsoleHost:    pulumi.String("192.168.1.150"),
    			NetconsolePort:    pulumi.Int(1514),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Unifi = Pulumiverse.Unifi;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Unifi.Setting.Rsyslogd("example", new()
        {
            Enabled = true,
            Ip = "192.168.1.200",
            Port = 514,
            Contents = new[]
            {
                "device",
                "client",
                "admin_activity",
            },
            Debug = true,
            NetconsoleEnabled = true,
            NetconsoleHost = "192.168.1.150",
            NetconsolePort = 1514,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.unifi.setting.Rsyslogd;
    import com.pulumiverse.unifi.setting.RsyslogdArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Rsyslogd("example", RsyslogdArgs.builder()
                .enabled(true)
                .ip("192.168.1.200")
                .port(514)
                .contents(            
                    "device",
                    "client",
                    "admin_activity")
                .debug(true)
                .netconsoleEnabled(true)
                .netconsoleHost("192.168.1.150")
                .netconsolePort(1514)
                .build());
    
        }
    }
    
    resources:
      example:
        type: unifi:setting:Rsyslogd
        properties:
          enabled: true # Remote syslog server IP address
          ip: 192.168.1.200
          port: 514 # Types of log content to send
          #   # Valid options: "device", "client", "admin_activity"
          contents:
            - device
            - client
            - admin_activity
          debug: true # Netconsole configuration (optional)
          netconsoleEnabled: true
          netconsoleHost: 192.168.1.150
          netconsolePort: 1514 # Specify the site (optional, defaults to site configured in provider, otherwise "default")
          #   # site = "default"
    

    Create Rsyslogd Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rsyslogd(name: string, args: RsyslogdArgs, opts?: CustomResourceOptions);
    @overload
    def Rsyslogd(resource_name: str,
                 args: RsyslogdArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rsyslogd(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 enabled: Optional[bool] = None,
                 contents: Optional[Sequence[str]] = None,
                 debug: Optional[bool] = None,
                 ip: Optional[str] = None,
                 log_all_contents: Optional[bool] = None,
                 netconsole_enabled: Optional[bool] = None,
                 netconsole_host: Optional[str] = None,
                 netconsole_port: Optional[int] = None,
                 port: Optional[int] = None,
                 site: Optional[str] = None,
                 this_controller: Optional[bool] = None,
                 this_controller_encrypted_only: Optional[bool] = None)
    func NewRsyslogd(ctx *Context, name string, args RsyslogdArgs, opts ...ResourceOption) (*Rsyslogd, error)
    public Rsyslogd(string name, RsyslogdArgs args, CustomResourceOptions? opts = null)
    public Rsyslogd(String name, RsyslogdArgs args)
    public Rsyslogd(String name, RsyslogdArgs args, CustomResourceOptions options)
    
    type: unifi:setting:Rsyslogd
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RsyslogdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RsyslogdArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RsyslogdArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RsyslogdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RsyslogdArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var rsyslogdResource = new Unifi.Setting.Rsyslogd("rsyslogdResource", new()
    {
        Enabled = false,
        Contents = new[]
        {
            "string",
        },
        Debug = false,
        Ip = "string",
        LogAllContents = false,
        NetconsoleEnabled = false,
        NetconsoleHost = "string",
        NetconsolePort = 0,
        Port = 0,
        Site = "string",
        ThisController = false,
        ThisControllerEncryptedOnly = false,
    });
    
    example, err := setting.NewRsyslogd(ctx, "rsyslogdResource", &setting.RsyslogdArgs{
    	Enabled: pulumi.Bool(false),
    	Contents: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Debug:                       pulumi.Bool(false),
    	Ip:                          pulumi.String("string"),
    	LogAllContents:              pulumi.Bool(false),
    	NetconsoleEnabled:           pulumi.Bool(false),
    	NetconsoleHost:              pulumi.String("string"),
    	NetconsolePort:              pulumi.Int(0),
    	Port:                        pulumi.Int(0),
    	Site:                        pulumi.String("string"),
    	ThisController:              pulumi.Bool(false),
    	ThisControllerEncryptedOnly: pulumi.Bool(false),
    })
    
    var rsyslogdResource = new Rsyslogd("rsyslogdResource", RsyslogdArgs.builder()
        .enabled(false)
        .contents("string")
        .debug(false)
        .ip("string")
        .logAllContents(false)
        .netconsoleEnabled(false)
        .netconsoleHost("string")
        .netconsolePort(0)
        .port(0)
        .site("string")
        .thisController(false)
        .thisControllerEncryptedOnly(false)
        .build());
    
    rsyslogd_resource = unifi.setting.Rsyslogd("rsyslogdResource",
        enabled=False,
        contents=["string"],
        debug=False,
        ip="string",
        log_all_contents=False,
        netconsole_enabled=False,
        netconsole_host="string",
        netconsole_port=0,
        port=0,
        site="string",
        this_controller=False,
        this_controller_encrypted_only=False)
    
    const rsyslogdResource = new unifi.setting.Rsyslogd("rsyslogdResource", {
        enabled: false,
        contents: ["string"],
        debug: false,
        ip: "string",
        logAllContents: false,
        netconsoleEnabled: false,
        netconsoleHost: "string",
        netconsolePort: 0,
        port: 0,
        site: "string",
        thisController: false,
        thisControllerEncryptedOnly: false,
    });
    
    type: unifi:setting:Rsyslogd
    properties:
        contents:
            - string
        debug: false
        enabled: false
        ip: string
        logAllContents: false
        netconsoleEnabled: false
        netconsoleHost: string
        netconsolePort: 0
        port: 0
        site: string
        thisController: false
        thisControllerEncryptedOnly: false
    

    Rsyslogd Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Rsyslogd resource accepts the following input properties:

    Enabled bool
    Whether remote syslog is enabled.
    Contents List<string>
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    Debug bool
    Whether debug logging is enabled.
    Ip string
    IP address of the remote syslog server.
    LogAllContents bool
    Whether to log all content types.
    NetconsoleEnabled bool
    Whether netconsole logging is enabled.
    NetconsoleHost string
    Hostname or IP address of the netconsole server.
    NetconsolePort int
    Port number for the netconsole server. Valid values: 1-65535.
    Port int
    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.
    ThisController bool
    Whether to use this controller as the syslog server.
    ThisControllerEncryptedOnly bool
    Whether to only use encrypted connections to this controller for syslog.
    Enabled bool
    Whether remote syslog is enabled.
    Contents []string
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    Debug bool
    Whether debug logging is enabled.
    Ip string
    IP address of the remote syslog server.
    LogAllContents bool
    Whether to log all content types.
    NetconsoleEnabled bool
    Whether netconsole logging is enabled.
    NetconsoleHost string
    Hostname or IP address of the netconsole server.
    NetconsolePort int
    Port number for the netconsole server. Valid values: 1-65535.
    Port int
    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.
    ThisController bool
    Whether to use this controller as the syslog server.
    ThisControllerEncryptedOnly bool
    Whether to only use encrypted connections to this controller for syslog.
    enabled Boolean
    Whether remote syslog is enabled.
    contents List<String>
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug Boolean
    Whether debug logging is enabled.
    ip String
    IP address of the remote syslog server.
    logAllContents Boolean
    Whether to log all content types.
    netconsoleEnabled Boolean
    Whether netconsole logging is enabled.
    netconsoleHost String
    Hostname or IP address of the netconsole server.
    netconsolePort Integer
    Port number for the netconsole server. Valid values: 1-65535.
    port Integer
    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.
    thisController Boolean
    Whether to use this controller as the syslog server.
    thisControllerEncryptedOnly Boolean
    Whether to only use encrypted connections to this controller for syslog.
    enabled boolean
    Whether remote syslog is enabled.
    contents string[]
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug boolean
    Whether debug logging is enabled.
    ip string
    IP address of the remote syslog server.
    logAllContents boolean
    Whether to log all content types.
    netconsoleEnabled boolean
    Whether netconsole logging is enabled.
    netconsoleHost string
    Hostname or IP address of the netconsole server.
    netconsolePort 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.
    thisController boolean
    Whether to use this controller as the syslog server.
    thisControllerEncryptedOnly boolean
    Whether to only use encrypted connections to this controller for syslog.
    enabled bool
    Whether remote syslog is enabled.
    contents Sequence[str]
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug bool
    Whether debug logging is enabled.
    ip str
    IP address of the remote syslog server.
    log_all_contents bool
    Whether to log all content types.
    netconsole_enabled bool
    Whether netconsole logging is enabled.
    netconsole_host str
    Hostname or IP address of the netconsole server.
    netconsole_port int
    Port number for the netconsole server. Valid values: 1-65535.
    port int
    Port number for the remote syslog server. Valid values: 1-65535.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    this_controller bool
    Whether to use this controller as the syslog server.
    this_controller_encrypted_only bool
    Whether to only use encrypted connections to this controller for syslog.
    enabled Boolean
    Whether remote syslog is enabled.
    contents List<String>
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug Boolean
    Whether debug logging is enabled.
    ip String
    IP address of the remote syslog server.
    logAllContents Boolean
    Whether to log all content types.
    netconsoleEnabled Boolean
    Whether netconsole logging is enabled.
    netconsoleHost String
    Hostname or IP address of the netconsole server.
    netconsolePort 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.
    thisController Boolean
    Whether to use this controller as the syslog server.
    thisControllerEncryptedOnly Boolean
    Whether to only use encrypted connections to this controller for syslog.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Rsyslogd resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Rsyslogd Resource

    Get an existing Rsyslogd resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RsyslogdState, opts?: CustomResourceOptions): Rsyslogd
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            contents: Optional[Sequence[str]] = None,
            debug: Optional[bool] = None,
            enabled: Optional[bool] = None,
            ip: Optional[str] = None,
            log_all_contents: Optional[bool] = None,
            netconsole_enabled: Optional[bool] = None,
            netconsole_host: Optional[str] = None,
            netconsole_port: Optional[int] = None,
            port: Optional[int] = None,
            site: Optional[str] = None,
            this_controller: Optional[bool] = None,
            this_controller_encrypted_only: Optional[bool] = None) -> Rsyslogd
    func GetRsyslogd(ctx *Context, name string, id IDInput, state *RsyslogdState, opts ...ResourceOption) (*Rsyslogd, error)
    public static Rsyslogd Get(string name, Input<string> id, RsyslogdState? state, CustomResourceOptions? opts = null)
    public static Rsyslogd get(String name, Output<String> id, RsyslogdState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:Rsyslogd    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Contents List<string>
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    Debug bool
    Whether debug logging is enabled.
    Enabled bool
    Whether remote syslog is enabled.
    Ip string
    IP address of the remote syslog server.
    LogAllContents bool
    Whether to log all content types.
    NetconsoleEnabled bool
    Whether netconsole logging is enabled.
    NetconsoleHost string
    Hostname or IP address of the netconsole server.
    NetconsolePort int
    Port number for the netconsole server. Valid values: 1-65535.
    Port int
    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.
    ThisController bool
    Whether to use this controller as the syslog server.
    ThisControllerEncryptedOnly bool
    Whether to only use encrypted connections to this controller for syslog.
    Contents []string
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    Debug bool
    Whether debug logging is enabled.
    Enabled bool
    Whether remote syslog is enabled.
    Ip string
    IP address of the remote syslog server.
    LogAllContents bool
    Whether to log all content types.
    NetconsoleEnabled bool
    Whether netconsole logging is enabled.
    NetconsoleHost string
    Hostname or IP address of the netconsole server.
    NetconsolePort int
    Port number for the netconsole server. Valid values: 1-65535.
    Port int
    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.
    ThisController bool
    Whether to use this controller as the syslog server.
    ThisControllerEncryptedOnly bool
    Whether to only use encrypted connections to this controller for syslog.
    contents List<String>
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug Boolean
    Whether debug logging is enabled.
    enabled Boolean
    Whether remote syslog is enabled.
    ip String
    IP address of the remote syslog server.
    logAllContents Boolean
    Whether to log all content types.
    netconsoleEnabled Boolean
    Whether netconsole logging is enabled.
    netconsoleHost String
    Hostname or IP address of the netconsole server.
    netconsolePort Integer
    Port number for the netconsole server. Valid values: 1-65535.
    port Integer
    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.
    thisController Boolean
    Whether to use this controller as the syslog server.
    thisControllerEncryptedOnly Boolean
    Whether to only use encrypted connections to this controller for syslog.
    contents string[]
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug boolean
    Whether debug logging is enabled.
    enabled boolean
    Whether remote syslog is enabled.
    ip string
    IP address of the remote syslog server.
    logAllContents boolean
    Whether to log all content types.
    netconsoleEnabled boolean
    Whether netconsole logging is enabled.
    netconsoleHost string
    Hostname or IP address of the netconsole server.
    netconsolePort 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.
    thisController boolean
    Whether to use this controller as the syslog server.
    thisControllerEncryptedOnly boolean
    Whether to only use encrypted connections to this controller for syslog.
    contents Sequence[str]
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug bool
    Whether debug logging is enabled.
    enabled bool
    Whether remote syslog is enabled.
    ip str
    IP address of the remote syslog server.
    log_all_contents bool
    Whether to log all content types.
    netconsole_enabled bool
    Whether netconsole logging is enabled.
    netconsole_host str
    Hostname or IP address of the netconsole server.
    netconsole_port int
    Port number for the netconsole server. Valid values: 1-65535.
    port int
    Port number for the remote syslog server. Valid values: 1-65535.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    this_controller bool
    Whether to use this controller as the syslog server.
    this_controller_encrypted_only bool
    Whether to only use encrypted connections to this controller for syslog.
    contents List<String>
    List of log types to include in the remote syslog. Valid values: device, client, firewalldefaultpolicy, triggers, updates, adminactivity, critical, securitydetections, vpn.
    debug Boolean
    Whether debug logging is enabled.
    enabled Boolean
    Whether remote syslog is enabled.
    ip String
    IP address of the remote syslog server.
    logAllContents Boolean
    Whether to log all content types.
    netconsoleEnabled Boolean
    Whether netconsole logging is enabled.
    netconsoleHost String
    Hostname or IP address of the netconsole server.
    netconsolePort 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.
    thisController Boolean
    Whether to use this controller as the syslog server.
    thisControllerEncryptedOnly Boolean
    Whether to only use encrypted connections to this controller for syslog.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Viewing docs for Unifi v0.2.0
    published on Tuesday, Feb 17, 2026 by Pulumiverse
      Try Pulumi Cloud free. Your team will thank you.