community.general.utm_dns_host module – Create, update or destroy dns entry in Sophos UTM
Note
This module is part of the community.general collection (version 8.6.4).
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 community.general
.
To use it in a playbook, specify: community.general.utm_dns_host
.
Synopsis
Create, update or destroy a dns entry in SOPHOS UTM.
This module needs to have the REST Ability of the UTM to be activated.
Aliases: web_infrastructure.sophos_utm.utm_dns_host
Parameters
Parameter |
Comments |
---|---|
The IPV4 Address of the entry. Can be left empty for automatic resolving. Default: |
|
The IPV6 Address of the entry. Can be left empty for automatic resolving. Default: |
|
An optional comment to add to the dns host object Default: |
|
A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules. Default: |
|
The hostname for the dns host object |
|
The reference name of the interface to use. If not provided the default interface will be used Default: |
|
The name of the object. Will be used to identify the entry |
|
whether the hostname’s ipv4 address is already resolved or not Choices:
|
|
whether the hostname’s ipv6 address is already resolved or not Choices:
|
|
The desired state of the object.
Choices:
|
|
the timeout for the utm to resolve the ip address for the hostname again Default: |
|
The REST Endpoint of the Sophos UTM. |
|
The port of the REST interface. Default: |
|
The protocol of the REST Endpoint. Choices:
|
|
The token used to identify at the REST-API. See https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, Chapter 2.4.2. |
|
Whether the REST interface’s ssl certificate should be verified or not. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create UTM dns host entry
community.general.utm_dns_host:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestDNSEntry
hostname: testentry.some.tld
state: present
- name: Remove UTM dns host entry
community.general.utm_dns_host:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestDNSEntry
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The utm object that was created Returned: success |
|
Whether or not the object is currently locked Returned: success |
|
The reference name of the object Returned: success |
|
The ipv4 address of the object Returned: success |
|
The ipv6 address of the object Returned: success |
|
The comment string Returned: success |
|
The hostname of the object Returned: success |
|
The reference name of the interface the object is associated with Returned: success |
|
The name of the object Returned: success |
|
Whether the ipv4 address is resolved or not Returned: success |
|
Whether the ipv6 address is resolved or not Returned: success |
|
The timeout until a new resolving will be attempted Returned: success |