infoblox.nios_modules.nios_dtc_monitor_snmp 模块 – 配置 Infoblox NIOS DTC SNMP 监控器

注意

此模块是 infoblox.nios_modules 集合(版本 1.7.1)的一部分。

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

要安装它,请使用:ansible-galaxy collection install infoblox.nios_modules。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:infoblox.nios_modules.nios_dtc_monitor_snmp

infoblox.nios_modules 1.6.0 中的新增功能

概要

  • 从 Infoblox NIOS 服务器添加和/或删除 DTC SNMP 监控器对象的实例。此模块使用 REST 通过 Infoblox WAPI 接口管理 dtc:monitor:snmp 对象。

要求

执行此模块的主机需要以下要求。

  • infoblox-client

参数

参数

注释

评论

字符串

配置与此对象实例关联的文本字符串注释。提供的文本字符串将在对象实例上配置。

社区

字符串

配置 SNMP 社区字符串以进行 SNMP 身份验证。

默认值: "public"

上下文

字符串

配置 SNMPv3 上下文。在此字段中,带有前导或尾随空格的值无效。

引擎_id

字符串

配置 SNMPv3 引擎标识符。在此字段中,带有前导或尾随空格的值无效。

extattrs

字典

允许在对象的实例上配置可扩展属性。此参数接受一组用于配置的键/值对。

间隔

整数

配置 SNMP 健康检查的间隔。

默认值: 5

名称

字符串 / 必需

配置此 DTC 监控器的显示名称。在此字段中,带有前导或尾随空格的值无效。

oids

列表 / elements=dictionary

配置用于 SNMP 监控的 OID 列表。

评论

字符串

配置与此对象实例关联的文本字符串注释。提供的文本字符串将在对象实例上配置。

条件

字符串

配置 SNMP 健康检查的验证结果的条件。

选择

  • "ANY" ← (默认)

  • "EXACT"

  • "GEQ"

  • "LEQ"

  • "RANGE"

第一

字符串

配置条件的第一个术语以匹配 SNMP 健康检查结果。

最后

字符串

配置条件的第二个术语,以使用“RANGE”条件匹配 SNMP 健康检查结果。

oid

字符串 / 必需

配置 DTC SNMP 监控器健康检查的 SNMP OID 值。

此字段在创建时是必需的

类型

字符串

配置 DTC SNMP 监控器健康检查结果的条件类型。

选择

  • "INTEGER"

  • "STRING" ← (默认)

端口

整数

配置 SNMP 请求的端口值。

默认值: 161

提供程序

字典

包含连接详细信息的字典对象。

cert

字符串

指定客户端证书文件,其中包含 x509 配置的摘要,用于与 NIOS 远程实例进行额外的安全连接。

也可以使用 INFOBLOX_CERT 环境变量指定值。

host

字符串

指定 DNS 主机名或地址,用于通过 REST 连接到 NIOS WAPI 的远程实例

也可以使用 INFOBLOX_HOST 环境变量指定值。

http_pool_connections

整数

在此处插入描述

默认值: 10

http_pool_maxsize

整数

在此处插入描述

默认值: 10

http_request_timeout

整数

等待收到响应之前的时间量

也可以使用 INFOBLOX_HTTP_REQUEST_TIMEOUT 环境变量指定值。

默认值: 10

key

字符串

指定用于使用证书加密的私钥文件,以便与 NIOS 的远程实例连接。

也可以使用 INFOBLOX_KEY 环境变量指定值。

max_results

整数

指定要返回的最大对象数,如果设置为负数,则当返回的对象数超过设置时,设备将返回错误。

也可以使用 INFOBLOX_MAX_RESULTS 环境变量指定值。

默认值: 1000

max_retries

整数

配置连接被声明为可用之前尝试的重试次数

也可以使用 INFOBLOX_MAX_RETRIES 环境变量指定值。

默认值: 3

密码

字符串

指定用于验证与 NIOS 远程实例的连接的密码。

也可以使用 INFOBLOX_PASSWORD 环境变量指定值。

silent_ssl_warnings

布尔值

在此处插入描述

选择

  • false

  • true ← (默认)

用户名

字符串

配置用于验证与 NIOS 远程实例的连接的用户名。

也可以使用 INFOBLOX_USERNAME 环境变量指定值。

validate_certs

别名:ssl_verify

布尔值

用于启用或禁用验证 SSL 证书的布尔值

也可以使用 INFOBLOX_SSL_VERIFY 环境变量指定值。

选择

  • false ← (默认)

  • true

wapi_version

字符串

指定要使用的 WAPI 版本

也可以使用 INFOBLOX_WAPI_VERSION 环境变量来指定值。

在 ansible 2.8 之前,默认的 WAPI 是 1.4。

默认值: "2.12.3"

retry_down

整数

配置服务器在被视为失效(在之前是活动状态)之前,应该连续出现多少次“宕机”状态。

默认值: 1

retry_up

整数

配置服务器在被视为活动(在之前是失效状态)之前,应该连续出现多少次“正常”状态。

默认值: 1

state

字符串

配置 NIOS 服务器上对象实例的预期状态。当此值设置为 present 时,将在设备上配置该对象;当此值设置为 absent 时,将从设备中删除该值(如果需要)。

选择

  • "present" ← (默认)

  • "absent"

timeout

整数

配置 SNMP 健康检查的超时时间(秒)。

默认值: 15

user

字符串

配置 SNMPv3 用户设置。

version

字符串

配置 SNMP 健康检查的 SNMP 协议版本。

选择

  • "V1"

  • "V2C" ← (默认)

  • "V3"

备注

注意

  • 此模块支持 check_mode

  • 此模块必须在本地运行,可以通过指定 connection: local 来实现。

  • 请阅读 :ref:`nios_guide` 获取有关如何将 Infoblox 与 Ansible 结合使用的更多详细信息。

示例

- name: Configure a DTC SNMP monitor
  infoblox.nios_modules.nios_dtc_monitor_snmp:
    name: snmp_monitor
    port: 8080
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Add a comment to an existing DTC SNMP monitor
  infoblox.nios_modules.nios_dtc_monitor_snmp:
    name: snmp_monitor
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Remove a DTC SNMP monitor from the system
  infoblox.nios_modules.nios_dtc_monitor_snmp:
    name: snmp_monitor
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

作者

  • Joachim Buyse (@jbisabel)