fortinet.fortimanager.fmgr_application_list 模块 – 配置应用程序控制列表。

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_application_list。

fortinet.fortimanager 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 url 中的参数 (adom)。

application_list

字典

顶层参数集。

app_replacemsg

别名：app-replacemsg

字符串

启用/禁用被阻止应用程序的替换消息。

选项

  • "disable"

  • "enable"

注释

字符串

注释

control_default_network_services

别名：control-default-network-services

字符串

启用/禁用对选定端口上的协议的强制执行。

选项

  • "disable"

  • "enable"

deep_app_inspection

别名：deep-app-inspection

字符串

启用/禁用深度应用程序检查。

选项

  • "disable"

  • "enable"

default_network_services

别名：default-network-services

列表 / 元素=字典

默认网络服务。

id

整数

条目 ID。

port

整数

端口号。

services

列表 / 元素=字符串

网络协议。

选项

  • "http"

  • "ssh"

  • "telnet"

  • "ftp"

  • "dns"

  • "smtp"

  • "pop3"

  • "imap"

  • "snmp"

  • "nntp"

  • "https"

violation_action

别名：violation-action

字符串

对于在选定端口下未列入白名单的协议的操作。

选项

  • "block"

  • "monitor"

  • "pass"

enforce_default_app_port

别名：enforce-default-app-port

字符串

启用/禁用允许的应用程序的默认应用程序端口强制执行。

选项

  • "disable"

  • "enable"

条目

列表 / 元素=字典

条目。

action

字符串

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

选项

  • "pass"

  • "block"

  • "reset"

application

任何

（列表）允许的应用程序的 ID。

behavior

任何

（列表）应用程序行为过滤器。

category

任何

（列表或字符串）类别 ID 列表。

exclusion

任何

（列表）排除的应用程序的 ID。

id

整数

条目 ID。

log

字符串

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

选项

  • "disable"

  • "enable"

log_packet

别名：log-packet

字符串

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

选项

  • "disable"

  • "enable"

parameters

列表 / 元素=字典

参数。

id

整数

参数 ID。

members

列表 / 元素=字典

成员。

id

整数

参数。

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

整数

速率的计数。

rate_duration

别名：rate-duration

整数

持续时间

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

整数

会话 TTL

shaper

字符串

流量整形器。

shaper_reverse

别名：shaper-reverse

字符串

反向流量整形器。

sub_category

别名：sub-category

任何

（列表）应用程序子类别 ID 列表。

tags

字符串

标签过滤器。

技术

任何

（列表）应用程序技术过滤器。

供应商

任何

（列表）应用程序供应商过滤器。

extended_log

别名: extended-log

字符串

启用/禁用扩展日志记录。

选项

  • "disable"

  • "enable"

force_inclusion_ssl_di_sigs

别名: force-inclusion-ssl-di-sigs

字符串

启用/禁用强制包含 SSL 深度检测签名。

选项

  • "disable"

  • "enable"

name

字符串 / 必需

列表名称。

选项

列表 / 元素=字符串

默认允许的基本应用程序协议签名。

选项

  • "allow-dns"

  • "allow-icmp"

  • "allow-http"

  • "allow-ssl"

  • "allow-quic"

other_application_action

别名: other-application-action

字符串

其他应用程序的操作。

选项

  • "pass"

  • "block"

other_application_log

别名: other-application-log

字符串

启用/禁用其他应用程序的日志记录。

选项

  • "disable"

  • "enable"

p2p_black_list

别名: p2p-black-list

列表 / 元素=字符串

要加入黑名单的 P2P 应用程序。

选项

  • "skype"

  • "edonkey"

  • "bittorrent"

p2p_block_list

别名: p2p-block-list

列表 / 元素=字符串

要加入阻止列表的 P2P 应用程序。

选项

  • "skype"

  • "edonkey"

  • "bittorrent"

replacemsg_group

别名: replacemsg-group

字符串

替换消息组。

unknown_application_action

别名: unknown-application-action

字符串

传递或阻止来自未知应用程序的流量。

选项

  • "pass"

  • "block"

unknown_application_log

别名: unknown-application-log

字符串

启用/禁用未知应用程序的日志记录。

选项

  • "disable"

  • "enable"

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

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

workspace_locking_timeout

整数

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

默认: 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: Configure application control lists.
      fortinet.fortimanager.fmgr_application_list:
        adom: ansible
        state: present
        application_list:
          app-replacemsg: enable
          comment: "ansible-test-comment"
          deep-app-inspection: enable
          extended-log: disable
          name: "ansible-test"
          other-application-action: pass
          other-application-log: disable
          unknown-application-action: pass
          unknown-application-log: disable

- 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 application list
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "application_list"
          params:
            adom: "ansible"
            list: "your_value"

返回值

常见的返回值在此处记录 这里, 以下是此模块独有的字段

键

描述

元

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

api 请求的状态。

返回: 总是

示例: 0

response_data

列表 / 元素=字符串

api 响应。

返回: 总是

response_message

字符串

api 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)