node-redfish
    Preparing search index...

    Class RedfishClient

    Client for querying and managing Redfish-compliant BMCs.

    const client = new RedfishClient({
      baseUrl: 'https://10.0.0.5',
      auth: { type: 'session', username: 'admin', password: 'secret' },
      insecure: true,
    });
    await client.connect();
    const systems = await client.getSystems();
    await client.resetSystem(systems[0].Id!, 'GracefulRestart');
    await client.disconnect();
    Index
    constructor
    isAuthenticated
    connect delete disconnect get getChassis getChassisCollection getChassisIds getCollection getExpandedCollection getManager getManagerIds getManagers getPower getServiceRoot getSessions getSystem getSystemIds getSystems getThermal patch post put resetManager resetSystem
    • get isAuthenticated(): boolean

      Whether the client currently holds a session token (from connect() or type: 'token' auth).

      Returns boolean

    • Establishes a session for { type: 'session' } auth by creating a Redfish session and capturing the X-Auth-Token. No-op for other auth types.

      Returns Promise<void>

    • Type Parameters

      • T = void

      Parameters

      • path: string

      Returns Promise<T>

    • Deletes the active session, if one was established via connect().

      Returns Promise<void>

    • Type Parameters

      • T

      Parameters

      • path: string

      Returns Promise<T>

    • Returns Promise<string[]>

    • Fetches a collection and resolves every member to its full resource body.

      Type Parameters

      • T

      Parameters

      • path: string

      Returns Promise<T[]>

    • Returns Promise<string[]>

    • Returns Promise<string[]>

    • PATCH a resource. Pass etag to send If-Match (recommended by the Redfish spec for PATCH).

      Type Parameters

      • T

      Parameters

      • path: string
      • body: unknown
      • Optionaletag: string

      Returns Promise<T>

    post

    • post<T>(path: string, body?: unknown): Promise<T>

      Type Parameters

      • T

      Parameters

      • path: string
      • Optionalbody: unknown

      Returns Promise<T>

    • PUT a full resource replacement. Rarely used by Redfish services compared to PATCH.

      Type Parameters

      • T

      Parameters

      • path: string
      • body: unknown
      • Optionaletag: string

      Returns Promise<T>

    • Invokes #ComputerSystem.Reset on the given system. The action target is read from the system's Actions block so vendor-specific paths are respected; falls back to the standard path if absent.

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods