Class QmMonitor

Hierarchy

QmMonitor

Index

Constructors

constructor

new QmMonitor(proxmox: Api, node: string, vmid: number): QmMonitor
Parameters
- proxmox: Api
- node: string
- vmid: number
Returns QmMonitor
- Defined in QmMonitor.ts:62

Properties

`Private` _node

_node: string

`Private` _vmid

_vmid: number

monitor

monitor: ((command: string) => Promise<string>)

Type declaration

- (command: string): Promise<string>
- Parameters
  - command: string
  Returns Promise<string>

Accessors

node

get node(): string
Returns string
- Defined in QmMonitor.ts:76

vmid

get vmid(): number
Returns number
- Defined in QmMonitor.ts:72

Methods

deviceAddById

deviceAddById(id: string, params: { productId: string; vendorId: string }): Promise<any>
Parameters
- id: string
- params: { productId: string; vendorId: string }
  - productId: string
  - vendorId: string
Returns Promise<any>
- Defined in QmMonitor.ts:151

deviceAddByPort

deviceAddByPort(id: string, params: { bus: number; port: string }): Promise<any>
Parameters
- id: string
- params: { bus: number; port: string }
  - bus: number
  - port: string
Returns Promise<any>
- Defined in QmMonitor.ts:163

deviceAddMissing

deviceAddMissing(id: string, filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }): Promise<any>
Parameters
- id: string
- filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }
  - Optional name?: RegExp
  - Optional productId?: RegExp
  - Optional vendorId?: RegExp
Returns Promise<any>
- Defined in QmMonitor.ts:172

deviceDel

deviceDel(id: string): Promise<string>
Parameters
- id: string
Returns Promise<string>
- Defined in QmMonitor.ts:109

info

info(type: "name" | "backup" | "migrate" | "rdma" | "network" | "status" | "version" | "cpus" | "balloon" | "kvm" | "numa" | "spice" | "history" | "block-jobs" | "blockstats" | "capture" | "chardev" | "cpustats" | "dump" | "hotpluggable-cpus" | "ioapic" | "iothreads" | "irq" | "jit" | "memdev" | "memory-devices" | "memory_size_summary" | "mice" | "migrate_cache_size" | "migrate_capabilities" | "migrate_parameters" | "opcount" | "pci" | "pic" | "profile" | "qdm" | "qtree" | "ramblock" | "roms" | "savevm" | "sev" | "snapshots" | "tpm" | "usb" | "usbhost" | "usernet" | "uuid" | "vm-generation-id" | "vnc"): Promise<string>
Parameters
- type: "name" | "backup" | "migrate" | "rdma" | "network" | "status" | "version" | "cpus" | "balloon" | "kvm" | "numa" | "spice" | "history" | "block-jobs" | "blockstats" | "capture" | "chardev" | "cpustats" | "dump" | "hotpluggable-cpus" | "ioapic" | "iothreads" | "irq" | "jit" | "memdev" | "memory-devices" | "memory_size_summary" | "mice" | "migrate_cache_size" | "migrate_capabilities" | "migrate_parameters" | "opcount" | "pci" | "pic" | "profile" | "qdm" | "qtree" | "ramblock" | "roms" | "savevm" | "sev" | "snapshots" | "tpm" | "usb" | "usbhost" | "usernet" | "uuid" | "vm-generation-id" | "vnc"
Returns Promise<string>
- Defined in QmMonitor.ts:80
info(type: "block" | "lapic" | "mtree" | "qom-tree" | "registers" | "sync-profile" | "trace-events", ...args: string[]): Promise<string>
Parameters
- type: "block" | "lapic" | "mtree" | "qom-tree" | "registers" | "sync-profile" | "trace-events"
- Rest ...args: string[]
Returns Promise<string>
- Defined in QmMonitor.ts:81
info(type: "rocker-of-dpa-flows" | "rocker-of-dpa-groups" | "rocker-ports", arg1: string, ...args: string[]): Promise<string>
Parameters
- type: "rocker-of-dpa-flows" | "rocker-of-dpa-groups" | "rocker-ports"
- arg1: string
- Rest ...args: string[]
Returns Promise<string>
- Defined in QmMonitor.ts:82

infoUsb

infoUsb(filters?: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }): Promise<USBInfo[]>
Parameters
- Optional filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }
  - Optional name?: RegExp
  - Optional productId?: RegExp
  - Optional vendorId?: RegExp
Returns Promise<USBInfo[]>
- Defined in QmMonitor.ts:90

infoUsbhost

infoUsbhost(filters?: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }): Promise<USBHostInfo[]>
list available usb on host
Parameters
- Optional filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }
  - Optional name?: RegExp
  - Optional productId?: RegExp
  - Optional vendorId?: RegExp
Returns Promise<USBHostInfo[]>
- Defined in QmMonitor.ts:119

Class QmMonitor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

proxmox: Api

node: string

vmid: number

Returns QmMonitor

Properties

Private _node

Private _vmid

monitor

Type declaration

Parameters

command: string

Returns Promise<string>

Accessors

node

Returns string

vmid

Returns number

Methods

deviceAddById

Parameters

id: string

params: { productId: string; vendorId: string }

productId: string

vendorId: string

Returns Promise<any>

deviceAddByPort

Parameters

id: string

params: { bus: number; port: string }

bus: number

port: string

Returns Promise<any>

deviceAddMissing

Parameters

id: string

filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }

Optional name?: RegExp

Optional productId?: RegExp

Optional vendorId?: RegExp

Returns Promise<any>

deviceDel

Parameters

id: string

Returns Promise<string>

info

Parameters

Returns Promise<string>

Parameters

type: "block" | "lapic" | "mtree" | "qom-tree" | "registers" | "sync-profile" | "trace-events"

Rest ...args: string[]

Returns Promise<string>

Parameters

type: "rocker-of-dpa-flows" | "rocker-of-dpa-groups" | "rocker-ports"

arg1: string

Rest ...args: string[]

Returns Promise<string>

infoUsb

Parameters

Optional filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }

Optional name?: RegExp

Optional productId?: RegExp

Optional vendorId?: RegExp

Returns Promise<USBInfo[]>

infoUsbhost

Parameters

Optional filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }

Optional name?: RegExp

Optional productId?: RegExp

Optional vendorId?: RegExp

Returns Promise<USBHostInfo[]>

`Private` _node

`Private` _vmid

`Optional` name?: RegExp

`Optional` productId?: RegExp

`Optional` vendorId?: RegExp

`Rest` ...args: string[]

`Rest` ...args: string[]

`Optional` filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }

`Optional` name?: RegExp

`Optional` productId?: RegExp

`Optional` vendorId?: RegExp

`Optional` filters: { name?: RegExp; productId?: RegExp; vendorId?: RegExp }

`Optional` name?: RegExp

`Optional` productId?: RegExp

`Optional` vendorId?: RegExp