occi 2.0.0 → 2.0.1

data/lib/OpenNebula/VirtualMachine.rb

@@ -1,319 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, 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",
-            :chmod    => "vm.chmod",
-        }
-
-        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)
-        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
-
-        # Shutdowns an already deployed VM
-        def reboot
-            action('reboot')
-        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
-        # @param image_type [String] Type of the new image. Set to empty string
-        #   to use the default type
-        #
-        # @return [Integer, OpenNebula::Error] the new Image ID in case of
-        #   success, error otherwise
-        def save_as(disk_id, image_name, image_type="")
-            return Error.new('ID not defined') if !@pe_id
-
-            rc = @client.call(VM_METHODS[:savedisk],
-                              @pe_id,
-                              disk_id,
-                              image_name,
-                              image_type)
-
-            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
-
-        # Changes the permissions.
-        #
-        # @param octet [String] Permissions octed , e.g. 640
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chmod_octet(octet)
-            super(VM_METHODS[:chmod], octet)
-        end
-
-        # Changes the permissions.
-        # Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
-                other_m, other_a)
-            super(VM_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
-                group_m, group_a, other_u, other_m, other_a)
-        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

data/lib/OpenNebula/VirtualMachinePool.rb

@@ -1,120 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, 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 VirtualMachinePool < Pool
-        #######################################################################
-        # Constants and Class attribute accessors
-        #######################################################################
-
-
-        VM_POOL_METHODS = {
-            :info => "vmpool.info"
-        }
-
-        # Constants for info queries (include/RequestManagerPoolInfoFilter.h)
-        INFO_NOT_DONE = -1
-        INFO_ALL_VM   = -2
-
-        #######################################################################
-        # Class constructor & Pool Methods
-        #######################################################################
-
-
-        # +client+ a Client object that represents a XML-RPC connection
-        # +user_id+ is to refer to a Pool with VirtualMachines from that user
-        def initialize(client, user_id=0)
-            super('VM_POOL','VM',client)
-
-            @user_id  = user_id
-        end
-
-        # Default Factory Method for the Pools
-        def factory(element_xml)
-            OpenNebula::VirtualMachine.new(element_xml,@client)
-        end
-
-        #######################################################################
-        # XML-RPC Methods for the Virtual Network Object
-        #######################################################################
-
-        # Retrieves all or part of the VirtualMachines in the pool.
-        # No arguments, returns the not-in-done VMs for the user 
-        # [user_id, start_id, end_id]
-        # [user_id, start_id, end_id, state]
-        def info(*args)
-            case args.size
-                when 0
-                    info_filter(VM_POOL_METHODS[:info],
-                                @user_id,
-                                -1,
-                                -1,
-                                INFO_NOT_DONE)
-                when 1
-                    info_filter(VM_POOL_METHODS[:info],
-                                args[0],
-                                -1,
-                                -1,
-                                INFO_NOT_DONE)
-                when 3
-                    info_filter(VM_POOL_METHODS[:info],
-                                args[0],
-                                args[1],
-                                args[2],
-                                INFO_NOT_DONE)
-                when 4
-                    info_filter(VM_POOL_METHODS[:info],
-                                args[0],
-                                args[1],
-                                args[2],
-                                args[3])
-            end
-        end
-
-        def info_all()
-            return info_filter(VM_POOL_METHODS[:info],
-                               INFO_ALL,
-                               -1,
-                               -1,
-                               INFO_NOT_DONE)
-        end
-
-        def info_mine()
-            return info_filter(VM_POOL_METHODS[:info],
-                               INFO_MINE,
-                               -1,
-                               -1,
-                               INFO_NOT_DONE)
-        end
-
-        def info_group()
-            return info_filter(VM_POOL_METHODS[:info],
-                               INFO_GROUP,
-                               -1,
-                               -1,
-                               INFO_NOT_DONE)
-        end
-
-        private
-
-        def info_filter(xml_method, who, start_id, end_id, state)
-            return xmlrpc_info(xml_method, who, start_id, end_id, state)
-        end
-    end
-end

data/lib/OpenNebula/VirtualNetwork.rb

@@ -1,229 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2012, 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 VirtualNetwork < PoolElement
-        #######################################################################
-        # Constants and Class Methods
-        #######################################################################
-
-
-        VN_METHODS = {
-            :info       => "vn.info",
-            :allocate   => "vn.allocate",
-            :publish    => "vn.publish",
-            :delete     => "vn.delete",
-            :addleases  => "vn.addleases",
-            :rmleases   => "vn.rmleases",
-            :chown      => "vn.chown",
-            :chmod      => "vn.chmod",
-            :update     => "vn.update",
-            :hold       => "vn.hold",
-            :release    => "vn.release"
-        }
-
-        VN_TYPES=%w{RANGED FIXED}
-
-        SHORT_VN_TYPES={
-            "RANGED" => "R",
-            "FIXED"  => "F"
-        }
-
-        # Creates a VirtualNetwork description with just its identifier
-        # this method should be used to create plain VirtualNetwork objects.
-        # +id+ the id of the network
-        #
-        # Example:
-        #   vnet = VirtualNetwork.new(VirtualNetwork.build_xml(3),rpc_client)
-        #
-        def VirtualNetwork.build_xml(pe_id=nil)
-            if pe_id
-                vn_xml = "<VNET><ID>#{pe_id}</ID></VNET>"
-            else
-                vn_xml = "<VNET></VNET>"
-            end
-
-            XMLElement.build_xml(vn_xml, 'VNET')
-        end
-
-        # Class constructor
-        def initialize(xml, client)
-            super(xml,client)
-        end
-
-        #######################################################################
-        # XML-RPC Methods for the Virtual Network Object
-        #######################################################################
-
-        # Retrieves the information of the given VirtualNetwork.
-        def info()
-            super(VN_METHODS[:info], 'VNET')
-        end
-
-        # Allocates a new VirtualNetwork in OpenNebula
-        #
-        # +description+ A string containing the template of the VirtualNetwork.
-        def allocate(description)
-            super(VN_METHODS[:allocate],description)
-        end
-
-        # Replaces the template contents
-        #
-        # +new_template+ New template contents
-        def update(new_template)
-            super(VN_METHODS[:update], new_template)
-        end
-
-        # Publishes the VirtualNetwork, to be used by other users
-        def publish
-            set_publish(true)
-        end
-
-        # Unplubishes the VirtualNetwork
-        def unpublish
-            set_publish(false)
-        end
-
-        # Deletes the VirtualNetwork
-        def delete()
-            super(VN_METHODS[:delete])
-        end
-
-        # Adds a lease to the VirtualNetwork
-        def addleases(ip, mac = nil)
-            return Error.new('ID not defined') if !@pe_id
-
-            lease_template = "LEASES = [ IP = #{ip}"
-            lease_template << ", MAC = #{mac}" if mac
-            lease_template << " ]"
-
-            rc = @client.call(VN_METHODS[:addleases], @pe_id, lease_template)
-            rc = nil if !OpenNebula.is_error?(rc)
-
-            return rc
-        end
-
-        # Removes a lease from the VirtualNetwork
-        def rmleases(ip)
-            return Error.new('ID not defined') if !@pe_id
-
-            lease_template = "LEASES = [ IP = #{ip} ]"
-
-            rc = @client.call(VN_METHODS[:rmleases], @pe_id, lease_template)
-            rc = nil if !OpenNebula.is_error?(rc)
-
-            return rc
-        end
-
-        # Holds a virtual network Lease as used
-        # @param ip [String] IP to hold
-        def hold(ip)
-            return Error.new('ID not defined') if !@pe_id
-
-            lease_template = "LEASES = [ IP = #{ip} ]"
-
-            rc = @client.call(VN_METHODS[:hold], @pe_id, lease_template)
-            rc = nil if !OpenNebula.is_error?(rc)
-
-            return rc
-        end
-
-        # Releases a virtual network Lease on hold
-        # @param ip [String] IP to release
-        def release(ip)
-            return Error.new('ID not defined') if !@pe_id
-
-            lease_template = "LEASES = [ IP = #{ip} ]"
-
-            rc = @client.call(VN_METHODS[:release], @pe_id, lease_template)
-            rc = nil if !OpenNebula.is_error?(rc)
-
-            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(VN_METHODS[:chown], uid, gid)
-        end
-
-        # Changes the virtual network permissions.
-        #
-        # @param octet [String] Permissions octed , e.g. 640
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chmod_octet(octet)
-            super(VN_METHODS[:chmod], octet)
-        end
-
-        # Changes the virtual network permissions.
-        # Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
-                other_m, other_a)
-            super(VN_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
-                group_m, group_a, other_u, other_m, other_a)
-        end
-
-        #######################################################################
-        # Helpers to get VirtualNetwork information
-        #######################################################################
-
-        # Returns the group identifier
-        # [return] _Integer_ the element's group ID
-        def gid
-            self['GID'].to_i
-        end
-
-        # Returns the type of the Virtual Network (numeric value)
-        def type
-            self['TYPE'].to_i
-        end
-
-        # Returns the type of the Virtual Network (string value)
-        def type_str
-            VN_TYPES[type]
-        end
-
-        # Returns the state of the Virtual Network (string value)
-        def short_type_str
-            SHORT_VN_TYPES[type_str]
-        end
-
-        def public?
-            if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
-                true
-            else
-                false
-            end
-        end
-
-    private
-        def set_publish(published)
-            group_u = published ? 1 : 0
-
-            chmod(-1, -1, -1, group_u, -1, -1, -1, -1, -1)
-        end
-
-    end
-end