fortinet.fortimanager.fmgr_application_list_entries (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: Application list entries.
      fortinet.fortimanager.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: 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 entries in application list
      fortinet.fortimanager.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
    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

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: (list) No description.
        type: raw
      behavior:
        description: (list) No description.
        type: raw
      category:
        description: (list or str) Category ID list.
        type: raw
      exclusion:
        description: (list) No description.
        type: raw
      id:
        description: Entry ID.
        required: true
        type: int
      log:
        choices:
        - disable
        - enable
        description: Enable/disable logging for this application list.
        type: str
      log-packet:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to log_packet. Enable/disable packet
          logging.
        type: str
      parameters:
        description: No description.
        elements: dict
        suboptions:
          id:
            description: Parameter ID.
            type: int
          members:
            description: No 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: Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper.
        type: str
      popularity:
        choices:
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
        description: No description.
        elements: str
        type: list
      protocols:
        description: (list) No description.
        type: raw
      quarantine:
        choices:
        - none
        - attacker
        description: Quarantine method.
        type: str
      quarantine-expiry:
        description: Deprecated, please rename it to quarantine_expiry. Duration of quarantine.
        type: str
      quarantine-log:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to quarantine_log. Enable/disable quarantine
          logging.
        type: str
      rate-count:
        description: Deprecated, please rename it to rate_count. Count of the rate.
        type: int
      rate-duration:
        description: Deprecated, please rename it to rate_duration. Duration
        type: int
      rate-mode:
        choices:
        - periodical
        - continuous
        description: Deprecated, please rename it to rate_mode. Rate limit mode.
        type: str
      rate-track:
        choices:
        - none
        - src-ip
        - dest-ip
        - dhcp-client-mac
        - dns-domain
        description: Deprecated, please rename it to rate_track. Track the packet protocol
          field.
        type: str
      risk:
        description: (list) No description.
        type: raw
      session-ttl:
        description: Deprecated, please rename it to session_ttl. Session TTL
        type: int
      shaper:
        description: Traffic shaper.
        type: str
      shaper-reverse:
        description: Deprecated, please rename it to shaper_reverse. Reverse traffic shaper.
        type: str
      sub-category:
        description: (list) Deprecated, please rename it to sub_category.
        type: raw
      tags:
        description: Tag filter.
        type: str
      technology:
        description: (list) No description.
        type: raw
      vendor:
        description: (list) No description.
        type: raw
    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