Class LANDevice

Hierarchy (View Summary)

Constructors

Properties

_id adoptableWhenUpgraded adopted adoptIp? adoptUrl? anomalies? anonId architecture boardRevision bytes cfgVersion configNetwork configNetworkLAN? connectedAt connectionNetworkName connectRequestIp connectRequestPort default? deviceId DHCPServerTable? disabled? discoveredVia? displayableVersion dot1xPortctrlEnabled downlinkTable ethernetOverrides? ethernetTable flowctrlEnabled fwCaps gatewayMac? geoInfo? guestKicks? guestLanNumSta? guestNumSta guestToken? guestWLANNumSta? hasEth1? hasFan hashId hasSpeaker? hasTemperature hostname? hwCaps informIp informUrl internet ip jumboFrameEnabled kernelVersion knownCfgversion lanNumSta? lastSeen lastUplink? lcmBrightnessOverride? lcmIdleTimeoutOverride? lcmNightModeBegins lcmNightModeEnabled lcmNightModeEnds ledOverride? ledOverrideColor? ledOverrideColorBrightness? LEDState? licenseState lldpTable locating mac manufacturerId mgmtNetworkId minInformIntervalSeconds model modelIncompatible modelInEOL modelInLTS name? networkTable? nextInterval numDesktop? numHandheld? numMobile? numSta outdoorModeOverride? overheating portOverrides? portTable powerSourceCtrlEnabled prevNonBusyState provisionedAt requiredVersion rollupgrade rulesetInterfaces? rxBytes satisfaction? serial setupId setupProvisionCompleted? setupProvisionTracking? siteId snmpContact? snmpLocation? speedTest? speedTestSaved? sshSessionTable? startConnectedMillis startDisconnectedMillis startupTimestamp stat state storage? stpPriority stpVersion switchCaps sysErrorCaps? syslogKey sysStats systemStats temperatures? totalMaxPower? twoPhaseAdopt txBytes type unifiCare? unsupported unsupportedReason upgradable uplink uplinkDepth? uptime uptimeStats? userLanNumSta? userNumSta userWLANNumSta? usgCaps? version wan1? wan2? wifiCaps? wlanNumSta? xAesGcm xAuthkey xFingerprint xHasSshHostkey xInformAuthkey? xSshHostkeyFingerprint? debug

Accessors

Methods

Constructors

Properties

_id: string
adoptableWhenUpgraded: boolean
adopted: boolean
adoptIp?: string
adoptUrl?: string
anomalies?: number
anonId: string
architecture: string
boardRevision: number
bytes: number
cfgVersion: string
configNetwork: IConfigNetwork
configNetworkLAN?: IConfigNetworkLAN
connectedAt: number
connectionNetworkName: EConnectionNetworkName
connectRequestIp: string
connectRequestPort: string
default?: boolean
deviceId: string
DHCPServerTable?: unknown[]
disabled?: boolean
discoveredVia?: string
displayableVersion: string
dot1xPortctrlEnabled: boolean
downlinkTable: IDownlinkTable[]
ethernetOverrides?: IEthernetOverride[]
ethernetTable: IEthernetTable[]
flowctrlEnabled: boolean
fwCaps: number
gatewayMac?: string
geoInfo?: IGeoInfo
guestKicks?: number
guestLanNumSta?: number
guestNumSta: number
guestToken?: string
guestWLANNumSta?: number
hasEth1?: boolean
hasFan: boolean
hashId: string
hasSpeaker?: boolean
hasTemperature: boolean
hostname?: string
hwCaps: number
informIp: string
informUrl: string
internet: boolean
ip: string
jumboFrameEnabled: boolean
kernelVersion: string
knownCfgversion: string
lanNumSta?: number
lastSeen: number
lastUplink?: ILastUplink
lcmBrightnessOverride?: boolean
lcmIdleTimeoutOverride?: boolean
lcmNightModeBegins: string
lcmNightModeEnabled: boolean
lcmNightModeEnds: string
ledOverride?: string
ledOverrideColor?: string
ledOverrideColorBrightness?: number
LEDState?: ILEDState
licenseState: string
lldpTable: ILldpTable[]
locating: boolean
mac: string
manufacturerId: number
mgmtNetworkId: string
minInformIntervalSeconds: number
model: string
modelIncompatible: boolean
modelInEOL: boolean
modelInLTS: boolean
name?: string
networkTable?: INetworkTable[]
nextInterval: number
numDesktop?: number
numHandheld?: number
numMobile?: number
numSta: number
outdoorModeOverride?: string
overheating: boolean
portOverrides?: IPortOverride[]
portTable: IPortTable[]
powerSourceCtrlEnabled: boolean
prevNonBusyState: number
provisionedAt: number
requiredVersion: string
rollupgrade: boolean
rulesetInterfaces?: Record<string, string>
rxBytes: number
satisfaction?: number
serial: string
setupId: string
setupProvisionCompleted?: boolean
setupProvisionTracking?: boolean
siteId: string
snmpContact?: string
snmpLocation?: string
speedTest?: ISpeedtestStatus
speedTestSaved?: boolean
sshSessionTable?: unknown[]
startConnectedMillis: number
startDisconnectedMillis: number
startupTimestamp: number
stat: IStat
storage?: IStorage[]
stpPriority: string
stpVersion: string
switchCaps: ISwitchCaps
sysErrorCaps?: number
syslogKey: string
sysStats: ISysStats
systemStats: ISystemStats
temperatures?: ITemperature[]
totalMaxPower?: number
twoPhaseAdopt: boolean
txBytes: number
unifiCare?: IUnifiCare
unsupported: boolean
unsupportedReason: number
upgradable: boolean
uplink: IUplink
uplinkDepth?: number
uptime: number
uptimeStats?: IUptimeStats
userLanNumSta?: number
userNumSta: number
userWLANNumSta?: number
usgCaps?: number
version: string
wan1?: IWAN
wan2?: IWAN
wifiCaps?: number
wlanNumSta?: number
xAesGcm: boolean
xAuthkey: string
xFingerprint: string
xHasSshHostkey: boolean
xInformAuthkey?: string
xSshHostkeyFingerprint?: string
debug: Debugger = ...

Accessors

Methods

  • Parameters

    • OptionalminVersion: string

      the minimal semver version for this object

    • OptionalunifiOs: boolean

      need to be unifiOs ? or Unifi Controller ? if no need, pass undefined

    • parameterName: string = ''

      a name for the parameter

    Returns void

  • Type Parameters

    • T

    Parameters

    • key: keyof LANDevice

      the key object that need to be only supported on some versions

    • Optionalvalue: T

      the value store in this object

    • OptionalminVersion: string

      the minimal semver version for this object

    • OptionalunifiOs: boolean

      need to be unifiOs ? or Unifi Controller ? if no need, pass undefined

    • allowUndefined: boolean = false

      to undefined check ?

    Returns boolean

  • Parameters

    • type: "soft" | "hard" = 'soft'

      two options: 'soft' or 'hard', defaults to soft soft can be used for all devices, requests a plain restart of that device hard is special for PoE switches and besides the restart also requests a power cycle on all PoE capable ports. Keep in mind that a 'hard' reboot does NOT trigger a factory-reset.

    Returns Promise<boolean>