get_guest_portal
get_guest_portal
Section titled “get_guest_portal”Show the guest captive-portal configuration for the site.
The portal is a site setting (guest_access), not a property of
any WLAN. Turning a WLAN off “Hotspot” mode does not disable the
portal — check and change it here.
Side effects: None (read-only).
Returns portal_enabled (the click-through page toggle), auth
("none" means a bare Connect button with no credential),
expire/expire_number/expire_unit (how long an authorised
guest session lasts before the page reappears), redirect_enabled
and redirect_url, the restricted_subnet_* entries, and the
payment/voucher/Facebook toggles. portal_enabled and auth are
independent axes.
Example
Section titled “Example”get_guest_portal(controller="default")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |