fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit 模块 – 消息速率限制。

注意

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

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortimanager

要在 playbook 中使用它,请指定: fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit

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_messageratelimit

字典

设置的顶级参数。

create_aa_pdp_request

别名:create-aa-pdp-request

整数

创建 AA PDP 上下文请求的速率限制

create_aa_pdp_response

别名:create-aa-pdp-response

整数

创建 AA PDP 上下文响应的速率限制

create_mbms_request

别名:create-mbms-request

整数

创建 MBMS 上下文请求的速率限制

create_mbms_response

别名:create-mbms-response

整数

创建 MBMS 上下文响应的速率限制

create_pdp_request

别名:create-pdp-request

整数

创建 PDP 上下文请求的速率限制

create_pdp_response

别名:create-pdp-response

整数

创建 PDP 上下文响应的速率限制

delete_aa_pdp_request

别名:delete-aa-pdp-request

整数

删除 AA PDP 上下文请求的速率限制

delete_aa_pdp_response

别名:delete-aa-pdp-response

整数

删除 AA PDP 上下文响应的速率限制

delete_mbms_request

别名:delete-mbms-request

整数

删除 MBMS 上下文请求的速率限制

delete_mbms_response

别名:delete-mbms-response

整数

删除 MBMS 上下文响应的速率限制

delete_pdp_request

别名:delete-pdp-request

整数

删除 PDP 上下文请求的速率限制

delete_pdp_response

别名:delete-pdp-response

整数

删除 PDP 上下文响应的速率限制

echo_reponse

别名:echo-reponse

整数

回显响应的速率限制

echo_request

别名:echo-request

整数

回显请求的速率限制

echo_response

别名:echo-response

整数

回显响应的速率限制

error_indication

别名:error-indication

整数

错误指示的速率限制

failure_report_request

别名:failure-report-request

整数

故障报告请求的速率限制

failure_report_response

别名:failure-report-response

整数

故障报告响应的速率限制

fwd_reloc_complete_ack

别名:fwd-reloc-complete-ack

整数

转发重定位完成确认的速率限制

fwd_relocation_complete

别名:fwd-relocation-complete

整数

转发重定位完成的速率限制

fwd_relocation_request

别名:fwd-relocation-request

整数

转发重定位请求的速率限制

fwd_relocation_response

别名:fwd-relocation-response

整数

转发重定位响应的速率限制

fwd_srns_context

别名:fwd-srns-context

整数

转发 SRNS 上下文的速率限制

fwd_srns_context_ack

别名:fwd-srns-context-ack

整数

转发 SRNS 上下文确认的速率限制

g_pdu

别名:g-pdu

整数

G-PDU 的速率限制

identification_request

别名:identification-request

整数

身份验证请求的速率限制

identification_response

别名:identification-response

整数

身份验证响应的速率限制

mbms_de_reg_request

别名:mbms-de-reg-request

整数

MBMS 注销请求的速率限制

mbms_de_reg_response

别名:mbms-de-reg-response

整数

MBMS注销响应的速率限制

mbms_notify_rej_request

别名:mbms-notify-rej-request

整数

MBMS通知拒绝请求的速率限制

mbms_notify_rej_response

别名:mbms-notify-rej-response

整数

MBMS通知拒绝响应的速率限制

mbms_notify_request

别名:mbms-notify-request

整数

MBMS通知请求的速率限制

mbms_notify_response

别名:mbms-notify-response

整数

MBMS通知响应的速率限制

mbms_reg_request

别名:mbms-reg-request

整数

MBMS注册请求的速率限制

mbms_reg_response

别名:mbms-reg-response

整数

MBMS注册响应的速率限制

mbms_ses_start_request

别名:mbms-ses-start-request

整数

MBMS会话启动请求的速率限制

mbms_ses_start_response

别名:mbms-ses-start-response

整数

MBMS会话启动响应的速率限制

mbms_ses_stop_request

别名:mbms-ses-stop-request

整数

MBMS会话停止请求的速率限制

mbms_ses_stop_response

别名:mbms-ses-stop-response

整数

MBMS会话停止响应的速率限制

note_ms_request

别名:note-ms-request

整数

note MS GPRS存在请求的速率限制

note_ms_response

别名:note-ms-response

整数

note MS GPRS存在响应的速率限制

pdu_notify_rej_request

别名:pdu-notify-rej-request

整数

PDU通知拒绝请求的速率限制

pdu_notify_rej_response

别名:pdu-notify-rej-response

整数

PDU通知拒绝响应的速率限制

pdu_notify_request

别名:pdu-notify-request

整数

PDU通知请求的速率限制

pdu_notify_response

别名:pdu-notify-response

整数

PDU通知响应的速率限制

ran_info

别名:ran-info

整数

RAN信息中继的速率限制

relocation_cancel_request

别名:relocation-cancel-request

整数

重新定位取消请求的速率限制

relocation_cancel_response

别名:relocation-cancel-response

整数

重新定位取消响应的速率限制

send_route_request

别名:send-route-request

整数

发送GPRS路由信息的请求速率限制

send_route_response

别名:send-route-response

整数

发送GPRS路由信息的响应速率限制

sgsn_context_ack

别名:sgsn-context-ack

整数

SGSN上下文确认的速率限制

sgsn_context_request

别名:sgsn-context-request

整数

SGSN上下文请求的速率限制

sgsn_context_response

别名:sgsn-context-response

整数

SGSN上下文响应的速率限制

support_ext_hdr_notify

别名:support-ext-hdr-notify

整数

支持扩展报头通知的速率限制

update_mbms_request

别名:update-mbms-request

整数

更新MBMS上下文请求的速率限制

update_mbms_response

别名:update-mbms-response

整数

更新MBMS上下文响应的速率限制

update_pdp_request

别名:update-pdp-request

整数

更新PDP上下文请求的速率限制

update_pdp_response

别名:update-pdp-response

整数

更新PDP上下文响应的速率限制

version_not_support

别名:version-not-support

整数

版本不支持的速率限制

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,值可以是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有助于完成此工作。

  • 通常,当返回非零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: Message rate limiting.
      fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit:
        # 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_messageratelimit:
          create_aa_pdp_request: <integer>
          create_aa_pdp_response: <integer>
          create_mbms_request: <integer>
          create_mbms_response: <integer>
          create_pdp_request: <integer>
          create_pdp_response: <integer>
          delete_aa_pdp_request: <integer>
          delete_aa_pdp_response: <integer>
          delete_mbms_request: <integer>
          delete_mbms_response: <integer>
          delete_pdp_request: <integer>
          delete_pdp_response: <integer>
          echo_reponse: <integer>
          echo_request: <integer>
          error_indication: <integer>
          failure_report_request: <integer>
          failure_report_response: <integer>
          fwd_reloc_complete_ack: <integer>
          fwd_relocation_complete: <integer>
          fwd_relocation_request: <integer>
          fwd_relocation_response: <integer>
          fwd_srns_context: <integer>
          fwd_srns_context_ack: <integer>
          g_pdu: <integer>
          identification_request: <integer>
          identification_response: <integer>
          mbms_de_reg_request: <integer>
          mbms_de_reg_response: <integer>
          mbms_notify_rej_request: <integer>
          mbms_notify_rej_response: <integer>
          mbms_notify_request: <integer>
          mbms_notify_response: <integer>
          mbms_reg_request: <integer>
          mbms_reg_response: <integer>
          mbms_ses_start_request: <integer>
          mbms_ses_start_response: <integer>
          mbms_ses_stop_request: <integer>
          mbms_ses_stop_response: <integer>
          note_ms_request: <integer>
          note_ms_response: <integer>
          pdu_notify_rej_request: <integer>
          pdu_notify_rej_response: <integer>
          pdu_notify_request: <integer>
          pdu_notify_response: <integer>
          ran_info: <integer>
          relocation_cancel_request: <integer>
          relocation_cancel_response: <integer>
          send_route_request: <integer>
          send_route_response: <integer>
          sgsn_context_ack: <integer>
          sgsn_context_request: <integer>
          sgsn_context_response: <integer>
          support_ext_hdr_notify: <integer>
          update_mbms_request: <integer>
          update_mbms_response: <integer>
          update_pdp_request: <integer>
          update_pdp_response: <integer>
          version_not_support: <integer>
          echo_response: <integer>

返回值

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

描述

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

列表 / 元素=字符串

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

返回: 复杂

作者

  • 杜欣蔚 (@dux-fortinet)

  • 李兴 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)