fortinet.fortimanager.fmgr_system_replacemsggroup_mm7 模块 – 替换消息表条目。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必填

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

replacemsg-group

字符串

已弃用，请使用“replacemsg_group”

replacemsg_group

字符串

请求 URL 中的参数 (replacemsg-group)。

state

字符串 / 必填

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

system_replacemsggroup_mm7

字典

设置的顶级参数。

add_smil

别名：add-smil

字符串

添加消息封装

选项

  • "disable"

  • "enable"

addr_type

别名：addr-type

字符串

源地址类型

选项

  • "rfc2822-addr"

  • "number"

  • "short-code"

allow_content_adaptation

别名：allow-content-adaptation

字符串

允许内容适配

选项

  • "disable"

  • "enable"

charset

字符串

用于替换消息的字符编码

选项

  • "us-ascii"

  • "utf-8"

class

字符串

消息类别

选项

  • "personal"

  • "advertisement"

  • "informational"

  • "auto"

  • "not-included"

fmgr_message

字符串

消息文本

format

字符串

格式标志。

选项

  • "none"

  • "text"

  • "html"

  • "wml"

from

字符串

发件人地址

from_sender

别名：from-sender

字符串

从收件人发送的通知消息

选项

  • "disable"

  • "enable"

header

字符串

标题标志。

选项

  • "none"

  • "http"

  • "8bit"

image

字符串

消息字符串。

msg_type

别名：msg-type

字符串 / 必填

消息类型。

priority

字符串

消息优先级

选项

  • "low"

  • "normal"

  • "high"

  • "not-included"

rsp_status

别名：rsp-status

字符串

响应状态

选项

  • "success"

  • "partial-success"

  • "client-err"

  • "oper-restrict"

  • "addr-err"

  • "addr-not-found"

  • "content-refused"

  • "msg-id-not-found"

  • "link-id-not-found"

  • "msg-fmt-corrupt"

  • "app-id-not-found"

  • "repl-app-id-not-found"

  • "srv-err"

  • "not-possible"

  • "msg-rejected"

  • "multiple-addr-not-supp"

  • "app-addr-not-supp"

  • "gen-service-err"

  • "improper-ident"

  • "unsupp-ver"

  • "unsupp-oper"

  • "validation-err"

  • "service-err"

  • "service-unavail"

  • "service-denied"

  • "app-denied"

smil_part

别名：smil-part

字符串

消息封装文本

subject

字符串

主题文本字符串

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 (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: Replacement message table entries.
      fortinet.fortimanager.fmgr_system_replacemsggroup_mm7:
        # 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>
        replacemsg_group: <your own value>
        state: present # <value in [present, absent]>
        system_replacemsggroup_mm7:
          add_smil: <value in [disable, enable]>
          addr_type: <value in [rfc2822-addr, number, short-code]>
          allow_content_adaptation: <value in [disable, enable]>
          charset: <value in [us-ascii, utf-8]>
          class: <value in [personal, advertisement, informational, ...]>
          format: <value in [none, text, html, ...]>
          from: <string>
          from_sender: <value in [disable, enable]>
          header: <value in [none, http, 8bit]>
          image: <string>
          fmgr_message: <string>
          msg_type: <string>
          priority: <value in [low, normal, high, ...]>
          rsp_status: <value in [success, partial-success, client-err, ...]>
          smil_part: <string>
          subject: <string>

返回值

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

键

描述

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)