Try SpotterManage system near functionality such as licenses, patches and upgrades on 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.0Manage system near functionality such as licenses, patches and upgrades on an Ingate SBC.
# Install a license
- fuego_system:
client: "{{ stored_client_data }}"
license: true
username: myusername
password: mypassword
liccode: 2STW-2UL8-JWJD
# Install a patch
- fuego_system:
client: "{{ stored_client_data }}"
patch: true
filename: patch-6.2.1-rc2-vm2.fup
# Install an upgrade
- fuego_system:
client: "{{ stored_client_data }}"
upgrade: true
filename: fupgrade.fup.any
# Accept an upgrade
- fuego_system:
client: "{{ stored_client_data }}"
upgrade_accept: true
# Abort an upgrade
- fuego_system:
client: "{{ stored_client_data }}"
upgrade_abort: true
# Downgrade an upgrade
- fuego_system:
client: "{{ stored_client_data }}"
upgrade_downgrade: true
# Upgrade to the latest version available
- fuego_system:
client: "{{ stored_client_data }}"
upgrade_download: true
username: myusername
password: mypassword
latest: true
# Change the operational mode to Siparator
- fuego_system:
client: "{{ stored_client_data }}"
opmode: true
mode: siparator
# Reboot the unit
- fuego_system:
client: "{{ stored_client_data }}"
reboot: true
# Restart the SIP module
- fuego_system:
client: "{{ stored_client_data }}"
restart_sip: true
# Log out all logged in admin users
- fuego_system:
client: "{{ stored_client_data }}"
flush_logins: true
mode:
choices:
- siparator
- firewall
description:
- The operational mode.
type: str
patch:
description:
- Install a patch.
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
latest:
description:
- Upgrade to the latest available version.
type: bool
opmode:
description:
- Set mode to siparator or firewall.
type: bool
reboot:
description:
- Reboot the unit.
type: bool
liccode:
description:
- The license code (e.g. KRJM-Q625-FUVG). Must be set for C(license).
type: str
license:
description:
- Download and install a license.
type: bool
upgrade:
description:
- Install a firmware upgrade.
type: bool
version:
description:
- The the desired version to upgrade to.
type: str
filename:
description:
- Path to a valid Ingate patch or upgrade file.
type: str
password:
description:
- Password for account login on ingate.com. Must be set for C(license) and C(upgrade_download).
type: str
username:
description:
- Username for account login on ingate.com. Must be set for C(license) and C(upgrade_download).
type: str
restart_sip:
description:
- Restart the SIP module and remove all state, like registrations etc.
type: bool
version_added: 1.1.0
version_added_collection: ingatesystems.fuego_modules
flush_logins:
description:
- Log out all logged in admin users.
type: bool
version_added: 1.1.0
version_added_collection: ingatesystems.fuego_modules
latest_major:
description:
- Upgrade to the latest major level.
type: bool
latest_minor:
description:
- Upgrade to the latest minor level.
type: bool
latest_patch:
description:
- Upgrade to the latest patch level.
type: bool
upgrade_abort:
description:
- Abort an upgrade after an upgrade has been installed.
type: bool
upgrade_accept:
description:
- Accept an upgrade after an upgrade has been installed.
type: bool
upgrade_download:
description:
- Download and install a firmware upgrade. The upgrade(s) will be downloaded from
the Ingate Websystem. You can upgrade to the latest patch, minor or major version.
You can also specify a desired version that is available in the respective level.
type: bool
upgrade_downgrade:
description:
- Downgrade from a previously installed upgrade.
type: bool
flush_logins:
contains:
msg:
description: The command status message
returned: success
sample: Successfully flushed all logins.
type: str
description: A command status message
returned: when C(flush_logins) is yes and success
type: dict
license:
contains:
msg:
description: Information regarding the installed license.
returned: success
sample: Install a Base license.
type: str
description: A list of information about the installed license.
elements: dict
returned: when C(license) is yes and success
type: list
opmode:
contains:
msg:
description: The command status message
returned: success
sample: Operational mode set to siparator.
type: str
description: A command status message
returned: when C(opmode) is yes and success
type: dict
patch:
contains:
msg:
description: Patch information.
returned: success
sample: Installed the patch patch-6.2.0-apipatch-1.fup (Test REST API 1).
type: str
description: Information about the installed patch.
returned: when C(patch) is yes and success
type: str
reboot:
contains:
msg:
description: The command status message
returned: success
sample: Rebooting the unit now...
type: str
description: A command status message
returned: when C(reboot) is yes and success
type: dict
restart_sip:
contains:
msg:
description: The command status message
returned: success
sample: Successfully restarted the SIP module.
type: str
description: A command status message
returned: when C(restart_sip) is yes and success
type: dict
upgrade:
contains:
msg:
description: The command status message
returned: success
sample: Rebooting with new version. Please contact the unit again once it has
rebooted.
type: str
description: A command status message
returned: when C(upgrade) is yes and success
type: dict
upgrade_abort:
contains:
msg:
description: The command status message
returned: success
sample: The upgrade has been removed. Rebooting..
type: str
description: A command status message
returned: when C(upgrade_abort) is yes and success
type: dict
upgrade_accept:
contains:
msg:
description: The command status message
returned: success
sample: Made the upgrade permanent.
type: str
description: A command status message
returned: when C(upgrade_accept) is yes and success
type: dict
upgrade_downgrade:
contains:
msg:
description: The command status message
returned: success
sample: Downgrade in progress (6.2.0). Rebooting...
type: str
description: A command status message
returned: when C(upgrade_downgrade) is yes and success
type: dict
upgrade_download:
contains:
msg:
description: The command status message
returned: success
sample: Your unit is upgraded to the latest version (6.2.2)
type: str
description: A command status message
returned: when C(upgrade_download) is yes and success
type: dict