DTC SIP Monitor

Use the nios_dtc_monitor_sip module to create, update, or remove instances of the DTC SIP monitor object from a NIOS Grid. The DTC SIP monitor object is used to determine the health of a server by monitoring the response to an SIP request. For more information on the health monitor, refer to the Using DNS Traffic Control Health Monitors section in the Infoblox NIOS Documentation.

The following table describes the parameters you can define in the nios_dtc_monitor_sip module:

Parameter	Required/Optional	Description

Parameter	Required/Optional	Description
`name`	Required	Specifies the display name of the DTC monitor.
`port`	Optional	Specifies the port number for SIP requests. The default value is `5060`.
`ciphers`	Optional	Specifies an optional cipher list for the secure TLS/SIPS connection.
`client_cert`	Optional	Specifies an optional client certificate, supplied in a secure TLS or SIPS mode if present.
`request`	Optional	Specifies the type of the SIP request to send.
`result`	Optional	Specifies the type of the expected result. The default is `ANY`.
`result_code`	Optional	Specifies the expected return code. The default value is `200`.
`transport`	Optional	Specifies the transport layer protocol to use for the SIP health check. The default value is `TCP`.
`validate_cert`	Optional	Indicates whether the validation of the remote server's certificate is enabled. The default value is `true`.
`interval`	Optional	Specifies the interval for the HTTP health check. The interval value is measured from the end of the previous monitor cycle. The default value is `5`.
`retry_down`	Optional	Specifies the number of times the server should appear as down, for it to be treated as dead after it was alive. The default value is `1`.
`retry_up`	Optional	Specifies the number of times the server should appear as up, for it to be treated as alive after it was dead. The default value is `1`.
`timeout`	Optional	Specifies the timeout in seconds for the SIP health check. It is the duration that a monitor waits to receive a response after sending a request. If a response is not received, it considers the check as failed. The default value is `15`.
`extattrs`	Optional	Specifies extensible attributes for the DTC SIP monitor object. This field accepts a set of key / value pairs for the configuration.
`state`	Optional	Specifies the state of the DTC SIP monitor instance in NIOS. Set one of the following values: `present` (default): Configures the object on the device. `absent`: Removes the object from the device.
`comment`	Optional	Describes the DTC SIP monitor object.
`provider`	Required	A dictionary object that contains the connection details. `host`: DNS host name or IP address to connect to the remote instance of NIOS. `username`: User name to use for authenticating the connection to the remote instance. `password`: Password to use for authenticating the connection to the remote instance. For information on additional fields you can define, see the list of subparameters in the NIOS Modules for Ansible Collections topic.
`connection`	Required	The `nios_dtc_monitor_sip` module must be run locally.

Examples

name: Configure a DTC SIP monitor
infoblox.nios_modules.nios_dtc_monitor_sip:
name: sip_monitor
state: present
provider:
host: <nios_hostname_or_hostip>
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: <nios_hostname_or_hostip>
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: <nios_hostname_or_hostip>
username: admin
password: admin
connection: local

Infoblox NIOS Modules for Ansible Collections

DTC SIP Monitor

Analytics

Examples

Related content