fortinet.fortios.fortios_switch_controller_snmp_user 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中全局配置 FortiSwitch SNMP v3 用户。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定： fortinet.fortios.fortios_switch_controller_snmp_user。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 switch_controller 功能和 snmp_user 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
全局配置 FortiSwitch SNMP v3 用户。 |
|
身份验证协议。 选项
|
|
身份验证协议的密码。 |
|
SNMP 用户名。 |
|
隐私（加密）协议。 选项
|
|
隐私（加密）协议的密码。 |
|
启用/禁用此用户的 SNMP 查询。 选项
|
|
SNMPv3 查询端口。 |
|
消息身份验证和加密的安全级别。 选项
|
|
虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： |
注释
注意
旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方法。
该模块支持 check_mode。
示例
- name: Configure FortiSwitch SNMP v3 users globally.
fortinet.fortios.fortios_switch_controller_snmp_user:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_snmp_user:
auth_proto: "md5"
auth_pwd: "<your_own_value>"
name: "default_name_5"
priv_proto: "aes128"
priv_pwd: "<your_own_value>"
queries: "disable"
query_port: "161"
security_level: "no-auth-no-priv"
返回值
常用的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
Fortigate 镜像的构建编号 返回： 始终 示例： |
|
上次用于将内容置备到 FortiGate 的方法 返回： 始终 示例： |
|
FortiGate 在上次应用的操作中给出的最后结果 返回： 始终 示例： |
|
上次调用 FortiGate 时使用的主密钥 (id) 返回： 成功 示例： |
|
用于完成请求的表的名称 返回： 始终 示例： |
|
用于完成请求的表的路径 返回： 始终 示例： |
|
内部修订号 返回： 始终 示例： |
|
设备的序列号 返回： 始终 示例： |
|
操作结果指示 返回： 始终 示例： |
|
使用的虚拟域 返回： 始终 示例： |
|
FortiGate 版本 返回： 始终 示例： |