fortinet.fortimanager.fmgr_application_list_entries 模块 – 应用列表条目。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_application_list_entries。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有参数和值，在使用前需要调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

application_list_entries

字典

设置的顶级参数。

action

字符串

允许或阻止来自此应用程序的流量，或重置连接。

选项

  • "pass"

  • "block"

  • "reset"

application

任意

(列表) 允许的应用程序的 ID。

behavior

任意

(列表) 应用行为过滤器。

category

任意

(列表或字符串) 类别 ID 列表。

exclusion

任意

(列表) 排除的应用程序的 ID。

id

整数 / 必需

条目 ID。

log

字符串

启用/禁用此应用程序列表的日志记录。

选项

  • "disable"

  • "enable"

log_packet

别名：log-packet

字符串

启用/禁用数据包日志记录。

选项

  • "disable"

  • "enable"

parameters

列表 / 元素=字典

参数。

id

integer

参数 ID。

members

列表 / 元素=字典

成员。

id

integer

参数。

name

字符串

参数名称。

value

字符串

参数值。

value

字符串

参数值。

per_ip_shaper

别名：per-ip-shaper

字符串

每个 IP 的流量整形器。

popularity

列表 / 元素=字符串

应用流行度过滤器

选项

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

protocols

任意

(列表) 应用协议过滤器。

quarantine

字符串

隔离方法。

选项

  • "none"

  • "attacker"

quarantine_expiry

别名：quarantine-expiry

字符串

隔离持续时间。

quarantine_log

别名：quarantine-log

字符串

启用/禁用隔离日志记录。

选项

  • "disable"

  • "enable"

rate_count

别名：rate-count

integer

速率计数。

rate_duration

别名：rate-duration

integer

持续时间

rate_mode

别名：rate-mode

字符串

速率限制模式。

选项

  • "periodical"

  • "continuous"

rate_track

别名：rate-track

字符串

跟踪数据包协议字段。

选项

  • "none"

  • "src-ip"

  • "dest-ip"

  • "dhcp-client-mac"

  • "dns-domain"

risk

任意

(列表) 允许此应用程序发生流量的风险或影响

session_ttl

别名：session-ttl

integer

会话 TTL

shaper

字符串

流量整形器。

shaper_reverse

别名：shaper-reverse

字符串

反向流量整形器。

sub_category

别名：sub-category

任意

(列表) 应用子类别 ID 列表。

tags

字符串

标签过滤器。

technology

任意

(列表) 应用技术过滤器。

vendor

任意

(列表) 应用供应商过滤器。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

list

字符串 / 必需

请求 URL 中的参数 (list)。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是全局的和其他值，包括 root。

workspace_locking_timeout

integer

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

注释

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此FortiManager模块支持在工作区锁定模式下运行，顶级参数`workspace_locking_adom`和`workspace_locking_timeout`用于实现此功能。

  • 要创建或更新对象，请使用`state present`指令。

  • 要删除对象，请使用`state absent`指令。

  • 通常情况下，如果返回非零rc，则运行一个模块可能会失败。您也可以使用参数`rc_failed`和`rc_succeeded`来覆盖失败或成功的条件。

示例

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

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

返回值

常见的返回值已在此处记录，以下是此模块特有的字段：

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整URL。

返回：始终

示例： "/sys/login/user"

response_code

integer

API请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回：始终

response_message

字符串

API响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

integer

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈峰 (@fshen01)

  • 卢宏斌 (@fgtdev-hblu)