fortinet.fortimanager.fmgr_devprof_log_syslogd_setting (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Global settings for remote syslog server.
      fortinet.fortimanager.fmgr_devprof_log_syslogd_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, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_log_syslogd_setting:
          certificate: <string>
          enc_algorithm: <value in [high, low, disable, ...]>
          facility: <value in [kernel, user, mail, ...]>
          mode: <value in [udp, legacy-reliable, reliable]>
          port: <integer>
          server: <string>
          ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          status: <value in [disable, enable]>
          reliable: <value in [disable, enable]>
          csv: <value in [disable, enable]>
          max_log_rate: <integer>
          priority: <value in [low, default]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          format: <value in [default, csv, cef, ...]>
          syslog_type: <integer>
          custom_field_name:
            -
              custom: <string>
              id: <integer>
              name: <string>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

devprof:
    description: The parameter (devprof) in requested url.
    required: true
    type: str

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

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

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    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.
    type: str

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

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

devprof_log_syslogd_setting:
    description: The top level parameters set.
    required: false
    suboptions:
      certificate:
        description: Certificate used to communicate with Syslog server.
        type: str
      csv:
        choices:
        - disable
        - enable
        description: Enable/disable CSV formatting of logs.
        type: str
      custom-field-name:
        description: Deprecated, please rename it to custom_field_name.
        elements: dict
        suboptions:
          custom:
            description: Field custom name.
            type: str
          id:
            description: Entry ID.
            type: int
          name:
            description: Field name.
            type: str
        type: list
      enc-algorithm:
        choices:
        - high
        - low
        - disable
        - high-medium
        description: Deprecated, please rename it to enc_algorithm. Enable/disable reliable
          syslogging with TLS encryption.
        type: str
      facility:
        choices:
        - kernel
        - user
        - mail
        - daemon
        - auth
        - syslog
        - lpr
        - news
        - uucp
        - cron
        - authpriv
        - ftp
        - ntp
        - audit
        - alert
        - clock
        - local0
        - local1
        - local2
        - local3
        - local4
        - local5
        - local6
        - local7
        description: Remote syslog facility.
        type: str
      format:
        choices:
        - default
        - csv
        - cef
        - rfc5424
        - json
        description: Log format.
        type: str
      interface:
        description: Specify outgoing interface to reach server.
        type: str
      interface-select-method:
        choices:
        - auto
        - sdwan
        - specify
        description: Deprecated, please rename it to interface_select_method. Specify
          how to select outgoing interface to reach server.
        type: str
      max-log-rate:
        description: Deprecated, please rename it to max_log_rate. Syslog maximum log
          rate in MBps
        type: int
      mode:
        choices:
        - udp
        - legacy-reliable
        - reliable
        description: Remote syslog logging over UDP/Reliable TCP.
        type: str
      port:
        description: Server listen port.
        type: int
      priority:
        choices:
        - low
        - default
        description: Set log transmission priority.
        type: str
      reliable:
        choices:
        - disable
        - enable
        description: Enable/disable reliable logging
        type: str
      server:
        description: Address of remote syslog server.
        type: str
      ssl-min-proto-version:
        choices:
        - default
        - TLSv1-1
        - TLSv1-2
        - SSLv3
        - TLSv1
        - TLSv1-3
        description: Deprecated, please rename it to ssl_min_proto_version. Minimum supported
          protocol version for SSL/TLS connections
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable remote syslog logging.
        type: str
      syslog-type:
        description: Deprecated, please rename it to syslog_type.
        type: int
    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