@unraid/libvirt/dist/domain.d.ts

Libvirt bindings for Node.js® - forked from vmngr/libvirt

import { Domain as NativeDomain, DomainInfo, DomainGetXMLDescFlags } from './types.js';
import { Hypervisor } from './hypervisor.js';
/**
 * Represents a libvirt domain (virtual machine).
 * This class provides methods to interact with and manage a virtual machine instance.
 */
export declare class Domain {
    private nativeDomain;
    private hypervisor;
    /**
     * Creates a new Domain instance.
     * @param nativeDomain - The native libvirt domain object
     * @param hypervisor - The hypervisor instance this domain belongs to
     */
    constructor(nativeDomain: NativeDomain, hypervisor: Hypervisor);
    /**
     * Saves the current state of the domain to a file.
     * This allows the domain to be restored later using the saved state.
     * @param filename - The path where the domain state should be saved
     * @throws {LibvirtError} If saving the domain state fails
     */
    save(filename: string): Promise<void>;
    /**
     * Starts the domain.
     * This operation is only valid for defined but inactive domains.
     * @throws {LibvirtError} If starting the domain fails
     */
    create(): Promise<void>;
    /**
     * Gracefully shuts down the domain.
     * This sends an ACPI shutdown signal to the domain's operating system.
     * @throws {LibvirtError} If shutting down the domain fails
     */
    shutdown(): Promise<void>;
    /**
     * Pauses the domain's execution
     * @throws {LibvirtError} If pausing the domain fails
     */
    suspend(): Promise<void>;
    /**
     * Resumes a paused domain.
     * This operation restarts execution of a domain that was previously paused.
     * @throws {LibvirtError} If resuming the domain fails
     */
    resume(): Promise<void>;
    /**
     * Forcefully terminates the domain.
     * This is equivalent to pulling the power plug on a physical machine.
     * @throws {LibvirtError} If destroying the domain fails
     */
    destroy(): Promise<void>;
    /**
     * Removes the domain's configuration from the hypervisor.
     * This operation is only valid for inactive domains.
     * @throws {LibvirtError} If undefining the domain fails
     */
    undefine(): Promise<void>;
    /**
     * Gets the XML description of the domain.
     * @param flags - Optional flags to modify the XML output
     * @returns The domain's XML configuration
     * @throws {LibvirtError} If getting the domain XML fails
     */
    getXMLDesc(flags?: DomainGetXMLDescFlags): Promise<string>;
    /**
     * Gets information about the domain's current state and resource usage.
     * @returns Domain information including state, memory usage, CPU time, etc.
     * @throws {LibvirtError} If getting domain information fails
     */
    getInfo(): Promise<DomainInfo>;
    /**
     * Gets the ID of the domain.
     * @returns The domain ID if the domain is running, null otherwise
     * @throws {LibvirtError} If getting the domain ID fails
     */
    getID(): Promise<number | null>;
    /**
     * Gets the name of the domain.
     * @returns The domain name
     * @throws {LibvirtError} If getting the domain name fails
     */
    getName(): Promise<string>;
    /**
     * Gets the UUID of the domain.
     * @returns The domain UUID as a string
     * @throws {LibvirtError} If getting the domain UUID fails
     */
    getUUIDString(): Promise<string>;
    /**
     * Gets the native libvirt domain object.
     * This method is for internal use only.
     * @returns The native domain object
     */
    getNativeDomain(): NativeDomain;
}
//# sourceMappingURL=domain.d.ts.map