fortinet.fortimanager.fmgr_system_logfetch_clientprofile (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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Log-fetch client profile settings.
      fortinet.fortimanager.fmgr_system_logfetch_clientprofile:
        bypass_validation: false
        state: present
        system_logfetch_clientprofile:
          client-adom: ansible
          data-range: custom # <value in [custom]>
          id: 1
          index-fetch-logs: enable
          name: ansible-test-clientprofile
          password: fortinet
          server-ip: "222.222.22.25"
          user: ansible

Scanned by Steampunk Spotter

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

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the Log-fetch client profile settings
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_logfetch_clientprofile"
          params:
            client-profile: "your_value"

Inputs

    
state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    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

system_logfetch_clientprofile:
    description: The top level parameters set.
    required: false
    suboptions:
      client-adom:
        description: Deprecated, please rename it to client_adom. Log-fetch client sides
          adom name.
        type: str
      data-range:
        choices:
        - custom
        description:
        - Deprecated, please rename it to data_range.
        - Data-range for fetched logs.
        - custom - Specify some other date and time range.
        type: str
      data-range-value:
        description: Deprecated, please rename it to data_range_value. Last n days or
          hours.
        type: int
      device-filter:
        description: Deprecated, please rename it to device_filter. Device-Filter.
        elements: dict
        suboptions:
          adom:
            description: Adom name.
            type: str
          device:
            description: Device name or Serial number.
            type: str
          id:
            description: Add or edit a device filter.
            type: int
          vdom:
            description: Vdom filters.
            type: str
        type: list
      end-time:
        description: (list) Deprecated, please rename it to end_time. End date and time
          of the data-range
        type: raw
      id:
        description: Log-fetch client profile ID.
        required: true
        type: int
      index-fetch-logs:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to index_fetch_logs.
        - Enable/Disable indexing logs automatically after fetching logs.
        - disable - Disable attribute function.
        - enable - Enable attribute function.
        type: str
      log-filter:
        description: Deprecated, please rename it to log_filter. Log-Filter.
        elements: dict
        suboptions:
          field:
            description: Field name.
            type: str
          id:
            description: Log filter ID.
            type: int
          oper:
            choices:
            - '='
            - '!='
            - <
            - '>'
            - <=
            - '>='
            - contain
            - not-contain
            - match
            description:
            - Field filter operator.
            - no description
            - no description
            - contain - Contain
            - not-contain - Not contain
            - match - Match
            type: str
          value:
            description: Field filter operand or free-text matching expression.
            type: str
        type: list
      log-filter-logic:
        choices:
        - and
        - or
        description:
        - Deprecated, please rename it to log_filter_logic.
        - And/Or logic for log-filters.
        - and - Logic And.
        - or - Logic Or.
        type: str
      log-filter-status:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to log_filter_status.
        - Enable/Disable log-filter.
        - disable - Disable attribute function.
        - enable - Enable attribute function.
        type: str
      name:
        description: Name of log-fetch client profile.
        type: str
      password:
        description: (list) Log-fetch server login password.
        type: raw
      peer-cert-cn:
        description: Deprecated, please rename it to peer_cert_cn. Certificate common
          name of log-fetch server.
        type: str
      secure-connection:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to secure_connection.
        - Enable/Disable protecting log-fetch connection with TLS/SSL.
        - disable - Disable attribute function.
        - enable - Enable attribute function.
        type: str
      server-adom:
        description: Deprecated, please rename it to server_adom. Log-fetch server sides
          adom name.
        type: str
      server-ip:
        description: Deprecated, please rename it to server_ip. Log-fetch server IP address.
        type: str
      start-time:
        description: (list) Deprecated, please rename it to start_time. Start date and
          time of the data-range
        type: raw
      sync-adom-config:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to sync_adom_config.
        - Enable/Disable sync adom related config.
        - disable - Disable attribute function.
        - enable - Enable attribute function.
        type: str
      user:
        description: Log-fetch server login username.
        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