Class UGWDevice

Hierarchy (view full)

LANDevice
- UGWDevice

Index

Constructors

Constructors

constructor

new UGWDevice(config, props): UGWDevice
Parameters
- config: IObjectSubSiteConfig
- props: Partial<IBaseDeviceRaw> & {
  mac: string;
  }
Returns UGWDevice
Inherited from LANDevice.constructor
- Defined in src/Devices/BaseDevice.ts:44

Properties

`Optional` DHCPServerTable

DHCPServerTable?: unknown[]

`Optional` LEDState

LEDState?: ILEDState

_id

_id: string

`Optional` adoptIp

adoptIp?: string

`Optional` adoptUrl

adoptUrl?: string

adoptableWhenUpgraded

adoptableWhenUpgraded: boolean

adopted

adopted: boolean

`Optional` anomalies

anomalies?: number

anonId

anonId: string

architecture

architecture: string

boardRevision

boardRevision: number

bytes

bytes: number

cfgVersion

cfgVersion: string

configNetwork

configNetwork: IConfigNetwork

`Optional` configNetworkLAN

configNetworkLAN?: IConfigNetworkLAN

connectRequestIp

connectRequestIp: string

connectRequestPort

connectRequestPort: string

connectedAt

connectedAt: number

connectionNetworkName

connectionNetworkName: EConnectionNetworkName

`Optional` default

default?: boolean

deviceId

deviceId: string

`Optional` disabled

disabled?: boolean

`Optional` discoveredVia

discoveredVia?: string

displayableVersion

displayableVersion: string

dot1xPortctrlEnabled

dot1xPortctrlEnabled: boolean

downlinkTable

downlinkTable: IDownlinkTable[]

`Optional` ethernetOverrides

ethernetOverrides?: IEthernetOverride[]

ethernetTable

ethernetTable: IEthernetTable[]

flowctrlEnabled

flowctrlEnabled: boolean

fwCaps

fwCaps: number

`Optional` gatewayMac

gatewayMac?: string

`Optional` geoInfo

geoInfo?: IGeoInfo

`Optional` guestKicks

guestKicks?: number

`Optional` guestLanNumSta

guestLanNumSta?: number

guestNumSta

guestNumSta: number

`Optional` guestToken

guestToken?: string

`Optional` guestWLANNumSta

guestWLANNumSta?: number

`Optional` hasEth1

hasEth1?: boolean

hasFan

hasFan: boolean

`Optional` hasSpeaker

hasSpeaker?: boolean

hasTemperature

hasTemperature: boolean

hashId

hashId: string

`Optional` hostname

hostname?: string

hwCaps

hwCaps: number

informIp

informIp: string

informUrl

informUrl: string

internet

internet: boolean

ip

ip: string

jumboFrameEnabled

jumboFrameEnabled: boolean

kernelVersion

kernelVersion: string

knownCfgversion

knownCfgversion: string

`Optional` lanNumSta

lanNumSta?: number

lastSeen

lastSeen: number

`Optional` lastUplink

lastUplink?: ILastUplink

`Optional` lcmBrightnessOverride

lcmBrightnessOverride?: boolean

`Optional` lcmIdleTimeoutOverride

lcmIdleTimeoutOverride?: boolean

lcmNightModeBegins

lcmNightModeBegins: string

lcmNightModeEnabled

lcmNightModeEnabled: boolean

lcmNightModeEnds

lcmNightModeEnds: string

`Optional` ledOverride

ledOverride?: string

`Optional` ledOverrideColor

ledOverrideColor?: string

`Optional` ledOverrideColorBrightness

ledOverrideColorBrightness?: number

licenseState

licenseState: string

lldpTable

lldpTable: ILldpTable[]

locating

locating: boolean

mac

mac: string

manufacturerId

manufacturerId: number

mgmtNetworkId

mgmtNetworkId: string

minInformIntervalSeconds

minInformIntervalSeconds: number

model

model: string

modelInEOL

modelInEOL: boolean

modelInLTS

modelInLTS: boolean

modelIncompatible

modelIncompatible: boolean

`Optional` name

name?: string

`Optional` networkTable

networkTable?: INetworkTable[]

nextInterval

nextInterval: number

`Optional` numDesktop

numDesktop?: number

`Optional` numHandheld

numHandheld?: number

`Optional` numMobile

numMobile?: number

numSta

numSta: number

`Optional` outdoorModeOverride

outdoorModeOverride?: string

overheating

overheating: boolean

`Optional` portOverrides

portOverrides?: IPortOverride[]

portTable

portTable: IPortTable[]

powerSourceCtrlEnabled

powerSourceCtrlEnabled: boolean

prevNonBusyState

prevNonBusyState: number

provisionedAt

provisionedAt: number

requiredVersion

requiredVersion: string

rollupgrade

rollupgrade: boolean

`Optional` rulesetInterfaces

rulesetInterfaces?: Record<string, string>

rxBytes

rxBytes: number

`Optional` satisfaction

satisfaction?: number

serial

serial: string

setupId

setupId: string

`Optional` setupProvisionCompleted

setupProvisionCompleted?: boolean

`Optional` setupProvisionTracking

setupProvisionTracking?: boolean

siteId

siteId: string

`Optional` snmpContact

snmpContact?: string

`Optional` snmpLocation

snmpLocation?: string

`Optional` speedTest

speedTest?: ISpeedtestStatus

`Optional` speedTestSaved

speedTestSaved?: boolean

`Optional` sshSessionTable

sshSessionTable?: unknown[]

startConnectedMillis

startConnectedMillis: number

startDisconnectedMillis

startDisconnectedMillis: number

startupTimestamp

startupTimestamp: number

stat

stat: IStat

state

state: EDeviceStates

`Optional` storage

storage?: IStorage[]

stpPriority

stpPriority: string

stpVersion

stpVersion: string

switchCaps

switchCaps: ISwitchCaps

`Optional` sysErrorCaps

sysErrorCaps?: number

sysStats

sysStats: ISysStats

syslogKey

syslogKey: string

systemStats

systemStats: ISystemStats

`Optional` temperatures

temperatures?: ITemperature[]

`Optional` totalMaxPower

totalMaxPower?: number

twoPhaseAdopt

twoPhaseAdopt: boolean

txBytes

txBytes: number

type

type: EDeviceType = EDeviceType.UGW

`Optional` unifiCare

unifiCare?: IUnifiCare

unsupported

unsupported: boolean

unsupportedReason

unsupportedReason: number

upgradable

upgradable: boolean

uplink

uplink: IUplink

`Optional` uplinkDepth

uplinkDepth?: number

uptime

uptime: number

`Optional` uptimeStats

uptimeStats?: IUptimeStats

`Optional` userLanNumSta

userLanNumSta?: number

userNumSta

userNumSta: number

`Optional` userWLANNumSta

userWLANNumSta?: number

`Optional` usgCaps

usgCaps?: number

version

version: string

`Optional` wan1

wan1?: IWAN

`Optional` wan2

wan2?: IWAN

`Optional` wifiCaps

wifiCaps?: number

`Optional` wlanNumSta

wlanNumSta?: number

xAesGcm

xAesGcm: boolean

xAuthkey

xAuthkey: string

xFingerprint

xFingerprint: string

xHasSshHostkey

xHasSshHostkey: boolean

`Optional` xInformAuthkey

xInformAuthkey?: string

`Optional` xSshHostkeyFingerprint

xSshHostkeyFingerprint?: string

`Static` debug

debug: Debugger = ...

`Static` type

type: EDeviceType = EDeviceType.UGW

Accessors

`Protected` config

get config(): IObjectSubSiteConfigComplete
Returns IObjectSubSiteConfigComplete
Inherited from LANDevice.config
- Defined in src/commons/_ObjectSubSite.ts:31
set config(value): void
Parameters
- value: IObjectSubSiteConfigComplete
Returns void
Inherited from LANDevice.config
- Defined in src/commons/_ObjectSubSite.ts:35

`Protected` controller

get controller(): Controller
Returns Controller
Inherited from LANDevice.controller
- Defined in src/commons/_ObjectSubController.ts:31
set controller(value): void
Parameters
- value: Controller
Returns void
Inherited from LANDevice.controller
- Defined in src/commons/_ObjectSubController.ts:35

`Protected` controllerInstance

get controllerInstance(): AxiosInstance
Returns AxiosInstance
Inherited from LANDevice.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:24
set controllerInstance(value): void
Parameters
- value: AxiosInstance
Returns void
Inherited from LANDevice.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:28

`Protected` debug

get debug(): Debugger
Returns Debugger
Inherited from LANDevice.debug
- Defined in src/commons/_ObjectSubController.ts:144
set debug(value): void
Parameters
- value: Debugger
Returns void
Inherited from LANDevice.debug
- Defined in src/commons/_ObjectSubController.ts:148

`Protected` instance

get instance(): AxiosInstance
Returns AxiosInstance
Inherited from LANDevice.instance
- Defined in src/commons/_ObjectSubSite.ts:14

`Protected` privateMap

get privateMap(): WeakMap<any, any>
Returns WeakMap<any, any>
Inherited from LANDevice.privateMap
- Defined in src/commons/ObjectWithPrivateValues.ts:28

`Protected` site

get site(): Site
Returns Site
Inherited from LANDevice.site
- Defined in src/commons/_ObjectSubController.ts:38
set site(value): void
Parameters
- value: Site
Returns void
Inherited from LANDevice.site
- Defined in src/commons/_ObjectSubController.ts:42

Methods

`Protected` _updateDevice

_updateDevice(payload): Promise<UGWDevice>
Parameters
- payload: unknown
Returns Promise<UGWDevice>
Inherited from LANDevice._updateDevice
- Defined in src/Devices/BaseDevice.ts:427

`Protected` checkNeedVersion

checkNeedVersion(minVersion?, unifiOs?, parameterName?): void
Parameters
- Optional minVersion: string
  the minimal semver version for this object
- Optional unifiOs: boolean
  need to be unifiOs ? or Unifi Controller ? if no need, pass undefined
- parameterName: string = ''
  a name for the parameter
Returns void
Inherited from LANDevice.checkNeedVersion
- Defined in src/commons/_ObjectSubController.ts:104

`Protected` checkNeeds

checkNeeds(minVersion?, unifiOs?): boolean
Parameters
- Optional minVersion: string
- Optional unifiOs: boolean
Returns boolean
Inherited from LANDevice.checkNeeds
- Defined in src/commons/_ObjectSubController.ts:94

forceProvision

forceProvision(): Promise<unknown>
Returns Promise<unknown>
Inherited from LANDevice.forceProvision
- Defined in src/Devices/BaseDevice.ts:378

getController

getController(): Controller
Returns Controller
Inherited from LANDevice.getController
- Defined in src/commons/_ObjectSubController.ts:79

getInstance

getInstance(): AxiosInstance
Returns AxiosInstance
Inherited from LANDevice.getInstance
- Defined in src/commons/_ObjectSubController.ts:75

`Protected` getPrivate

getPrivate<T>(key): T
Type Parameters
- T
  the type retrieve.
Parameters
- key: string
  the key to retrieve
Returns T
Inherited from LANDevice.getPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:11

import

import(props): this
Parameters
- props: Partial<ILANDeviceRaw> & IBaseDeviceMandatoryRaw
Returns this
Inherited from LANDevice.import
- Defined in src/Devices/LANDevice.ts:21

locate

locate(locate?): Promise<boolean>
Parameters
- locate: boolean = true
Returns Promise<boolean>
Inherited from LANDevice.locate
- Defined in src/Devices/BaseDevice.ts:412

`Protected` mapObject

mapObject<U>(constructor, object): U
Type Parameters
- U extends _ObjectSubSite
Parameters
- constructor: (new (config, props) => U)
  the construtor to map the object
  - - new (config, props): U
    - Parameters
      config: IObjectSubSiteConfig
      props: any
      Returns U
- object: any
  the properties passed to the constructor if defined
Returns U
Inherited from LANDevice.mapObject
- Defined in src/commons/_ObjectSubSite.ts:60

`Protected` needVersion

needVersion<T>(key, value?, minVersion?, unifiOs?, allowUndefined?): boolean
Type Parameters
- T
Parameters
- key: keyof UGWDevice
  the key object that need to be only supported on some versions
- Optional value: T
  the value store in this object
- Optional minVersion: string
  the minimal semver version for this object
- Optional unifiOs: boolean
  need to be unifiOs ? or Unifi Controller ? if no need, pass undefined
- allowUndefined: boolean = false
  to undefined check ?
Returns boolean
Inherited from LANDevice.needVersion
- Defined in src/commons/_ObjectSubController.ts:116

reboot

reboot(type?): Promise<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>
Inherited from LANDevice.reboot
- Defined in src/Devices/BaseDevice.ts:365

setLedOverride

setLedOverride(props): unknown
Override LED mode for a device (using REST)
Parameters
- props: ILedOverrideProps
Returns unknown
Inherited from LANDevice.setLedOverride
- Defined in src/Devices/BaseDevice.ts:387

`Protected` setPrivate

setPrivate<T>(key, value): void
Type Parameters
- T
  the type to set.
Parameters
- key: string
  the key to set
- value: T
  the value
Returns void
Inherited from LANDevice.setPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:21

toJSON

toJSON(): Partial<UGWDevice>
Returns Partial<UGWDevice>
Inherited from LANDevice.toJSON
- Defined in src/commons/_ObjectSubController.ts:59

updateDevice

updateDevice(payload): Promise<UGWDevice>
Parameters
- payload: Partial<ILANDeviceRaw>
Returns Promise<UGWDevice>
Inherited from LANDevice.updateDevice
- Defined in src/Devices/LANDevice.ts:156

Class UGWDevice

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UGWDevice

Properties

Optional DHCPServerTable

Optional LEDState

_id

Optional adoptIp

Optional adoptUrl

adoptableWhenUpgraded

adopted

Optional anomalies

anonId

architecture

boardRevision

bytes

cfgVersion

configNetwork

Optional configNetworkLAN

connectRequestIp

connectRequestPort

connectedAt

connectionNetworkName

Optional default

deviceId

Optional disabled

Optional discoveredVia

displayableVersion

dot1xPortctrlEnabled

downlinkTable

Optional ethernetOverrides

ethernetTable

flowctrlEnabled

fwCaps

Optional gatewayMac

Optional geoInfo

Optional guestKicks

Optional guestLanNumSta

guestNumSta

Optional guestToken

Optional guestWLANNumSta

Optional hasEth1

hasFan

Optional hasSpeaker

hasTemperature

hashId

Optional hostname

hwCaps

informIp

informUrl

internet

ip

jumboFrameEnabled

kernelVersion

knownCfgversion

Optional lanNumSta

lastSeen

Optional lastUplink

Optional lcmBrightnessOverride

Optional lcmIdleTimeoutOverride

lcmNightModeBegins

lcmNightModeEnabled

lcmNightModeEnds

Optional ledOverride

Optional ledOverrideColor

Optional ledOverrideColorBrightness

licenseState

lldpTable

locating

mac

manufacturerId

mgmtNetworkId

`Optional` DHCPServerTable

`Optional` LEDState

`Optional` adoptIp

`Optional` adoptUrl

`Optional` anomalies

`Optional` configNetworkLAN

`Optional` default

`Optional` disabled

`Optional` discoveredVia

`Optional` ethernetOverrides

`Optional` gatewayMac

`Optional` geoInfo

`Optional` guestKicks

`Optional` guestLanNumSta

`Optional` guestToken

`Optional` guestWLANNumSta

`Optional` hasEth1

`Optional` hasSpeaker

`Optional` hostname

`Optional` lanNumSta

`Optional` lastUplink

`Optional` lcmBrightnessOverride

`Optional` lcmIdleTimeoutOverride

`Optional` ledOverride

`Optional` ledOverrideColor

`Optional` ledOverrideColorBrightness

`Optional` name

`Optional` networkTable

`Optional` numDesktop

`Optional` numHandheld

`Optional` numMobile

`Optional` outdoorModeOverride

`Optional` portOverrides

`Optional` rulesetInterfaces

`Optional` satisfaction

`Optional` setupProvisionCompleted

`Optional` setupProvisionTracking

`Optional` snmpContact

`Optional` snmpLocation

`Optional` speedTest

`Optional` speedTestSaved

`Optional` sshSessionTable

`Optional` storage

`Optional` sysErrorCaps

`Optional` temperatures

`Optional` totalMaxPower

`Optional` unifiCare

`Optional` uplinkDepth

`Optional` uptimeStats

`Optional` userLanNumSta

`Optional` userWLANNumSta

`Optional` usgCaps

`Optional` wan1

`Optional` wan2

`Optional` wifiCaps

`Optional` wlanNumSta