Interface UniFiDevice

interface UniFiDevice {
    _id: string;
    mac: string;
    model: string;
    name?: string;
    type: "uap" | "usw" | "ugw" | "usg" | "udm" | "uxg" | "ubb" | "ulte" | "unvr" | "uck" | "uph";
    state: 0 | 1 | 2 | 3 | 4 | 5;
    adopted: boolean;
    disabled?: boolean;
    ip?: string;
    version?: string;
    serial?: string;
    firmware_version?: string;
    upgrade_to_firmware?: string;
    uptime?: number;
    last_seen?: number;
    next_heartbeat_at?: number;
    cfgversion?: string;
    config_network?: {
        type: string;
        ip: string;
    };
    vlan_enabled?: boolean;
    jumboframe_enabled?: boolean;
    flowctrl_enabled?: boolean;
    stp_version?: string;
    stp_priority?: string;
    mgmt_network_id?: string;
    led_override?: "default" | "on" | "off";
    led_override_color?: string;
    led_override_color_brightness?: number;
    outdoor_mode_override?: "default" | "on" | "off";
    lcm_brightness_override?: boolean;
    lcm_brightness?: number;
    lcm_idle_timeout_override?: boolean;
    lcm_idle_timeout?: number;
    power_source_ctrl_enabled?: boolean;
    radio_table?: DeviceRadio[];
    radio_table_stats?: DeviceRadioStats[];
    antenna_table?: DeviceAntenna[];
    scan_radio_table?: DeviceScanRadio[];
    port_table?: DevicePort[];
    ethernet_table?: DeviceEthernet[];
    wan1?: DeviceWan;
    wan2?: DeviceWan;
    speedtest_status?: DeviceSpeedtest;
    stat?: DeviceStats;
    tx_bytes?: number;
    rx_bytes?: number;
    bytes?: number;
    num_sta?: number;
    user_num_sta?: number;
    guest_num_sta?: number;
    board_rev?: number;
    device_id?: string;
    hash_id?: string;
    in_router_mode?: boolean;
    inform_ip?: string;
    inform_url?: string;
    kernel_version?: string;
    architecture?: string;
    adoption_completed?: boolean;
    provisioned_at?: number;
    x?: number;
    y?: number;
    map_id?: string;
    device_tag_ids?: string[];
    wlangroup_id_ng?: string;
    wlangroup_id_na?: string;
}

Properties

_id mac model name? type state adopted disabled? ip? version? serial? firmware_version? upgrade_to_firmware? uptime? last_seen? next_heartbeat_at? cfgversion? config_network? vlan_enabled? jumboframe_enabled? flowctrl_enabled? stp_version? stp_priority? mgmt_network_id? led_override? led_override_color? led_override_color_brightness? outdoor_mode_override? lcm_brightness_override? lcm_brightness? lcm_idle_timeout_override? lcm_idle_timeout? power_source_ctrl_enabled? radio_table? radio_table_stats? antenna_table? scan_radio_table? port_table? ethernet_table? wan1? wan2? speedtest_status? stat? tx_bytes? rx_bytes? bytes? num_sta? user_num_sta? guest_num_sta? board_rev? device_id? hash_id? in_router_mode? inform_ip? inform_url? kernel_version? architecture? adoption_completed? provisioned_at? x? y? map_id? device_tag_ids? wlangroup_id_ng? wlangroup_id_na?

Properties

_id

_id: string

mac

mac: string

model

model: string

Optional name

name?: string

type

type: "uap" | "usw" | "ugw" | "usg" | "udm" | "uxg" | "ubb" | "ulte" | "unvr" | "uck" | "uph"

state

state: 0 | 1 | 2 | 3 | 4 | 5

adopted

adopted: boolean

Optional disabled

disabled?: boolean

Optional ip

ip?: string

Optional version

version?: string

Optional serial

serial?: string

Optional firmware_version

firmware_version?: string

Optional upgrade_to_firmware

upgrade_to_firmware?: string

Optional uptime

uptime?: number

Optional last_seen

last_seen?: number

Optional next_heartbeat_at

next_heartbeat_at?: number

Optional cfgversion

cfgversion?: string

Optional config_network

config_network?: {
    type: string;
    ip: string;
}

Type declaration

  • type: string
  • ip: string

Optional vlan_enabled

vlan_enabled?: boolean

Optional jumboframe_enabled

jumboframe_enabled?: boolean

Optional flowctrl_enabled

flowctrl_enabled?: boolean

Optional stp_version

stp_version?: string

Optional stp_priority

stp_priority?: string

Optional mgmt_network_id

mgmt_network_id?: string

Optional led_override

led_override?: "default" | "on" | "off"

Optional led_override_color

led_override_color?: string

Optional led_override_color_brightness

led_override_color_brightness?: number

Optional outdoor_mode_override

outdoor_mode_override?: "default" | "on" | "off"

Optional lcm_brightness_override

lcm_brightness_override?: boolean

Optional lcm_brightness

lcm_brightness?: number

Optional lcm_idle_timeout_override

lcm_idle_timeout_override?: boolean

Optional lcm_idle_timeout

lcm_idle_timeout?: number

Optional power_source_ctrl_enabled

power_source_ctrl_enabled?: boolean

Optional radio_table

radio_table?: DeviceRadio[]

Optional radio_table_stats

radio_table_stats?: DeviceRadioStats[]

Optional antenna_table

antenna_table?: DeviceAntenna[]

Optional scan_radio_table

scan_radio_table?: DeviceScanRadio[]

Optional port_table

port_table?: DevicePort[]

Optional ethernet_table

ethernet_table?: DeviceEthernet[]

Optional wan1

wan1?: DeviceWan

Optional wan2

wan2?: DeviceWan

Optional speedtest_status

speedtest_status?: DeviceSpeedtest

Optional stat

stat?: DeviceStats

Optional tx_bytes

tx_bytes?: number

Optional rx_bytes

rx_bytes?: number

Optional bytes

bytes?: number

Optional num_sta

num_sta?: number

Optional user_num_sta

user_num_sta?: number

Optional guest_num_sta

guest_num_sta?: number

Optional board_rev

board_rev?: number

Optional device_id

device_id?: string

Optional hash_id

hash_id?: string

Optional in_router_mode

in_router_mode?: boolean

Optional inform_ip

inform_ip?: string

Optional inform_url

inform_url?: string

Optional kernel_version

kernel_version?: string

Optional architecture

architecture?: string

Optional adoption_completed

adoption_completed?: boolean

Optional provisioned_at

provisioned_at?: number

Optional x

x?: number

Optional y

y?: number

Optional map_id

map_id?: string

Optional device_tag_ids

device_tag_ids?: string[]

Optional wlangroup_id_ng

wlangroup_id_ng?: string

Optional wlangroup_id_na

wlangroup_id_na?: string

Settings

Member Visibility

Theme

On This Page

_idmacmodelnametypestateadopteddisabledipversionserialfirmware_versionupgrade_to_firmwareuptimelast_seennext_heartbeat_atcfgversionconfig_networkvlan_enabledjumboframe_enabledflowctrl_enabledstp_versionstp_prioritymgmt_network_idled_overrideled_override_colorled_override_color_brightnessoutdoor_mode_overridelcm_brightness_overridelcm_brightnesslcm_idle_timeout_overridelcm_idle_timeoutpower_source_ctrl_enabledradio_tableradio_table_statsantenna_tablescan_radio_tableport_tableethernet_tablewan1wan2speedtest_statusstattx_bytesrx_bytesbytesnum_stauser_num_staguest_num_staboard_revdevice_idhash_idin_router_modeinform_ipinform_urlkernel_versionarchitectureadoption_completedprovisioned_atxymap_iddevice_tag_idswlangroup_id_ngwlangroup_id_na