xclarity_client 0.5.3 → 0.5.4

data/docs/apib/users.apib

@@ -0,0 +1,387 @@
+FORMAT: 1A
+
+# XClarity Users
+
+# GET /userAccounts
+
++ Response 200 (application/json)
+{
+        "response": [{
+                "ldapDn": "cn=SYSMGR_MK0XRF2I,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "d5d12b7b-45d9-444a-bda0-7801f6a782ed",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System Manager",
+                "pwExpirationWarning": false,
+                "pwdAge": 1815701,
+                "userName": "SYSMGR_MK0XRF2I",
+                "groups": ["lxc-sysmgr"],
+                "loginAttempts": 1
+        }, {
+                "ldapDn": "cn=ADMIN,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 1,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 2211,
+                "PasswordChangeFirstAccess": false,
+                "reserved": false,
+                "timeBeforeExpirationInDays": 34,
+                "modifyTimestamp": "2017-07-06T07:43:24Z",
+                "id": "aad6a497-566c-4323-a08e-6fd939defb54",
+                "createTimestamp": "2017-05-11T13:11:26Z",
+                "supervisor": true,
+                "lastLoginTimestamp": "2017-07-06T07:43:24Z",
+                "userPw": "NA",
+                "description": "",
+                "pwExpirationWarning": false,
+                "pwdAge": 4818730,
+                "userName": "ADMIN",
+                "groups": ["lxc-supervisor"],
+                "loginAttempts": 2211
+        }, {
+                "ldapDn": "cn=SYSRDR_BWMH0XO0,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "6a3ca55b-5bf1-406d-87fb-e0f44d5c0897",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System reader",
+                "pwExpirationWarning": false,
+                "pwdAge": 1815701,
+                "userName": "SYSRDR_BWMH0XO0",
+                "groups": ["lxc-sysrdr"],
+                "loginAttempts": 1
+        }],
+        "result": "success",
+        "messages": [{
+                "id": "FQXHMSE0001I",
+                "text": "The request completed successfully.",
+                "explanation": "",
+                "recovery": {
+                        "text": "Information only. No action is required.",
+                        "URL": ""
+                }
+        }]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# GET /userAccounts?includeAttributes=ldapDn,loginAttempts
+
++ Response 200 (application/json)
+{
+        "response": [{
+                "ldapDn": "cn=SYSMGR_MK0XRF2I,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "d5d12b7b-45d9-444a-bda0-7801f6a782ed",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System Manager",
+                "pwExpirationWarning": false,
+                "pwdAge": 1815701,
+                "userName": "SYSMGR_MK0XRF2I",
+                "groups": ["lxc-sysmgr"],
+                "loginAttempts": 1
+        }, {
+                "ldapDn": "cn=ADMIN,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 1,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 2211,
+                "PasswordChangeFirstAccess": false,
+                "reserved": false,
+                "timeBeforeExpirationInDays": 34,
+                "modifyTimestamp": "2017-07-06T07:43:24Z",
+                "id": "aad6a497-566c-4323-a08e-6fd939defb54",
+                "createTimestamp": "2017-05-11T13:11:26Z",
+                "supervisor": true,
+                "lastLoginTimestamp": "2017-07-06T07:43:24Z",
+                "userPw": "NA",
+                "description": "",
+                "pwExpirationWarning": false,
+                "pwdAge": 4818730,
+                "userName": "ADMIN",
+                "groups": ["lxc-supervisor"],
+                "loginAttempts": 2211
+        }, {
+                "ldapDn": "cn=SYSRDR_BWMH0XO0,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "6a3ca55b-5bf1-406d-87fb-e0f44d5c0897",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System reader",
+                "pwExpirationWarning": false,
+                "pwdAge": 1815701,
+                "userName": "SYSRDR_BWMH0XO0",
+                "groups": ["lxc-sysrdr"],
+                "loginAttempts": 1
+        }],
+        "result": "success",
+        "messages": [{
+                "id": "FQXHMSE0001I",
+                "text": "The request completed successfully.",
+                "explanation": "",
+                "recovery": {
+                        "text": "Information only. No action is required.",
+                        "URL": ""
+                }
+        }]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# GET /userAccounts?excludeAttributes=ldapDn,loginAttempts
+
++ Response 200 (application/json)
+{
+        "response": [{
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "d5d12b7b-45d9-444a-bda0-7801f6a782ed",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System Manager",
+                "pwExpirationWarning": false,
+                "pwdAge": 1815701,
+                "userName": "SYSMGR_MK0XRF2I",
+                "groups": ["lxc-sysmgr"]
+        }, {
+                "activeSessions": 1,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 2211,
+                "PasswordChangeFirstAccess": false,
+                "reserved": false,
+                "timeBeforeExpirationInDays": 34,
+                "modifyTimestamp": "2017-07-06T07:43:24Z",
+                "id": "aad6a497-566c-4323-a08e-6fd939defb54",
+                "createTimestamp": "2017-05-11T13:11:26Z",
+                "supervisor": true,
+                "lastLoginTimestamp": "2017-07-06T07:43:24Z",
+                "userPw": "NA",
+                "description": "",
+                "pwExpirationWarning": false,
+                "pwdAge": 4818730,
+                "userName": "ADMIN",
+                "groups": ["lxc-supervisor"]
+        }, {
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "6a3ca55b-5bf1-406d-87fb-e0f44d5c0897",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System reader",
+                "pwExpirationWarning": false,
+                "pwdAge": 1815701,
+                "userName": "SYSRDR_BWMH0XO0",
+                "groups": ["lxc-sysrdr"]
+        }],
+        "result": "success",
+        "messages": [{
+                "id": "FQXHMSE0001I",
+                "text": "The request completed successfully.",
+                "explanation": "",
+                "recovery": {
+                        "text": "Information only. No action is required.",
+                        "URL": ""
+                }
+        }]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# GET /userAccounts/d5d12b7b-45d9-444a-bda0-7801f6a782ed
+
++ Response 200 (application/json)
+{
+        "response": {
+                "ldapDn": "cn=SYSMGR_MK0XRF2I,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "d5d12b7b-45d9-444a-bda0-7801f6a782ed",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System Manager",
+                "pwExpirationWarning": false,
+                "pwdAge": 1818070,
+                "userName": "SYSMGR_MK0XRF2I",
+                "groups": ["lxc-sysmgr"],
+                "loginAttempts": 1
+        },
+        "result": "success",
+        "messages": [{
+                "id": "FQXHMSE0001I",
+                "text": "The request completed successfully.",
+                "explanation": "",
+                "recovery": {
+                        "text": "Information only. No action is required.",
+                        "URL": ""
+                }
+        }]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# GET /userAccounts/d5d12b7b-45d9-444a-bda0-7801f6a782ed?includeAttributes=ldapDn,loginAttempts
+
++ Response 200 (application/json)
+{
+        "response": {
+                "ldapDn": "cn=SYSMGR_MK0XRF2I,ou=Users,dc=ibmbase,dc=com",
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "d5d12b7b-45d9-444a-bda0-7801f6a782ed",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System Manager",
+                "pwExpirationWarning": false,
+                "pwdAge": 1818070,
+                "userName": "SYSMGR_MK0XRF2I",
+                "groups": ["lxc-sysmgr"],
+                "loginAttempts": 1
+        },
+        "result": "success",
+        "messages": [{
+                "id": "FQXHMSE0001I",
+                "text": "The request completed successfully.",
+                "explanation": "",
+                "recovery": {
+                        "text": "Information only. No action is required.",
+                        "URL": ""
+                }
+        }]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# GET /userAccounts/d5d12b7b-45d9-444a-bda0-7801f6a782ed?excludeAttributes=ldapDn,loginAttempts
+
++ Response 200 (application/json)
+{
+        "response": {
+                "activeSessions": 0,
+                "pwExpired": false,
+                "state": "Active",
+                "loginCount": 1,
+                "PasswordChangeFirstAccess": false,
+                "reserved": true,
+                "timeBeforeExpirationInDays": 68,
+                "modifyTimestamp": "2017-06-15T07:21:55Z",
+                "id": "d5d12b7b-45d9-444a-bda0-7801f6a782ed",
+                "createTimestamp": "2017-06-15T07:21:55Z",
+                "supervisor": false,
+                "lastLoginTimestamp": "",
+                "userPw": "NA",
+                "description": "System Manager",
+                "pwExpirationWarning": false,
+                "pwdAge": 1818070,
+                "userName": "SYSMGR_MK0XRF2I",
+                "groups": ["lxc-sysmgr"]
+        },
+        "result": "success",
+        "messages": [{
+                "id": "FQXHMSE0001I",
+                "text": "The request completed successfully.",
+                "explanation": "",
+                "recovery": {
+                        "text": "Information only. No action is required.",
+                        "URL": ""
+                }
+        }]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+

data/lib/xclarity_client/client.rb

@@ -155,5 +155,53 @@ module XClarityClient
     def turn_off_loc_led(uuid = '')
       NodeManagement.new(@connection).set_loc_led_state(uuid, 'Off')
     end
+  
+    def fetch_ffdc(uuids = nil,
+                   includeAttributes = nil,
+                   excludeAttributes = nil)
+      FfdcManagement.new(@connection).get_object(uuids,
+                                                includeAttributes,
+                                                excludeAttributes,
+                                                Ffdc)
+    end
+
+    def discover_jobs(opts = {})
+      JobManagement.new(@connection).population opts
+    end
+
+    def fetch_jobs(ids = nil,
+                   includeAttributes = nil,
+                   excludeAttributes = nil)
+      JobManagement.new(@connection).get_object_with_id(ids,
+                                                includeAttributes,
+                                                excludeAttributes,
+                                                Job)
+    end
+
+    def cancel_job(id = '')
+      JobManagement.new(@connection).cancel_job(id)
+    end
+
+    def delete_job(id = '')
+      JobManagement.new(@connection).delete_job(id)
+    end
+
+    def discover_update_repo(opts = {})
+      UpdateRepoManagement.new(@connection).population opts
+    end
+
+    def discover_users(opts = {})
+      UserManagement.new(@connection).population
+    end
+
+    def fetch_users(ids = nil,
+                   includeAttributes = nil,
+                   excludeAttributes = nil)
+      UserManagement.new(@connection).get_object_with_id(ids,
+                                                includeAttributes,
+                                                excludeAttributes,
+                                                User)
+    end
+  
   end
 end

data/lib/xclarity_client/ffdc.rb

@@ -0,0 +1,15 @@
+module XClarityClient
+  class Ffdc
+    include XClarityClient::Resource
+
+    BASE_URI = '/ffdc/endpoint'.freeze
+    LIST_NAME = 'ffdcList'.freeze
+
+    attr_accessor :jobURL
+
+    def initialize(attributes)
+      build_resource(attributes)
+    end
+
+  end
+end

data/lib/xclarity_client/ffdc_management.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'uuid'
+
+module XClarityClient
+  class FfdcManagement < XClarityBase
+    include XClarityClient::ManagementMixin
+
+    def initialize(conf)
+      super(conf, Ffdc::BASE_URI)
+    end
+
+  end
+end

data/lib/xclarity_client/job.rb

@@ -0,0 +1,16 @@
+module XClarityClient
+  class Job
+    include XClarityClient::Resource
+
+    BASE_URI = '/jobs'.freeze
+    LIST_NAME = 'jobsList'.freeze
+
+    attr_accessor :status, :cancelledBy, :createdBy, :category, :typeId, :messageDisplay, :cancelURI,
+    :messageParameters, :startTime, :messageID, :messageBundle, :endTime, :id, :isCancelable, :uuid
+
+    def initialize(attributes)
+      build_resource(attributes)
+    end
+
+  end
+end

data/lib/xclarity_client/job_management.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module XClarityClient
+  class JobManagement < XClarityBase
+
+    include XClarityClient::ManagementMixin
+
+    def initialize(conf)
+      super(conf, Job::BASE_URI)
+    end
+
+    def population(opts = {})
+      get_all_resources(Job, opts)
+    end
+
+    def cancel_job(uuid='')
+      cancelReq = JSON.generate(cancelRequest: 'true')
+      response = do_put(Job::BASE_URI + '/' + uuid, cancelReq)
+      puts response.body
+    end
+
+    def delete_job(uuid='')
+      response = do_delete(Job::BASE_URI + '/' + uuid)
+      puts response.body
+    end
+
+  end
+end

data/lib/xclarity_client/update_repo.rb

@@ -0,0 +1,15 @@
+module XClarityClient
+  class UpdateRepo
+    include XClarityClient::Resource
+
+    BASE_URI = '/updateRepositories/firmware'.freeze
+    LIST_NAME = 'updateRepoList'.freeze
+
+    attr_accessor :importDir, :status, :lastRefreshed, :size, :publicKeys, :updates, :updatesByMt, :supportedMts, :updatesByMtByComp
+
+    def initialize(attributes)
+      build_resource(attributes)
+    end
+
+  end
+end

data/lib/xclarity_client/update_repo_management.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module XClarityClient
+  class UpdateRepoManagement < XClarityBase
+
+    include XClarityClient::ManagementMixin
+
+    def initialize(conf)
+      super(conf, UpdateRepo::BASE_URI)
+    end
+
+    def population(opts = {})
+      raise "Option key must be provided for update_repo resource" if opts.empty?
+      raise "Option key must be provided for update_repo resource" if not (opts.has_key?(:key) || opts.has_key?("key"))
+      repoKey = opts[:key] || opts["key"]
+      if repoKey == "supportedMts" || repoKey == "size" || repoKey == "lastRefreshed" || repoKey == "importDir" || repoKey == "publicKeys" || repoKey == "updates" || repoKey == "updatesByMt" || repoKey == "updatesByMtByComp"
+        get_all_resources(UpdateRepo, opts)
+      else 
+        raise "The value for option key should be one of these : supportedMts, lastRefreshed, size, importDir, publicKeys, updates, updatesByMt, updatesByMtByComp"
+      end
+    end
+
+  end
+end

data/lib/xclarity_client/user.rb

@@ -0,0 +1,18 @@
+module XClarityClient
+  class User
+    include XClarityClient::Resource
+
+    BASE_URI = '/userAccounts'.freeze
+    LIST_NAME = 'usersList'.freeze
+
+    attr_accessor :response, :PasswordChangeFirstAccess, :activeSessions, :createTimestamp, :description, :groups,
+    :id, :lastLoginTimestamp, :ldapDn, :loginAttempts, :loginCount, :modifyTimestamp, :pwExpirationWarning, 
+    :pwExpired, :pwdAge, :reserved, :state, :supervisor, :timeBeforeExpirationInDays, :userName, :userPw,
+    :result, :messages
+    
+    def initialize(attributes)
+      build_resource(attributes)
+    end
+
+  end
+end

data/lib/xclarity_client/user_management.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+module XClarityClient
+  class UserManagement < XClarityBase
+
+    include XClarityClient::ManagementMixin
+
+    def initialize(conf)
+      super(conf, User::BASE_URI)
+    end
+
+    def population()
+      get_all_resources(User)
+    end
+
+  end
+end

data/lib/xclarity_client/version.rb

@@ -1,3 +1,3 @@
 module XClarityClient
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/lib/xclarity_client/xclarity_base.rb

@@ -65,6 +65,13 @@ module XClarityClient
       end
     end
 
+    def do_delete (uri="")
+      @conn.delete do |req|
+        req.url uri
+        req.headers['Content-Type'] = 'application/json'
+      end
+    end
+
     def authentication(conf)
       response = @conn.post do |request|
         request.url '/session'

data/lib/xclarity_client/xclarity_management_mixin.rb

@@ -10,6 +10,10 @@ module XClarityClient
       return [] unless response.success?
 
       body = JSON.parse(response.body)
+      if resource == XClarityClient::User
+        body = body['response']
+      end
+
       body = {resource::LIST_NAME => body} if body.is_a? Array
       body = {resource::LIST_NAME => [body]} unless body.has_key? resource::LIST_NAME
       body[resource::LIST_NAME].map do |resource_params|
@@ -70,6 +74,48 @@ module XClarityClient
       end
     end
 
+    def get_object_with_id(ids, includeAttributes, excludeAttributes, resource)
+      response = if not includeAttributes.nil?
+        get_object_with_id_include_attributes(ids, includeAttributes, resource)
+      elsif not excludeAttributes.nil?
+        get_object_with_id_exclude_attributes(ids, excludeAttributes, resource)
+      elsif not ids.nil?
+        connection(resource::BASE_URI + "/" + ids.join(","))
+      else
+        connection(resource::BASE_URI)
+      end
+
+      return [] unless response.success?
+
+      body = JSON.parse(response.body)
+
+      if resource == XClarityClient::User
+        body = body['response']
+      end
+
+      body = {resource::LIST_NAME => body} if body.is_a? Array
+      body = {resource::LIST_NAME => [body]} unless body.has_key? resource::LIST_NAME
+      body[resource::LIST_NAME].map do |resource_params|
+        resource.new resource_params
+      end
+    end
+
+    def get_object_with_id_include_attributes(uuids, attributes, resource)
+      response = if not uuids.nil?
+        connection(resource::BASE_URI + "/" + uuids.join(",") + "?includeAttributes=" + attributes.join(","))
+      else
+        connection(resource::BASE_URI + "?includeAttributes=" + attributes.join(","))
+      end
+    end
+
+    def get_object_with_id_exclude_attributes(uuids, attributes, resource)
+      response = if not uuids.nil?
+        connection(resource::BASE_URI + "/#{uuids.join(",")}"+"?excludeAttributes=#{attributes.join(",")}")
+      else
+        connection(resource::BASE_URI + "?excludeAttributes=" + attributes.join(","))
+      end
+    end
+
     def get_object_with_opts(opts, resource)
       raise "The opts cannot be empty" if opts.empty?
       filter = ""