Class VM

Hierarchy

VM

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VM(instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>, name: string, state: VMState, id?: string): VM

- Defined in modules/vms/vm.ts:30
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
- name: string
- state: VMState
- Optional id: string
Returns VM

Properties

Optional id

id?: string

Readonly name

name: string

state

state: VMState

Methods

autostart

autostart(disable?: boolean): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:71
Parameters
- Optional disable: boolean
Returns Promise<IVMRawReturn>

reboot

reboot(mode: IVMRebootModes): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:81
Parameters
- mode: IVMRebootModes
Returns Promise<IVMRawReturn>

reset

reset(): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:55
Returns Promise<IVMRawReturn>

resume

resume(): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:90
Returns Promise<IVMRawReturn>

shutdown

shutdown(mode: IVMShutdownModes): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:37
Parameters
- mode: IVMShutdownModes
Returns Promise<IVMRawReturn>

start

start(): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:63
Returns Promise<IVMRawReturn>

suspend

suspend(): Promise<IVMRawReturn>

- Defined in modules/vms/vm.ts:47
Returns Promise<IVMRawReturn>

toJSON

toJSON(): { id: string; name: string; state: VMState }

- Defined in modules/vms/vm.ts:98
Returns { id: string; name: string; state: VMState }
- id: string
- name: string
- state: VMState

Generated using TypeDoc