fortinet.fortimanager.fmgr_firewall_gtp_ievalidation 模块 – IE 验证。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_gtp_ievalidation

字典

设置的顶层参数。

apn_restriction

别名: apn-restriction

字符串

验证 APN 限制。

选项

  • "disable"

  • "enable"

charging_gateway_addr

别名: charging-gateway-addr

字符串

验证计费网关地址。

选项

  • "disable"

  • "enable"

charging_ID

别名: charging-ID

字符串

验证计费 ID。

选项

  • "disable"

  • "enable"

end_user_addr

别名: end-user-addr

字符串

验证最终用户地址。

选项

  • "disable"

  • "enable"

gsn_addr

别名: gsn-addr

字符串

验证 GSN 地址。

选项

  • "disable"

  • "enable"

imei

字符串

验证 IMEI

选项

  • "disable"

  • "enable"

imsi

字符串

验证 IMSI。

选项

  • "disable"

  • "enable"

mm_context

别名: mm-context

字符串

验证 MM 上下文。

选项

  • "disable"

  • "enable"

ms_tzone

别名: ms-tzone

字符串

验证 MS 时区。

选项

  • "disable"

  • "enable"

ms_validated

别名: ms-validated

字符串

验证 MS 已验证。

选项

  • "disable"

  • "enable"

msisdn

字符串

验证 MSISDN。

选项

  • "disable"

  • "enable"

nsapi

字符串

验证 NSAPI。

选项

  • "disable"

  • "enable"

pdp_context

别名: pdp-context

字符串

验证 PDP 上下文。

选项

  • "disable"

  • "enable"

qos_profile

别名: qos-profile

字符串

验证服务质量

选项

  • "disable"

  • "enable"

rai

字符串

验证 RAI。

选项

  • "disable"

  • "enable"

rat_type

别名: rat-type

字符串

验证 RAT 类型。

选项

  • "disable"

  • "enable"

reordering_required

别名: reordering-required

字符串

验证是否需要重新排序。

选项

  • "disable"

  • "enable"

selection_mode

别名: selection-mode

字符串

验证选择模式。

选项

  • "disable"

  • "enable"

uli

字符串

验证用户位置信息。

选项

  • "disable"

  • "enable"

forticloud_access_token

字符串

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

gtp

字符串 / 必需

请求 URL 中的参数 (gtp)。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是全局的，也可以是包括 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 有助于完成工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: IE validation.
      fortinet.fortimanager.fmgr_firewall_gtp_ievalidation:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        gtp: <your own value>
        firewall_gtp_ievalidation:
          apn_restriction: <value in [disable, enable]>
          charging_ID: <value in [disable, enable]>
          charging_gateway_addr: <value in [disable, enable]>
          end_user_addr: <value in [disable, enable]>
          gsn_addr: <value in [disable, enable]>
          imei: <value in [disable, enable]>
          imsi: <value in [disable, enable]>
          mm_context: <value in [disable, enable]>
          ms_tzone: <value in [disable, enable]>
          ms_validated: <value in [disable, enable]>
          msisdn: <value in [disable, enable]>
          nsapi: <value in [disable, enable]>
          pdp_context: <value in [disable, enable]>
          qos_profile: <value in [disable, enable]>
          rai: <value in [disable, enable]>
          rat_type: <value in [disable, enable]>
          reordering_required: <value in [disable, enable]>
          selection_mode: <value in [disable, enable]>
          uli: <value in [disable, enable]>

返回值

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

键

描述

元数据

字典

请求的结果。

返回值： 始终

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)

  • 沈锋 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)