SystemModule | Unraid API Client

Hierarchy

EventExtension<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }>
SystemModuleDateExtension
SystemModuleDiskfree
SystemModuleHostnameExtension
SystemModuleInfoExtension
SystemModuleLoadAverageExtension
SystemModuleLsblkExtension
SystemModuleLscpuExtension
SystemModuleLsusbExtension
SystemModuleNtpExtension
SystemModuleSmartctlExtension
SystemModuleSyslogExtension
SystemModuleUptimeExtension
SystemModuleCpuExtension
SystemModuleUsersExtension
- SystemModule

Index

Constructors

constructor

Methods

Constructors

constructor

new SystemModule(instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>): SystemModule

Inherited from SystemModuleUsersExtension.constructor
- Defined in modules/system/system-module.ts:69
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
Returns SystemModule

Methods

date

date(parsed?: false): Promise<string>
date(parsed?: true): Promise<Date>

Inherited from SystemModuleDateExtension.date
- Defined in modules/system/extensions/date.ts:4
Parameters
- Optional parsed: false
Returns Promise<string>
Inherited from SystemModuleDateExtension.date
- Defined in modules/system/extensions/date.ts:6
Parameters
- Optional parsed: true
Returns Promise<Date>

diskfree

diskfree(): Promise<IDiskFreeReturn[]>

Inherited from SystemModuleDiskfree.diskfree
- Defined in modules/system/extensions/diskfree.ts:15
Returns the current disk free stats

Returns Promise<IDiskFreeReturn[]>

getHostname

getHostname(): Promise<string>

Inherited from SystemModuleHostnameExtension.getHostname
- Defined in modules/system/extensions/hostname.ts:4
Returns Promise<string>

info

info(): Promise<IInfoResult>

Inherited from SystemModuleInfoExtension.info
- Defined in modules/system/extensions/info.ts:13
Returns current System info like manufacturer, productname and also the version

Returns Promise<IInfoResult>

loadAverage

loadAverage(): Promise<ILoadAverage>

Inherited from SystemModuleLoadAverageExtension.loadAverage
- Defined in modules/system/extensions/loadaverage.ts:25
Returns Promise<ILoadAverage>

lsblk

lsblk(all?: ILsblk): Promise<Record<never, never>>

Inherited from SystemModuleLsblkExtension.lsblk
- Defined in modules/system/extensions/lsblk.ts:22
List all block devices
example
Get basic information
```
await lsblk();
await lsblk({all: false});
```
example
Get all information
```
await lsblk({all: true});
```
Parameters
- all: ILsblk = {}
  
  toggles --all flag in lsblk
Returns Promise<Record<never, never>>

lscpu

lscpu(): Promise<ILscpuResult>

Inherited from SystemModuleLscpuExtension.lscpu
- Defined in modules/system/extensions/lscpu.ts:18
Get Processor Information

Returns Promise<ILscpuResult>

lsusb

lsusb(): Promise<ILsusbResult[]>

Inherited from SystemModuleLsusbExtension.lsusb
- Defined in modules/system/extensions/lsusb.ts:22
List all usb devices
example
Get usb devices
```
await lsusb();
```
Returns Promise<ILsusbResult[]>

ntp

ntp(): Promise<string[]>

Inherited from SystemModuleNtpExtension.ntp
- Defined in modules/system/extensions/ntp.ts:4
Returns Promise<string[]>

on

on<Key>(module: Key, listener: (value: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "handlerType">) => void, options?: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "optionType">): [() => void]

Inherited from EventExtension.on
- Defined in modules/extension/event-extension.ts:18
Type parameters
- Key: "syslog" | "loadAverage" | "cpuUsage"
Parameters
- module: Key
- listener: (value: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "handlerType">) => void
  - - (value: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "handlerType">): void
    - Parameters
      - value: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "handlerType">
      Returns void
- Optional options: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "optionType">
Returns [() => void]

on_cpuUsage

on_cpuUsage(listener: (newLoad: CPUUsage) => void, options?: ICpuUsageStreamOption): [() => void]

Inherited from SystemModuleCpuExtension.on_cpuUsage
- Defined in modules/system/extensions/cpu.ts:139
Parameters
- listener: (newLoad: CPUUsage) => void
  - - (newLoad: CPUUsage): void
    - Parameters
      - newLoad: CPUUsage
      Returns void
- Optional options: ICpuUsageStreamOption
Returns [() => void]

on_loadAverage

on_loadAverage(listener: (newLoad: ILoadAverage) => void, options?: ILoadAverageStreamOption): [() => void]

Inherited from SystemModuleLoadAverageExtension.on_loadAverage
- Defined in modules/system/extensions/loadaverage.ts:51
Parameters
- listener: (newLoad: ILoadAverage) => void
  - - (newLoad: ILoadAverage): void
    - Parameters
      - newLoad: ILoadAverage
      Returns void
- Optional options: ILoadAverageStreamOption
Returns [() => void]

on_syslog

on_syslog(listener: (newLine: string) => void): [() => void]

Inherited from SystemModuleSyslogExtension.on_syslog
- Defined in modules/system/extensions/syslog.ts:14
Parameters
- listener: (newLine: string) => void
  - - (newLine: string): void
    - Parameters
      - newLine: string
      Returns void
Returns [() => void]

smartctl

smartctl(__namedParameters: ISmartctl): Promise<Record<never, never>>

Inherited from SystemModuleSmartctlExtension.smartctl
- Defined in modules/system/extensions/smartctl.ts:19
List smart information for specified device
example
Get information for device /dev/sda1
```
await smartctl({deviceName: '/dev/sda1', all: true});
```
Parameters
- __namedParameters: ISmartctl
  
  Set device name and toggle all flag
Returns Promise<Record<never, never>>

syslog

syslog(__namedParameters?: ISyslog): Promise<string[]>

Inherited from SystemModuleSyslogExtension.syslog
- Defined in modules/system/extensions/syslog.ts:8
Parameters
- __namedParameters: ISyslog = {}
Returns Promise<string[]>

uptime

uptime(): Promise<IUptime>

Inherited from SystemModuleUptimeExtension.uptime
- Defined in modules/system/extensions/uptime.ts:9
Returns Promise<IUptime>

usage

usage(): Promise<CPUUsage>

Inherited from SystemModuleCpuExtension.usage
- Defined in modules/system/extensions/cpu.ts:59
Returns Promise<CPUUsage>

users

users(): Promise<IUsersResult[]>

Inherited from SystemModuleUsersExtension.users
- Defined in modules/system/extensions/users.ts:17
Returns Promise<IUsersResult[]>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>

Returns SystemModule

Methods

date

Parameters

Optional parsed: false

Returns Promise<string>

Parameters

Optional parsed: true

Returns Promise<Date>

diskfree

Returns Promise<IDiskFreeReturn[]>

getHostname

Returns Promise<string>

info

Returns Promise<IInfoResult>

loadAverage

Returns Promise<ILoadAverage>

lsblk

Parameters

all: ILsblk = {}

Returns Promise<Record<never, never>>

lscpu

Returns Promise<ILscpuResult>

lsusb

Returns Promise<ILsusbResult[]>

ntp

Returns Promise<string[]>

on

Type parameters

Key: "syslog" | "loadAverage" | "cpuUsage"

Parameters

module: Key

listener: (value: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "handlerType">) => void

Parameters

value: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "handlerType">

Returns void

Optional options: PropType<PropType<{ cpuUsage: { handlerType: CPUUsage; options: ICpuUsageStreamOption }; loadAverage: { handlerType: ILoadAverage; optionType: ILoadAverageStreamOption }; syslog: { handlerType: string } }, Key>, "optionType">

Returns [() => void]

on_cpuUsage

Parameters

listener: (newLoad: CPUUsage) => void

Parameters

newLoad: CPUUsage

Returns void

Optional options: ICpuUsageStreamOption

Returns [() => void]

on_loadAverage

Parameters

listener: (newLoad: ILoadAverage) => void

Parameters

newLoad: ILoadAverage

Returns void

Optional options: ILoadAverageStreamOption

Returns [() => void]

on_syslog

Parameters

listener: (newLine: string) => void

Parameters

newLine: string

Returns void

Returns [() => void]

smartctl

Parameters

__namedParameters: ISmartctl

Returns Promise<Record<never, never>>

syslog

Parameters

__namedParameters: ISyslog = {}

Returns Promise<string[]>

uptime

Returns Promise<IUptime>

usage