@kubevirt-ui/kubevirt-api
    Preparing search index...

    Interface V1VirtualMachineInstance

    VirtualMachineInstance is the VirtualMachineInstance Definition. It represents a virtual machine in the runtime environment of kubernetes.

    interface V1VirtualMachineInstance {
        apiVersion?: string;
        kind?: string;
        metadata?: K8sIoApimachineryPkgApisMetaV1ObjectMeta;
        spec: V1VirtualMachineInstanceSpec;
        status?: {
            activePods?: Record<string, string>;
            changedBlockTracking?: V1ChangedBlockTrackingStatus;
            conditions?: V1VirtualMachineInstanceCondition[];
            currentCPUTopology?: V1CPUTopology;
            evacuationNodeName?: string;
            fsFreezeStatus?: string;
            guestOSInfo?: V1VirtualMachineInstanceGuestOSInfo;
            interfaces?: V1VirtualMachineInstanceNetworkInterface[];
            kernelBootStatus?: V1KernelBootStatus;
            launcherContainerImageVersion?: string;
            machine?: V1Machine;
            memory?: V1MemoryStatus;
            migratedVolumes?: V1StorageMigratedVolumeInfo[];
            migrationMethod?: string;
            migrationState?: V1VirtualMachineInstanceMigrationState;
            migrationTransport?: string;
            nodeName?: string;
            phase?: string;
            phaseTransitionTimestamps?: V1VirtualMachineInstancePhaseTransitionTimestamp[];
            qosClass?: "BestEffort" | "Burstable" | "Guaranteed";
            reason?: string;
            runtimeUser?: number;
            selinuxContext?: string;
            topologyHints?: V1TopologyHints;
            virtualMachineRevisionName?: string;
            volumeStatus?: V1VolumeStatus[];
            VSOCKCID?: number;
        };
    }
    Index

    Properties

    apiVersion? kind? metadata? spec status?

    Properties

    apiVersion?: string

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

    kind?: string

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    metadata?: K8sIoApimachineryPkgApisMetaV1ObjectMeta

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    {}
    spec: V1VirtualMachineInstanceSpec

    VirtualMachineInstance Spec contains the VirtualMachineInstance specification.

    status?: {
        activePods?: Record<string, string>;
        changedBlockTracking?: V1ChangedBlockTrackingStatus;
        conditions?: V1VirtualMachineInstanceCondition[];
        currentCPUTopology?: V1CPUTopology;
        evacuationNodeName?: string;
        fsFreezeStatus?: string;
        guestOSInfo?: V1VirtualMachineInstanceGuestOSInfo;
        interfaces?: V1VirtualMachineInstanceNetworkInterface[];
        kernelBootStatus?: V1KernelBootStatus;
        launcherContainerImageVersion?: string;
        machine?: V1Machine;
        memory?: V1MemoryStatus;
        migratedVolumes?: V1StorageMigratedVolumeInfo[];
        migrationMethod?: string;
        migrationState?: V1VirtualMachineInstanceMigrationState;
        migrationTransport?: string;
        nodeName?: string;
        phase?: string;
        phaseTransitionTimestamps?: V1VirtualMachineInstancePhaseTransitionTimestamp[];
        qosClass?: "BestEffort" | "Burstable" | "Guaranteed";
        reason?: string;
        runtimeUser?: number;
        selinuxContext?: string;
        topologyHints?: V1TopologyHints;
        virtualMachineRevisionName?: string;
        volumeStatus?: V1VolumeStatus[];
        VSOCKCID?: number;
    }

    Status is the high level overview of how the VirtualMachineInstance is doing. It contains information available to controllers and users.

    Type Declaration

    • OptionalactivePods?: Record<string, string>

      ActivePods is a mapping of pod UID to node name. It is possible for multiple pods to be running for a single VMI during migration.

    • OptionalchangedBlockTracking?: V1ChangedBlockTrackingStatus

      ChangedBlockTracking represents the status of the changedBlockTracking

    • Optionalconditions?: V1VirtualMachineInstanceCondition[]

      Conditions are specific points in VirtualMachineInstance's pod runtime.

    • OptionalcurrentCPUTopology?: V1CPUTopology

      CurrentCPUTopology specifies the current CPU topology used by the VM workload. Current topology may differ from the desired topology in the spec while CPU hotplug takes place.

    • OptionalevacuationNodeName?: string

      EvacuationNodeName is used to track the eviction process of a VMI. It stores the name of the node that we want to evacuate. It is meant to be used by KubeVirt core components only and can't be set or modified by users.

    • OptionalfsFreezeStatus?: string

      FSFreezeStatus indicates whether a freeze operation was requested for the guest filesystem. It will be set to "frozen" if the request was made, or unset otherwise. This does not reflect the actual state of the guest filesystem.

    • OptionalguestOSInfo?: V1VirtualMachineInstanceGuestOSInfo

      Guest OS Information

      {}
    • Optionalinterfaces?: V1VirtualMachineInstanceNetworkInterface[]

      Interfaces represent the details of available network interfaces.

    • OptionalkernelBootStatus?: V1KernelBootStatus

      KernelBootStatus contains info about the kernelBootContainer

    • OptionallauncherContainerImageVersion?: string

      LauncherContainerImageVersion indicates what container image is currently active for the vmi.

    • Optionalmachine?: V1Machine

      Machine shows the final resulting qemu machine type. This can be different than the machine type selected in the spec, due to qemus machine type alias mechanism.

    • Optionalmemory?: V1MemoryStatus

      Memory shows various informations about the VirtualMachine memory.

    • OptionalmigratedVolumes?: V1StorageMigratedVolumeInfo[]

      MigratedVolumes lists the source and destination volumes during the volume migration

    • OptionalmigrationMethod?: string

      Represents the method using which the vmi can be migrated: live migration or block migration

    • OptionalmigrationState?: V1VirtualMachineInstanceMigrationState

      Represents the status of a live migration

    • OptionalmigrationTransport?: string

      This represents the migration transport

    • OptionalnodeName?: string

      NodeName is the name where the VirtualMachineInstance is currently running.

    • Optionalphase?: string

      Phase is the status of the VirtualMachineInstance in kubernetes world. It is not the VirtualMachineInstance status, but partially correlates to it.

    • OptionalphaseTransitionTimestamps?: V1VirtualMachineInstancePhaseTransitionTimestamp[]

      PhaseTransitionTimestamp is the timestamp of when the last phase change occurred

    • OptionalqosClass?: "BestEffort" | "Burstable" | "Guaranteed"

      The Quality of Service (QOS) classification assigned to the virtual machine instance based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md

      Possible enum values:

      • "BestEffort" is the BestEffort qos class.
      • "Burstable" is the Burstable qos class.
      • "Guaranteed" is the Guaranteed qos class.
    • Optionalreason?: string

      A brief CamelCase message indicating details about why the VMI is in this state. e.g. 'NodeUnresponsive'

    • OptionalruntimeUser?: number

      RuntimeUser is used to determine what user will be used in launcher

      int64

      0
    • OptionalselinuxContext?: string

      SELinuxContext is the actual SELinux context of the virt-launcher pod

    • OptionaltopologyHints?: V1TopologyHints
    • OptionalvirtualMachineRevisionName?: string

      VirtualMachineRevisionName is used to get the vm revision of the vmi when doing an online vm snapshot

    • OptionalvolumeStatus?: V1VolumeStatus[]

      VolumeStatus contains the statuses of all the volumes

    • OptionalVSOCKCID?: number

      VSOCKCID is used to track the allocated VSOCK CID in the VM.

      int64

    {}

    Settings

    Member Visibility

    On This Page

    Properties