xclarity_client 0.6.0 → 0.6.1

data/lib/xclarity_client/mixins/job_mixin.rb

@@ -0,0 +1,32 @@
+module XClarityClient
+  #
+  # Exposes JobManagement features
+  #
+  module Mixins::JobMixin
+    def discover_jobs(opts = {})
+      JobManagement.new(@config).fetch_all(opts)
+    end
+
+    def fetch_jobs(ids = nil,
+                   include_attributes = nil,
+                   exclude_attributes = nil)
+      JobManagement.new(@config).get_object_with_id(
+        ids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+
+    def cancel_job(id = '')
+      JobManagement.new(@config).cancel_job(id)
+    end
+
+    def delete_job(id = '')
+      JobManagement.new(@config).delete_job(id)
+    end
+
+    def get_job(job_id = '')
+      JobManagement.new(@config).get_job(job_id)
+    end
+  end
+end

data/lib/xclarity_client/mixins/mixins.rb

@@ -0,0 +1,38 @@
+module XClarityClient
+  #
+  # Contains mixins to provide XClarityClient::Client features
+  #
+  module Mixins
+  end
+end
+
+require 'xclarity_client/mixins/aicc_mixin'
+require 'xclarity_client/mixins/cabinet_mixin'
+require 'xclarity_client/mixins/canister_mixin'
+require 'xclarity_client/mixins/chassi_mixin'
+require 'xclarity_client/mixins/cmm_mixin'
+require 'xclarity_client/mixins/compliance_policy_mixin'
+require 'xclarity_client/mixins/config_pattern_mixin'
+require 'xclarity_client/mixins/config_profile_mixin'
+require 'xclarity_client/mixins/config_target_mixin'
+require 'xclarity_client/mixins/discover_request_mixin'
+require 'xclarity_client/mixins/discovery_mixin'
+require 'xclarity_client/mixins/event_mixin'
+require 'xclarity_client/mixins/fan_mixin'
+require 'xclarity_client/mixins/fan_mux_mixin'
+require 'xclarity_client/mixins/ffdc_mixin'
+require 'xclarity_client/mixins/global_setting_mixin'
+require 'xclarity_client/mixins/host_platform_mixin'
+require 'xclarity_client/mixins/job_mixin'
+require 'xclarity_client/mixins/node_mixin'
+require 'xclarity_client/mixins/os_image_mixin'
+require 'xclarity_client/mixins/persisted_result_mixin'
+require 'xclarity_client/mixins/power_supply_mixin'
+require 'xclarity_client/mixins/remote_access_mixin'
+require 'xclarity_client/mixins/remote_file_server_mixin'
+require 'xclarity_client/mixins/scalable_complex_mixin'
+require 'xclarity_client/mixins/storage_mixin'
+require 'xclarity_client/mixins/switch_mixin'
+require 'xclarity_client/mixins/unmanage_request_mixin'
+require 'xclarity_client/mixins/update_repo_mixin'
+require 'xclarity_client/mixins/user_mixin'

data/lib/xclarity_client/mixins/node_mixin.rb

@@ -0,0 +1,66 @@
+module XClarityClient
+  #
+  # Exposes NodeManagement features
+  #
+  module Mixins::NodeMixin
+    def discover_nodes(opts = {})
+      node_management.fetch_all(opts)
+    end
+
+    def fetch_nodes(uuids = nil,
+                    include_attributes = nil,
+                    exclude_attributes = nil)
+      node_management.get_object(
+        uuids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+
+    def blink_loc_led(uuid = '')
+      node_management.set_loc_led_state(uuid, 'Blinking')
+    end
+
+    def turn_on_loc_led(uuid = '')
+      node_management.set_loc_led_state(uuid, 'On')
+    end
+
+    def turn_off_loc_led(uuid = '')
+      node_management.set_loc_led_state(uuid, 'Off')
+    end
+
+    def power_on_node(uuid = '')
+      node_management.set_power_state(uuid, :powerOn)
+    end
+
+    def power_off_node(uuid = '')
+      node_management.set_power_state(uuid, :powerOffSoftGraceful)
+    end
+
+    def power_off_node_now(uuid = '')
+      node_management.set_power_state(uuid, :powerOff)
+    end
+
+    def power_restart_node(uuid = '')
+      node_management.set_power_state(uuid, :powerCycleSoftGrace)
+    end
+
+    def power_restart_node_now(uuid = '')
+      node_management.set_power_state(uuid, :powerCycleSoft)
+    end
+
+    def power_restart_node_controller(uuid = '')
+      node_management.set_bmc_power_state(uuid, :restart)
+    end
+
+    def power_restart_node_to_setup(uuid = '')
+      node_management.set_power_state(uuid, :bootToF1)
+    end
+
+    private
+
+    def node_management
+      NodeManagement.new(@config)
+    end
+  end
+end

data/lib/xclarity_client/mixins/os_image_mixin.rb

@@ -0,0 +1,14 @@
+module XClarityClient
+  #
+  # Exposes OsImageManagement features
+  #
+  module Mixins::OsImageMixin
+    def import_osimage(server_id = '', path = '')
+      OsImageManagement.new(@config).import_osimage(server_id, path)
+    end
+
+    def get_osimages
+      OsImageManagement.new(@config).population
+    end
+  end
+end

data/lib/xclarity_client/mixins/persisted_result_mixin.rb

@@ -0,0 +1,10 @@
+module XClarityClient
+  #
+  # Exposes PersistedResultManagement features
+  #
+  module Mixins::PersistedResultMixin
+    def fetch_compliance_policies
+      PersistedResultManagement.new(@config).fetch_all
+    end
+  end
+end

data/lib/xclarity_client/mixins/power_supply_mixin.rb

@@ -0,0 +1,20 @@
+module XClarityClient
+  #
+  # Exposes PowerSupplyManagement features
+  #
+  module Mixins::PowerSupplyMixin
+    def discover_power_supplies(opts = {})
+      PowerSupplyManagement.new(@config).fetch_all(opts)
+    end
+
+    def fetch_power_supplies(uuids = nil,
+                             include_attributes = nil,
+                             exclude_attributes = nil)
+      PowerSupplyManagement.new(@config).get_object(
+        uuids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+  end
+end

data/lib/xclarity_client/mixins/remote_access_mixin.rb

@@ -0,0 +1,10 @@
+module XClarityClient
+  #
+  # Exposes RemoteAccessManagement features
+  #
+  module Mixins::RemoteAccessMixin
+    def remote_control(uuid)
+      RemoteAccessManagement.new(@config).remote_control(uuid)
+    end
+  end
+end

data/lib/xclarity_client/mixins/remote_file_server_mixin.rb

@@ -0,0 +1,28 @@
+module XClarityClient
+  #
+  # Exposes RemoteFileServerManagement features
+  #
+  module Mixins::RemoteFileServerMixin
+    def get_remotefileserver_profiles
+      RemoteFileServerManagement.new(@config).population
+    end
+
+    def create_remotefileserver_profile(opts = {})
+      RemoteFileServerManagement.new(@config).create_remotefileserver_profile(
+        opts
+      )
+    end
+
+    def delete_remotefileserver_profile(server_id = '')
+      RemoteFileServerManagement.new(@config).delete_remotefileserver_profile(
+        server_id
+      )
+    end
+
+    def get_remotefileserver_profile(server_id = '')
+      RemoteFileServerManagement.new(@config).get_remotefileserver_profile(
+        server_id
+      )
+    end
+  end
+end

data/lib/xclarity_client/mixins/scalable_complex_mixin.rb

@@ -0,0 +1,20 @@
+module XClarityClient
+  #
+  # Exposes ScalableComplexManagement features
+  #
+  module Mixins::ScalableComplexMixin
+    def discover_scalableComplexes(opts = {})
+      ScalableComplexManagement.new(@config).fetch_all(opts)
+    end
+
+    def fetch_scalableComplexes(uuids = nil,
+                                include_attributes = nil,
+                                exclude_attributes = nil)
+      ScalableComplexManagement.new(@config).get_object(
+        uuids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+  end
+end

data/lib/xclarity_client/mixins/storage_mixin.rb

@@ -0,0 +1,20 @@
+module XClarityClient
+  #
+  # Exposes StorageManagement features
+  #
+  module Mixins::StorageMixin
+    def discover_storages(opts = {})
+      StorageManagement.new(@config).fetch_all(opts)
+    end
+
+    def fetch_storages(uuids = nil,
+                       include_attributes = nil,
+                       exclude_attributes = nil)
+      StorageManagement.new(@config).get_object(
+        uuids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+  end
+end

data/lib/xclarity_client/mixins/switch_mixin.rb

@@ -0,0 +1,30 @@
+module XClarityClient
+  #
+  # Exposes SwitchManagement features
+  #
+  module Mixins::SwitchMixin
+    def discover_switches(opts = {})
+      switch_management.fetch_all(opts)
+    end
+
+    def fetch_switches(uuids = nil,
+                       include_attributes = nil,
+                       exclude_attributes = nil)
+      switch_management.get_object(
+        uuids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+
+    def power_cycle_soft_switch(uuid = '')
+      switch_management.set_power_state(uuid, :powerCycleSoft)
+    end
+
+    private
+
+    def switch_management
+      SwitchManagement.new(@config)
+    end
+  end
+end

data/lib/xclarity_client/mixins/unmanage_request_mixin.rb

@@ -0,0 +1,18 @@
+module XClarityClient
+  #
+  # Exposes UnmanageRequestManagement features
+  #
+  module Mixins::UnmanageRequestMixin
+    def fetch_unmanage_request(job_id)
+      UnmanageRequestManagement.new(@config).fetch_unmanage_request(
+        job_id
+      )
+    end
+
+    def unmanage_discovered_devices(endpoints, force)
+      UnmanageRequestManagement.new(@config).unmanage_discovered_devices(
+        endpoints, force
+      )
+    end
+  end
+end

data/lib/xclarity_client/mixins/update_repo_mixin.rb

@@ -0,0 +1,10 @@
+module XClarityClient
+  #
+  # Exposes UpdateRepoManagement features
+  #
+  module Mixins::UpdateRepoMixin
+    def discover_update_repo(opts = {})
+      UpdateRepoManagement.new(@config).fetch_all(opts)
+    end
+  end
+end

data/lib/xclarity_client/mixins/user_mixin.rb

@@ -0,0 +1,26 @@
+module XClarityClient
+  #
+  # Exposes UserManagement features
+  #
+  module Mixins::UserMixin
+    def discover_users(_opts = {})
+      UserManagement.new(@config).fetch_all
+    end
+
+    def fetch_users(ids = nil,
+                    include_attributes = nil,
+                    exclude_attributes = nil)
+      UserManagement.new(@config).get_object_with_id(
+        ids,
+        include_attributes,
+        exclude_attributes
+      )
+    end
+
+    def change_user_password(current_password, new_password)
+      UserManagement.new(@config).change_password(
+        current_password, new_password
+      )
+    end
+  end
+end

data/lib/xclarity_client/schemas.rb

@@ -2,198 +2,193 @@ require 'json-schema'
 
 module XClarityClient
   class Schemas
-     @remotefs = {
-	        "id" => "create_remotefileserver_profile",
-	        "type" => "object",
-	        "required" => ["address", "displayName", "port", "protocol"],
-	        "properties" => {
-                                "address" => {
-				               "type" => "string"
-				             },
-                                "displayName" => {
-					           "type" => "string" 
-						 },
-				"keyComment" => {
-				                    "type" => "string" 
-						},
-				"keyPassphras" => {
-				                    "type" => "string" 
-						  },
-				"keyType" => {
-                                               "type" => "string"
-					     },
-				"password" => {
-						 "type" => "string"
-					      },
-				"port" => {
-						 "type" => "integer"
-					  },
-				"protocol" => { 
-                                                 "type" => "string"
-					      },
-				"serverId" =>  {
-						 "type" => "string"
-						},
-			        "username" => {
-						"type" => "string"
-					      }
-                               }
-                     }
- 
-     @hostplatforms = {
-                    "id" => "deploy_osimage",
-                    "type" => "array",
-                    "items" => { 
-                                "type" => "object",
-                                "required" => ["networkSettings", "selectedImage", "storageSettings", "uuid"],
-                                "properties" => {
-                                     "adusername" => {
-                                                       "type" => "string"
-                                                     },
-                                     "adpassword" => {
-                                                        "type" => "string"
-                                                     },
-                                     "configFileId" => {
-                                                         "type" => "string"
-                                                       },
-                                     "licenseKey" => {
-                                                       "type" => "string"
-                                                     },
-                                     "selectedImage" => {
-                                                          "type" => "string"
-                                                        },
-                                     "storageSettings" => {
-                                                            "type" => "object"
-                                                          },
-                                     "unattendFileId" => {
-                                                            "type" => "string"
-                                                         },
-                                     "uuid" => {
-                                                 "type" => "string"
-                                               },         
-                                     "windowsDomain" => {
-                                                          "type" => "string"
-                                                        },
-                                     "windowsDomainBlob" => {
-                                                              "type" => "string"
-                                                            },
-                                     "networkSettings" => {
-                                                           "type" => "object",
-                                                           "properties" =>
-                                                                  {
-                                                                    "dns1" => {
-                                                                                "type" => "string"
-                                                                              },
-                                                                    "dns2" => {
-                                                                                "type" => "string"
-                                                                              },
-                                                                    "gateway" => {
-                                                                                "type" => "string"
-                                                                              },
-                                                                    "hostname" => {
-                                                                                "type" => "string"
-                                                                              },
-                                                                    "ipAddress" => {
-                                                                                "type" => "string"
-                                                                              },
-                                                                    "mtu" => {
-                                                                               "type" => "integer"
-                                                                             },
-                                                                    "prefixLength" => {
-                                                                                       "type" => "string"
-                                                                                      },
-                                                                    "selectedMAC" => {
-                                                                                      "type" => "string"
-                                                                                     },
-                                                                    "vlanId" => {
-                                                                                  "type" => "string"
-                                                                                }
-                                                                  }        
-                                                            }
-                                     } 
-                                  }
-                               }
+    @remotefs = {
+      "id"         => "create_remotefileserver_profile",
+      "type"       => "object",
+      "required"   => %w(address displayName port protocol),
+      "properties" => {
+        "address"      => {
+          "type" => "string"
+        },
+        "displayName"  => {
+          "type" => "string"
+        },
+        "keyComment"   => {
+          "type" => "string"
+        },
+        "keyPassphras" => {
+          "type" => "string"
+        },
+        "keyType"      => {
+          "type" => "string"
+        },
+        "password"     => {
+          "type" => "string"
+        },
+        "port"         => {
+          "type" => "integer"
+        },
+        "protocol"     => {
+          "type" => "string"
+        },
+        "serverId"     => {
+          "type" => "string"
+        },
+        "username"     => {
+          "type" => "string"
+        }
+      }
+    }
 
-     @globalsettings = {
-                       "id" => "set_globalsettings",
-                       "type" => "object",
-                       "required" => ["activeDirectory", "ipAssignment", "isVLANMode", "licenseKeys", "credentials"],
-                       "properties" => {
-                                          "activeDirectory": {
-                                                              "type" => "object"
-                                                             },
-                                           "ipAssignment":{
-                                                            "type" => "string"
-                                                          },
-                                           "isVLANMode": {
-                                                           "type" => "boolean"
-                                                         },
-                                           "licenseKeys":{
-                                                           "type" => "object"
-                                                         },
-                                           "deploySettings":{
-                                                              "type" => "string"
-                                                            },
-                                           "credentials":{
-                                                           "type" => "array",
-                                                            "items" => {
-                                                                          "type" => "object",
-                                                                          "required" => ["type",
-                                                                                         "name",
-                                                                                         "password", 
-                                                                                         "passwordChanged"],
-                                                                          "properties" =>
-                                                                                  {
-                                                                                    "type":{
-                                                                                             "type"=> "string"
-                                                                                           },
-                                                                                    "name":{
-                                                                                             "type" => "string"
-                                                                                           },
-                                                                                    "password":{
-                                                                                                 "type" => "string"
-                                                                                              },
-                                                                                    "passwordChanged":{
-                                                                                                        "type" => "boolean"
-                                                                                                      }
-                                                                                    }
-                                                                            }
-                                                                       }
-                                                                  }
-                                                             }
+    @hostplatforms = {
+      "id"    => "deploy_osimage",
+      "type"  => "array",
+      "items" => {
+        "type"       => "object",
+        "required"   => %w(networkSettings selectedImage storageSettings uuid),
+        "properties" => {
+          "adusername"        => {
+            "type" => "string"
+          },
+          "adpassword"        => {
+            "type" => "string"
+          },
+          "configFileId"      => {
+            "type" => "string"
+          },
+          "licenseKey"        => {
+            "type" => "string"
+          },
+          "selectedImage"     => {
+            "type" => "string"
+          },
+          "storageSettings"   => {
+            "type" => "object"
+          },
+          "unattendFileId"    => {
+            "type" => "string"
+          },
+          "uuid"              => {
+            "type" => "string"
+          },
+          "windowsDomain"     => {
+            "type" => "string"
+          },
+          "windowsDomainBlob" => {
+            "type" => "string"
+          },
+          "networkSettings"   => {
+            "type"       => "object",
+            "properties" => {
+              "dns1"         => {
+                "type" => "string"
+              },
+              "dns2"         => {
+                "type" => "string"
+              },
+              "gateway"      => {
+                "type" => "string"
+              },
+              "hostname"     => {
+                "type" => "string"
+              },
+              "ipAddress"    => {
+                "type" => "string"
+              },
+              "mtu"          => {
+                "type" => "integer"
+              },
+              "prefixLength" => {
+                "type" => "string"
+              },
+              "selectedMAC"  => {
+                "type" => "string"
+              },
+              "vlanId"       => {
+                "type" => "string"
+              }
+            }
+          }
+        }
+      }
+    }
 
-     REQ_SCHEMA={
-                 "deploy_osimage" => @hostplatforms,
-                 "set_globalsettings" => @globalsettings,
-                 "create_remotefileserver_profile" => @remotefs 
-                }
+    @globalsettings = {
+      "id"         => "set_globalsettings",
+      "type"       => "object",
+      "required"   => %w(activeDirectory
+                         ipAssignment
+                         isVLANMode
+                         licenseKeys
+                         credentials),
+      "properties" => {
+        "activeDirectory" => {
+          "type" => "object"
+        },
+        "ipAssignment"    => {
+          "type" => "string"
+        },
+        "isVLANMode"      => {
+          "type" => "boolean"
+        },
+        "licenseKeys"     => {
+          "type" => "object"
+        },
+        "deploySettings"  => {
+          "type" => "string"
+        },
+        "credentials"     => {
+          "type"  => "array",
+          "items" => {
+            "type"       => "object",
+            "required"   => %w(type name password passwordChanged),
+            "properties" => {
+              "type"            => {
+                "type" => "string"
+              },
+              "name"            => {
+                "type" => "string"
+              },
+              "password"        => {
+                "type" => "string"
+              },
+              "passwordChanged" => {
+                "type" => "boolean"
+              }
+            }
+          }
+        }
+      }
+    }
 
-     def Schemas.validate_input(schema_name, data)
-         x=JSON::Validator.fully_validate(Schemas::REQ_SCHEMA[schema_name], data)
-         if not x.empty?
-            errmsg = "input validation failed for data #{data}" 
-            $lxca_log.error errmsg, ""
-            puts errmsg
-            for k in x
-               $lxca_log.error k, ""
-               puts k
-            end
-            return nil
-         else
-            return 1
-         end
-     end
+    REQ_SCHEMA = {
+      'deploy_osimage'                  => @hostplatforms,
+      'set_globalsettings'              => @globalsettings,
+      'create_remotefileserver_profile' => @remotefs
+    }.freeze
 
-     #parameter name should be string
-     def Schemas.validate_input_parameter(name, value, exp_type)
-         if not value.kind_of?(exp_type)
-            errmsg = "invalid #{name} #{value}, expected #{name} of type #{exp_type}"
-            $lxca_log.error errmsg, ""
-            puts errmsg
-            return nil
-         else
-            return 1
-         end
-     end
+    def self.validate_input(schema_name, data)
+      x = JSON::Validator.fully_validate(Schemas::REQ_SCHEMA[schema_name], data)
+      if !x.empty?
+        errmsg = "input validation failed for data #{data}"
+        $lxca_log.error(errmsg, '')
+        x.each { |k| $lxca_log.error(k, '') }
+        return nil
+      else
+        return 1
+      end
+    end
+
+    # parameter name should be string
+    def self.validate_input_parameter(name, value, exp_type)
+      if !value.kind_of?(exp_type)
+        errmsg = "invalid #{name} #{value},"\
+                 " expected #{name} of type #{exp_type}"
+        $lxca_log.error(errmsg, '')
+        return nil
+      else
+        return 1
+      end
+    end
   end
 end