Class: Com::Vmware::Vcenter::Host::Summary

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb

Overview

The ``Com::Vmware::Vcenter::Host::Summary`` class contains commonly used information about a host in vCenter Server.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Summary) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



1773
1774
1775
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1773

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (Com::Vmware::Vcenter::Host::ConnectionState) connection_state

Connection status of the host

Returns:



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1744

class Summary < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.host.summary',
                {
                    'host' => VAPI::Bindings::IdType.new(resource_types='HostSystem'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'connection_state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::ConnectionState'),
                    'power_state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::PowerState')),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :host,
                  :name,
                  :connection_state,
                  :power_state

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) host

Identifier of the host.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1744

class Summary < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.host.summary',
                {
                    'host' => VAPI::Bindings::IdType.new(resource_types='HostSystem'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'connection_state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::ConnectionState'),
                    'power_state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::PowerState')),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :host,
                  :name,
                  :connection_state,
                  :power_state

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) name

Name of the host.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1744

class Summary < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.host.summary',
                {
                    'host' => VAPI::Bindings::IdType.new(resource_types='HostSystem'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'connection_state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::ConnectionState'),
                    'power_state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::PowerState')),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :host,
                  :name,
                  :connection_state,
                  :power_state

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

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

Power state of the host This field is optional and it is only relevant when the value of ``connectionState`` is :attr:`Com::Vmware::Vcenter::Host::ConnectionState.CONNECTED` .

Returns:



1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1744

class Summary < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.host.summary',
                {
                    'host' => VAPI::Bindings::IdType.new(resource_types='HostSystem'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'connection_state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::ConnectionState'),
                    'power_state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::PowerState')),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :host,
                  :name,
                  :connection_state,
                  :power_state

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

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

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1750

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.host.summary',
        {
            'host' => VAPI::Bindings::IdType.new(resource_types='HostSystem'),
            'name' => VAPI::Bindings::StringType.instance,
            'connection_state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::ConnectionState'),
            'power_state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Host::PowerState')),
        },
        Summary,
        false,
        nil)
end