fortinet.fortimanager.fmgr_firewall_mmsprofile_dupe (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: Duplicate configuration.
      fortinet.fortimanager.fmgr_firewall_mmsprofile_dupe:
        # 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>
        mms_profile: <your own value>
        firewall_mmsprofile_dupe:
          action1:
            - log
            - archive
            - intercept
            - block
            - archive-first
            - alert-notif
          action2:
            - log
            - archive
            - intercept
            - block
            - archive-first
            - alert-notif
          action3:
            - log
            - archive
            - intercept
            - block
            - archive-first
            - alert-notif
          block_time1: <integer>
          block_time2: <integer>
          block_time3: <integer>
          limit1: <integer>
          limit2: <integer>
          limit3: <integer>
          protocol: <string>
          status1: <value in [disable, enable]>
          status2: <value in [disable, enable]>
          status3: <value in [disable, enable]>
          window1: <integer>
          window2: <integer>
          window3: <integer>

Inputs

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

mms-profile:
    description: Deprecated, please use "mms_profile"
    type: str

mms_profile:
    description: The parameter (mms-profile) in requested url.
    type: str

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

firewall_mmsprofile_dupe:
    description: The top level parameters set.
    required: false
    suboptions:
      action1:
        choices:
        - log
        - archive
        - intercept
        - block
        - archive-first
        - alert-notif
        description: No description.
        elements: str
        type: list
      action2:
        choices:
        - log
        - archive
        - intercept
        - block
        - archive-first
        - alert-notif
        description: No description.
        elements: str
        type: list
      action3:
        choices:
        - log
        - archive
        - intercept
        - block
        - archive-first
        - alert-notif
        description: No description.
        elements: str
        type: list
      block-time1:
        description: Deprecated, please rename it to block_time1. Duration for which action
          takes effect
        type: int
      block-time2:
        description: Deprecated, please rename it to block_time2. Duration for which action
          takes effect
        type: int
      block-time3:
        description: Deprecated, please rename it to block_time3. Duration action takes
          effect
        type: int
      limit1:
        description: Maximum number of messages allowed.
        type: int
      limit2:
        description: Maximum number of messages allowed.
        type: int
      limit3:
        description: Maximum number of messages allowed.
        type: int
      protocol:
        description: Protocol.
        type: str
      status1:
        choices:
        - disable
        - enable
        description: Enable/disable status1 detection.
        type: str
      status2:
        choices:
        - disable
        - enable
        description: Enable/disable status2 detection.
        type: str
      status3:
        choices:
        - disable
        - enable
        description: Enable/disable status3 detection.
        type: str
      window1:
        description: Window to count messages over
        type: int
      window2:
        description: Window to count messages over
        type: int
      window3:
        description: Window to count messages over
        type: int
    type: dict

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