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

参数 

参数	注释
comment 字符串	配置与该对象实例关联的文本字符串注释。提供的文本字符串将在对象实例上配置。
community 字符串	配置用于 SNMP 身份验证的 SNMP 社区字符串。默认值： `"public"`
context 字符串	配置 SNMPv3 上下文。此字段的值不能有前导或尾随空格。
engine_id 字符串	配置 SNMPv3 引擎标识符。此字段的值不能有前导或尾随空格。
extattrs 字典	允许在对象实例上配置可扩展属性。此参数接受一组键/值对进行配置。
interval 整数	配置 SNMP 健康检查的间隔。默认值： `5`
name 字符串 / 必填	配置此 DTC 监控器的显示名称。此字段的值不能有前导或尾随空格。
oids 列表 / 元素=字典	配置用于 SNMP 监控的 OID 列表。
comment 字符串	配置与该对象实例关联的文本字符串注释。提供的文本字符串将在对象实例上配置。
condition 字符串	配置 SNMP 健康检查验证结果的条件。选项 `"ANY"` ← (默认) `"EXACT"` `"GEQ"` `"LEQ"` `"RANGE"`
first 字符串	配置与 SNMP 健康检查结果匹配的条件的第一项。
last 字符串	使用“RANGE”条件配置与 SNMP 健康检查结果匹配的条件的第二项。
oid 字符串 / 必填	配置 DTC SNMP 监控器健康检查的 SNMP OID 值。创建时此字段为必填项
type 字符串	配置 DTC SNMP 监控器健康检查结果的条件类型。选项 `"INTEGER"` `"STRING"` ← (默认)
port 整数	配置 SNMP 请求的端口值。默认值： `161`
provider 字典	包含连接详细信息的字典对象。
cert 字符串	指定客户端证书文件，其中包含 x509 配置摘要，用于为与 NIOS 的远程实例的安全连接增加额外的安全层。值也可以使用 `INFOBLOX_CERT` 环境变量指定。
host 字符串	指定用于通过 REST 连接到 NIOS WAPI 远程实例的 DNS 主机名或地址值也可以使用 `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`
状态字符串	配置NIOS服务器上对象实例的目标状态。当此值设置为`present`时，对象在设备上被配置；当此值设置为`absent`时，该值将从设备中删除（如有必要）。选项 `"present"` ← (默认) `"absent"`
超时整数	配置SNMP健康检查的超时时间（秒）。默认值： `15`
用户字符串	配置SNMPv3用户设置。
版本字符串	配置SNMP健康检查的SNMP协议版本。选项 `"V1"` `"V2C"` ← (默认) `"V3"`

备注 

注意

此模块支持check_mode。
此模块必须在本地运行，可以通过指定connection: local来实现。
请阅读 :ref:`nios_guide` 以获取有关如何使用 Ansible 与 Infoblox 的更多详细信息。

示例 

- 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)