Class: OpenNebula::VirtualRouter
- Inherits:
-
PoolElement
- Object
- XMLElement
- PoolElement
- OpenNebula::VirtualRouter
- Defined in:
- lib/opennebula/virtual_router.rb
Constant Summary collapse
- VIRTUAL_ROUTER_METHODS =
Constants and Class Methods
{ :allocate => "vrouter.allocate", :instantiate => "vrouter.instantiate", :info => "vrouter.info", :update => "vrouter.update", :delete => "vrouter.delete", :chown => "vrouter.chown", :chmod => "vrouter.chmod", :rename => "vrouter.rename", :attachnic => "vrouter.attachnic", :detachnic => "vrouter.detachnic", }
Class Method Summary collapse
-
.build_xml(pe_id = nil) ⇒ Object
Creates a VirtualRouter description with just its identifier this method should be used to create plain VirtualRouter objects.
Instance Method Summary collapse
-
#allocate(description) ⇒ nil, OpenNebula::Error
Allocates a new VirtualRouter in OpenNebula.
-
#chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a) ⇒ nil, OpenNebula::Error
Changes the VirtualRouter permissions.
-
#chmod_octet(octet) ⇒ nil, OpenNebula::Error
Changes the VirtualRouter permissions.
-
#chown(uid, gid) ⇒ nil, OpenNebula::Error
Changes the owner/group.
-
#delete ⇒ Object
Deletes the VirtualRouter.
-
#gid ⇒ Integer
Returns the group identifier.
-
#info ⇒ Object
(also: #info!)
Retrieves the information of the given Virtual Router.
-
#initialize(xml, client) ⇒ VirtualRouter
constructor
Class constructor.
-
#instantiate(n_vms, template_id, name = "", hold = false, template = "") ⇒ nil, OpenNebula::Error
Creates VM instances from a VM Template.
-
#nic_attach(nic_template) ⇒ nil, OpenNebula::Error
Attaches a NIC to this VirtualRouter, and each one of its VMs.
-
#nic_detach(nic_id) ⇒ nil, OpenNebula::Error
Detaches a NIC from this VirtualRouter, and each one of its VMs.
- #owner_id ⇒ Object
-
#rename(name) ⇒ nil, OpenNebula::Error
Renames this VirtualRouter.
-
#update(new_template, append = false) ⇒ nil, OpenNebula::Error
Replaces the template contents.
-
#vm_ids ⇒ Object
Returns an array with the numeric VM ids.
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, #retrieve_xmlelements, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml, #xml_nil?
Constructor Details
#initialize(xml, client) ⇒ VirtualRouter
Class constructor
57 58 59 60 61 |
# File 'lib/opennebula/virtual_router.rb', line 57 def initialize(xml, client) super(xml,client) @client = client end |
Class Method Details
.build_xml(pe_id = nil) ⇒ Object
Creates a VirtualRouter description with just its identifier this method should be used to create plain VirtualRouter objects. id
the id of the user
Example:
vrouter = VirtualRouter.new(VirtualRouter.build_xml(3),rpc_client)
46 47 48 49 50 51 52 53 54 |
# File 'lib/opennebula/virtual_router.rb', line 46 def VirtualRouter.build_xml(pe_id=nil) if pe_id obj_xml = "<VROUTER><ID>#{pe_id}</ID></VROUTER>" else obj_xml = "<VROUTER></VROUTER>" end XMLElement.build_xml(obj_xml,'VROUTER') end |
Instance Method Details
#allocate(description) ⇒ nil, OpenNebula::Error
Allocates a new VirtualRouter in OpenNebula
80 81 82 |
# File 'lib/opennebula/virtual_router.rb', line 80 def allocate(description) super(VIRTUAL_ROUTER_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 VirtualRouter permissions. Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
144 145 146 147 148 |
# File 'lib/opennebula/virtual_router.rb', line 144 def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u, other_m, other_a) super(VIRTUAL_ROUTER_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 VirtualRouter permissions.
135 136 137 |
# File 'lib/opennebula/virtual_router.rb', line 135 def chmod_octet(octet) super(VIRTUAL_ROUTER_METHODS[:chmod], octet) end |
#chown(uid, gid) ⇒ nil, OpenNebula::Error
Changes the owner/group
126 127 128 |
# File 'lib/opennebula/virtual_router.rb', line 126 def chown(uid, gid) super(VIRTUAL_ROUTER_METHODS[:chown], uid, gid) end |
#delete ⇒ Object
Deletes the VirtualRouter
105 106 107 |
# File 'lib/opennebula/virtual_router.rb', line 105 def delete() super(VIRTUAL_ROUTER_METHODS[:delete]) end |
#gid ⇒ Integer
Returns the group identifier
184 185 186 |
# File 'lib/opennebula/virtual_router.rb', line 184 def gid self['GID'].to_i end |
#info ⇒ Object Also known as: info!
Retrieves the information of the given Virtual Router
68 69 70 |
# File 'lib/opennebula/virtual_router.rb', line 68 def info() super(VIRTUAL_ROUTER_METHODS[:info], 'VROUTER') end |
#instantiate(n_vms, template_id, name = "", hold = false, template = "") ⇒ nil, OpenNebula::Error
Creates VM instances from a VM Template. New VMs will be associated to this Virtual Router, and its Virtual Networks
98 99 100 101 |
# File 'lib/opennebula/virtual_router.rb', line 98 def instantiate(n_vms, template_id, name="", hold=false, template="") return call(VIRTUAL_ROUTER_METHODS[:instantiate], @pe_id, n_vms.to_i, template_id.to_i, name, hold, template) end |
#nic_attach(nic_template) ⇒ nil, OpenNebula::Error
Attaches a NIC to this VirtualRouter, and each one of its VMs
165 166 167 |
# File 'lib/opennebula/virtual_router.rb', line 165 def nic_attach(nic_template) return call(VIRTUAL_ROUTER_METHODS[:attachnic], @pe_id, nic_template) end |
#nic_detach(nic_id) ⇒ nil, OpenNebula::Error
Detaches a NIC from this VirtualRouter, and each one of its VMs
174 175 176 |
# File 'lib/opennebula/virtual_router.rb', line 174 def nic_detach(nic_id) return call(VIRTUAL_ROUTER_METHODS[:detachnic], @pe_id, nic_id) end |
#owner_id ⇒ Object
188 189 190 |
# File 'lib/opennebula/virtual_router.rb', line 188 def owner_id self['UID'].to_i end |
#rename(name) ⇒ nil, OpenNebula::Error
Renames this VirtualRouter
156 157 158 |
# File 'lib/opennebula/virtual_router.rb', line 156 def rename(name) return call(VIRTUAL_ROUTER_METHODS[:rename], @pe_id, name) end |
#update(new_template, append = false) ⇒ nil, OpenNebula::Error
Replaces the template contents
117 118 119 |
# File 'lib/opennebula/virtual_router.rb', line 117 def update(new_template, append=false) super(VIRTUAL_ROUTER_METHODS[:update], new_template, append ? 1 : 0) end |
#vm_ids ⇒ Object
Returns an array with the numeric VM ids
193 194 195 196 197 198 199 200 201 |
# File 'lib/opennebula/virtual_router.rb', line 193 def vm_ids array = Array.new self.each("VMS/ID") do |id| array << id.text.to_i end return array end |