unifi_failover - USG failover WAN status

Checks a Unifi Security Gateway for failover WAN status. Connects via SSH; the USG must be in your known_hosts file. Requires the specified interface to have the carrier up, a gateway, and not be in the failover state.

router_address

Type

string

Required

true

the address of the USG

router_username

Type

string

Required

true

the username to log in as

router_password

Type

string

Required

conditional

the password to log in with. Required if not using ssh_key.

ssh_key

Type

string

Required

conditional

path to the SSH private key to log in with. Required if not using router_password.

check_interface

Type

string

Required

false

Default

eth2

the interface which should be ready for failover.