drmofu.fortimanager.fmgr_devprof_log_fortianalyzercloud_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: Global FortiAnalyzer Cloud settings.
      fmgr_devprof_log_fortianalyzercloud_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_fortianalyzercloud_setting:
            __change_ip: <value of integer>
            access-config: <value in [disable, enable]>
            certificate: <value of string>
            conn-timeout: <value of integer>
            enc-algorithm: <value in [high, low, high-medium, ...]>
            hmac-algorithm: <value in [sha256, sha1]>
            ips-archive: <value in [disable, enable]>
            monitor-failure-retry-period: <value of integer>
            monitor-keepalive-period: <value of integer>
            source-ip: <value of string>
            ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]>
            status: <value in [disable, enable]>
            upload-day: <value of string>
            upload-interval: <value in [daily, weekly, monthly]>
            upload-option: <value in [store-and-upload, realtime, 1-minute, ...]>
            upload-time: <value of string>
            max-log-rate: <value of integer>
            priority: <value in [low, default]>
            interface: <value of string>
            interface-select-method: <value in [auto, sdwan, specify]>
            preshared-key: <value of string>
            certificate-verification: <value in [disable, enable]>
            serial: <value of 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
    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

devprof_log_fortianalyzercloud_setting:
    description: the top level parameters set
    required: false
    suboptions:
      __change_ip:
        description: Hidden attribute.
        type: int
      access-config:
        choices:
        - disable
        - enable
        description: Enable/disable FortiAnalyzer access to configuration and data.
        type: str
      certificate:
        description: Certificate used to communicate with FortiAnalyzer.
        type: str
      certificate-verification:
        choices:
        - disable
        - enable
        description: Enable/disable identity verification of FortiAnalyzer by use of certificate.
        type: str
      conn-timeout:
        description: FortiAnalyzer connection time-out in seconds
        type: int
      enc-algorithm:
        choices:
        - high
        - low
        - high-medium
        - low-medium
        description: Configure the level of SSL protection for secure communication with
          FortiAnalyzer.
        type: str
      hmac-algorithm:
        choices:
        - sha256
        - sha1
        description: FortiAnalyzer IPsec tunnel HMAC algorithm.
        type: str
      interface:
        description: Specify outgoing interface to reach server.
        type: str
      interface-select-method:
        choices:
        - auto
        - sdwan
        - specify
        description: Specify how to select outgoing interface to reach server.
        type: str
      ips-archive:
        choices:
        - disable
        - enable
        description: Enable/disable IPS packet archive logging.
        type: str
      max-log-rate:
        description: FortiAnalyzer maximum log rate in MBps
        type: int
      monitor-failure-retry-period:
        description: Time between FortiAnalyzer connection retries in seconds
        type: int
      monitor-keepalive-period:
        description: Time between OFTP keepalives in seconds
        type: int
      preshared-key:
        description: Preshared-key used for auto-authorization on FortiAnalyzer.
        type: str
      priority:
        choices:
        - low
        - default
        description: Set log transmission priority.
        type: str
      serial:
        description: description
        type: str
      source-ip:
        description: Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.
        type: str
      ssl-min-proto-version:
        choices:
        - default
        - TLSv1-1
        - TLSv1-2
        - SSLv3
        - TLSv1
        - TLSv1-3
        description: Minimum supported protocol version for SSL/TLS connections
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable logging to FortiAnalyzer.
        type: str
      upload-day:
        description: Day of week
        type: str
      upload-interval:
        choices:
        - daily
        - weekly
        - monthly
        description: Frequency to upload log files to FortiAnalyzer.
        type: str
      upload-option:
        choices:
        - store-and-upload
        - realtime
        - 1-minute
        - 5-minute
        description: Enable/disable logging to hard disk and then uploading to FortiAnalyzer.
        type: str
      upload-time:
        description: Time to upload logs
        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