fortinet.fortimanager.fmgr_system_snmp_sysinfo 模块 – SNMP 配置。

注意

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

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

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

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

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

system_snmp_sysinfo

字典

设置的顶层参数。

contact_info

字符串

联系信息。

description

字符串

系统描述。

engine_id

别名: engine-id

字符串

本地 SNMP engineID 字符串

location

字符串

系统位置。

status

字符串

启用/禁用 SNMP。

disable - 禁用设置。

enable - 启用设置。

选择

  • "disable"

  • "enable"

trap_cpu_high_exclude_nice_threshold

别名: trap-cpu-high-exclude-nice-threshold

整数

CPU 使用率阈值的 SNMP 陷阱

trap_high_cpu_threshold

别名: trap-high-cpu-threshold

整数

CPU 使用率阈值的 SNMP 陷阱。

trap_low_memory_threshold

别名: trap-low-memory-threshold

整数

内存使用率阈值的 SNMP 陷阱。

workspace_locking_adom

字符串

要在工作区模式下运行的 FortiManager 锁定的 adom，该值可以是全局的和其他包括 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 有助于完成工作。

  • 通常，当返回非零 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: SNMP configuration.
      fortinet.fortimanager.fmgr_system_snmp_sysinfo:
        # 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, ...]
        system_snmp_sysinfo:
          contact_info: <string>
          description: <string>
          engine_id: <string>
          location: <string>
          status: <value in [disable, enable]>
          trap_cpu_high_exclude_nice_threshold: <integer>
          trap_high_cpu_threshold: <integer>
          trap_low_memory_threshold: <integer>

返回值

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

键

描述

元数据

字典

请求的结果。

返回值: 始终

request_url

字符串

请求的完整 URL。

返回值: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回值: 始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回值: 始终

response_message

字符串

API 响应的描述性消息。

返回值: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回值: 始终

rc

整数

请求的状态。

返回值: 始终

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回值: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)