xclarity_client 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 714241cc9417ae4ab27aab39a98b1b1618f154fc
-  data.tar.gz: a73d88ab737024ee116444c4927ba503e7c427e0
+  metadata.gz: 46c74492a0ba842bb4252ace8c8a29eb6ff3eb0b
+  data.tar.gz: adaddc2302e33b60d7b4246fc0ffb19b2aeb1912
 SHA512:
-  metadata.gz: 40844b7e6df453eb351141f13ca950becdafa967807524c03df999b2cdda2fd8c9ee03b48f92434765a002ee8a761ac1bcf2d47c5b011ac1b791f01024981b4d
-  data.tar.gz: 6db55eecaaf8a2d5764df2da2b1b58e7d5d8937445115803efb29274752035f49927dd58a99621726a9d4e92c122272f23ec27295b351f3dcc2a5d3b582b55b3
+  metadata.gz: db19eeba154a7afa8b8d33491ce33792fa461e54d2b714c40ded82e7e48eeef9d4e5c3ecbd8e918e427da6839c09abf40fae2e03fe842d7a0d6ba5fc1d88fbc4
+  data.tar.gz: 8475d380d21a2bfd08fb0f5c57cfb81d3248e096e7e72071c8da6d781b6502b3b8b39f5a03ae78e79f2c0fa167540a95ed82b9f5e49096d93820dd9a694a0db0

data/README.md

@@ -1,57 +1,11 @@
-# XClarity Client
+<p align="center"><a href="https://www3.lenovo.com/us/en/data-center/software/systems-management/xclarity/" target="_blank" rel="noopener noreferrer"><img width="200" src="https://www3.lenovo.com/medias/lenovo-systems-software-management-xclarity-intro.png?context=bWFzdGVyfHJvb3R8NjY0OXxpbWFnZS9wbmd8aDI2L2hlMS85NDQ4OTkwODAxOTUwLnBuZ3xjZTdiOWJhNDViMTVhMjJjNTFiMWRmNzlhMDFkYzRmN2NkNGJjMzk1NTUxN2ZhYjExYWU1MDJlYmUyNGJkYjIw" alt="Lenovo Xclarity Logo"></a></p>
 
-[![Build Status](https://travis-ci.org/lenovo/xclarity_client.svg)](https://travis-ci.org/lenovo/xclarity_client)
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xclarity_client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Pre Configuration for Connection with LXCA
-
-
-Get up and running mongo database
-
-Execute rails console:
-
-```ruby
-  $ bundle exec rails console
-```
-
-Add resources to your database:
-
-Nodes:
-
-```ruby
-  $ FactoryGirl.create(:node)
-```
-Switches:
-
-```ruby
-  $ FactoryGirl.create(:switch)
-```
-Scalable Complexes:
-
-```ruby
-  $ FactoryGirl.create(:scalable_complex)
-```
-
-Power Supplies:
-
-```ruby
-  $ FactoryGirl.create(:power_supply)
-```
+xclarity_client
+===
 
-Chassis:
-
-```ruby
-  $ FactoryGirl.create(:chassi)
-```
-
-Get up LXCA-Mock server:
+[![Build Status](https://travis-ci.org/lenovo/xclarity_client.svg)](https://travis-ci.org/lenovo/xclarity_client)
 
-```ruby
-  $ bundle exec rails s
-```
+Ruby gem to interact with Lenovo XClarity.
 
 ## Installation
 
@@ -71,27 +25,46 @@ Or install it yourself as:
 
 ## Usage
 
-To get basic information from the virtual appliance
+To configure your appliance access:
 
 ```ruby
 require 'xclarity_client'
 
 conf = XClarityClient::Configuration.new(
-  :username   => 'admin',
-  :password   => 'pass',
-  :host       => 'http://example.com'
-  :auth_type  => 'token'
+  :host             => 'http://lxca_host.com'
+  :username         => 'username',
+  :password         => 'password',
+  :port             => 'lxca_port',
+  :auth_type        => 'auth_type',  # ('token', 'basic_auth')
+  :verify_ssl       => 'verify_ssl', # ('PEER', 'NONE')
+  :user_agent_label => 'user_agent'  # Api gem client identification
 )
 
-virtual_appliance = XClarityClient::VirtualApplianceManagement.new(conf)
+client = XClarityClient::Client.new(conf)
+```
 
-puts virtual_appliance.configuration_settings
+To access the appliance data:
 
-client = XClarityClient::Client.new(conf)
+```ruby
+client.discover_aicc # get AICC informations
+
+client.discover_cabinet # get Cabinets from LXCA appliance
 
-puts client.discover_nodes
+# get the cabinets with the specifieds UUIDs,
+# and retrive just `storageList` and `height` attributes.
+client.fetch_cabinet(
+  uuids = ['590b2546bbbc457f-bf801661018c408e', 'd27e57aa278c49a9b57e34a8e6c6e8ae'],
+  include_attributes = ['storageList', 'height']
+)
+
+# get the cabinets with the specifieds UUIDs,
+# and retrive all attributes except `height`.
+client.fetch_cabinet(
+  uuids = ['590b2546bbbc457f-bf801661018c408e', 'd27e57aa278c49a9b57e34a8e6c6e8ae'],
+  exclude_attributes = ['height']
+)
 ```
-NOTE: `auth_type` variable must have 'token' or 'basic_auth' as value.
+> To see how to interact with other LXCA resources, please take a look at `lib/xclarity_client/mixins` folder.
 
 ## Development
 
@@ -101,4 +74,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/juliancheal/xclarity_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/lenovo/xclarity_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/docs/apib/chassis.apib

@@ -75,3 +75,7 @@ FORMAT: 1A
 + Response 404
 + Response 409
 + Response 500
+
+# PUT /chassis/7F3E7E375B5747E0938969896B1CFDF5
+
++ Response 200 (application/json)

data/docs/apib/storages.apib

@@ -147,7 +147,54 @@ FORMAT: 1A
                   }
                ],
                "drives":[
-
+                  {
+                      "model": "ST9300653SS",
+                      "vendorName": "IBM-ESXS",
+                      "status": "Up",
+                      "location": "0.22",
+                      "serialNumber": "6XN43QX50000B349D4LY",
+                      "healthReason": "",
+                      "health": "OK",
+                      "type": "SAS",
+                      "healthRecommendation": "",
+                      "size": "300.0GB"
+                  },
+                  {
+                      "model": "ST9300605SS",
+                      "vendorName": "IBM-ESXS",
+                      "status": "Up",
+                      "location": "0.17",
+                      "serialNumber": "6XP5L6ZE0000B344HRZG",
+                      "healthReason": "",
+                      "health": "OK",
+                      "type": "SAS",
+                      "healthRecommendation": "",
+                      "size": "300.0GB"
+                  },
+                  {
+                      "model": "ST9300653SS",
+                      "vendorName": "IBM-ESXS",
+                      "status": "Up",
+                      "location": "0.23",
+                      "serialNumber": "6XN43QR90000B350B5G2",
+                      "healthReason": "A disk that was previously a member of a disk group has been detected.",
+                      "health": "Degraded",
+                      "type": "SAS",
+                      "healthRecommendation": "- If the associated disk group is offline or quarantined, contact technical support. Otherwise, clear the disk metadata to reuse the disk.",
+                      "size": "300.0GB"
+                  },
+                  {
+                      "model": "ST9300605SS",
+                      "vendorName": "IBM-ESXS",
+                      "status": "Up",
+                      "location": "0.16",
+                      "serialNumber": "6XP5L7QP0000B344HS0E",
+                      "healthReason": "",
+                      "health": "OK",
+                      "type": "SAS",
+                      "healthRecommendation": "",
+                      "size": "300.0GB"
+                  }
                ],
                "canisters":[
                   {

data/lib/xclarity_client/endpoints/chassi.rb

@@ -1,8 +1,15 @@
 module XClarityClient
   class Chassi < Endpoints::XclarityEndpoint
     BASE_URI = '/chassis'.freeze
+
     LIST_NAME = 'chassisList'.freeze
 
+    LED_STATES = %w(
+      Blinking
+      On
+      Off
+    ).freeze
+
     attr_accessor :accessState, :activationKeys, :activeAlerts, :backedBy,
                   :bladeSlots, :cmmDisplayName, :cmmHealthState, :cmms, :complex,
                   :contact, :dataHandle, :description, :displayName, :domainName,

data/lib/xclarity_client/endpoints/node.rb

@@ -1,7 +1,9 @@
 module XClarityClient
   class Node < Endpoints::XclarityEndpoint
     BASE_URI = '/nodes'.freeze
+
     LIST_NAME = 'nodeList'.freeze
+
     POWER_ACTIONS = %i(
       powerOn
       powerOffSoftGraceful
@@ -11,6 +13,12 @@ module XClarityClient
       bootToF1
     ).freeze
 
+    LED_STATES = %w(
+      Blinking
+      On
+      Off
+    ).freeze
+
     attr_accessor :accessState, :activationKeys, :addinCards, :addinCardSlots, :arch, :backedBy, :bladeState, :bladeState_health,
                   :bladeState_string, :bootMode, :bootOrder, :cmmDisplayName, :cmmHealthState, :complexID, :contact, :dataHandle,
                   :description, :displayName, :dnsHostnames, :domainName, :driveBays, :drives, :embeddedHypervisorPresence, :encapsulation,

data/lib/xclarity_client/endpoints/storage.rb

@@ -10,9 +10,10 @@ module XClarityClient
     LIST_NAME = 'storageList'.freeze
 
     attr_accessor :uuid, :name, :type, :accessState, :cmmHealthState,
-                  :overallHealthState, :driveBays, :enclosureCount,
-                  :canisterSlots, :productName, :machineType, :model,
-                  :serialNumber, :contact, :description, :location,
-                  :room, :rack, :lowestRackUnit, :mgmtProcIPaddress
+                  :enclosures, :overallHealthState, :driveBays,
+                  :enclosureCount, :canisterSlots, :productName,
+                  :machineType, :model, :serialNumber, :contact,
+                  :description, :location, :room, :rack,
+                  :lowestRackUnit, :mgmtProcIPaddress
   end
 end

data/lib/xclarity_client/mixins/chassi_mixin.rb

@@ -4,17 +4,35 @@ module XClarityClient
   #
   module Mixins::ChassiMixin
     def discover_chassis(opts = {})
-      ChassiManagement.new(@config).fetch_all(opts)
+      chassi_management.fetch_all(opts)
     end
 
     def fetch_chassis(uuids = nil,
                       include_attributes = nil,
                       exclude_attributes = nil)
-      ChassiManagement.new(@config).get_object(
+      chassi_management.get_object(
         uuids,
         include_attributes,
         exclude_attributes
       )
     end
+
+    def blink_loc_led_chassis(uuid = '', name = 'Location')
+      chassi_management.set_loc_led_state(uuid, 'Blinking', name)
+    end
+
+    def turn_on_loc_led_chassis(uuid = '', name = 'Location')
+      chassi_management.set_loc_led_state(uuid, 'On', name)
+    end
+
+    def turn_off_loc_led_chassis(uuid = '', name = 'Location')
+      chassi_management.set_loc_led_state(uuid, 'Off', name)
+    end
+
+    private
+
+    def chassi_management
+      ChassiManagement.new(@config)
+    end
   end
 end

data/lib/xclarity_client/mixins/node_mixin.rb

@@ -17,16 +17,16 @@ module XClarityClient
       )
     end
 
-    def blink_loc_led(uuid = '')
-      node_management.set_loc_led_state(uuid, 'Blinking')
+    def blink_loc_led(uuid = '', name = 'Identify')
+      node_management.set_loc_led_state(uuid, 'Blinking', name)
     end
 
-    def turn_on_loc_led(uuid = '')
-      node_management.set_loc_led_state(uuid, 'On')
+    def turn_on_loc_led(uuid = '', name = 'Identify')
+      node_management.set_loc_led_state(uuid, 'On', name)
     end
 
-    def turn_off_loc_led(uuid = '')
-      node_management.set_loc_led_state(uuid, 'Off')
+    def turn_off_loc_led(uuid = '', name = 'Identify')
+      node_management.set_loc_led_state(uuid, 'Off', name)
     end
 
     def power_on_node(uuid = '')

data/lib/xclarity_client/services/chassi_management.rb

@@ -1,5 +1,9 @@
+require 'xclarity_client/services/mixins/power_action_sender_mixin'
+
 module XClarityClient
   class ChassiManagement < Services::XClarityService
+    include Services::PowerActionSenderMixin
+
     manages_endpoint Chassi
   end
 end

data/lib/xclarity_client/services/mixins/power_action_sender_mixin.rb

@@ -4,6 +4,10 @@ module XClarityClient
     # A Power Action Sender is capable to send power
     # operation request for its managed endpoint.
     #
+    # An XclarityEndpoint that supports power or LED operations
+    # must configure the supported operations through `POWER_ACTIONS` and
+    # `LED_STATES` constants.
+    #
     module PowerActionSenderMixin
       #
       # Changes the power state for some resource.
@@ -15,21 +19,46 @@ module XClarityClient
       # @return the LXCA response.
       #
       def set_power_state(uuid, state)
-        unless valid_arguments?(uuid, state)
+        unless valid_arguments?(uuid, state, managed_resource::POWER_ACTIONS)
           error = 'Invalid target or power state requested'
           source = "#{self.class.name} set_power_state"
           $lxca_log.info(source, error)
           raise ArgumentError, error
         end
 
-        send_power_request(managed_resource::BASE_URI + '/' + uuid, state)
+        send_power_request(
+          "#{managed_resource::BASE_URI}/#{uuid}", state
+        )
+      end
+
+      #
+      # Changes the state of a LED of some resource.
+      #
+      # @param [String] uuid  - resource identifier
+      # @param [String] state - the new LED state
+      #   it must be listed on `managed_resource::LED_STATES`
+      # @param [String] name  - name of the LED that must have it state changed
+      #
+      # @return the LXCA response
+      #
+      def set_loc_led_state(uuid, state, name = 'Identify')
+        unless valid_arguments?(uuid, state, managed_resource::LED_STATES)
+          error = 'Invalid target or power state requested'
+          source = "#{self.class.name} set_loc_led_state"
+          $lxca_log.info(source, error)
+          raise ArgumentError, error
+        end
+
+        send_led_state_request(
+          "#{managed_resource::BASE_URI}/#{uuid}", state, name
+        )
       end
 
       #
       # Do a change power state request for an endpoint
       #
-      # @param [String] uri - the URI of the endpoint that must
-      #   have its power state changed.
+      # @param [String] uri
+      #  - the URI of the endpoint that must have its power state changed.
       # @param [symbol] requested_state - the new power state.
       #
       # @return the LXCA response.
@@ -43,6 +72,31 @@ module XClarityClient
         response
       end
 
+      #
+      # Do a change LED state request for an endpoint
+      #
+      # @param [String] uri
+      #   - The URI that must receive the request.
+      # @param [String] requested_state
+      #   - The new LED state.
+      # @param [String] led_name
+      #   - name of the LED that must have it state changed.
+      #
+      # @return the LXCA response.
+      #
+      def send_led_state_request(uri,
+                                 requested_state = nil,
+                                 led_name = 'Identify')
+        request = JSON.generate(
+          :leds => [{ :name => led_name, :state => requested_state }]
+        )
+        response = @connection.do_put(uri, request)
+        msg = "LED state request has been sent with request #{request}"
+
+        $lxca_log.info("#{self.class.name} send_led_state_request", msg)
+        response
+      end
+
       private
 
       #
@@ -50,9 +104,9 @@ module XClarityClient
       #   Verifies if the uuid is not blank
       #   Verifies if the endpoint supports the new state
       #
-      def valid_arguments?(uuid, state)
+      def valid_arguments?(uuid, desired_state, allowed_states)
         uuid ||= ''
-        !uuid.empty? && managed_resource::POWER_ACTIONS.include?(state)
+        !uuid.empty? && allowed_states.include?(desired_state)
       end
     end
   end

data/lib/xclarity_client/services/node_management.rb

@@ -20,13 +20,5 @@ module XClarityClient
 
       send_power_request(managed_resource::BASE_URI + '/' + uuid + '/bmc', requested_state)
     end
-
-    def set_loc_led_state(uuid, state, name = 'Identify')
-      request = JSON.generate(leds:  [{ name: name, state: state }])
-
-      $lxca_log.info "XclarityClient::ManagementMixin set_loc_led_state", "Loc led state action has been sent"
-
-      @connection.do_put("#{managed_resource::BASE_URI}/#{uuid}", request)
-    end
   end
 end

data/lib/xclarity_client/version.rb

@@ -1,3 +1,3 @@
 module XClarityClient
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xclarity_client
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Manasa Rao
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler