You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.network.ig_unit_information module – Get unit information from an Ingate SBC.

Note

This module is part of the community.network collection (version 5.0.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.network. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.network.ig_unit_information.

Synopsis

• Get unit information from an Ingate SBC.

Requirements

The below requirements are needed on the host that executes this module.

• ingatesdk >= 1.0.6

Parameters

Parameter	Comments
client string	A dict object containing connection details.
address string / required	The hostname or IP address to the unit.
password string / required	The password for the REST API user.
port integer	Which HTTP(S) port to connect to.
scheme string / required	Which HTTP protocol to use. Choices: "http" "https"
timeout integer	The timeout (in seconds) for REST API requests.
username string / required	The username of the REST API user.
validate_certs aliases: verify_ssl boolean	Verify the unit’s HTTPS certificate. Choices: false true ← (default)
version string	REST API version. Choices: "v1" ← (default)

Notes

Note

• This module requires that the Ingate Python SDK is installed on the host. To install the SDK use the pip command from your shell pip install ingatesdk.

Examples

- name: Get unit information
  community.network.ig_unit_information:
    client:
      version: v1
      scheme: http
      address: 192.168.1.1
      username: alice
      password: foobar

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
unit-information complex	Information about the unit Returned: success
installid string	The installation identifier Returned: success Sample: "any"
interfaces string	List of interface names Returned: success Sample: "eth0 eth1 eth2 eth3 eth4 eth5"
lang string	The unit’s language Returned: success Sample: "en"
lic_email string	License email information Returned: success Sample: "example@example.com"
lic_mac string	License MAC information Returned: success Sample: "any"
lic_name string	License name information Returned: success Sample: "Example Inc"
macaddr string	The MAC address of the first interface Returned: success Sample: "52:54:00:4c:e2:07"
mode string	Operational mode of the unit Returned: success Sample: "Siparator"
modules string	Installed module licenses Returned: success Sample: "failover vpn sip qturn ems qos rsc voipsm"
patches list / elements=string	Installed patches on the unit Returned: success Sample: []
product string	The product name Returned: success Sample: "Software SIParator/Firewall"
serial string	The serial number of the unit Returned: success Sample: "IG-200-839-2008-0"
systemid string	The system identifier of the unit Returned: success Sample: "IG-200-839-2008-0"
unitname string	The name of the unit Returned: success Sample: "Testname"
version string	Firmware version Returned: success Sample: "6.2.0-beta2"

Authors

• Ingate Systems AB (@ingatesystems)

Collection links

Issue Tracker Repository (Sources)