Class: OpenNebula::Template

Inherits:

PoolElement

• Object
• XMLElement
• PoolElement
• OpenNebula::Template

show all

Defined in:

OpenNebula/Template.rb

Constant Summary

TEMPLATE_METHODS =

{
    :allocate    => "template.allocate",
    :instantiate => "template.instantiate",
    :info        => "template.info",
    :update      => "template.update",
    :delete      => "template.delete",
    :chown       => "template.chown",
    :chmod       => "template.chmod",
    :clone       => "template.clone"
}

Class Method Summary (collapse)

• + (Object) build_xml(pe_id = nil)

  Creates a Template description with just its identifier this method should be used to create plain Template objects.

Instance Method Summary (collapse)

• - (nil, OpenNebula::Error) allocate(description)

  Allocates a new Template in OpenNebula.

• - (nil, OpenNebula::Error) chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a)

  Changes the Template permissions.

• - (nil, OpenNebula::Error) chmod_octet(octet)

  Changes the Template permissions.

• - (Object) chown(uid, gid)

  Changes the owner/group

  uid	Integer the new owner id.

• - (Integer, OpenNebula::Error) clone(name)

  Clones this Template into a new one.

• - (Object) delete

  Deletes the Template.

• - (Object) gid

  Returns the group identifier

  return

  Integer the element's group ID.

• - (Object) info

  Retrieves the information of the given Template.

• - (Template) initialize(xml, client) constructor

  Class constructor.

• - (Object) instantiate(name = "")

  Creates a VM instance from a Template.

• - (Object) owner_id
• - (Boolean) public?
• - (Object) publish

  Publishes the Template, to be used by other users.

• - (Object) unpublish

  Unplubishes the Image.

• - (Object) update(new_template)

  Replaces the template contents.

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

56
57
58
59
60

# File 'OpenNebula/Template.rb', line 56

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

    @client = client
end

template = Template.new(Template.build_xml(3),rpc_client)

45
46
47
48
49
50
51
52
53

# File 'OpenNebula/Template.rb', line 45

def Template.build_xml(pe_id=nil)
    if pe_id
        obj_xml = "<VMTEMPLATE><ID>#{pe_id}</ID></VMTEMPLATE>"
    else
        obj_xml = "<VMTEMPLATE></VMTEMPLATE>"
    end

    XMLElement.build_xml(obj_xml,'VMTEMPLATE')
end

77
78
79

# File 'OpenNebula/Template.rb', line 77

def allocate(description)
    super(TEMPLATE_METHODS[:allocate], description)
end

140
141
142
143
144

# File 'OpenNebula/Template.rb', line 140

def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
        other_m, other_a)
    super(TEMPLATE_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
        group_m, group_a, other_u, other_m, other_a)
end

131
132
133

# File 'OpenNebula/Template.rb', line 131

def chmod_octet(octet)
    super(TEMPLATE_METHODS[:chmod], octet)
end

122
123
124

# File 'OpenNebula/Template.rb', line 122

def chown(uid, gid)
    super(TEMPLATE_METHODS[:chown], uid, gid)
end

152
153
154
155
156
157
158

# File 'OpenNebula/Template.rb', line 152

def clone(name)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(TEMPLATE_METHODS[:clone], @pe_id, name)

    return rc
end

82
83
84

# File 'OpenNebula/Template.rb', line 82

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

166
167
168

# File 'OpenNebula/Template.rb', line 166

def gid
    self['GID'].to_i
end

67
68
69

# File 'OpenNebula/Template.rb', line 67

def info()
    super(TEMPLATE_METHODS[:info], 'VMTEMPLATE')
end

90
91
92
93
94
95
96
97

# File 'OpenNebula/Template.rb', line 90

def instantiate(name="")
    return Error.new('ID not defined') if !@pe_id

    name ||= ""
    rc = @client.call(TEMPLATE_METHODS[:instantiate], @pe_id, name)

    return rc
end

170
171
172

# File 'OpenNebula/Template.rb', line 170

def owner_id
    self['UID'].to_i
end

174
175
176
177
178
179
180

# File 'OpenNebula/Template.rb', line 174

def public?
    if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
        true
    else
        false
    end
end

109
110
111

# File 'OpenNebula/Template.rb', line 109

def publish
    set_publish(true)
end

114
115
116

# File 'OpenNebula/Template.rb', line 114

def unpublish
    set_publish(false)
end

102
103
104
105
106

# File 'OpenNebula/Template.rb', line 102

def update(new_template)
    return Error.new('ID not defined') if !@pe_id

    super(TEMPLATE_METHODS[:update], new_template)
end