Enum VmStatus

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOWN
      This status indicates that the virtual machine process is not running.
      IMAGE_LOCKED
      This status indicates that the virtual machine process is not running and there is some operation on the disks of the virtual machine that prevents it from being started.
      MIGRATING
      This status indicates that the virtual machine process is running and the virtual machine is being migrated from one host to another.
      NOT_RESPONDING
      This status indicates that the hypervisor detected that the virtual machine is not responding.
      PAUSED
      This status indicates that the virtual machine process is running and the virtual machine is paused.
      POWERING_DOWN
      This status indicates that the virtual machine process is running and it is about to stop running.
      POWERING_UP
      This status indicates that the virtual machine process is running and the guest operating system is being loaded.
      REBOOT_IN_PROGRESS
      This status indicates that the virtual machine process is running and the guest operating system is being rebooted.
      RESTORING_STATE
      This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation.
      SAVING_STATE
      This status indicates that the virtual machine process is running and the virtual machine is being hibernated.
      SUSPENDED
      This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved.
      UNASSIGNED
      This status is set when an invalid status is received.
      UNKNOWN
      This status indicates that the system failed to determine the status of the virtual machine.
      UP
      This status indicates that the virtual machine process is running and the guest operating system is loaded.
      WAIT_FOR_LAUNCH
      This status indicates that the virtual machine process is about to run.
    • Enum Constant Detail

      • DOWN

        public static final VmStatus DOWN
        This status indicates that the virtual machine process is not running.
      • IMAGE_LOCKED

        public static final VmStatus IMAGE_LOCKED
        This status indicates that the virtual machine process is not running and there is some operation on the disks of the virtual machine that prevents it from being started.
      • MIGRATING

        public static final VmStatus MIGRATING
        This status indicates that the virtual machine process is running and the virtual machine is being migrated from one host to another.
      • NOT_RESPONDING

        public static final VmStatus NOT_RESPONDING
        This status indicates that the hypervisor detected that the virtual machine is not responding.
      • PAUSED

        public static final VmStatus PAUSED
        This status indicates that the virtual machine process is running and the virtual machine is paused. This may happen in two cases: when running a virtual machine is paused mode and when the virtual machine is being automatically paused due to an error.
      • POWERING_DOWN

        public static final VmStatus POWERING_DOWN
        This status indicates that the virtual machine process is running and it is about to stop running.
      • POWERING_UP

        public static final VmStatus POWERING_UP
        This status indicates that the virtual machine process is running and the guest operating system is being loaded. Note that if no guest-agent is installed, this status is set for a predefined period of time, that is by default 60 seconds, when running a virtual machine.
      • REBOOT_IN_PROGRESS

        public static final VmStatus REBOOT_IN_PROGRESS
        This status indicates that the virtual machine process is running and the guest operating system is being rebooted.
      • RESTORING_STATE

        public static final VmStatus RESTORING_STATE
        This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation. In this status, the running state of the virtual machine is being restored.
      • SAVING_STATE

        public static final VmStatus SAVING_STATE
        This status indicates that the virtual machine process is running and the virtual machine is being hibernated. In this status, the running state of the virtual machine is being saved. Note that this status does not mean that the guest operating system is being hibernated.
      • SUSPENDED

        public static final VmStatus SUSPENDED
        This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved. This status is similar to Down, but when the VM is started in this status its saved running state is restored instead of being booted using the normal procedue.
      • UNASSIGNED

        public static final VmStatus UNASSIGNED
        This status is set when an invalid status is received.
      • UNKNOWN

        public static final VmStatus UNKNOWN
        This status indicates that the system failed to determine the status of the virtual machine. The virtual machine process may be running or not running in this status. For instance, when host becomes non-responsive the virtual machines that ran on it are set with this status.
      • UP

        public static final VmStatus UP
        This status indicates that the virtual machine process is running and the guest operating system is loaded. Note that if no guest-agent is installed, this status is set after a predefined period of time, that is by default 60 seconds, when running a virtual machine.
      • WAIT_FOR_LAUNCH

        public static final VmStatus WAIT_FOR_LAUNCH
        This status indicates that the virtual machine process is about to run. This status is set when a request to run a virtual machine arrives to the host. It is possible that the virtual machine process will fail to run.
    • Method Detail

      • values

        public static VmStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (VmStatus c : VmStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static VmStatus valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • value

        public String value()