oca 3.0.1

data/lib/OpenNebula/Template.rb

@@ -0,0 +1,146 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class Template < PoolElement
+        # ---------------------------------------------------------------------
+        # Constants and Class Methods
+        # ---------------------------------------------------------------------
+        TEMPLATE_METHODS = {
+            :allocate    => "template.allocate",
+            :instantiate => "template.instantiate",
+            :info        => "template.info",
+            :update      => "template.update",
+            :publish     => "template.publish",
+            :delete      => "template.delete",
+            :chown       => "template.chown"
+        }
+
+        # Creates a Template description with just its identifier
+        # this method should be used to create plain Template objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   template = Template.new(Template.build_xml(3),rpc_client)
+        #
+        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
+
+        # ---------------------------------------------------------------------
+        # Class constructor
+        # ---------------------------------------------------------------------
+        def initialize(xml, client)
+            super(xml,client)
+
+            @client = client
+        end
+
+        # ---------------------------------------------------------------------
+        # XML-RPC Methods for the Template Object
+        # ---------------------------------------------------------------------
+
+        # Retrieves the information of the given Template.
+        def info()
+            super(TEMPLATE_METHODS[:info], 'VMTEMPLATE')
+        end
+
+        # Allocates a new Template in OpenNebula
+        #
+        # +templatename+ A string containing the name of the Template.
+        def allocate(templatename)
+            super(TEMPLATE_METHODS[:allocate], templatename)
+        end
+
+        # Deletes the Template
+        def delete()
+            super(TEMPLATE_METHODS[:delete])
+        end
+
+        # Creates a VM instance from a Template
+        #
+        # +name+ A string containing the name of the VM instance.
+        # [return] The new VM Instance ID, or an Error object
+        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
+
+        # Replaces the template contents
+        #
+        # +new_template+ New template contents
+        def update(new_template)
+            return Error.new('ID not defined') if !@pe_id
+
+            super(TEMPLATE_METHODS[:update], new_template)
+        end
+
+        # Publishes the Template, to be used by other users
+        def publish
+            set_publish(true)
+        end
+
+        # Unplubishes the Image
+        def unpublish
+            set_publish(false)
+        end
+
+        # Changes the owner/group
+        # 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
+        # [return] nil in case of success or an Error object
+        def chown(uid, gid)
+            super(TEMPLATE_METHODS[:chown], uid, gid)
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get Template information
+        # ---------------------------------------------------------------------
+
+        # Returns the group identifier
+        # [return] _Integer_ the element's group ID
+        def gid
+            self['GID'].to_i
+        end
+
+        def owner_id
+            self['UID'].to_i
+        end
+
+    private
+
+        def set_publish(published)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(TEMPLATE_METHODS[:publish], @pe_id, published)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+    end
+end

data/lib/OpenNebula/TemplatePool.rb

@@ -0,0 +1,71 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class TemplatePool < Pool
+        # ---------------------------------------------------------------------
+        # Constants and Class attribute accessors
+        # ---------------------------------------------------------------------
+
+        TEMPLATE_POOL_METHODS = {
+            :info => "templatepool.info"
+        }
+
+        # ---------------------------------------------------------------------
+        # Class constructor & Pool Methods
+        # ---------------------------------------------------------------------
+
+        # +client+ a Client object that represents an XML-RPC connection
+        # +user_id+ used to refer to a Pool with Templates from that user
+        def initialize(client, user_id=-1)
+            super('VMTEMPLATE_POOL','VMTEMPLATE',client)
+
+            @user_id  = user_id
+        end
+
+        # Factory method to create Template objects
+        def factory(element_xml)
+            OpenNebula::Template.new(element_xml,@client)
+        end
+
+        # ---------------------------------------------------------------------
+        # XML-RPC Methods for the Template Object
+        # ---------------------------------------------------------------------
+        # Retrieves all or part of the VirtualMachines in the pool.
+        def info(*args)
+            case args.size
+                when 0
+                    info_filter(TEMPLATE_POOL_METHODS[:info],@user_id,-1,-1)
+                when 3
+                    info_filter(TEMPLATE_POOL_METHODS[:info],args[0],args[1],args[2])
+            end
+        end
+
+        def info_all()
+            return super(TEMPLATE_POOL_METHODS[:info])
+        end
+
+        def info_mine()
+            return super(TEMPLATE_POOL_METHODS[:info])
+        end
+
+        def info_group()
+            return super(TEMPLATE_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/User.rb

@@ -0,0 +1,117 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class User < PoolElement
+        # ---------------------------------------------------------------------
+        # Constants and Class Methods
+        # ---------------------------------------------------------------------
+        USER_METHODS = {
+            :info     => "user.info",
+            :allocate => "user.allocate",
+            :delete   => "user.delete",
+            :passwd   => "user.passwd",
+            :chgrp    => "user.chgrp"
+        }
+
+        SELF = -1
+
+        # Creates a User description with just its identifier
+        # this method should be used to create plain User objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   user = User.new(User.build_xml(3),rpc_client)
+        #
+        def User.build_xml(pe_id=nil)
+            if pe_id
+                user_xml = "<USER><ID>#{pe_id}</ID></USER>"
+            else
+                user_xml = "<USER></USER>"
+            end
+
+            XMLElement.build_xml(user_xml, 'USER')
+        end
+
+        # ---------------------------------------------------------------------
+        # Class constructor
+        # ---------------------------------------------------------------------
+        def initialize(xml, client)
+            super(xml,client)
+
+            @client = client
+        end
+
+        # ---------------------------------------------------------------------
+        # XML-RPC Methods for the User Object
+        # ---------------------------------------------------------------------
+
+        # Retrieves the information of the given User.
+        def info()
+            super(USER_METHODS[:info], 'USER')
+        end
+
+        # Allocates a new User in OpenNebula
+        #
+        # +username+ Name of the new user.
+        #
+        # +password+ Password for the new user
+        def allocate(username, password)
+            super(USER_METHODS[:allocate], username, password)
+        end
+
+        # Deletes the User
+        def delete()
+            super(USER_METHODS[:delete])
+        end
+
+        # Changes the password of the given User
+        #
+        # +password+ String containing the new password
+        def passwd(password)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(USER_METHODS[:passwd], @pe_id, password)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Changes the main group
+        # gid:: _Integer_ the new group id. Set to -1 to leave the current one
+        # [return] nil in case of success or an Error object
+        def chgrp(gid)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(USER_METHODS[:chgrp],@pe_id, gid)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get User information
+        # ---------------------------------------------------------------------
+
+        # Returns the group identifier
+        # [return] _Integer_ the element's group ID
+        def gid
+            self['GID'].to_i
+        end
+    end
+end

data/lib/OpenNebula/UserPool.rb

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class UserPool < Pool
+        # ---------------------------------------------------------------------
+        # Constants and Class attribute accessors
+        # ---------------------------------------------------------------------
+
+        USER_POOL_METHODS = {
+            :info => "userpool.info"
+        }
+
+        # ---------------------------------------------------------------------
+        # Class constructor & Pool Methods
+        # ---------------------------------------------------------------------
+        
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('USER_POOL','USER',client)
+        end
+
+        # Factory method to create User objects
+        def factory(element_xml)
+            OpenNebula::User.new(element_xml,@client)
+        end
+
+        # ---------------------------------------------------------------------
+        # XML-RPC Methods for the User Object
+        # ---------------------------------------------------------------------
+
+        # Retrieves all the Users in the pool.
+        def info()
+            super(USER_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/VirtualMachine.rb

@@ -0,0 +1,289 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'OpenNebula/Pool'
+
+module OpenNebula
+    class VirtualMachine < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+        VM_METHODS = {
+            :info     => "vm.info",
+            :allocate => "vm.allocate",
+            :action   => "vm.action",
+            :migrate  => "vm.migrate",
+            :deploy   => "vm.deploy",
+            :savedisk => "vm.savedisk",
+            :chown    => "vm.chown"
+        }
+
+        VM_STATE=%w{INIT PENDING HOLD ACTIVE STOPPED SUSPENDED DONE FAILED}
+
+        LCM_STATE=%w{LCM_INIT PROLOG BOOT RUNNING MIGRATE SAVE_STOP SAVE_SUSPEND
+            SAVE_MIGRATE PROLOG_MIGRATE PROLOG_RESUME EPILOG_STOP EPILOG
+            SHUTDOWN CANCEL FAILURE CLEANUP UNKNOWN}
+
+        SHORT_VM_STATES={
+            "INIT"      => "init",
+            "PENDING"   => "pend",
+            "HOLD"      => "hold",
+            "ACTIVE"    => "actv",
+            "STOPPED"   => "stop",
+            "SUSPENDED" => "susp",
+            "DONE"      => "done",
+            "FAILED"    => "fail"
+        }
+
+        SHORT_LCM_STATES={
+            "PROLOG"        => "prol",
+            "BOOT"          => "boot",
+            "RUNNING"       => "runn",
+            "MIGRATE"       => "migr",
+            "SAVE_STOP"     => "save",
+            "SAVE_SUSPEND"  => "save",
+            "SAVE_MIGRATE"  => "save",
+            "PROLOG_MIGRATE"=> "migr",
+            "PROLOG_RESUME" => "prol",
+            "EPILOG_STOP"   => "epil",
+            "EPILOG"        => "epil",
+            "SHUTDOWN"      => "shut",
+            "CANCEL"        => "shut",
+            "FAILURE"       => "fail",
+            "CLEANUP"       => "clea",
+            "UNKNOWN"       => "unkn"
+        }
+
+        MIGRATE_REASON=%w{NONE ERROR STOP_RESUME USER CANCEL}
+
+        SHORT_MIGRATE_REASON={
+            "NONE"          => "none",
+            "ERROR"         => "erro",
+            "STOP_RESUME"   => "stop",
+            "USER"          => "user",
+            "CANCEL"        => "canc"
+        }
+
+        # Creates a VirtualMachine description with just its identifier
+        # this method should be used to create plain VirtualMachine objects.
+        # +id+ the id of the vm
+        #
+        # Example:
+        #   vnet = VirtualMachine.new(VirtualMachine.build_xml(3),rpc_client)
+        #
+        def VirtualMachine.build_xml(pe_id=nil)
+            if pe_id
+                vm_xml = "<VM><ID>#{pe_id}</ID></VM>"
+            else
+                vm_xml = "<VM></VM>"
+            end
+
+            XMLElement.build_xml(vm_xml, 'VM')
+        end
+
+        def VirtualMachine.get_reason(reason)
+            reason=MIGRATE_REASON[reason.to_i]
+            reason_str=SHORT_MIGRATE_REASON[reason]
+
+            reason_str
+        end
+
+        #######################################################################
+        # Class constructor
+        #######################################################################
+        def initialize(xml, client)
+            super(xml,client)
+
+            @element_name = "VM"
+            @client       = client
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Virtual Machine Object
+        #######################################################################
+
+        # Retrieves the information of the given VirtualMachine.
+        def info()
+            super(VM_METHODS[:info], 'VM')
+        end
+
+        # Allocates a new VirtualMachine in OpenNebula
+        #
+        # +description+ A string containing the template of the VirtualMachine.
+        def allocate(description)
+            super(VM_METHODS[:allocate],description)
+        end
+
+        # Initiates the instance of the VM on the target host.
+        #
+        # +host_id+ The host id (hid) of the target host where
+        # the VM will be instantiated.
+        def deploy(host_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(VM_METHODS[:deploy], @pe_id, host_id.to_i)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Shutdowns an already deployed VM
+        def shutdown
+            action('shutdown')
+        end
+
+        # Cancels a running VM
+        def cancel
+            action('cancel')
+        end
+
+        # Sets a VM to hold state, scheduler will not deploy it
+        def hold
+            action('hold')
+        end
+
+        # Releases a VM from hold state
+        def release
+            action('release')
+        end
+
+        # Stops a running VM
+        def stop
+            action('stop')
+        end
+
+        # Saves a running VM
+        def suspend
+            action('suspend')
+        end
+
+        # Resumes the execution of a saved VM
+        def resume
+            action('resume')
+        end
+
+        # Deletes a VM from the pool
+        def finalize
+            action('finalize')
+        end
+
+        # Forces a re-deployment of a VM in UNKNOWN or BOOT state
+        def restart
+            action('restart')
+        end
+
+        # Resubmits a VM to PENDING state
+        def resubmit
+            action('resubmit')
+        end
+
+        # Saves a running VM and starts it again in the specified host
+        def migrate(host_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(VM_METHODS[:migrate], @pe_id, host_id.to_i, false)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Migrates a running VM to another host without downtime
+        def live_migrate(host_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(VM_METHODS[:migrate], @pe_id, host_id.to_i, true)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Set the specified vm's disk to be saved in a new image
+        # when the VirtualMachine shutdowns
+        #
+        # @param disk_id [Integer] ID of the disk to be saved
+        # @param image_name [String] Name for the new image where the
+        #   disk will be saved
+        #
+        # @return [Integer, OpenNebula::Error] the new Image ID in case of
+        #   success, error otherwise
+        def save_as(disk_id, image_name)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(VM_METHODS[:savedisk], @pe_id, disk_id, image_name)
+
+            return rc
+        end
+
+        # Changes the owner/group
+        # 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
+        # [return] nil in case of success or an Error object
+        def chown(uid, gid)
+            super(VM_METHODS[:chown], uid, gid)
+        end
+
+        #######################################################################
+        # Helpers to get VirtualMachine information
+        #######################################################################
+
+        # Returns the VM state of the VirtualMachine (numeric value)
+        def state
+            self['STATE'].to_i
+        end
+
+        # Returns the VM state of the VirtualMachine (string value)
+        def state_str
+            VM_STATE[state]
+        end
+
+        # Returns the LCM state of the VirtualMachine (numeric value)
+        def lcm_state
+            self['LCM_STATE'].to_i
+        end
+
+        # Returns the LCM state of the VirtualMachine (string value)
+        def lcm_state_str
+            LCM_STATE[lcm_state]
+        end
+
+        # Returns the short status string for the VirtualMachine
+        def status
+            short_state_str=SHORT_VM_STATES[state_str]
+
+            if short_state_str=="actv"
+                short_state_str=SHORT_LCM_STATES[lcm_state_str]
+            end
+
+            short_state_str
+        end
+
+        # Returns the group identifier
+        # [return] _Integer_ the element's group ID
+        def gid
+            self['GID'].to_i
+        end
+
+    private
+        def action(name)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(VM_METHODS[:action], name, @pe_id)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+    end
+end