drmofu.fortimanager.fmgr_application_list_entries (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: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Application list entries.
      fmgr_application_list_entries:
         adom: ansible
         list: 'ansible-test' # name
         state: present
         application_list_entries:
            action: pass
            behavior: 'all'
            category: '2'
            id: 1
            log: enable
            log-packet: enable
            protocols: 'all'

Scanned by Steampunk Spotter

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

 - name: gathering fortimanager facts
   hosts: fortimanager00
   gather_facts: no
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
   tasks:
    - name: retrieve all the entries in application list
      fmgr_fact:
        facts:
            selector: 'application_list_entries'
            params:
                adom: 'ansible'
                list: 'ansible-test' # name
                entries: 'your_value'

Inputs

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

list:
    description: the parameter (list) in requested url
    required: true
    type: str

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
    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

application_list_entries:
    description: the top level parameters set
    required: false
    suboptions:
      action:
        choices:
        - pass
        - block
        - reset
        description: Pass or block traffic, or reset connection for traffic from this
          application.
        type: str
      application:
        description: description
        type: int
      behavior:
        description: description
        type: str
      category:
        description: Category ID list.
        type: str
      exclusion:
        description: description
        type: int
      id:
        description: Entry ID.
        type: int
      log:
        choices:
        - disable
        - enable
        description: Enable/disable logging for this application list.
        type: str
      log-packet:
        choices:
        - disable
        - enable
        description: Enable/disable packet logging.
        type: str
      parameters:
        description: description
        elements: dict
        suboptions:
          id:
            description: Parameter ID.
            type: int
          members:
            description: description
            elements: dict
            suboptions:
              id:
                description: Parameter.
                type: int
              name:
                description: Parameter name.
                type: str
              value:
                description: Parameter value.
                type: str
            type: list
          value:
            description: Parameter value.
            type: str
        type: list
      per-ip-shaper:
        description: Per-IP traffic shaper.
        type: str
      popularity:
        choices:
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
        description: description
        elements: str
        type: list
      protocols:
        description: description
        type: str
      quarantine:
        choices:
        - none
        - attacker
        description: Quarantine method.
        type: str
      quarantine-expiry:
        description: Duration of quarantine.
        type: str
      quarantine-log:
        choices:
        - disable
        - enable
        description: Enable/disable quarantine logging.
        type: str
      rate-count:
        description: Count of the rate.
        type: int
      rate-duration:
        description: Duration
        type: int
      rate-mode:
        choices:
        - periodical
        - continuous
        description: Rate limit mode.
        type: str
      rate-track:
        choices:
        - none
        - src-ip
        - dest-ip
        - dhcp-client-mac
        - dns-domain
        description: Track the packet protocol field.
        type: str
      risk:
        description: description
        type: int
      session-ttl:
        description: Session TTL
        type: int
      shaper:
        description: Traffic shaper.
        type: str
      shaper-reverse:
        description: Reverse traffic shaper.
        type: str
      sub-category:
        description: description
        type: int
      tags:
        description: Tag filter.
        type: str
      technology:
        description: description
        type: str
      vendor:
        description: description
        type: str
    type: dict

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

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