Class: OpenNebula::Cluster

Inherits:
PoolElement show all
Defined in:
lib/opennebula/cluster.rb

Constant Summary collapse

CLUSTER_METHODS =

Constants and Class Methods

{
    :info           => "cluster.info",
    :allocate       => "cluster.allocate",
    :delete         => "cluster.delete",
    :addhost        => "cluster.addhost",
    :delhost        => "cluster.delhost",
    :adddatastore   => "cluster.adddatastore",
    :deldatastore   => "cluster.deldatastore",
    :addvnet        => "cluster.addvnet",
    :delvnet        => "cluster.delvnet",
    :update         => "cluster.update",
}

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

#[], #add_element, #attr, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml

Constructor Details

#initialize(xml, client) ⇒ Cluster

Class constructor



57
58
59
 
# File 'lib/opennebula/cluster.rb', line 57

def initialize(xml, client)
    super(xml,client)
end

Class Method Details

.build_xml(pe_id = nil) ⇒ Object

Creates a Cluster description with just its identifier this method should be used to create plain Cluster objects. id the id of the host

Example:

cluster = Cluster.new(Cluster.build_xml(3),rpc_client)



46
47
48
49
50
51
52
53
54
 
# File 'lib/opennebula/cluster.rb', line 46

def Cluster.build_xml(pe_id=nil)
    if pe_id
        cluster_xml = "<CLUSTER><ID>#{pe_id}</ID></CLUSTER>"
    else
        cluster_xml = "<CLUSTER></CLUSTER>"
    end

    XMLElement.build_xml(cluster_xml,'CLUSTER')
end

Instance Method Details

#adddatastore(ds_id) ⇒ nil, OpenNebula::Error

Adds a Datastore to this Cluster

Parameters:

  • ds_id (Integer) —

    Datastore ID

Returns:



114
115
116
117
118
119
120
121
 
# File 'lib/opennebula/cluster.rb', line 114

def adddatastore(ds_id)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(CLUSTER_METHODS[:adddatastore], @pe_id, ds_id)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#addhost(hid) ⇒ nil, OpenNebula::Error

Adds a Host to this Cluster

Parameters:

  • hid (Integer) —

    Host ID

Returns:



88
89
90
91
92
93
94
95
 
# File 'lib/opennebula/cluster.rb', line 88

def addhost(hid)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(CLUSTER_METHODS[:addhost], @pe_id, hid)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#addvnet(vnet_id) ⇒ nil, OpenNebula::Error

Adds a VNet to this Cluster

Parameters:

  • vnet_id (Integer) —

    VNet ID

Returns:



140
141
142
143
144
145
146
147
 
# File 'lib/opennebula/cluster.rb', line 140

def addvnet(vnet_id)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(CLUSTER_METHODS[:addvnet], @pe_id, vnet_id)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#allocate(clustername) ⇒ Object

Allocates a new Cluster in OpenNebula

clustername A string containing the name of the Cluster.



75
76
77
 
# File 'lib/opennebula/cluster.rb', line 75

def allocate(clustername)
    super(CLUSTER_METHODS[:allocate], clustername)
end

#contains_datastore?(id) ⇒ Boolean

Returns whether or not the datastore with ‘id’ is part of this cluster

Parameters:

  • id (Integer|Array) —

    datastore ID

Returns:

  • (Boolean) —

    true if found



200
201
202
 
# File 'lib/opennebula/cluster.rb', line 200

def contains_datastore?(id)
    contains_resource?('DATASTORES/ID', id)
end

#contains_host?(id) ⇒ Boolean

Returns whether or not the host with ‘id’ is part of this cluster

Parameters:

  • id (Integer|Array) —

    host ID

Returns:

  • (Boolean) —

    true if found



181
182
183
 
# File 'lib/opennebula/cluster.rb', line 181

def contains_host?(id)
    contains_resource?('HOSTS/ID', id)
end

#contains_vnet?(id) ⇒ Boolean

Returns whether or not the vnet with ‘id’ is part of this cluster

Parameters:

  • id (Integer|Arrray) —

    vnet ID

Returns:

  • (Boolean) —

    true if found



219
220
221
 
# File 'lib/opennebula/cluster.rb', line 219

def contains_vnet?(id)
    contains_resource?('VNETS/ID', id)
end

#datastore_ids ⇒ Array<Integer>

Returns an array with the numeric datastore ids

Returns:

  • (Array<Integer>) 


206
207
208
209
210
211
212
213
214
 
# File 'lib/opennebula/cluster.rb', line 206

def datastore_ids
    array = Array.new

    self.each("DATASTORES/ID") do |id|
        array << id.text.to_i
    end

    return array
end

#deldatastore(ds_id) ⇒ nil, OpenNebula::Error

Deletes a Datastore from this Cluster

Parameters:

  • ds_id (Integer) —

    Datastore ID

Returns:



127
128
129
130
131
132
133
134
 
# File 'lib/opennebula/cluster.rb', line 127

def deldatastore(ds_id)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(CLUSTER_METHODS[:deldatastore], @pe_id, ds_id)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#delete ⇒ Object

Deletes the Cluster



80
81
82
 
# File 'lib/opennebula/cluster.rb', line 80

def delete()
    super(CLUSTER_METHODS[:delete])
end

#delhost(hid) ⇒ nil, OpenNebula::Error

Deletes a Host from this Cluster

Parameters:

  • hid (Integer) —

    Host ID

Returns:



101
102
103
104
105
106
107
108
 
# File 'lib/opennebula/cluster.rb', line 101

def delhost(hid)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(CLUSTER_METHODS[:delhost], @pe_id, hid)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#delvnet(vnet_id) ⇒ nil, OpenNebula::Error

Deletes a VNet from this Cluster

Parameters:

  • vnet_id (Integer) —

    VNet ID

Returns:



153
154
155
156
157
158
159
160
 
# File 'lib/opennebula/cluster.rb', line 153

def delvnet(vnet_id)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(CLUSTER_METHODS[:delvnet], @pe_id, vnet_id)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#host_ids ⇒ Array<Integer>

Returns an array with the numeric host ids

Returns:

  • (Array<Integer>) 


187
188
189
190
191
192
193
194
195
 
# File 'lib/opennebula/cluster.rb', line 187

def host_ids
    array = Array.new

    self.each("HOSTS/ID") do |id|
        array << id.text.to_i
    end

    return array
end

#info ⇒ Object Also known as: info!

Retrieves the information of the given Cluster.



66
67
68
 
# File 'lib/opennebula/cluster.rb', line 66

def info()
    super(CLUSTER_METHODS[:info], 'CLUSTER')
end

#update(new_template, append = false) ⇒ nil, OpenNebula::Error

Replaces the template contents

Parameters:

  • new_template (String) —

    New template contents

  • append (true, false) (defaults to: false) —

    True to append new attributes instead of replace the whole template

Returns:



170
171
172
 
# File 'lib/opennebula/cluster.rb', line 170

def update(new_template, append=false)
    super(CLUSTER_METHODS[:update], new_template, append ? 1 : 0)
end

#vnet_ids ⇒ Array<Integer>

Returns an array with the numeric vnet ids

Returns:

  • (Array<Integer>) 


225
226
227
228
229
230
231
232
233
 
# File 'lib/opennebula/cluster.rb', line 225

def vnet_ids
    array = Array.new

    self.each("VNETS/ID") do |id|
        array << id.text.to_i
    end

    return array
end