Class: OpenNebula::VMGroup

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

Constant Summary collapse

VMGROUP_METHODS =

Constants and Class Methods

{
    :allocate    => "vmgroup.allocate",
    :info        => "vmgroup.info",
    :update      => "vmgroup.update",
    :delete      => "vmgroup.delete",
    :chown       => "vmgroup.chown",
    :chmod       => "vmgroup.chmod",
    :rename      => "vmgroup.rename",
    :lock        => "vmgroup.lock",
    :unlock        => "vmgroup.unlock"
}

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PoolElement

#id, #name, new_with_id, #replace, #to_str

Methods inherited from XMLElement

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

Constructor Details

#initialize(xml, client) ⇒ VMGroup

Class constructor



50
51
52
53
54
 
# File 'lib/opennebula/vm_group.rb', line 50

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

    @client = client
end

Class Method Details

.build_xml(pe_id = nil) ⇒ Object

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

Parameters:

  • pe_id (Integer) (defaults to: nil) —

    the id of the object



39
40
41
42
43
44
45
46
47
 
# File 'lib/opennebula/vm_group.rb', line 39

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

    XMLElement.build_xml(obj_xml,'VM_GROUP')
end

Instance Method Details

#allocate(description) ⇒ nil, OpenNebula::Error

Allocates a new VMGroup in OpenNebula

Parameters:

  • description (String) —

    The contents of the VMGroup.

Returns:



73
74
75
 
# File 'lib/opennebula/vm_group.rb', line 73

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

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

Changes the SecurityGroup permissions. Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change

Returns:



118
119
120
121
122
 
# File 'lib/opennebula/vm_group.rb', line 118

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

#chmod_octet(octet) ⇒ nil, OpenNebula::Error

Changes the SecurityGroup permissions.

Parameters:

  • octet (String) —

    Permissions octed , e.g. 640

Returns:



109
110
111
 
# File 'lib/opennebula/vm_group.rb', line 109

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

#chown(uid, gid) ⇒ nil, OpenNebula::Error

Changes the owner/group

Parameters:

  • uid (Integer) —

    the new owner id. Set to -1 to leave the current one

  • gid (Integer) —

    the new group id. Set to -1 to leave the current one

Returns:



100
101
102
 
# File 'lib/opennebula/vm_group.rb', line 100

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

#delete ⇒ Object

Deletes the SecurityGroup



78
79
80
 
# File 'lib/opennebula/vm_group.rb', line 78

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

#gid ⇒ Object

Returns the group identifier

return

Integer the element’s group ID



150
151
152
 
# File 'lib/opennebula/vm_group.rb', line 150

def gid
    self['GID'].to_i
end

#info ⇒ Object Also known as: info!

Retrieves the information of the VMGroup.



61
62
63
 
# File 'lib/opennebula/vm_group.rb', line 61

def info()
    super(VMGROUP_METHODS[:info], 'VM_GROUP')
end

#lock(level) ⇒ Object

Lock a VMGroup



135
136
137
 
# File 'lib/opennebula/vm_group.rb', line 135

def lock(level)
    return call(VMGROUP_METHODS[:lock], @pe_id, level)
end

#owner_id ⇒ Object 



154
155
156
 
# File 'lib/opennebula/vm_group.rb', line 154

def owner_id
    self['UID'].to_i
end

#rename(name) ⇒ nil, OpenNebula::Error

Renames this VMGroup

Parameters:

  • name (String) —

    New name for the VMGroup.

Returns:



130
131
132
 
# File 'lib/opennebula/vm_group.rb', line 130

def rename(name)
    return call(VMGROUP_METHODS[:rename], @pe_id, name)
end

#role_names ⇒ Object

return

Array with the name of roles



159
160
161
 
# File 'lib/opennebula/vm_group.rb', line 159

def role_names
    self.retrieve_elements('ROLES/ROLE/NAME')
end

#unlock ⇒ Object

Unlock a VMGroup



140
141
142
 
# File 'lib/opennebula/vm_group.rb', line 140

def unlock()
    return call(VMGROUP_METHODS[:unlock], @pe_id)
end

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

Replaces the vm group contents

Parameters:

  • new_vmgroup (String) —

    New vmgroup contents

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

    True to append new attributes instead of replace the whole securitygroup

Returns:



90
91
92
 
# File 'lib/opennebula/vm_group.rb', line 90

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