opennebula-cli 3.8.0.beta1

data/lib/one_helper/oneacct_helper.rb

@@ -0,0 +1,179 @@
+# -------------------------------------------------------------------------- #
+# 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 'one_helper'
+
+class AcctHelper < OpenNebulaHelper::OneHelper
+    START_TIME = {
+        :name   => "start_time",
+        :short  => "-s TIME",
+        :large  => "--start TIME" ,
+        :description => "Start date and time to take into account",
+        :format => String # TODO Time
+    }
+
+    END_TIME = {
+        :name   => "end_time",
+        :short  => "-e TIME",
+        :large  => "--end TIME" ,
+        :description => "End date and time",
+        :format => String # TODO Time
+    }
+
+    USER = {
+        :name   => "user",
+        :short  => "-u user",
+        :large  => "--user user" ,
+        :description => "User name or id to filter the results",
+        :format => String,
+        :proc => lambda { |o, options|
+            OpenNebulaHelper.rname_to_id(o, "USER")
+        }
+    }
+
+    GROUP = {
+        :name   => "group",
+        :short  => "-g group",
+        :large  => "--group group" ,
+        :description => "Group name or id to filter the results",
+        :format => String,
+        :proc => lambda { |o, options|
+            puts o
+            OpenNebulaHelper.rname_to_id(o, "GROUP")
+        }
+    }
+
+    HOST = {
+        :name   => "host",
+        :short  => "-H HOST",
+        :large  => "--host HOST" ,
+        :description => "Host name or id to filter the results",
+        :format => String,
+        :proc => lambda { |o, options|
+            OpenNebulaHelper.rname_to_id(o, "HOST")
+        }
+    }
+
+    XPATH = {
+        :name   => "xpath",
+        :large  => "--xpath XPATH_EXPRESSION" ,
+        :description => "Xpath expression to filter the results. \
+            For example: oneacct --xpath 'HISTORY[ETIME>0]'",
+        :format => String
+    }
+
+    XML = {
+        :name  => "xml",
+        :short => "-x",
+        :large => "--xml",
+        :description => "Show the resource in xml format"
+    }
+
+    JSON = {
+        :name  => "json",
+        :short => "-j",
+        :large => "--json",
+        :description => "Show the resource in xml format"
+    }
+
+    SPLIT={
+        :name  => "split",
+        :large => "--split",
+        :description => "Split the output in a table for each VM"
+    }
+
+    ACCT_OPTIONS = [START_TIME, END_TIME, USER, GROUP, HOST, XPATH, XML, JSON, SPLIT]
+
+
+    ACCT_TABLE = CLIHelper::ShowTable.new("oneacct.yaml", nil) do
+        column :VID, "Virtual Machine ID", :size=>4 do |d|
+            d["OID"]
+        end
+
+        column :SEQ, "History record sequence number", :size=>3 do |d|
+            d["SEQ"]
+        end
+
+        column :HOSTNAME, "Host name", :left, :size=>15 do |d|
+            d["HOSTNAME"]
+        end
+
+        column :REASON, "VM state change reason", :left, :size=>4 do |d|
+            VirtualMachine.get_reason d["REASON"]
+        end
+
+        column :START_TIME, "Start time", :size=>14 do |d|
+            OpenNebulaHelper.time_to_str(d['STIME'])
+        end
+
+        column :END_TIME, "End time", :size=>14 do |d|
+            OpenNebulaHelper.time_to_str(d['ETIME'])
+        end
+
+        column :MEMORY, "Assigned memory", :size=>6 do |d|
+            OpenNebulaHelper.unit_to_str(d["VM"]["TEMPLATE"]["MEMORY"].to_i, {}, 'M')
+        end
+
+        column :CPU, "Number of CPUs", :size=>3 do |d|
+            d["VM"]["TEMPLATE"]["CPU"]
+        end
+
+        column :NET_RX, "Data received from the network", :size=>6 do |d|
+            # NET is measured in bytes, unit_to_str expects KBytes
+            OpenNebulaHelper.unit_to_str(d["VM"]["NET_RX"].to_i / 1024.0, {})
+        end
+
+        column :NET_TX, "Data sent to the network", :size=>6 do |d|
+            # NET is measured in bytes, unit_to_str expects KBytes
+            OpenNebulaHelper.unit_to_str(d["VM"]["NET_TX"].to_i / 1024.0, {})
+        end
+
+        default :VID, :HOSTNAME, :REASON, :START_TIME, :END_TIME, :MEMORY, :CPU, :NET_RX, :NET_TX
+    end
+
+    def self.print_start_enc_time_header(start_time, end_time)
+        print "Showing active history records from "
+
+        CLIHelper.scr_bold
+        if ( start_time != -1 )
+            print Time.at(start_time).to_s
+        else
+            print "-"
+        end
+
+        CLIHelper.scr_restore
+        print " to "
+
+        CLIHelper.scr_bold
+        if ( end_time != -1 )
+            print Time.at(end_time).to_s
+        else
+            print "-"
+        end
+
+        CLIHelper.scr_restore
+        puts
+        puts
+    end
+
+    def self.print_user_header(user_id)
+        CLIHelper.scr_bold
+        CLIHelper.scr_underline
+        puts "# User #{user_id}".ljust(80)
+        CLIHelper.scr_restore
+        puts
+    end
+end

data/lib/one_helper/oneacl_helper.rb

@@ -0,0 +1,130 @@
+# -------------------------------------------------------------------------- #
+# 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 'one_helper'
+
+class OneAclHelper < OpenNebulaHelper::OneHelper
+    def self.rname
+        "ACL"
+    end
+
+    def self.conf_file
+        "oneacl.yaml"
+    end
+
+private
+
+    def factory(id = nil)
+        if id
+            OpenNebula::Acl.new_with_id(id, @client)
+        else
+            xml = OpenNebula::Acl.build_xml
+            OpenNebula::Acl.new(xml, @client)
+        end
+    end
+
+    def factory_pool(filter)
+        OpenNebula::AclPool.new(@client)
+    end
+
+    # TODO check that @content[:resources_str]  is valid
+    def self.resource_mask(str)
+        resource_type=str.split("/")[0]
+
+        mask = "----------"
+
+        resource_type.split("+").each{|type|
+            case type
+                when "VM"
+                    mask[0] = "V"
+                when "HOST"
+                    mask[1] = "H"
+                when "NET"
+                    mask[2] = "N"
+                when "IMAGE"
+                    mask[3] = "I"
+                when "USER"
+                    mask[4] = "U"
+                when "TEMPLATE"
+                    mask[5] = "T"
+                when "GROUP"
+                    mask[6] = "G"
+                when "DATASTORE"
+                    mask[7] = "D"
+                when "CLUSTER"
+                    mask[8] = "C"
+                when "DOCUMENT"
+                    mask[9] = "O"
+            end
+        }
+        mask
+    end
+
+    # TODO check that @content[:resources_str]  is valid
+    def self.right_mask(str)
+        mask = "----"
+
+        str.split("+").each{|type|
+            case type
+                when "USE"
+                    mask[0] = "u"
+                when "MANAGE"
+                    mask[1] = "m"
+                when "ADMIN"
+                    mask[2] = "a"
+                when "CREATE"
+                    mask[3] = "c"
+            end
+        }
+
+        mask
+    end
+
+    def format_pool(options)
+        config_file = self.class.table_conf
+
+        table = CLIHelper::ShowTable.new(config_file, self) do
+            column :ID, "Rule Identifier",
+                          :size=>5 do |d|
+                d['ID']
+            end
+
+            column :USER, "To which resource owner the rule applies to",
+                          :size=>8 do |d|
+                d['STRING'].split(" ")[0]
+            end
+
+            column :RES_VHNIUTGDCO, "Resource to which the rule applies",
+                            :size => 14 do |d|
+               OneAclHelper::resource_mask d['STRING'].split(" ")[1]
+            end
+
+            column :RID, "Resource ID", :right, :size=>5 do |d|
+                d['STRING'].split(" ")[1].split("/")[1]
+            end
+
+            column :OPE_UMAC,
+                    "Operation to which the rule applies", :size =>8 do |d|
+                OneAclHelper::right_mask d['STRING'].split(" ")[2]
+            end
+
+            default :ID, :USER, :RES_VHNIUTGDCO, :RID, :OPE_UMAC
+        end
+
+        table
+    end
+
+end

data/lib/one_helper/onecluster_helper.rb

@@ -0,0 +1,129 @@
+# -------------------------------------------------------------------------- #
+# 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 'one_helper'
+
+class OneClusterHelper < OpenNebulaHelper::OneHelper
+
+    CLUSTER = {
+        :name   => "cluster",
+        :short  => "-c id|name",
+        :large  => "--cluster id|name" ,
+        :description => "Selects the cluster",
+        :format => String,
+        :proc   => lambda { |o, options|
+            OpenNebulaHelper.rname_to_id(o, "CLUSTER")
+        }
+    }
+
+    def self.rname
+        "CLUSTER"
+    end
+
+    def self.conf_file
+        "onecluster.yaml"
+    end
+
+    def element_size(ehash, ename)
+        ids = ehash[ename]["ID"]
+
+        if ids.nil?
+            return 0
+        elsif ids.class == String
+            return 1
+        else
+            return ids.size
+        end
+    end
+
+
+    def format_pool(options)
+        config_file = self.class.table_conf
+
+        table = CLIHelper::ShowTable.new(config_file, self) do
+            column :ID, "ONE identifier for the Cluster", :size=>5 do |d|
+                d["ID"]
+            end
+
+            column :NAME, "Name of the Cluster", :left, :size=>25 do |d|
+                d["NAME"]
+            end
+
+            column :HOSTS, "Number of Hosts", :size=>5 do |d|
+                @ext.element_size(d,"HOSTS")
+            end
+
+            column :VNETS, "Number of Networks", :size=>5 do |d|
+                @ext.element_size(d,"VNETS")
+            end
+
+            column :DATASTORES, "Number of Datastores", :size=>10 do |d|
+                @ext.element_size(d,"DATASTORES")
+            end
+
+            default :ID, :NAME, :HOSTS, :VNETS, :DATASTORES
+        end
+
+        table
+    end
+
+    private
+
+    def factory(id=nil)
+        if id
+            OpenNebula::Cluster.new_with_id(id, @client)
+        else
+            xml=OpenNebula::Cluster.build_xml
+            OpenNebula::Cluster.new(xml, @client)
+        end
+    end
+
+    def factory_pool(user_flag=-2)
+        OpenNebula::ClusterPool.new(@client)
+    end
+
+    def format_resource(cluster)
+        str="%-15s: %-20s"
+        str_h1="%-80s"
+
+        CLIHelper.print_header(str_h1 % "CLUSTER #{cluster['ID']} INFORMATION")
+        puts str % ["ID",   cluster.id.to_s]
+        puts str % ["NAME", cluster.name]
+        puts
+
+        CLIHelper.print_header(str_h1 % "CLUSTER TEMPLATE", false)
+        puts cluster.template_str
+
+        puts
+
+        CLIHelper.print_header("%-15s" % ["HOSTS"])
+        cluster.host_ids.each do |id|
+            puts "%-15s" % [id]
+        end
+
+        puts
+        CLIHelper.print_header("%-15s" % ["VNETS"])
+        cluster.vnet_ids.each do |id|
+            puts "%-15s" % [id]
+        end
+
+        puts
+        CLIHelper.print_header("%-15s" % ["DATASTORES"])
+        cluster.datastore_ids.each do |id|
+            puts "%-15s" % [id]
+        end
+    end
+end

data/lib/one_helper/onedatastore_helper.rb

@@ -0,0 +1,131 @@
+# -------------------------------------------------------------------------- #
+# 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 'one_helper'
+
+class OneDatastoreHelper < OpenNebulaHelper::OneHelper
+    DATASTORE = {
+        :name   => "datastore",
+        :short  => "-d id|name",
+        :large  => "--datastore id|name" ,
+        :description => "Selects the datastore",
+        :format => String,
+        :proc   => lambda { |o, options|
+            OpenNebulaHelper.rname_to_id(o, "DATASTORE")
+        }
+    }
+
+    def self.rname
+        "DATASTORE"
+    end
+
+    def self.conf_file
+        "onedatastore.yaml"
+    end
+
+    def format_pool(options)
+        config_file = self.class.table_conf
+
+        table = CLIHelper::ShowTable.new(config_file, self) do
+            column :ID, "ONE identifier for the Datastore", :size=>4 do |d|
+                d["ID"]
+            end
+
+            column :NAME, "Name of the Datastore", :left, :size=>25 do |d|
+                d["NAME"]
+            end
+
+            column :CLUSTER, "Name of the Cluster", :left, :size=>15 do |d|
+                OpenNebulaHelper.cluster_str(d["CLUSTER"])
+            end
+
+            column :IMAGES, "Number of Images", :size=>6 do |d|
+                if d["IMAGES"]["ID"].nil?
+                    "0"
+                else
+                    d["IMAGES"]["ID"].size
+                end
+            end
+
+            column :TYPE, "Datastore driver", :left, :size=>8 do |d|
+                d["DS_MAD"]
+            end
+
+            column :TM, "Transfer driver", :left, :size=>8 do |d|
+                d["TM_MAD"]
+            end
+
+            default :ID, :NAME, :CLUSTER, :IMAGES, :TYPE, :TM
+        end
+
+        table
+    end
+
+    private
+
+    def factory(id=nil)
+        if id
+            OpenNebula::Datastore.new_with_id(id, @client)
+        else
+            xml=OpenNebula::Datastore.build_xml
+            OpenNebula::Datastore.new(xml, @client)
+        end
+    end
+
+    def factory_pool(user_flag=-2)
+        #TBD OpenNebula::UserPool.new(@client, user_flag)
+        OpenNebula::DatastorePool.new(@client)
+    end
+
+    def format_resource(datastore)
+        str="%-15s: %-20s"
+        str_h1="%-80s"
+
+        CLIHelper.print_header(str_h1 % "DATASTORE #{datastore['ID']} INFORMATION")
+        puts str % ["ID",       datastore.id.to_s]
+        puts str % ["NAME",     datastore.name]
+        puts str % ["USER",     datastore['UNAME']]
+        puts str % ["GROUP",    datastore['GNAME']]
+        puts str % ["CLUSTER",  OpenNebulaHelper.cluster_str(datastore['CLUSTER'])]
+
+        puts str % ["DS_MAD",   datastore['DS_MAD']]
+        puts str % ["TM_MAD",   datastore['TM_MAD']]
+        puts str % ["BASE PATH",datastore['BASE_PATH']]
+        puts
+
+        CLIHelper.print_header(str_h1 % "PERMISSIONS",false)
+
+        ["OWNER", "GROUP", "OTHER"].each { |e|
+            mask = "---"
+            mask[0] = "u" if datastore["PERMISSIONS/#{e}_U"] == "1"
+            mask[1] = "m" if datastore["PERMISSIONS/#{e}_M"] == "1"
+            mask[2] = "a" if datastore["PERMISSIONS/#{e}_A"] == "1"
+
+            puts str % [e,  mask]
+        }
+        puts
+
+        CLIHelper.print_header(str_h1 % "DATASTORE TEMPLATE", false)
+        puts datastore.template_str
+
+        puts
+
+        CLIHelper.print_header("%-15s" % "IMAGES")
+        datastore.img_ids.each do |id|
+            puts "%-15s" % [id]
+        end
+    end
+end