Try SpotterRetrieve information from an Ingate SBC.
| "added in version" 1.0.0 of ingatesystems.fuego_modules"
Authors: Ingate Systems AB (@ingatesystems)
Install with ansible-galaxy collection install ingatesystems.fuego_modules:==1.1.0
collections:
- name: ingatesystems.fuego_modules
version: 1.1.0Retrieve information from an Ingate SBC.
# Retrieve information about the unit
- fuego_information:
client: "{{ stored_client_data }}"
unit: true
# List current configuration error(s)
- fuego_information:
client: "{{ stored_client_data }}"
error: true
# Describe all tables
- fuego_information:
client: "{{ stored_client_data }}"
table_describe: true
# List all tables
- fuego_information:
client: "{{ stored_client_data }}"
table_list: true
# Return SIP status information and metrics
- fuego_information:
client: "{{ stored_client_data }}"
sip_status: true
unit:
description:
- Retrieve information about the unit.
type: bool
error:
description:
- List all errors in all tables in the preliminary configuration.
type: bool
client:
description:
- A dict object containing connection details.
required: true
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
type: dict
sip_status:
description:
- Return SIP status information and metrics.
type: bool
version_added: 1.1.0
version_added_collection: ingatesystems.fuego_modules
table_list:
description:
- List all tables.
type: bool
table_describe:
description:
- Describe all configuration tables, listing its columns and their types.
type: bool
error:
contains:
error:
contains:
column:
description: Column name
returned: success
sample: lower_ip_dns
type: str
err_id:
description: Error number
returned: success
sample: 4
type: int
msg:
description: Error message
returned: success
sample: No value given.
type: str
rowid:
description: Row number
returned: success
sample: 1
type: int
table:
description: Table name
returned: success
sample: firewall.network_groups
type: str
type:
description: Type of error
returned: success
sample: VALUE_MISSING
type: str
description: Error information
returned: success
type: dict
href:
description: The REST API URL to the affected row
returned: success
sample: http://192.168.1.1/api/v1/misc/dns_servers/1
type: str
description: List of error(s) found in the the preliminary configuration
elements: dict
returned: when C(error) is yes and success
type: list
sip_status:
contains:
active_sessions:
contains:
call_id:
description: The SIP Call-ID
returned: success
sample: qrvmhopdqmmfyjt@foouser
type: str
callee:
description: The SIP callee
returned: success
sample: '<sip:foo@example.com>'
type: str
caller:
description: The SIP caller
returned: success
sample: '<sip:alice@192.168.20.45>'
type: str
start:
description: The time when the SIP session was established
returned: success
sample: '10:50:51'
type: str
state:
description: The state of the SIP session
returned: success
sample: Established
type: str
description: A list of active SIP sessions
elements: dict
returned: success
type: list
count_active_sessions:
description: The amount of active SIP sessions
returned: success
sample: 0
type: int
count_max_registered_users:
description: The amount of maximum registered SIP users
returned: success
sample: 0
type: int
count_max_sessions:
description: The amount of maximum active SIP sessions
returned: success
sample: 0
type: int
count_registered_users:
description: The amount of registered SIP users
returned: success
sample: 0
type: int
idsips_blacklist:
description: A list of blacklisted peers
elements: dict
returned: success
sample: []
type: list
idsips_packet_filtering:
contains:
hits:
description: The amount of hits for a rule
returned: success
sample: 0
type: int
name:
description: The name of a rule
returned: success
sample: Scanners
type: str
number:
description: The rule number
returned: success
sample: 1
type: int
description: A list of blacklisted peers
elements: dict
returned: success
type: list
idsips_rate_limiting:
contains:
hits:
description: The amount of hits for a rule
returned: success
sample: 0
type: int
name:
description: The name of a rule
returned: success
sample: Default auto
type: str
description: A list of blacklisted peers
elements: dict
returned: success
type: list
license_statistics:
contains:
current_use:
description: The amount of used licenses
returned: success
sample: 0
type: int
license:
description: The type of license
returned: success
sample: SIP Registrar Users
type: str
max_used:
description: The amount of maximum used licenses
returned: success
sample: 0
type: int
description: A list of different license statistics
elements: dict
returned: success
type: list
message_statistics:
contains:
message:
description: The type of message
returned: success
sample: INVITE
type: str
rx:
description: The amount of received messages
returned: success
sample: 0
type: int
tx:
description: The amount of transmitted messages
returned: success
sample: 0
type: int
description: A list of different message statistics
elements: dict
returned: success
type: list
monitored_servers:
contains:
port:
description: The port used for monitoring
returned: success
sample: 5060
type: int
server:
description: The server that is monitored
returned: success
sample: 192.168.28.28
type: str
status:
description: The current monitoring status
returned: success
sample: Online
type: str
transport:
description: The used transport protocol
returned: success
sample: UDP
type: str
description: A list of monitored SIP servers
elements: dict
returned: success
type: list
registered_users:
contains:
registered_from:
description: The IP address for which the user is registered from
returned: success
sample: 192.168.56.3
type: str
user:
description: The registered user
returned: success
sample: foouser@example.com
type: str
description: A list of registered SIP users
elements: dict
returned: success
type: list
description: SIP status information and metrics
returned: when C(sip_status) is yes and success
type: dict
table_describe:
contains:
table:
contains:
href:
description: The REST API URL to the table
returned: success
sample: http://192.168.1.1/api/v1/misc/dns_servers
type: str
info:
description: Column names and associated datatype
returned: success
sample:
cert: OptPrivCert
name: Name
type: dict
name:
description: The name of the table
returned: success
sample: misc.dns_servers
type: str
description: Table information
returned: success
type: dict
description: Description of tables and associated information
elements: dict
returned: when C(table_describe) is yes and success
type: list
table_list:
contains:
table:
contains:
href:
description: The REST API URL to the table
returned: success
sample: http://192.168.1.1/api/v1/misc/dns_servers
type: str
methods:
description: A list of allowed HTTP methods
elements: str
returned: success
sample: GET
type: list
name:
description: The name of the table
returned: success
sample: misc.dns_servers
type: str
sdk_methods:
description: A list of allowed SDK methods
elements: str
returned: success
sample: add_row
type: list
description: Table information
returned: success
type: dict
description: List of tables and associated information
elements: dict
returned: when C(table_list) is yes and success
type: list
unit:
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: when C(unit) is yes and success
type: dict