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

    Interface V1beta1VirtualMachine

    interface V1beta1VirtualMachine {
        metadata?: K8sIoApimachineryPkgApisMetaV1ObjectMeta;
        spec?: V1VirtualMachineSpec;
        status?: {
            changedBlockTracking?: V1ChangedBlockTrackingStatus;
            conditions?: V1VirtualMachineCondition[];
            created?: boolean;
            desiredGeneration?: number;
            instancetypeRef?: V1InstancetypeStatusRef;
            memoryDumpRequest?: V1VirtualMachineMemoryDumpRequest;
            observedGeneration?: number;
            preferenceRef?: V1InstancetypeStatusRef;
            printableStatus?: string;
            ready?: boolean;
            restoreInProgress?: string;
            runStrategy?: string;
            snapshotInProgress?: string;
            startFailure?: V1VirtualMachineStartFailure;
            stateChangeRequests?: V1VirtualMachineStateChangeRequest[];
            volumeRequests?: V1VirtualMachineVolumeRequest[];
            volumeSnapshotStatuses?: V1VolumeSnapshotStatus[];
            volumeUpdateState?: V1VolumeUpdateState;
        };
    }
    Index

    Properties

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

    {}
    

    VirtualMachineSpec contains the VirtualMachine specification.

    {}
    
    status?: {
        changedBlockTracking?: V1ChangedBlockTrackingStatus;
        conditions?: V1VirtualMachineCondition[];
        created?: boolean;
        desiredGeneration?: number;
        instancetypeRef?: V1InstancetypeStatusRef;
        memoryDumpRequest?: V1VirtualMachineMemoryDumpRequest;
        observedGeneration?: number;
        preferenceRef?: V1InstancetypeStatusRef;
        printableStatus?: string;
        ready?: boolean;
        restoreInProgress?: string;
        runStrategy?: string;
        snapshotInProgress?: string;
        startFailure?: V1VirtualMachineStartFailure;
        stateChangeRequests?: V1VirtualMachineStateChangeRequest[];
        volumeRequests?: V1VirtualMachineVolumeRequest[];
        volumeSnapshotStatuses?: V1VolumeSnapshotStatus[];
        volumeUpdateState?: V1VolumeUpdateState;
    }

    Status holds the current state of the controller and brief information about its associated VirtualMachineInstance

    Type Declaration

    • OptionalchangedBlockTracking?: V1ChangedBlockTrackingStatus

      ChangedBlockTracking represents the status of the changedBlockTracking

    • Optionalconditions?: V1VirtualMachineCondition[]

      Hold the state information of the VirtualMachine and its VirtualMachineInstance

    • Optionalcreated?: boolean

      Created indicates if the virtual machine is created in the cluster

    • OptionaldesiredGeneration?: number

      DesiredGeneration is the generation which is desired for the VMI. This will be used in comparisons with ObservedGeneration to understand when the VMI is out of sync. This will be changed at the same time as ObservedGeneration to remove errors which could occur if Generation is updated through an Update() before ObservedGeneration in Status.

      int64

    • OptionalinstancetypeRef?: V1InstancetypeStatusRef

      InstancetypeRef captures the state of any referenced instance type from the VirtualMachine

    • OptionalmemoryDumpRequest?: V1VirtualMachineMemoryDumpRequest

      MemoryDumpRequest tracks memory dump request phase and info of getting a memory dump to the given pvc

    • OptionalobservedGeneration?: number

      ObservedGeneration is the generation observed by the vmi when started.

      int64

    • OptionalpreferenceRef?: V1InstancetypeStatusRef

      PreferenceRef captures the state of any referenced preference from the VirtualMachine

    • OptionalprintableStatus?: string

      PrintableStatus is a human readable, high-level representation of the status of the virtual machine

    • Optionalready?: boolean

      Ready indicates if the virtual machine is running and ready

    • OptionalrestoreInProgress?: string

      RestoreInProgress is the name of the VirtualMachineRestore currently executing

    • OptionalrunStrategy?: string

      RunStrategy tracks the last recorded RunStrategy used by the VM. This is needed to correctly process the next strategy (for now only the RerunOnFailure)

    • OptionalsnapshotInProgress?: string

      SnapshotInProgress is the name of the VirtualMachineSnapshot currently executing

    • OptionalstartFailure?: V1VirtualMachineStartFailure

      StartFailure tracks consecutive VMI startup failures for the purposes of crash loop backoffs

    • OptionalstateChangeRequests?: V1VirtualMachineStateChangeRequest[]

      StateChangeRequests indicates a list of actions that should be taken on a VMI e.g. stop a specific VMI then start a new one.

    • OptionalvolumeRequests?: V1VirtualMachineVolumeRequest[]

      VolumeRequests indicates a list of volumes add or remove from the VMI template and hotplug on an active running VMI.

    • OptionalvolumeSnapshotStatuses?: V1VolumeSnapshotStatus[]

      VolumeSnapshotStatuses indicates a list of statuses whether snapshotting is supported by each volume.

    • OptionalvolumeUpdateState?: V1VolumeUpdateState

      VolumeUpdateState contains the information about the volumes set updates related to the volumeUpdateStrategy

    {}