community.general.utm_network_interface_address – Create, update or destroy network/interface_address object

Note

This plugin is part of the community.general collection (version 2.2.0).

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 Choices/Defaults Comments
address
string / required
The ip4 address of the network/interface_address object.
address6
string
The ip6 address of the network/interface_address object.
comment
string
An optional comment to add to the object
headers
dictionary
A dictionary of additional headers to be sent to POST and PUT requests.
Is needed for some modules
name
string / required
The name of the object. Will be used to identify the entry
resolved
boolean
    Choices:
  • no
  • yes
Whether or not the object is resolved
resolved6
boolean
    Choices:
  • no
  • yes
Whether or not the object is resolved
state
string
    Choices:
  • absent
  • present ←
The desired state of the object.
present will create or update an object
absent will delete an object if it was present
utm_host
string / required
The REST Endpoint of the Sophos UTM.
utm_port
integer
Default:
4444
The port of the REST interface.
utm_protocol
string
    Choices:
  • http
  • https ←
The protocol of the REST Endpoint.
utm_token
string / required
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether the REST interface's ssl certificate should be verified or not.

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 Returned Description
result
complex
success
The utm object that was created

 
_locked
boolean
success
Whether or not the object is currently locked

 
_ref
string
success
The reference name of the object

 
_type
string
success
The type of the object

 
address
string
success
The ip4 address of the network/interface_address object

 
address6
string
success
The ip6 address of the network/interface_address object

 
comment
string
success
The comment string

 
name
string
success
The name of the object

 
resolved
boolean
success
Whether or not the object is resolved

 
resolved6
boolean
success
Whether or not the object is resolved



Authors

  • Juergen Wiebe (@steamx)