community.general.ig_unit_information (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Get unit information from an Ingate SBC.

Requirements

• ingatesdk >= 1.0.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
client:
    description:
    - A dict object containing connection details.
    suboptions:
      address:
        description:
        - The hostname or IP address to the unit.
        required: true
        type: str
      password:
        description:
        - The password for the REST API user.
        required: true
        type: str
      port:
        description:
        - Which HTTP(S) port to connect to.
        type: int
      scheme:
        choices:
        - http
        - https
        description:
        - Which HTTP protocol to use.
        required: true
        type: str
      timeout:
        description:
        - The timeout (in seconds) for REST API requests.
        type: int
      username:
        description:
        - The username of the REST API user.
        required: true
        type: str
      validate_certs:
        aliases:
        - verify_ssl
        default: true
        description:
        - Verify the unit's HTTPS certificate.
        type: bool
      version:
        choices:
        - v1
        default: v1
        description:
        - REST API version.
        type: str

Outputs

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