Resource Type: opnsense_syslog_destination

Defined in:
lib/puppet/type/opnsense_syslog_destination.rb

Summary

Manage opnsense syslog destination

Overview

This type provides Puppet with the capabilities to manage opnsense syslog destination.

Examples:

opnsense_syslog_destination { 'example syslog destination':
  device      => 'opnsense-test.device.com',
  enabled     => true,
  transport   => 'tls4',
  program     => 'ntp,ntpdate,ntpd',
  level       => ['info', 'notice', 'warn', 'err', 'crit', 'alert', 'emerg'],
  facility    => ['ntp', 'security', 'console'],
  hostname    => '10.0.0.2',
  certificate => '60cc4641eb577',
  port        => '514',
  rfc5424     => true,
  ensure      => 'present',
}

Properties

  • certificate

    Transport certificate to use, please make sure to check the general system log when experiencing issues. Error messages can be a bit cryptic from time to time, in which case “support.oneidentity.com/kb/263658/common-issues-of-tls-encrypted-message-transfer this is a good resource for tracking common issues.

  • enabled

    Set this option to enable this destination.

  • ensure (defaults to: present)

    Whether this resource should be present or absent on the target system.

  • facility

    Choose which facilities to include, omit to select all.

  • hostname

    The hostname or ip address of the syslog destination.

  • level

    Choose which levels to include, omit to select all.

  • port

    The port of the syslog destination.

  • program

    Choose which applications should be forwarded to the specified target, omit to select all.

  • rfc5424

    Use rfc5424 formated messages for this destination.

  • transport

    Transport protocol

  • uuid

    The uuid of the rule.

Parameters

  • description (namevar)

    You may enter a description here for your reference.

  • device (namevar)

    The name of the opnsense_device type you want to manage.