fortinet.fortimanager.fmgr_antivirus_profile_cifs (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: Configure CIFS AntiVirus options.
      fortinet.fortimanager.fmgr_antivirus_profile_cifs:
        # 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>
        profile: <your own value>
        antivirus_profile_cifs:
          archive_block:
            - encrypted
            - corrupted
            - multipart
            - nested
            - mailbomb
            - unhandled
            - partiallycorrupted
            - fileslimit
            - timeout
          archive_log:
            - encrypted
            - corrupted
            - multipart
            - nested
            - mailbomb
            - unhandled
            - partiallycorrupted
            - fileslimit
            - timeout
          emulator: <value in [disable, enable]>
          options:
            - scan
            - quarantine
            - avmonitor
          outbreak_prevention: <value in [disabled, files, full-archive, ...]>
          av_scan: <value in [disable, monitor, block]>
          external_blocklist: <value in [disable, monitor, block]>
          quarantine: <value in [disable, enable]>
          fortindr: <value in [disable, block, monitor]>
          fortisandbox: <value in [disable, block, monitor]>
          fortiai: <value in [disable, monitor, block]>

Inputs

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

profile:
    description: The parameter (profile) 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

antivirus_profile_cifs:
    description: The top level parameters set.
    required: false
    suboptions:
      archive-block:
        choices:
        - encrypted
        - corrupted
        - multipart
        - nested
        - mailbomb
        - unhandled
        - partiallycorrupted
        - fileslimit
        - timeout
        description: Deprecated, please rename it to archive_block.
        elements: str
        type: list
      archive-log:
        choices:
        - encrypted
        - corrupted
        - multipart
        - nested
        - mailbomb
        - unhandled
        - partiallycorrupted
        - fileslimit
        - timeout
        description: Deprecated, please rename it to archive_log.
        elements: str
        type: list
      av-scan:
        choices:
        - disable
        - monitor
        - block
        description: Deprecated, please rename it to av_scan. Enable AntiVirus scan service.
        type: str
      emulator:
        choices:
        - disable
        - enable
        description: Enable/disable the virus emulator.
        type: str
      external-blocklist:
        choices:
        - disable
        - monitor
        - block
        description: Deprecated, please rename it to external_blocklist. Enable external-blocklist.
        type: str
      fortiai:
        choices:
        - disable
        - monitor
        - block
        description: Enable/disable scanning of files by FortiAI.
        type: str
      fortindr:
        choices:
        - disable
        - block
        - monitor
        description: Enable scanning of files by FortiNDR.
        type: str
      fortisandbox:
        choices:
        - disable
        - block
        - monitor
        description: Enable scanning of files by FortiSandbox.
        type: str
      options:
        choices:
        - scan
        - quarantine
        - avmonitor
        description: No description.
        elements: str
        type: list
      outbreak-prevention:
        choices:
        - disabled
        - files
        - full-archive
        - disable
        - block
        - monitor
        description: Deprecated, please rename it to outbreak_prevention. Enable Virus
          Outbreak Prevention service.
        type: str
      quarantine:
        choices:
        - disable
        - enable
        description: Enable/disable quarantine for infected files.
        type: str
    type: dict

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

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