fortinet.fortimanager.fmgr_firewall_internetservicecustom 模块 – 配置自定义互联网服务。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_firewall_internetservicecustom。

fortinet.fortimanager 2.0.0 中的新功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

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

bypass_validation

布尔值

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

选择

  • false ← (默认)

  • true

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

firewall_internetservicecustom

字典

设置的顶层参数。

comment

字符串

注释。

disable_entry

别名: disable-entry

列表 / 元素=字典

禁用条目。

id

整数

禁用条目 ID。

ip_range

别名: ip-range

列表 / 元素=字典

IP 范围。

end_ip

别名: end-ip

字符串

结束 IP 地址。

id

整数

禁用条目范围 ID。

start_ip

别名: start-ip

字符串

起始 IP 地址。

port

任何

(列表) TCP/IP 端口的整数值

protocol

整数

IANA 定义的协议类型的整数值

entry

列表 / 元素=字典

条目。

addr_mode

别名: addr-mode

字符串

地址模式

选择

  • "ipv4"

  • "ipv6"

dst

任何

(列表或字符串) 目标地址或地址组名称。

dst6

任何

(列表) 目标地址6或地址6组名称。

id

整数

条目 ID

port_range

别名: port-range

列表 / 元素=字典

端口范围。

end_port

别名: end-port

整数

范围中结束的 TCP/UDP/SCTP 目标端口的整数值

id

整数

自定义条目端口范围 ID。

start_port

别名: start-port

整数

范围中起始的 TCP/UDP/SCTP 目标端口的整数值

protocol

整数

IANA 定义的协议类型的整数值

id

整数

互联网服务 ID。

master_service_id

别名: master-service-id

字符串

互联网服务数据库中的互联网服务 ID。

name

字符串 / 必需

互联网服务名称。

reputation

整数

自定义互联网服务的信誉级别。

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 custom Internet Services via Generic Module.
      fortinet.fortimanager.fmgr_generic:
        method: "set"
        params:
          - url: "/pm/config/adom/ansible/obj/firewall/internet-service-custom"
            data:
              - name: "ansible-test"
                comment: "ansible-comment"
    - name: Configure custom Internet Services.
      when: false
      fortinet.fortimanager.fmgr_firewall_internetservicecustom:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_internetservicecustom:
          comment: "ansible-comment"
          name: "ansible-test"

- 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 custom Internet Services
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_internetservicecustom"
          params:
            adom: "ansible"
            internet-service-custom: "your_value"

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

meta

字典

请求的结果。

返回: 总是

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)