@containernerds/incus-client/src/types/instance.ts

A Node.js client for automating Incus (LXD) servers.

export interface InstanceSpec {
    architecture?: string;
    config?: any;
    description?: string;
    devices?: any;
    ephemeral?: boolean;
    instance_type?: string;
    name?: string;
    profiles?: string[];
    restore?: string;
    source?: InstanceSource;
    start?: boolean;
    stateful?: boolean;
    type?: string;
};

export interface InstanceSource {
    alias?: string; // ubuntu/22.04 Image alias name (for image source)
    allow_inconsistent?: boolean; // false Whether to ignore errors when copying
    "base-image"?: string; // ed56997f7c5b48e8d78986d2467a26109be6fb9f2d92e8c7b08eb8b6cec7629a Image fingerprint (for image source)
    certificate?: string; // X509 PEM certificate Certificate to use for authentication
    fingerprint?: string; // ed56997f7c5b48e8d78986d2467a26109be6fb9f2d92e8c7b08eb8b6cec7629a Image fingerprint (for image source)
    instance_only?: boolean; // false Whether the image is instance-only
    live?: boolean; // false Whether to use live mode
    mode?: string; // pull Image source mode
    operation?: string; // https://
    project?: string; // blah Project name
    properties?: any; // { os: 'Ubuntu', release: 'jammy', variant: 'cloud' } Image properties
    protocol?: string; // simplestreams Image source protocol
    refresh?: boolean; // false Whether to refresh the image
    refresh_exclude_older?: boolean; // false Whether to exclude older images
    secret?: string; // RANDOM-STRING Secret token
    secrets?: any; // { criu: 'RANDOM-STRING', rsync: 'RANDOM-STRING' } Image source secrets
    server?: string; // https://images.linuxcontainers.org Image server
    source?: string; // foo/snap0 Image source
    type?: string; // image Source type
};