Class: Com::Vmware::Vcenter::Ovf::LibraryItem::DeploymentTarget

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

Overview

The ``Com::Vmware::Vcenter::Ovf::LibraryItem::DeploymentTarget`` class describes the location (target) where a virtual machine or virtual appliance should be deployed. It is used in the ``deploy`` and ``filter`` methods . See :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy` and :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter` .

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (DeploymentTarget) 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) 



817
818
819
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 817

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

Instance Attribute Details

- (String?) folder_id

Identifier of the vCenter folder that should contain the virtual machine or virtual appliance. The folder must be virtual machine folder. If nil , the server will choose the deployment folder.

Returns:

  • (String, nil) 


790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 790

class DeploymentTarget < 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.ovf.library_item.deployment_target',
                {
                    'resource_pool_id' => VAPI::Bindings::IdType.new(resource_types='ResourcePool'),
                    'host_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                    'folder_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                },
                DeploymentTarget,
                false,
                nil)
        end
    end

    attr_accessor :resource_pool_id,
                  :host_id,
                  :folder_id

    # 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_id

Identifier of the target host on which the virtual machine or virtual appliance will run. The target host must be a member of the cluster that contains the resource pool identified by :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::DeploymentTarget.resource_pool_id` . If nil , the server will automatically select a target host from the resource pool if :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::DeploymentTarget.resource_pool_id` is a stand-alone host or a cluster with Distributed Resource Scheduling (DRS) enabled.

Returns:

  • (String, nil) 


790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 790

class DeploymentTarget < 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.ovf.library_item.deployment_target',
                {
                    'resource_pool_id' => VAPI::Bindings::IdType.new(resource_types='ResourcePool'),
                    'host_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                    'folder_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                },
                DeploymentTarget,
                false,
                nil)
        end
    end

    attr_accessor :resource_pool_id,
                  :host_id,
                  :folder_id

    # 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) resource_pool_id

Identifier of the resource pool to which the virtual machine or virtual appliance should be attached.

Returns:

  • (String) 


790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 790

class DeploymentTarget < 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.ovf.library_item.deployment_target',
                {
                    'resource_pool_id' => VAPI::Bindings::IdType.new(resource_types='ResourcePool'),
                    'host_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                    'folder_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                },
                DeploymentTarget,
                false,
                nil)
        end
    end

    attr_accessor :resource_pool_id,
                  :host_id,
                  :folder_id

    # 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 



796
797
798
799
800
801
802
803
804
805
806
807
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 796

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.ovf.library_item.deployment_target',
        {
            'resource_pool_id' => VAPI::Bindings::IdType.new(resource_types='ResourcePool'),
            'host_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
            'folder_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
        },
        DeploymentTarget,
        false,
        nil)
end