fortinet.fortimanager.fmgr_firewall_gtp_policyv2 模块 – 对每个 GTPv2-c 数据包应用允许或拒绝操作。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_gtp_policyv2

字典

设置的顶级参数。

action

字符串

操作。

选项

  • "deny"

  • "allow"

apn_sel_mode

别名：apn-sel-mode

列表 / 元素=字符串

APN 选择模式。

选项

  • "ms"

  • "net"

  • "vrf"

apnmember

任意

(列表或字符串) APN 成员。

id

整数 / 必需

ID。

imsi_prefix

别名：imsi-prefix

字符串

IMSI 前缀。

max_apn_restriction

别名：max-apn-restriction

字符串

最大 APN 限制值。

选项

  • "all"

  • "public-1"

  • "public-2"

  • "private-1"

  • "private-2"

mei

字符串

MEI 模式。

messages

列表 / 元素=字符串

GTP 消息。

选项

  • "create-ses-req"

  • "create-ses-res"

  • "modify-bearer-req"

  • "modify-bearer-res"

msisdn_prefix

别名：msisdn-prefix

字符串

MSISDN 前缀。

rat_type

别名：rat-type

列表 / 元素=字符串

RAT 类型。

选项

  • "any"

  • "utran"

  • "geran"

  • "wlan"

  • "gan"

  • "hspa"

  • "eutran"

  • "virtual"

  • "nbiot"

  • "ltem"

  • "nr"

uli

任意

(列表) GTPv2 ULI 模式

forticloud_access_token

字符串

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

gtp

字符串 / 必需

请求 URL 中的参数 (gtp)。

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

整数

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

默认值： 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 (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: Apply allow or deny action to each GTPv2-c packet.
      fortinet.fortimanager.fmgr_firewall_gtp_policyv2:
        # 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>
        state: present # <value in [present, absent]>
        firewall_gtp_policyv2:
          action: <value in [deny, allow]>
          apn_sel_mode:
            - "ms"
            - "net"
            - "vrf"
          apnmember: <list or string>
          id: <integer>
          imsi_prefix: <string>
          max_apn_restriction: <value in [all, public-1, public-2, ...]>
          mei: <string>
          messages:
            - "create-ses-req"
            - "create-ses-res"
            - "modify-bearer-req"
            - "modify-bearer-res"
          msisdn_prefix: <string>
          rat_type:
            - "any"
            - "utran"
            - "geran"
            - "wlan"
            - "gan"
            - "hspa"
            - "eutran"
            - "virtual"
            - "nbiot"
            - "ltem"
            - "nr"
          uli: <list or string>

返回值

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

键

描述

元数据

字典

请求的结果。

返回值：始终返回

request_url

字符串

请求的完整URL。

返回值：始终返回

示例： "/sys/login/user"

response_code

整数

API请求的状态。

返回值：始终返回

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回值：始终返回

response_message

字符串

API响应的描述性消息。

返回值：始终返回

示例： "OK."

system_information

字典

目标系统的信息。

返回值：始终返回

rc

整数

请求的状态。

返回值：始终返回

示例： 0

version_check_warning

列表 / 元素=字符串

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

返回值：复杂结构

作者

  • 杜欣伟 (@dux-fortinet)

  • 李兴 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑连克 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)