fortinet.fortimanager.fmgr_system_snmp_community 模块 – SNMP 社区配置。

注意

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

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

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

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_system_snmp_community。

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

  • 示例包含所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

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

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 代码列表。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

system_snmp_community

字典

设置的顶级参数。

events

列表 / 元素=字符串

SNMP 陷阱事件。

disk_low - 磁盘使用率过高。

ha_switch - HA 切换。

intf_ip_chg - 接口 IP 地址已更改。

sys_reboot - 系统重启。

cpu_high - CPU 使用率过高。

mem_low - 可用内存不足。

log-alert - 日志基本警报消息。

log-rate - 检测到高传入日志速率。

log-data-rate - 检测到高传入日志数据速率。

lic-gbday - 检测到高许可日志 GB/天。

lic-dev-quota - 检测到高许可设备配额。

cpu-high-exclude-nice - 排除 NICE 阈值的 CPU 使用率。

选项

  • "disk_low"

  • "ha_switch"

  • "intf_ip_chg"

  • "sys_reboot"

  • "cpu_high"

  • "mem_low"

  • "log-alert"

  • "log-rate"

  • "log-data-rate"

  • "lic-gbday"

  • "lic-dev-quota"

  • "cpu-high-exclude-nice"

hosts

列表 / 元素=字典

主机。

id

整数

主机条目 ID。

interface

字符串

允许接口名称。

ip

字符串

允许主机 IP 地址。

hosts6

列表 / 元素=字典

Hosts6。

id

整数

主机条目 ID。

interface

字符串

允许接口名称。

ip

字符串

允许主机 IP 地址。

id

整数 / 必需

社区 ID。

name

字符串

社区名称。

query_v1_port

整数

SNMP v1 查询端口。

query_v1_status

字符串

启用/禁用 SNMP v1 查询。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_v2c_port

整数

SNMP v2c 查询端口。

query_v2c_status

字符串

启用/禁用 SNMP v2c 查询。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

status

字符串

启用/禁用社区。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

trap_v1_rport

整数

SNMP v1 陷阱远程端口。

trap_v1_status

字符串

启用/禁用 SNMP v1 陷阱。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

trap_v2c_rport

整数

SNMP v2c 陷阱远程端口。

trap_v2c_status

字符串

启用/禁用 SNMP v2c 陷阱。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fortimanager.fmgr_system_snmp_community:
        bypass_validation: false
        state: present
        system_snmp_community:
          id: 1
          name: ansible-test-snmp
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the SNMP communities
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_snmp_community"
          params:
            community: "your_value"

返回值

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

键

描述

元数据 (meta)

字典

请求的结果。

返回值：始终返回

请求URL (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)