node-ovsdb
    Preparing search index...

    Interface OvsdbClientOptions

    Options for configuring an OVSDBClient.

    interface OvsdbClientOptions {
        connectionFactory?: (
            options: OvsdbResolvedConnectionOptions,
        ) => OvsdbStream;
        host?: string;
        port?: number;
        reconnect?: boolean;
        reconnectDelay?: number;
        reconnectMaxDelay?: number;
        socketPath?: string;
        timeout?: number;
        tls?: boolean;
        tlsOptions?: ConnectionOptions;
    }
    Index

    Properties

    connectionFactory?: (options: OvsdbResolvedConnectionOptions) => OvsdbStream

    Optional stream factory used for testing or custom transports. When set, the client skips the socket path existence check.

    host?: string

    Hostname for TCP or TLS connections.

    When set, the client uses a network socket instead of a Unix socket.

    port?: number

    Port for TCP or TLS connections.

    6640

    reconnect?: boolean

    Automatically re-establishes the connection with exponential backoff after an unexpected disconnect (a transport error or an unrequested socket close).

    This does not apply to the initial OVSDBClient.connect, which always resolves or rejects exactly once. It also does not resend in-flight requests or re-arm monitors; re-subscribe from a connect listener, which fires again on every successful reconnect.

    false

    reconnectDelay?: number

    Base delay in milliseconds before the first reconnect attempt. Doubles after each failed attempt up to reconnectMaxDelay.

    1000

    reconnectMaxDelay?: number

    Upper bound in milliseconds for the reconnect backoff delay.

    30000

    socketPath?: string

    Path to the OVSDB Unix domain socket.

    "/var/run/openvswitch/db.sock"

    timeout?: number

    Request and connection timeout in milliseconds.

    5000

    tls?: boolean

    Enables TLS for network connections.

    false

    tlsOptions?: ConnectionOptions

    Extra TLS connection options forwarded to node:tls.

    These options are only used when tls is enabled.