fortinet.fortios.fortios_system_sms_server 模块 – 配置 SMS 服务器,以便在 Fortinet 的 FortiOS 和 FortiGate 中发送 SMS 消息来支持用户身份验证。
注意
此模块是 fortinet.fortios 集合(版本 2.3.8)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortios
。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_sms_server
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改系统功能和 sms_server 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值,需要在使用前调整为数据源。使用 FOS v6.0.0 测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选择
|
|
要操作的成员属性路径。 如果存在多个属性,则用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选择
|
|
指示是创建还是删除对象。 选择
|
|
配置 SMS 服务器,以便发送 SMS 消息来支持用户身份验证。 |
|
电子邮件到 SMS 服务器域名。 |
|
SMS 服务器的名称。 |
|
虚拟域,在先前定义的域中。vdom 是 FortiGate 的虚拟实例,可以配置并用作不同的单元。 默认值: |
注释
注意
旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方式
该模块支持 check_mode。
示例
- name: Configure SMS server for sending SMS messages to support user authentication.
fortinet.fortios.fortios_system_sms_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_sms_server:
mail_server: "<your_own_value>"
name: "default_name_4"
返回值
通用返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
Fortigate 映像的构建号 返回: 始终 示例: |
|
用于将内容置备到 FortiGate 的最后一个方法 返回: 始终 示例: |
|
FortiGate 在应用的上次操作中给出的最后结果 返回: 始终 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回: 成功 示例: |
|
用于满足请求的表的名称 返回: 始终 示例: |
|
用于满足请求的表的路径 返回: 始终 示例: |
|
内部修订号 返回: 始终 示例: |
|
设备的序列号 返回: 始终 示例: |
|
操作结果的指示 返回: 始终 示例: |
|
使用的虚拟域 返回: 始终 示例: |
|
FortiGate 的版本 返回: 始终 示例: |