Class List Method List File List

# Class: Com::Vmware::Vcenter::Host::PowerState

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Vcenter::Host::PowerState
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb

## Overview

The ``Com::Vmware::Vcenter::Host::PowerState`` enumerated type defines the power states of a host.

## Constant Summary

POWERED_ON =

      PowerState.new('POWERED_ON')

POWERED_OFF =

      PowerState.new('POWERED_OFF')

STANDBY =

      PowerState.new('STANDBY')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Host::PowerState) powered_off

  The host was specifically powered off by the user through vCenter server.

- - (Com::Vmware::Vcenter::Host::PowerState) powered_on

  The host is powered on.

- - (Com::Vmware::Vcenter::Host::PowerState) standby

  The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM.

## Class Method Summary (collapse)

- + (VAPI::Bindings::EnumType) binding_type

  Holds (gets or creates) the binding type metadata for this enumeration type.

- + (PowerState) from_string(value)

  Converts from a string value (perhaps off the wire) to an instance of this enum type.

## Instance Attribute Details

### - (`Com::Vmware::Vcenter::Host::PowerState`) powered_off

The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.

Returns:

- (`Com::Vmware::Vcenter::Host::PowerState`)

    1855
    1856
    1857
    1858
    1859
    1860
    1861
    1862
    1863
    1864
    1865
    1866
    1867
    1868
    1869
    1870
    1871
    1872
    1873
    1874
    1875
    1876
    1877
    1878
    1879
    1880
    1881
    1882
    1883
    1884
    1885
    1886
    1887
    1888
    1889
    1890
    1891
    1892
    1893
    1894
    1895
    1896
    1897
    1898
    1899
    1900
    1901
    1902
    1903
    1904
    1905
    1906
    1907
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1855

    class PowerState < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.host.power_state',
                    PowerState)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [PowerState] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    PowerState.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] powered_on
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host is powered on. A host that is entering standby mode is also in this state.
        POWERED_ON = PowerState.new('POWERED_ON')

        # @!attribute [rw] powered_off
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.
        POWERED_OFF = PowerState.new('POWERED_OFF')

        # @!attribute [rw] standby
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.
        STANDBY = PowerState.new('STANDBY')

    end

### - (`Com::Vmware::Vcenter::Host::PowerState`) powered_on

The host is powered on. A host that is entering standby mode is also in this state.

Returns:

- (`Com::Vmware::Vcenter::Host::PowerState`)

    1855
    1856
    1857
    1858
    1859
    1860
    1861
    1862
    1863
    1864
    1865
    1866
    1867
    1868
    1869
    1870
    1871
    1872
    1873
    1874
    1875
    1876
    1877
    1878
    1879
    1880
    1881
    1882
    1883
    1884
    1885
    1886
    1887
    1888
    1889
    1890
    1891
    1892
    1893
    1894
    1895
    1896
    1897
    1898
    1899
    1900
    1901
    1902
    1903
    1904
    1905
    1906
    1907
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1855

    class PowerState < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.host.power_state',
                    PowerState)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [PowerState] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    PowerState.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] powered_on
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host is powered on. A host that is entering standby mode is also in this state.
        POWERED_ON = PowerState.new('POWERED_ON')

        # @!attribute [rw] powered_off
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.
        POWERED_OFF = PowerState.new('POWERED_OFF')

        # @!attribute [rw] standby
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.
        STANDBY = PowerState.new('STANDBY')

    end

### - (`Com::Vmware::Vcenter::Host::PowerState`) standby

The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.

Returns:

- (`Com::Vmware::Vcenter::Host::PowerState`)

    1855
    1856
    1857
    1858
    1859
    1860
    1861
    1862
    1863
    1864
    1865
    1866
    1867
    1868
    1869
    1870
    1871
    1872
    1873
    1874
    1875
    1876
    1877
    1878
    1879
    1880
    1881
    1882
    1883
    1884
    1885
    1886
    1887
    1888
    1889
    1890
    1891
    1892
    1893
    1894
    1895
    1896
    1897
    1898
    1899
    1900
    1901
    1902
    1903
    1904
    1905
    1906
    1907
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1855

    class PowerState < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.host.power_state',
                    PowerState)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [PowerState] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    PowerState.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] powered_on
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host is powered on. A host that is entering standby mode is also in this state.
        POWERED_ON = PowerState.new('POWERED_ON')

        # @!attribute [rw] powered_off
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.
        POWERED_OFF = PowerState.new('POWERED_OFF')

        # @!attribute [rw] standby
        #     @return [Com::Vmware::Vcenter::Host::PowerState]
        #     The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.
        STANDBY = PowerState.new('STANDBY')

    end

## Class Method Details

### + (`VAPI::Bindings::EnumType`) binding_type

Holds (gets or creates) the binding type metadata for this enumeration type.

Returns:

- (`VAPI::Bindings::EnumType`) —

  the binding type

    1861
    1862
    1863
    1864
    1865
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1861

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.host.power_state',
            PowerState)
    end

### + (`PowerState`) from_string(value)

Converts from a string value (perhaps off the wire) to an instance of this enum type.

Parameters:

- value (`String`) —

  the actual value of the enum instance

Returns:

- (`PowerState`) —

  the instance found for the value, otherwise an unknown instance will be built for the value

    1872
    1873
    1874
    1875
    1876
    1877
    1878
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1872

    def from_string(value)
        begin
            const_get(value)
        rescue NameError
            PowerState.new('UNKNOWN', value)
        end
    end