drmofu.fortimanager.fmgr_system_locallog_syslogd2_setting (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Settings for remote syslog server.
      fmgr_system_locallog_syslogd2_setting:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         system_locallog_syslogd2_setting:
            csv: <value in [disable, enable]>
            facility: <value in [kernel, user, ntp, ...]>
            severity: <value in [emergency, alert, critical, ...]>
            status: <value in [disable, enable]>
            syslog-name: <value of string>
            cert: <value of string>
            reliable: <value in [disable, enable]>
            secure-connection: <value in [disable, enable]>

Inputs

    
rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

system_locallog_syslogd2_setting:
    description: the top level parameters set
    required: false
    suboptions:
      cert:
        description: Select local certificate used for secure connection.
        type: str
      csv:
        choices:
        - disable
        - enable
        description:
        - CSV format.
        - disable - Disable CSV format.
        - enable - Enable CSV format.
        type: str
      facility:
        choices:
        - kernel
        - user
        - ntp
        - audit
        - alert
        - clock
        - mail
        - daemon
        - auth
        - syslog
        - lpr
        - news
        - uucp
        - cron
        - authpriv
        - ftp
        - local0
        - local1
        - local2
        - local3
        - local4
        - local5
        - local6
        - local7
        description:
        - Remote syslog facility.
        - kernel - Kernel messages.
        - user - Random user-level messages.
        - ntp - NTP daemon.
        - audit - Log audit.
        - alert - Log alert.
        - clock - Clock daemon.
        - mail - Mail system.
        - daemon - System daemons.
        - auth - Security/authorization messages.
        - syslog - Messages generated internally by syslog daemon.
        - lpr - Line printer subsystem.
        - news - Network news subsystem.
        - uucp - Network news subsystem.
        - cron - Clock daemon.
        - authpriv - Security/authorization messages
        - ftp - FTP daemon.
        - local0 - Reserved for local use.
        - local1 - Reserved for local use.
        - local2 - Reserved for local use.
        - local3 - Reserved for local use.
        - local4 - Reserved for local use.
        - local5 - Reserved for local use.
        - local6 - Reserved for local use.
        - local7 - Reserved for local use.
        type: str
      reliable:
        choices:
        - disable
        - enable
        description:
        - Enable/disable reliable realtime logging.
        - disable - Disable reliable realtime logging.
        - enable - Enable reliable realtime logging.
        type: str
      secure-connection:
        choices:
        - disable
        - enable
        description:
        - Enable/disable connection secured by TLS/SSL.
        - disable - Disable SSL connection.
        - enable - Enable SSL connection.
        type: str
      severity:
        choices:
        - emergency
        - alert
        - critical
        - error
        - warning
        - notification
        - information
        - debug
        description:
        - Least severity level to log.
        - emergency - Emergency level.
        - alert - Alert level.
        - critical - Critical level.
        - error - Error level.
        - warning - Warning level.
        - notification - Notification level.
        - information - Information level.
        - debug - Debug level.
        type: str
      status:
        choices:
        - disable
        - enable
        description:
        - Remote syslog log.
        - disable - Do not log to remote syslog server.
        - enable - Log to remote syslog server.
        type: str
      syslog-name:
        description: Remote syslog server name.
        type: str
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list