Class SystemModuleSmartctlExtension

Hierarchy

SystemModuleExtensionBase
- SystemModuleSmartctlExtension
  - SystemModule

Index

Constructors

constructor

Properties

instance

Methods

smartctl

Constructors

constructor

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

Inherited from SystemModuleExtensionBase.constructor
- Defined in modules/system/system-module-extension-base.ts:6
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
Returns SystemModuleSmartctlExtension

Properties

Readonly instance

instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>

Methods

smartctl

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

- 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>>

Generated using TypeDoc