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.3).
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.
Aliases: network.ingate.ig_unit_information
Requirements
The below requirements are needed on the host that executes this module.
ingatesdk >= 1.0.6
Parameters
Parameter |
Comments |
---|---|
A dict object containing connection details. |
|
The hostname or IP address to the unit. |
|
The password for the REST API user. |
|
Which HTTP(S) port to connect to. |
|
Which HTTP protocol to use. Choices:
|
|
The timeout (in seconds) for REST API requests. |
|
The username of the REST API user. |
|
Verify the unit’s HTTPS certificate. Choices:
|
|
REST API version. Choices:
|
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 |
---|---|
Information about the unit Returned: success |
|
The installation identifier Returned: success Sample: |
|
List of interface names Returned: success Sample: |
|
The unit’s language Returned: success Sample: |
|
License email information Returned: success Sample: |
|
License MAC information Returned: success Sample: |
|
License name information Returned: success Sample: |
|
The MAC address of the first interface Returned: success Sample: |
|
Operational mode of the unit Returned: success Sample: |
|
Installed module licenses Returned: success Sample: |
|
Installed patches on the unit Returned: success Sample: |
|
The product name Returned: success Sample: |
|
The serial number of the unit Returned: success Sample: |
|
The system identifier of the unit Returned: success Sample: |
|
The name of the unit Returned: success Sample: |
|
Firmware version Returned: success Sample: |