infoblox.nios_modules.nios_dtc_monitor_sip module – Configure Infoblox NIOS DTC SIP monitors
Note
This module is part of the infoblox.nios_modules collection (version 1.7.0).
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_sip
.
New in infoblox.nios_modules 1.6.0
Synopsis
Adds and/or removes instances of DTC SIP monitor objects from Infoblox NIOS servers. This module manages
dtc:monitor:sip
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 |
---|---|
Configures an optional cipher list for the secure TLS/SIPS connection. |
|
Configures an optional client certificate, supplied in TLS or SIPS mode if present. |
|
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. |
|
Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration. |
|
Configures the interval for SIP health check. Default: |
|
Configures the display name for this DTC monitor. Values with leading or trailing white space are not valid for this field. |
|
Configures the port value for SIP requests. Default: |
|
A dict object containing connection details. |
|
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 |
|
Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using |
|
Insert decription here Default: |
|
Insert description here Default: |
|
The amount of time before to wait before receiving a response Value can also be specified using Default: |
|
Specifies private key file for encryption with the certificate in order to connect with remote instance of NIOS. Value can also be specified using |
|
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 Default: |
|
Configures the number of attempted retries before the connection is declared usable Value can also be specified using Default: |
|
Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using |
|
Insert description here Choices:
|
|
Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using |
|
Boolean value to enable or disable verifying SSL certificates Value can also be specified using Choices:
|
|
Specifies the version of WAPI to use Value can also be specified using Until ansible 2.8 the default WAPI was 1.4 Default: |
|
Configures the SIP request to send |
|
Configures the type of the expected result Choices:
|
|
Configures the expected return code Default: |
|
Configures the value of how many times the server should appear as down to be treated as dead after it was alive. Default: |
|
Configures the value of how many times the server should appear as up to be treated as alive after it was dead. Default: |
|
Configures the intended state of the instance of the object on the NIOS server. When this value is set to Choices:
|
|
Configures the timeout for SIP health check in seconds. Default: |
|
Configures the transport layer protocol to use for the SIP check Choices:
|
|
Configures whether the validation of the remote server’s certificate is enabled. Choices:
|
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 SIP monitor
infoblox.nios_modules.nios_dtc_monitor_sip:
name: sip_monitor
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Add a comment to an existing DTC SIP monitor
infoblox.nios_modules.nios_dtc_monitor_sip:
name: sip_monitor
comment: this is a test comment
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Remove a DTC SIP monitor from the system
infoblox.nios_modules.nios_dtc_monitor_sip:
name: sip_monitor
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local