opennebula 3.9.80.beta

data/lib/opennebula/template.rb

@@ -0,0 +1,213 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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_element'
+
+module OpenNebula
+    class Template < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+
+        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",
+            :rename      => "template.rename"
+        }
+
+        # 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
+
+        alias_method :info!, :info
+
+        # Allocates a new Template in OpenNebula
+        #
+        # @param description [String] The contents of the Template.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def allocate(description)
+            super(TEMPLATE_METHODS[:allocate], description)
+        end
+
+        # Deletes the Template
+        def delete()
+            super(TEMPLATE_METHODS[:delete])
+        end
+
+        # Creates a VM instance from a Template
+        #
+        # @param name [String] Name for the VM instance. If it is an empty
+        #   string OpenNebula will set a default name
+        # @param hold [true,false] false to create the VM in pending state,
+        #   true to create it on hold
+        # @param template [String] User provided Template to merge with the
+        #   one being instantiated
+        #
+        # @return [Integer, OpenNebula::Error] The new VM id, Error
+        #   otherwise
+        def instantiate(name="", hold=false, template="")
+            return Error.new('ID not defined') if !@pe_id
+
+            name ||= ""
+            template ||= ""
+
+            rc = @client.call(
+                TEMPLATE_METHODS[:instantiate], @pe_id, name, hold, template)
+
+            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
+
+        # Changes the Template 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(TEMPLATE_METHODS[:chmod], octet)
+        end
+
+        # Changes the Template 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(TEMPLATE_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
+                group_m, group_a, other_u, other_m, other_a)
+        end
+
+        # Clones this Template into a new one
+        #
+        # @param [String] name for the new Template.
+        #
+        # @return [Integer, OpenNebula::Error] The new Template ID in case
+        #   of success, Error otherwise
+        def clone(name)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(TEMPLATE_METHODS[:clone], @pe_id, name)
+
+            return rc
+        end
+
+        # Renames this Template
+        #
+        # @param name [String] New name for the Template.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def rename(name)
+            return call(TEMPLATE_METHODS[:rename], @pe_id, name)
+        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
+
+        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

data/lib/opennebula/template_pool.rb

@@ -0,0 +1,79 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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
+
+        alias_method :info!, :info
+        alias_method :info_all!, :info_all
+        alias_method :info_mine!, :info_mine
+        alias_method :info_group!, :info_group
+    end
+end

data/lib/opennebula/user.rb

@@ -0,0 +1,174 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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_element'
+
+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",
+            :update   => "user.update",
+            :chauth   => "user.chauth",
+            :quota    => "user.quota"
+        }
+
+        SELF      = -1
+
+        # Driver name for default core authentication
+        CORE_AUTH = "core"
+
+        # Driver name for default core authentication
+        CIPHER_AUTH = "server_cipher"
+
+        # Driver name for ssh authentication
+        SSH_AUTH  = "ssh"
+
+        # Driver name for x509 authentication
+        X509_AUTH = "x509"
+
+        # Driver name for x509 proxy authentication
+        X509_PROXY_AUTH = "x509_proxy"
+
+        # 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
+
+        alias_method :info!, :info
+
+        # Allocates a new User in OpenNebula
+        #
+        # +username+ Name of the new user.
+        #
+        # +password+ Password for the new user
+        def allocate(username, password, driver=CORE_AUTH)
+            super(USER_METHODS[:allocate], username, password, driver)
+        end
+
+        # Replaces the template contents
+        #
+        # +new_template+ New template contents
+        def update(new_template)
+            super(USER_METHODS[:update], new_template)
+        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
+
+        # Changes the auth driver and the password of the given User
+        #
+        # @param auth [String] the new auth driver
+        # @param password [String] the new password. If it is an empty string,
+        #   the user password is not changed
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chauth(auth, password="")
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(USER_METHODS[:chauth],@pe_id, auth, password)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Sets the user quota limits
+        # @param quota [String] a template (XML or txt) with the new quota limits 
+        # 
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def set_quota(quota)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(USER_METHODS[:quota],@pe_id, quota)
+            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