Class UAPDevice

Hierarchy (View Summary)

Constructors

Properties

_id accMeterStats adoptableWhenUpgraded adopted adoptIp? adoptUrl? anonId antennaTable architecture boardRevision bytes bytesD bytesR cfgVersion configNetwork connectedAt connectionNetworkName connectRequestIp connectRequestPort countryCode countrycodeTable default? deviceId disabled? disconnectionReason discoveredVia? displayableVersion dot1xPortctrlEnabled downlinkTable elementPeerMAC ethernetTable fwCaps gatewayMac? guestKicks? guestNumSta guestToken? guestWLANNumSta? hasEth1? hasFan hashId hasSpeaker? hasTemperature hideChWidth hwCaps informIp informUrl internet ip isolated kernelVersion knownCfgversion lastScan lastSeen lastUplink? lcmBrightnessOverride? lcmIdleTimeoutOverride? ledOverride? ledOverrideColor? ledOverrideColorBrightness? licenseState lldpTable locating mac manufacturerId meshv3PeerMAC minInformIntervalSeconds model modelIncompatible modelInEOL modelInLTS name? nextInterval numSta outdoorModeOverride? portStats portTable prevNonBusyState provisionedAt radioTable radioTableStats requiredVersion rollupgrade rxBytes rxBytesD satisfaction? scanning scanRadioTable serial setupId siteId spectrumScanning sshSessionTable? startConnectedMillis startDisconnectedMillis startupTimestamp stat state supportsFingerprintMl switchCaps sysErrorCaps? syslogKey sysStats systemStats twoPhaseAdopt txBytes txBytesD type unsupported unsupportedReason upgradable uplink uplinkTable uptime userNumSta userWLANNumSta? vapTable version vwireEnabled vwireTable vwireVapTable wifiCaps? wlangroupIdNa wlangroupIdNg xAesGcm xAuthkey xFingerprint xHasSshHostkey xSshHostkeyFingerprint? xVwirekey debug type

Accessors

Methods

Constructors

Properties

_id: string
accMeterStats: IAccMeterStats
adoptableWhenUpgraded: boolean
adopted: boolean
adoptIp?: string
adoptUrl?: string
anonId: string
antennaTable: IAntennaTable[]
architecture: string
boardRevision: number
bytes: number
bytesD: number
bytesR: number
cfgVersion: string
configNetwork: IConfigNetwork
connectedAt: number
connectionNetworkName: EConnectionNetworkName
connectRequestIp: string
connectRequestPort: string
countryCode: number
countrycodeTable: unknown[]
default?: boolean
deviceId: string
disabled?: boolean
disconnectionReason: string
discoveredVia?: string
displayableVersion: string
dot1xPortctrlEnabled: boolean
downlinkTable: IDownlinkTable[]
elementPeerMAC: string
ethernetTable: IEthernetTable[]
fwCaps: number
gatewayMac?: string
guestKicks?: number
guestNumSta: number
guestToken?: string
guestWLANNumSta?: number
hasEth1?: boolean
hasFan: boolean
hashId: string
hasSpeaker?: boolean
hasTemperature: boolean
hideChWidth: string
hwCaps: number
informIp: string
informUrl: string
internet: boolean
ip: string
isolated: boolean
kernelVersion: string
knownCfgversion: string
lastScan: number
lastSeen: number
lastUplink?: ILastUplink
lcmBrightnessOverride?: boolean
lcmIdleTimeoutOverride?: boolean
ledOverride?: string
ledOverrideColor?: string
ledOverrideColorBrightness?: number
licenseState: string
lldpTable: ILldpTable[]
locating: boolean
mac: string
manufacturerId: number
meshv3PeerMAC: string
minInformIntervalSeconds: number
model: string
modelIncompatible: boolean
modelInEOL: boolean
modelInLTS: boolean
name?: string
nextInterval: number
numSta: number
outdoorModeOverride?: string
portStats: unknown[]
portTable: IPortTable[]
prevNonBusyState: number
provisionedAt: number
radioTable: IRadioTable[]
radioTableStats: IRadioTableStat[]
requiredVersion: string
rollupgrade: boolean
rxBytes: number
rxBytesD: number
satisfaction?: number
scanning: boolean
scanRadioTable: unknown[]
serial: string
setupId: string
siteId: string
spectrumScanning: boolean
sshSessionTable?: unknown[]
startConnectedMillis: number
startDisconnectedMillis: number
startupTimestamp: number
stat: IStat
supportsFingerprintMl: boolean
switchCaps: ISwitchCaps
sysErrorCaps?: number
syslogKey: string
sysStats: ISysStats
systemStats: ISystemStats
twoPhaseAdopt: boolean
txBytes: number
txBytesD: number
type: EDeviceType = EDeviceType.UAP
unsupported: boolean
unsupportedReason: number
upgradable: boolean
uplink: IUplink
uplinkTable: unknown[]
uptime: number
userNumSta: number
userWLANNumSta?: number
vapTable: IVapTable[]
version: string
vwireEnabled: boolean
vwireTable: unknown[]
vwireVapTable: unknown[]
wifiCaps?: number
wlangroupIdNa: string
wlangroupIdNg: string
xAesGcm: boolean
xAuthkey: string
xFingerprint: string
xHasSshHostkey: boolean
xSshHostkeyFingerprint?: string
xVwirekey: string
debug: Debugger = ...
type: EDeviceType = EDeviceType.UAP

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 UAPDevice

      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>