fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy 模块 – 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_ieremovepolicy。

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_ieremovepolicy 字典	设置的顶级参数。
id 整数 / 必选	ID。
remove_ies 别名: remove-ies 列表 / 元素=字符串	要删除的 GTP IE。选项 `"apn-restriction"` `"rat-type"` `"rai"` `"uli"` `"imei"`
sgsn_addr 别名: sgsn-addr 字符串	SGSN 地址名称。
sgsn_addr6 别名: sgsn-addr6 字符串	SGSN IPv6 地址名称。
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌验证 Ansible 客户端。
gtp 字符串 / 必选	请求 URL 中的参数 (gtp)。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的返回码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的返回码列表。
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: IE remove policy.
      fortinet.fortimanager.fmgr_firewall_gtp_ieremovepolicy:
        bypass_validation: false
        adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
        gtp: "ansible-test" # name
        state: present
        firewall_gtp_ieremovepolicy:
          id: 1
          remove-ies:
            - apn-restriction
            - rat-type
            - rai
            - uli
            - imei
          sgsn-addr: "your_value"

- 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 IE remove policys in the GTP
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_gtp_ieremovepolicy"
          params:
            adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
            gtp: "ansible-test" # name
            ie-remove-policy: "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)