Class ProxmoxService

constructor

• new ProxmoxService(
      apiToken: undefined | string,
      baseUrl: undefined | string,
  ): ProxmoxService

  Constructor of ProxmoxService

  Parameters

  • apiToken: undefined | string

    the token for authentication
  • baseUrl: undefined | string

    the base url for the proxmox server

  Returns ProxmoxService

apiToken

baseUrl

getLXC

• getLXC(name: string): Promise<LXCResponse>

  Method to get resources for a sinlge LXC

  Parameters

  • name: string

  Returns Promise<LXCResponse>

getLXCs

• getLXCs(): Promise<LXCsResponse>

  Method to get all the LXCs

  Returns Promise<LXCsResponse>

getNode

• getNode(name: string): Promise<NodeResponse>

  Get method to get the information about a single node in the proxmos cluster

  Parameters

  • name: string

    The name of the node

  Returns Promise<NodeResponse>

getNodes

• getNodes(): Promise<NodesResponse>

  Get method to get all Nodes of proxmox cluster

  Returns Promise<NodesResponse>

getResources

• getResources(type?: null | string, name?: null | string): Promise<any>

  Gets all the ressources from the cluster Will later be used to split it up more.

  Parameters

  • type: null | string = null

    the type of ressource we want to filter for
  • name: null | string = null

    The name of the ressource we want to filter or

  Returns Promise<any>

getStatus

• getStatus(): Promise<StatusResponse>

  Fetch the status of the cluster from proxmox

  Returns Promise<StatusResponse>

getVM

• getVM(name: string): Promise<VMResponse>

  Method to get resources for a single VM

  Parameters

  • name: string

    The name of the VM

  Returns Promise<VMResponse>

getVMs

• getVMs(): Promise<VMsResponse>

  Method to get all the VMs

  Returns Promise<VMsResponse>