fortinet.fortimanager.fmgr_system_snmp_user 模块 – 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_user。

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_user

字典

设置的顶级参数。

auth_proto

别名：auth-proto

字符串

身份验证协议。

md5 - HMAC-MD5-96 身份验证协议。

sha - HMAC-SHA-96 身份验证协议。

选项

  • "md5"

  • "sha"

  • "sha224"

  • "sha256"

  • "sha384"

  • "sha512"

auth_pwd

别名：auth-pwd

任意

(列表) 身份验证协议的密码。

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"

name

字符串 / 必填

SNMP 用户名。

notify_hosts

别名：notify-hosts

字符串

发送通知的主机

notify_hosts6

别名：notify-hosts6

字符串

发送通知的 IPv6 主机

priv_proto

别名：priv-proto

字符串

隐私

aes - CFB128-AES-128 对称加密协议。

des - CBC-DES 对称加密协议。

选项

  • "aes"

  • "des"

  • "aes256"

  • "aes256cisco"

priv_pwd

别名：priv-pwd

任意

(列表) 隐私密码

queries

字符串

启用/禁用此用户的查询。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_port

别名：query-port

整数

SNMPv3 查询端口。

security_level

别名：security-level

字符串

消息身份验证和加密的安全级别。

no-auth-no-priv - 没有身份验证和没有隐私的消息

auth-no-priv - 有身份验证但没有隐私的消息

auth-priv - 有身份验证和隐私的消息

选项

  • “无认证无权限”

  • “已认证无权限”

  • “已认证有权限”

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 有助于完成此工作。

  • 要创建或更新对象，请使用 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 user configuration.
      fortinet.fortimanager.fmgr_system_snmp_user:
        bypass_validation: false
        state: present
        system_snmp_user:
          auth-proto: md5 # <value in [md5, sha]>
          auth-pwd: fortinet
          events:
            - 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
          name: ansible-test-snmpuser
          queries: disable
          security-level: no-auth-no-priv # <value in [no-auth-no-priv, auth-no-priv, auth-priv]>

- 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 users
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_snmp_user"
          params:
            user: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回值： 始终

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 版本支持，则会发出警告。

返回值： 复杂

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈峰 (@fshen01)

  • 卢洪斌 (@fgtdev-hblu)