community.general.utm_network_interface_address module – Create, update or destroy network/interface_address object
Note
This module is part of the community.general collection (version 9.5.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 community.general
.
To use it in a playbook, specify: community.general.utm_network_interface_address
.
Synopsis
Create, update or destroy a network/interface_address object in SOPHOS UTM.
This module needs to have the REST Ability of the UTM to be activated.
Parameters
Parameter |
Comments |
---|---|
The ip4 address of the network/interface_address object. |
|
The ip6 address of the network/interface_address object. |
|
An optional comment to add to the object Default: |
|
A dictionary of additional headers to be sent to POST and PUT requests. Is needed for some modules. Default: |
|
The name of the object. Will be used to identify the entry |
|
Whether or not the object is resolved Choices:
|
|
Whether or not the object is resolved Choices:
|
|
The desired state of the object.
Choices:
|
|
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 a network interface address
utm_proxy_backend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestNetworkInterfaceAddress
address: 0.0.0.0
state: present
- name: Remove a network interface address
network_interface_address:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestNetworkInterfaceAddress
address: 0.0.0.0
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 type of the object Returned: success |
|
The ip4 address of the network/interface_address object Returned: success |
|
The ip6 address of the network/interface_address object Returned: success |
|
The comment string Returned: success |
|
The name of the object Returned: success |
|
Whether or not the object is resolved Returned: success |
|
Whether or not the object is resolved Returned: success |