pve-client
    Preparing search index...

    Class Client

    Index
    constructor
    api events helpers task
    session
    login onSession renew request sessionCookie tokenAuthorizationHeader url
    api: APIClient

    Structured API surface generated from the spec. Example:

    client.api.cluster.replication.read({})
    client.api.cluster.replication.id("100-1").read({})
    events: {
        resources: () => TimerPulledEventEmitter<
            Record<
                string,
                {
                    "cgroup-mode"?: number;
                    content?: string;
                    cpu?: number;
                    disk?: number;
                    diskread?: number;
                    diskwrite?: number;
                    hastate?: string;
                    "host-arch"?: "x86_64"
                    | "aarch64";
                    id: string;
                    level?: string;
                    lock?: string;
                    maxcpu?: number;
                    maxdisk?: number;
                    maxmem?: number;
                    mem?: number;
                    memhost?: number;
                    name?: string;
                    netin?: number;
                    netout?: number;
                    network?: string;
                    "network-type"?: "zone" | "fabric";
                    node?: string;
                    plugintype?: string;
                    pool?: string;
                    protocol?: string;
                    sdn?: string;
                    shared?: boolean;
                    status?: string;
                    storage?: string;
                    tags?: string;
                    template?: boolean;
                    type:
                        | "qemu"
                        | "lxc"
                        | "storage"
                        | "node"
                        | "sdn"
                        | "pool"
                        | "openvz"
                        | "network";
                    uptime?: number;
                    vmid?: number;
                    "zone-type"?: string;
                },
            >,
        >;
        stopListening: () => void;
        tasks: () => TimerPulledEventEmitter<
            Record<
                string,
                {
                    endtime?: number;
                    id: string;
                    node: string;
                    starttime?: number;
                    status?: string;
                    type: string;
                    upid: string;
                    user: string;
                },
            > & {
                task: {
                    endtime?: number;
                    id: string;
                    node: string;
                    starttime?: number;
                    status?: string;
                    type: string;
                    upid: string;
                    user: string;
                };
            },
        >;
    } = ...
    helpers: {
        display: (vmid: string | number, options?: DisplayOptions) => Display;
        terminal: (vmid: string | number) => Terminal;
    } = ...

    Type Declaration

    • display: (vmid: string | number, options?: DisplayOptions) => Display

      noVNC display helper. Pass {ticket} to reuse a vncproxy ticket created earlier (e.g. by another process), so the browser's VNC password still matches.

    • terminal: (vmid: string | number) => Terminal
    task: {
        listen: (
            upid: string,
            handler?: TaskUpdateHandler,
            checkInterval?: number,
        ) => TaskSubscription;
        wait: (
            upid: string,
            handler?: TaskUpdateHandler,
            checkInterval?: number,
        ) => Promise<string[]>;
    } = ...
    • get session(): PveSession | undefined

      The current ticket session (password and session auth), or undefined before login / for API tokens.

      Returns PveSession | undefined

    • Log in using username/password (ticket + CSRF). Only applicable if you constructed the client with username/password.

      Returns Promise<Client>

    • Subscribe to new sessions (login, renewal), e.g. to persist them. Returns an unsubscribe function.

      Parameters

      Returns () => void

    • Renews the ticket using the current one as the password (what the Proxmox web UI does). Concurrent calls share one request.

      Returns Promise<Client>

    • Typed request function using the ProxmoxAPI mapping.

      • GET/DELETE use $query
      • POST/PUT/PATCH use $body (sent as application/x-www-form-urlencoded, matching Proxmox conventions)
      • Returns json.data when present (Proxmox wraps most results in { data: ... })

      Type Parameters

      • P extends
            | (keyof AccessAPI)
            | (keyof ClusterAPI)
            | (keyof NodesAPI)
            | (keyof PoolsAPI)
            | (keyof StorageAPI)
            | "/version"
      • M extends "GET" | "DELETE" | "POST" | "PUT" | "PATCH"

      Parameters

      • path: P
      • method: M
      • args: Params<P, M>
      • OptionalrequestInit: RequestInit
      • _retried: boolean = false

      Returns Promise<Ret<P, M>>

    • Returns string | undefined

    • Returns string | undefined

    • Parameters

      • path: string
      • Optionalquery: Record<string, any>

      Returns string

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods