infoblox.nios_modules.nios_dtc_monitor_snmp module – Configure Infoblox NIOS DTC SNMP monitors

Note

This module is part of the infoblox.nios_modules collection (version 1.7.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install infoblox.nios_modules. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infoblox.nios_modules.nios_dtc_monitor_snmp.

New in infoblox.nios_modules 1.6.0

Synopsis 

Adds and/or removes instances of DTC SNMP monitor objects from Infoblox NIOS servers. This module manages dtc:monitor:snmp objects using the Infoblox WAPI interface over REST.

Requirements 

The below requirements are needed on the host that executes this module.

infoblox-client

Parameters 

Parameter	Comments
comment string	Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance.
community string	Configures the SNMP community string for SNMP authentication. Default: `"public"`
context string	Configures the SNMPv3 context. Values with leading or trailing white space are not valid for this field.
engine_id string	Configures the SNMPv3 engine identifier. Values with leading or trailing white space are not valid for this field.
extattrs dictionary	Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration.
interval integer	Configures the interval for SNMP health check. Default: `5`
name string / required	Configures the display name for this DTC monitor. Values with leading or trailing white space are not valid for this field.
oids list / elements=dictionary	Configures the list of OIDs for SNMP monitoring.
comment string	Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance.
condition string	Configures the condition of the validation result for the SNMP health check. Choices: `"ANY"` ← (default) `"EXACT"` `"GEQ"` `"LEQ"` `"RANGE"`
first string	Configures the condition’s first term to match against the SNMP health check result.
last string	Configures the condition’s second term to match against the SNMP health check result with ‘RANGE’ condition.
oid string / required	Configures the SNMP OID value for DTC SNMP Monitor health checks. This field is required on creation
type string	Configures the condition type for DTC SNMP Monitor health checks results. Choices: `"INTEGER"` `"STRING"` ← (default)
port integer	Configures the port value for SNMP requests. Default: `161`
provider dictionary	A dict object containing connection details.
cert string	Specifies the client certificate file with digest of x509 config for extra layer secure connection the remote instance of NIOS. Value can also be specified using `INFOBLOX_CERT` environment variable.
host string	Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using `INFOBLOX_HOST` environment variable.
http_pool_connections integer	Insert decription here Default: `10`
http_pool_maxsize integer	Insert description here Default: `10`
http_request_timeout integer	The amount of time before to wait before receiving a response Value can also be specified using `INFOBLOX_HTTP_REQUEST_TIMEOUT` environment variable. Default: `10`
key string	Specifies private key file for encryption with the certificate in order to connect with remote instance of NIOS. Value can also be specified using `INFOBLOX_KEY` environment variable.
max_results integer	Specifies the maximum number of objects to be returned, if set to a negative number the appliance will return an error when the number of returned objects would exceed the setting. Value can also be specified using `INFOBLOX_MAX_RESULTS` environment variable. Default: `1000`
max_retries integer	Configures the number of attempted retries before the connection is declared usable Value can also be specified using `INFOBLOX_MAX_RETRIES` environment variable. Default: `3`
password string	Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_PASSWORD` environment variable.
silent_ssl_warnings boolean	Insert description here Choices: `false` `true` ← (default)
username string	Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_USERNAME` environment variable.
validate_certs aliases: ssl_verify boolean	Boolean value to enable or disable verifying SSL certificates Value can also be specified using `INFOBLOX_SSL_VERIFY` environment variable. Choices: `false` ← (default) `true`
wapi_version string	Specifies the version of WAPI to use Value can also be specified using `INFOBLOX_WAPI_VERSION` environment variable. Until ansible 2.8 the default WAPI was 1.4 Default: `"2.12.3"`
retry_down integer	Configures the value of how many times the server should appear as down to be treated as dead after it was alive. Default: `1`
retry_up integer	Configures the value of how many times the server should appear as up to be treated as alive after it was dead. Default: `1`
state string	Configures the intended state of the instance of the object on the NIOS server. When this value is set to `present`, the object is configured on the device and when this value is set to `absent` the value is removed (if necessary) from the device. Choices: `"present"` ← (default) `"absent"`
timeout integer	Configures the timeout for SNMP health check in seconds. Default: `15`
user string	Configures the SNMPv3 user setting.
version string	Configures the SNMP protocol version for the SNMP health check. Choices: `"V1"` `"V2C"` ← (default) `"V3"`

Notes 

Note

This module supports check_mode.
This module must be run locally, which can be achieved by specifying connection: local.
Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.

Examples 

- 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

Authors

Joachim Buyse (@jbisabel)

infoblox.nios_modules.nios_dtc_monitor_snmp module – Configure Infoblox NIOS DTC SNMP monitors

Synopsis

Requirements

Parameters

Notes

Examples