Try SpotterConfigure Infoblox NIOS DTC SNMP monitors
| "added in version" 1.6.0 of infoblox.nios_modules"
Authors: Joachim Buyse (@jbisabel)
Install with ansible-galaxy collection install infoblox.nios_modules:==1.6.1
collections:
- name: infoblox.nios_modules
version: 1.6.1Adds and/or removes instances of DTC SNMP monitor objects from Infoblox NIOS servers. This module manages C(dtc:monitor:snmp) objects using the Infoblox WAPI interface over REST.
- 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
name:
description:
- Configures the display name for this DTC monitor. Values with leading or trailing
white space are not valid for this field.
required: true
type: str
oids:
description:
- Configures the list of OIDs for SNMP monitoring.
elements: dict
suboptions:
comment:
description:
- 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.
type: str
condition:
choices:
- ANY
- EXACT
- GEQ
- LEQ
- RANGE
default: ANY
description:
- Configures the condition of the validation result for the SNMP health check.
type: str
first:
description:
- Configures the condition's first term to match against the SNMP health check
result.
type: str
last:
description:
- Configures the condition's second term to match against the SNMP health check
result with 'RANGE' condition.
type: str
oid:
description:
- Configures the SNMP OID value for DTC SNMP Monitor health checks.
- This field is required on creation
required: true
type: str
type:
choices:
- INTEGER
- STRING
default: STRING
description:
- Configures the condition type for DTC SNMP Monitor health checks results.
type: str
type: list
port:
default: 161
description:
- Configures the port value for SNMP requests.
type: int
user:
description:
- Configures the SNMPv3 user setting.
type: str
state:
choices:
- present
- absent
default: present
description:
- Configures the intended state of the instance of the object on the NIOS server. When
this value is set to C(present), the object is configured on the device and when
this value is set to C(absent) the value is removed (if necessary) from the device.
type: str
comment:
description:
- 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.
type: str
context:
description:
- Configures the SNMPv3 context. Values with leading or trailing white space are not
valid for this field.
type: str
timeout:
default: 15
description:
- Configures the timeout for SNMP health check in seconds.
type: int
version:
choices:
- V1
- V2C
- V3
default: V2C
description:
- Configures the SNMP protocol version for the SNMP health check.
type: str
extattrs:
description:
- Allows for the configuration of Extensible Attributes on the instance of the object. This
argument accepts a set of key / value pairs for configuration.
type: dict
interval:
default: 5
description:
- Configures the interval for SNMP health check.
type: int
provider:
description:
- A dict object containing connection details.
suboptions:
cert:
description:
- 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 C(INFOBLOX_CERT) environment variable.
type: str
host:
description:
- Specifies the DNS host name or address for connecting to the remote instance
of NIOS WAPI over REST
- Value can also be specified using C(INFOBLOX_HOST) environment variable.
type: str
http_pool_connections:
default: 10
description:
- Insert decription here
type: int
http_pool_maxsize:
default: 10
description:
- Insert description here
type: int
http_request_timeout:
default: 10
description:
- The amount of time before to wait before receiving a response
- Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
variable.
type: int
key:
description:
- Specifies private key file for encryption with the certificate in order to connect
with remote instance of NIOS.
- Value can also be specified using C(INFOBLOX_KEY) environment variable.
type: str
max_results:
default: 1000
description:
- 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 C(INFOBLOX_MAX_RESULTS) environment variable.
type: int
max_retries:
default: 3
description:
- Configures the number of attempted retries before the connection is declared
usable
- Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable.
type: int
password:
description:
- Specifies the password to use to authenticate the connection to the remote instance
of NIOS.
- Value can also be specified using C(INFOBLOX_PASSWORD) environment variable.
type: str
silent_ssl_warnings:
default: true
description:
- Insert description here
type: bool
username:
description:
- Configures the username to use to authenticate the connection to the remote
instance of NIOS.
- Value can also be specified using C(INFOBLOX_USERNAME) environment variable.
type: str
validate_certs:
aliases:
- ssl_verify
default: false
description:
- Boolean value to enable or disable verifying SSL certificates
- Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable.
type: bool
wapi_version:
default: '2.9'
description:
- Specifies the version of WAPI to use
- Value can also be specified using C(INFOBLOX_WAPI_VERSION) environment variable.
- Until ansible 2.8 the default WAPI was 1.4
type: str
type: dict
retry_up:
default: 1
description:
- Configures the value of how many times the server should appear as up to be treated
as alive after it was dead.
type: int
community:
default: public
description:
- Configures the SNMP community string for SNMP authentication.
type: str
engine_id:
description:
- Configures the SNMPv3 engine identifier. Values with leading or trailing white space
are not valid for this field.
type: str
retry_down:
default: 1
description:
- Configures the value of how many times the server should appear as down to be treated
as dead after it was alive.
type: int