fortinet.fortios.fortios_system_snmp_sysinfo 模块 – Fortinet 的 FortiOS 和 FortiGate 中的 SNMP 系统信息配置。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortios
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定: fortinet.fortios.fortios_system_snmp_sysinfo
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 system_snmp 功能和 sysinfo 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整到数据源。在 FOS v6.0.0 上进行了测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性,则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时,将忽略 state 选项。 选项
|
|
SNMP 系统信息配置。 |
|
启用/禁用允许在某些 RFC 表中追加 vdom 或接口索引。 选项
|
|
联系信息。 |
|
系统描述。 |
|
本地 SNMP engineID 字符串(最多 27 个字符)。 |
|
本地 SNMP engineID 类型(文本/十六进制/MAC)。 选项
|
|
系统位置。 |
|
启用/禁用允许来自非管理 vdom 的 SNMPv3 查询。 选项
|
|
启用/禁用 SNMP。 选项
|
|
发送陷阱时的可用内存使用率。 |
|
发送陷阱时的可释放内存使用率。 |
|
发送陷阱时的 CPU 使用率。 |
|
发送陷阱时的日志磁盘使用率。 |
|
发送陷阱时的内存使用率。 |
|
虚拟域,在之前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。 默认: |
备注
注意
旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方法。
示例
- name: SNMP system info configuration.
fortinet.fortios.fortios_system_snmp_sysinfo:
vdom: "{{ vdom }}"
system_snmp_sysinfo:
append_index: "enable"
contact_info: "<your_own_value>"
description: "<your_own_value>"
engine_id: "<your_own_value>"
engine_id_type: "text"
location: "<your_own_value>"
non_mgmt_vdom_query: "enable"
status: "enable"
trap_free_memory_threshold: "5"
trap_freeable_memory_threshold: "60"
trap_high_cpu_threshold: "80"
trap_log_full_threshold: "90"
trap_low_memory_threshold: "80"
返回值
常见的返回值已记录在 此处,以下是此模块特有的字段。
键 |
描述 |
---|---|
Fortigate 镜像的版本号 返回: 始终 示例: |
|
上次用于将内容置备到 FortiGate 的方法 返回: 始终 示例: |
|
FortiGate 在上次应用的操作中给出的最后结果 返回: 始终 示例: |
|
上次调用 FortiGate 时使用的主密钥 (id) 返回: 成功 示例: |
|
用于完成请求的表的名称 返回: 始终 示例: |
|
用于完成请求的表的路径 返回: 始终 示例: |
|
内部修订号 返回: 始终 示例: |
|
设备的序列号 返回: 始终 示例: |
|
操作结果的指示 返回: 始终 示例: |
|
使用的虚拟域名 返回: 始终 示例: |
|
FortiGate 版本 返回: 始终 示例: |