xclarity_client 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d635bea57d869451ba76b10e0d81712fda6e429b
-  data.tar.gz: 4387236943efa27f6460a7c1b5855e6effc9b188
+  metadata.gz: a94d8c6370c78465f0607a7ea7d5dece6ac95d94
+  data.tar.gz: ce694e22536e0b68ee82ad13bc8e523a9e497b84
 SHA512:
-  metadata.gz: 29bc67ba63626984eb9c43f980526857f3c0ffae04e04bad2e9b20d548f31d7633000fbb95b0cdca0dc5a23c88ece22ef78c2243f807bbccaf9d4e8ad6fbc446
-  data.tar.gz: 9e752a0fb9c1fe2edbf8160ac57f7522810ddd3a99fbdcf061f394ba3370fb7c7de2866509634ad8e9aeebcd8aef5f3b0a82d6400b64e6b517b14382aff9ed49
+  metadata.gz: '09cb4cfa48391846096107de5f4989d20246d8bd0edae3735264f304cf3d4df1b7d884ba0f9ad3f74f456aa971d83f5885e7fb8e503213f4356e1f5c607b503f'
+  data.tar.gz: dbb35e325ad671c58f5431bec6d40577f4655a569008afd33b2df25d4a9866d05bd809767c137e962c37ae558699068ebf25d50ef9c4f8a2f027b10fe030152d

data/docs/apib/discover_request.apib

@@ -30,7 +30,9 @@ FORMAT: 1A
     "ipAddresses" : [""]
   }
 ]
-+ Response 200
++ Response 200 (application/json)
+  +  Headers
+     Location: /discoverRequest/jobs/215
 
 + Response 400
 + Response 401

data/docs/apib/manage_request.apib

@@ -0,0 +1,359 @@
+FORMAT: 1A
+
+# XClarity Users
+
+# GET /manageRequest/jobs/4229
+
++ Response 200 (application/json)
+{
+ "progress": 100.0,
+ "results": [{
+  "result": "OTHER_FAIL",
+  "resultLongDescription": "An internal error occurred during the management process. Attempt the management operation again. If the problem persists, contact Support.",
+  "messageBundle": "com.lenovo.lxca.discovery.bundle.rest.messages",
+  "messageParameters": "10.240.72.172",
+  "resultShortDescription": "Other failure",
+  "progress": 100.0,
+  "messageID": "0509_LONG",
+  "uuid": "46920c143355486f97c19a34abc7d746",
+  "taskid": 4228,
+  "time_spent": 68026,
+  "status": {
+   "substatus": [{
+    "longDescription": "Starting endpoint management job",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1000_SHORT",
+    "progress": 100.0,
+    "started": true,
+    "id": "STARTING",
+    "shortDescription": "Starting",
+    "completed": true,
+    "status": {
+     "percentage": 100.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Complete"
+    }
+   }, {
+    "longDescription": "Choosing best network path to manage the endpoint",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1001_SHORT",
+    "progress": 100.0,
+    "started": true,
+    "id": "NETWORK_CHOICE",
+    "shortDescription": "Network choice",
+    "completed": true,
+    "status": {
+     "percentage": 100.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Complete"
+    }
+   }, {
+    "longDescription": "Creating hardware descriptor",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1002_SHORT",
+    "progress": 100.0,
+    "started": true,
+    "id": "DESCRIPTOR",
+    "shortDescription": "Descriptor",
+    "completed": true,
+    "status": {
+     "percentage": 100.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Complete"
+    }
+   }, {
+    "longDescription": "Logging in to endpoint",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1003_SHORT",
+    "progress": 100.0,
+    "started": true,
+    "id": "LOGIN",
+    "shortDescription": "Login",
+    "completed": true,
+    "status": {
+     "percentage": 100.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Complete"
+    }
+   }, {
+    "longDescription": "Checking for duplicates of endpoint management",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1004_SHORT",
+    "progress": 100.0,
+    "started": true,
+    "id": "DUPLICATE_CHECK",
+    "shortDescription": "Duplicate check",
+    "completed": true,
+    "status": {
+     "percentage": 100.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Complete"
+    }
+   }, {
+    "longDescription": "Collecting endpoint inventory",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1005_SHORT",
+    "progress": 0.0,
+    "started": false,
+    "id": "INVENTORY",
+    "shortDescription": "Inventory",
+    "completed": false,
+    "status": {
+     "substatus": [{
+      "longDescription": "Collecting chassis inventory",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1006_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "INV_CHASSIS",
+      "shortDescription": "Chassis inventory",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }, {
+      "longDescription": "Collecting node inventory",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1007_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "INV_NODES",
+      "shortDescription": "Node inventory",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }, {
+      "longDescription": "Collection I/O module inventory",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1008_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "INV_IOMS",
+      "shortDescription": "I/O module inventory",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }],
+     "percentage": 0.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Stopped_With_Error"
+    }
+   }, {
+    "longDescription": "Verifying endpoint interoperability",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1009_SHORT",
+    "progress": 0.0,
+    "started": false,
+    "id": "INTEROP_CHECK",
+    "shortDescription": "Interoperability check",
+    "completed": false,
+    "status": {
+     "percentage": 0.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Stopped_With_Error"
+    }
+   }, {
+    "longDescription": "Configuring endpoint for management",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1010_SHORT",
+    "progress": 0.0,
+    "started": false,
+    "id": "CONFIGURATION",
+    "shortDescription": "Configuration",
+    "completed": false,
+    "status": {
+     "substatus": [{
+      "longDescription": "Configuring NTP",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1011_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "CFG_NTP",
+      "shortDescription": "NTP",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }, {
+      "longDescription": "Updating DNS servers ip addresses on CMM as part of the manage chassis process.",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1067_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "CFG_DNS_UPD",
+      "shortDescription": "Updating DNS servers ip addresses on CMM",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }, {
+      "longDescription": "Configuring security",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1012_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "CFG_SECURITY",
+      "shortDescription": "Security",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }, {
+      "longDescription": "Putting endpoint under managed authentication",
+      "userAction": "",
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1013_SHORT",
+      "progress": 0.0,
+      "started": false,
+      "id": "CFG_CMGMT",
+      "shortDescription": "Managed authentication",
+      "completed": false,
+      "status": {
+       "percentage": 0.0,
+       "description": [{
+        "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+        "messageID": "1027_LONG"
+       }],
+       "state": "Stopped_With_Error"
+      }
+     }],
+     "percentage": 0.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Stopped_With_Error"
+    }
+   }, {
+    "longDescription": "Configuring Hardware location",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1097_SHORT",
+    "progress": 0.0,
+    "started": false,
+    "id": "CFG_CABINET",
+    "shortDescription": "Configuring Hardware location",
+    "completed": false,
+    "status": {
+     "percentage": 0.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Stopped_With_Error"
+    }
+   }, {
+    "longDescription": "Completing endpoint management job",
+    "userAction": "",
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1114_SHORT",
+    "progress": 0.0,
+    "started": true,
+    "id": "MANAGESTOP",
+    "shortDescription": "Completing",
+    "completed": false,
+    "status": {
+     "percentage": 0.0,
+     "description": [{
+      "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+      "messageID": "1027_LONG"
+     }],
+     "state": "Running"
+    }
+   }],
+   "percentage": 100.0,
+   "description": [{
+    "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
+    "messageID": "1027_LONG"
+   }],
+   "state": "Stopped_With_Error"
+  }
+ }],
+ "status": "INCOMPLETE"
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# POST /manageRequest
++ Request (application/json)
+
++ Response 200 (application/json)
+  + Headers
+    Location: /manageRequest/jobs/4229
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500

data/docs/apib/update_comp.apib

@@ -0,0 +1,426 @@
+FORMAT: 1A
+
+# XClarity UpdateComp
+
+# Components [/updatableComponents]
+
+## Retrieve [GET]
++ Response 200
+{
+   "DeviceList": [
+      {
+      "CMMList": [
+         {
+         "UpdateStatus": {
+            "JobID": 1,
+            "PercentComplete": 1,
+            "Phase": "Applying",
+            "StartTime": "2015-04-13 12:50:31.077",
+            "State": "InProgress",
+            "Status": "Active",
+            "TaskID": 1
+         },
+         "UUID": "6134AFCEA91311E199A5A45AC8953137"
+      }
+     ]
+   },
+   {
+      "ServerList": [
+         {
+         "UUID": "8BFBADCC33CB11E499F740F2E9903640",
+         "Components": [{
+            "Component": "System Prerequisites",
+            "UpdateStatus": {
+               "JobID": 1,
+               "PercentComplete": 0,
+               "Phase": "Queued",
+               "State": "Blocked",
+               "Status": "Queued",
+               "TaskID": 4
+            },
+            "Weight": 1
+         },
+         {
+            "Component": "ITE",
+            "UpdateStatus": {
+               "CurrentComponent": {
+                  "Component": "Queued"
+               },
+               "PercentComplete": 0,
+               "State": "NotStarted",
+               "Status": "Active",
+               "TotalComplete": 0,
+               "TotalComponents": 32
+            }
+         }
+       ]
+      },
+      {
+         "UUID": "0CDF130FDFC211E392806CAE8B704250",
+         "Components": [
+            {
+            "Component": "System Prerequisites",
+            "UpdateStatus": {
+               "JobID": 1,
+               "PercentComplete": 0,
+               "Phase": "Queued",
+               "State": "Blocked",
+               "Status": "Queued",
+               "TaskID": 64
+            },
+            "Weight": 1
+            
+         },
+         {
+            "Component": "ITE",
+            "UpdateStatus": {
+               "CurrentComponent": {
+                  "Component": "Queued"
+               },
+               "PercentComplete": 0,
+               "State": "NotStarted",
+               "Status": "Active",
+               "TotalComplete": 0,
+               "TotalComponents": 30
+            }
+         }
+        ]
+      }
+     ]
+   },
+   {
+      "SwitchList": [
+         {
+         "ReadinessCheck": {
+            "ElapsedTime": "00:00:00:01.509",
+            "ElapsedTimeFormatted": "1 second 509 milliseconds",
+            "EndTime": "2016-04-07 23:44:10.366",
+            "JobID": 1,
+            "PercentComplete": 100,
+            "Phase": "Complete",
+            "StartTime": "2016-04-07 23:44:08.857",
+            "State": "Complete",
+            "Status": "Failed",
+            "TaskID": 1,
+            "Message": {
+               "result": "informational",
+               "messages": [
+                {
+                  "id": "FQXHMUP1000I",
+                  "text": "The command completed successfully."
+               },
+               {
+                  "id": "FQXHMUP4545L",
+                  "text": "The device is not ready for an update.",
+                  "explanation": "The device did not pass validation for firmware updates..",
+                  "recovery": {
+                     "text": "Correct the issues discovered by validation checks."
+                  }
+               }
+             ]
+            }
+         },
+         "UpdateStatus": {
+            "EndTime": "2016-04-07 23:44:10.869",
+            "JobID": 1,
+            "PercentComplete": 100,
+            "Phase": "Complete",
+            "State": "Complete",
+            "Status": "Canceled",
+            "TaskID": 3,
+            "Message": {
+               "result": "warning",
+               "messages": [
+                  {
+                  "id": "FQXHMUP4086F",
+                  "text": "The RackSwitch G7052 xHMCUpdates task was canceled.",
+                  "explanation": "The task was canceled", 
+                  "recovery": {
+                     "text": "Try to perform the update again.If the problem persists"
+                  }
+               }
+              ]
+            }
+         },
+         "UUID": "0b0f5101bb8844b8b2d1c1aaeb24f446"
+      }
+     ]
+   }
+  ],
+   "UpdateStatusMetrics": {
+      "TotaldeviceUpdates": 6,
+      "TotaldeviceUpdatesActive": 6,
+      "TotaldeviceUpdatesComplete": 0,
+      "TotaldeviceUpdatesInProgress": 1,
+      "TotalJobs": 1,
+      "TotalJobsComplete": 0,
+      "TotalJobsInProgress": 1,
+      "TotalJobsPercentComplete": 0,
+      "TotalSupportTasks": 18,
+      "TotalSupportTasksActive": 18,
+      "TotalTasks": 93,
+      "TotalTasksBlocked": 92,
+      "TotalTasksCanceled": 0,
+      "TotalTasksComplete": 0,
+      "TotalTasksFailed": 0,
+      "TotalTasksInProgress": 1,
+      "TotalTasksSuccess": 0,
+      "TotalUpdateTasks": 75,
+      "TotalUpdateTasksActive": 72
+   },
+   "result": "informational",
+   "messages": [
+     {
+      "id": "FQXHMUP4091I",
+      "text": "Update Status was obtained successfully."
+   }
+  ]
+}
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# Components [/updatableComponents?action=getComponents]
+
+## Retrieve [GET]
++ Response 200
+{
+   "DeviceList": [
+      {
+      "CMMList": [
+         {
+         "UpdateStatus": {
+            "JobID": 1,
+            "PercentComplete": 1,
+            "Phase": "Applying",
+            "StartTime": "2015-04-13 12:50:31.077",
+            "State": "InProgress",
+            "Status": "Active",
+            "TaskID": 1
+         },
+         "UUID": "6134AFCEA91311E199A5A45AC8953137"
+      }
+     ]
+   },
+   {
+      "ServerList": [
+         {
+         "UUID": "8BFBADCC33CB11E499F740F2E9903640",
+         "Components": [
+            {
+            "Component": "System Prerequisites",
+            "UpdateStatus": {
+               "JobID": 1,
+               "PercentComplete": 0,
+               "Phase": "Queued",
+               "State": "Blocked",
+               "Status": "Queued",
+               "TaskID": 4
+            },
+            "Weight": 1
+         },
+         {
+            "Component": "ITE",
+            "UpdateStatus": {
+               "CurrentComponent": {
+                  "Component": "Queued"
+               },
+               "PercentComplete": 0,
+               "State": "NotStarted",
+               "Status": "Active",
+               "TotalComplete": 0,
+               "TotalComponents": 32
+            }
+         }
+        ]
+      },
+      {
+         "UUID": "0CDF130FDFC211E392806CAE8B704250",
+         "Components": [
+            {
+            "Component": "System Prerequisites",
+            "UpdateStatus": {
+               "JobID": 1,
+               "PercentComplete": 0,
+               "Phase": "Queued",
+               "State": "Blocked",
+               "Status": "Queued",
+               "TaskID": 64
+            },
+            "Weight": 1
+            
+         },
+         {
+            "Component": "ITE",
+            "UpdateStatus": {
+               "CurrentComponent": {
+                  "Component": "Queued"
+               },
+               "PercentComplete": 0,
+               "State": "NotStarted",
+               "Status": "Active",
+               "TotalComplete": 0,
+               "TotalComponents": 30
+            }
+         }
+        ]
+      }
+     ]
+   },
+   {
+      "SwitchList": [
+         {
+         "ReadinessCheck": {
+            "ElapsedTime": "00:00:00:01.509",
+            "ElapsedTimeFormatted": "1 second 509 milliseconds",
+            "EndTime": "2016-04-07 23:44:10.366",
+            "JobID": 1,
+            "PercentComplete": 100,
+            "Phase": "Complete",
+            "StartTime": "2016-04-07 23:44:08.857",
+            "State": "Complete",
+            "Status": "Failed",
+            "TaskID": 1,
+            "Message": {
+               "result": "informational",
+               "messages": [
+                  {
+                  "id": "FQXHMUP1000I",
+                  "text": "The command completed successfully."
+               },
+               {
+                  "id": "FQXHMUP4545L",
+                  "text": "The device is not ready for an update.",
+                  "explanation": "The device did not pass validation for firmware updates..",
+                  "recovery": {
+                     "text": "Correct the issues discovered by validation checks."
+                  }
+               }
+              ]
+            }
+         },
+         "UpdateStatus": {
+            "EndTime": "2016-04-07 23:44:10.869",
+            "JobID": 1,
+            "PercentComplete": 100,
+            "Phase": "Complete",
+            "State": "Complete",
+            "Status": "Canceled",
+            "TaskID": 3,
+            "Message": {
+               "result": "warning",
+               "messages": [
+                  {
+                  "id": "FQXHMUP4086F",
+                  "text": "The RackSwitch G7052 xHMCUpdates task was canceled.",
+                  "explanation": "The task was canceled",
+                  "recovery": {
+                     "text": "Try to perform the update again"
+                  }
+               }
+              ]
+            }
+         },
+         "UUID": "0b0f5101bb8844b8b2d1c1aaeb24f446"
+      }
+     ]
+   }
+  ],
+   "UpdateStatusMetrics": {
+      "TotaldeviceUpdates": 6,
+      "TotaldeviceUpdatesActive": 6,
+      "TotaldeviceUpdatesComplete": 0,
+      "TotaldeviceUpdatesInProgress": 1,
+      "TotalJobs": 1,
+      "TotalJobsComplete": 0,
+      "TotalJobsInProgress": 1,
+      "TotalJobsPercentComplete": 0,
+      "TotalSupportTasks": 18,
+      "TotalSupportTasksActive": 18,
+      "TotalTasks": 93,
+      "TotalTasksBlocked": 92,
+      "TotalTasksCanceled": 0,
+      "TotalTasksComplete": 0,
+      "TotalTasksFailed": 0,
+      "TotalTasksInProgress": 1,
+      "TotalTasksSuccess": 0,
+      "TotalUpdateTasks": 75,
+      "TotalUpdateTasksActive": 72
+   },
+   "result": "informational",
+   "messages": [
+     {
+      "id": "FQXHMUP4091I",
+      "text": "Update Status was obtained successfully."
+   }
+  ]
+}
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
+# Components [/updatableComponents{?action,activationMode,onErrorMode,forceUpdateMode}]
+
++ Parameters
+  + action - The action to take. This can be one of the following values - apply, cancelApply, powerState
+  + activationMode - Indicates when to activate the update. This can be one of the following values - immediate, delayed
+  + forceUpdateMode - Indicates whether to apply the update if firmware is already compliant. This can be one of the following values - true, false
+  + onErrorMode - Indicates how to handle errors during the firmware update. This can be one of the following values - stopOnError, stopdeviceOnError, continueOnError
+
+## Apply [PUT]
++ Request (application/json)
+{   
+   "DeviceList": [
+     {
+      "ServerList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_storage_1.1.1","Component": "Controller a"}]}]
+     },
+     {
+      "SwitchList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_scsw_en4093r-8.3.9.0_anyons_noarch","Component": "Main application"}]}]
+     },
+     {
+      "StorageList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_storage_1.1.1","Component": "Controller a"}]}]
+     },
+     {
+      "CMMList":[{"UUID": "8BFBADCC33CB11E499F740F2E9903640","Components": [{"Fixid": "lnvgy_fw_storage_1.1.1","Component": "Controller a"}]
+     }
+   ]
+} 
+
++ Response 200
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500
+
++ Request (application/json)
+{
+   "DeviceList": [
+     {
+      "ServerList":[{"PowerState": "reset","UUID": "8BFBADCC33CB11E499F740F2E9972457"}]
+     },
+     {
+      "SwitchList":[{"PowerState": "powerOn","UUID": "8BFBADCC33CB11E499F740F2E9972458"}]
+     },
+     {
+      "StorageList":[{"PowerState": "powerCycleSoft","UUID": "8BFBADCC33CB11E499F740F2E9972457"}]
+     },
+     {
+      "CMMList":[{"PowerState": "reset","UUID": "8BFBADCC33CB11E499F740F2E213123"}]
+     }
+   ]
+}
+
++ Response 200
+
++ Response 400
++ Response 401
++ Response 404
++ Response 409
++ Response 500

data/docs/apib/update_repo.apib

@@ -1547,60 +1547,3 @@ FORMAT: 1A
 + Response 404
 + Response 409
 + Response 500
-
-# XClarity Update Repositories [/updatableComponents{?action,with,filetypes}]
-
-+ Parameters
-  + action - The action to take. This can be one of the following values - read, refresh, acquire, delete, export
-  + with - The scope of the action. This can be one of the following values - all, latest, payloads
-  + filetypes - When action=delete or action=export is specified, this parameter is used. Value can be set to payloads
-
-## Update Repo [PUT]
-+ Request (application/json)
-{
-   "mt": [
-      "7167"
-   ],
-   "os": "",
-   "type": "catalog"
-}
-+ Response 200
-
-+ Response 400
-+ Response 401
-+ Response 404
-+ Response 409
-+ Response 500
-
-+ Request (application/json)
-{
-   "fixids": [
-      "brcd_fw_bcsw_nos5.0.1_anyos_noarch",
-      "brcd_fw_cna_3.2.4.0_linux_32-64",
-      "brcd_fw_cna_3.2.3.0_linux_32-64",
-      "lenovo_fw_dsa_dsyte2f-9.61_anyos_32-64"
-   ],
-   "mt": "0000",
-   "type": "latest"
-}
-+ Response 200
-
-+ Response 400
-+ Response 401
-+ Response 404
-+ Response 409
-+ Response 500
-
-+ Request (application/json)
-{
-   "fixids": [
-      "lnvgy_fw_cmm_1aon01k-1.0.0k_anyos_noarch"
-   ]
-}
-+ Response 200
-
-+ Response 400
-+ Response 401
-+ Response 404
-+ Response 409
-+ Response 500

data/lib/xclarity_client/client.rb

@@ -31,7 +31,9 @@ module XClarityClient
     include XClarityClient::Mixins::StorageMixin
     include XClarityClient::Mixins::SwitchMixin
     include XClarityClient::Mixins::UnmanageRequestMixin
+    include XClarityClient::Mixins::ManageRequestMixin
     include XClarityClient::Mixins::UpdateRepoMixin
+    include XClarityClient::Mixins::UpdateCompMixin
     include XClarityClient::Mixins::UserMixin
 
     def initialize(config)

data/lib/xclarity_client/endpoints/endpoints.rb

@@ -26,7 +26,9 @@ require 'xclarity_client/endpoints/scalable_complex'
 require 'xclarity_client/endpoints/switch'
 require 'xclarity_client/endpoints/storage'
 require 'xclarity_client/endpoints/unmanage_request'
+require 'xclarity_client/endpoints/manage_request'
 require 'xclarity_client/endpoints/update_repo'
+require 'xclarity_client/endpoints/update_comp'
 require 'xclarity_client/endpoints/user'
 require 'xclarity_client/endpoints/remote_access'
 require 'xclarity_client/endpoints/globalsettings'

data/lib/xclarity_client/endpoints/manage_request.rb

@@ -0,0 +1,11 @@
+module XClarityClient
+  # ManageRequest class
+  class ManageRequest < Endpoints::XclarityEndpoint
+    BASE_URI = '/manageRequest'.freeze
+    LIST_NAME = 'manageRequestList'.freeze
+
+    attr_accessor :progress, :results, :messageBundle, :messageID,
+                  :messageParameters, :result, :resultLongDescription,
+                  :resultShortDescription, :status, :taskid, :time_spent, :uuid
+  end
+end

data/lib/xclarity_client/endpoints/update_comp.rb

@@ -0,0 +1,18 @@
+module XClarityClient
+  # update component class
+  class UpdateComp < Endpoints::XclarityEndpoint
+    BASE_URI = '/updatableComponents'.freeze
+    LIST_NAME = 'updateCompList'.freeze
+
+    attr_accessor :DeviceList, :CMMList, :ServerList, :StorageList, :SwitchList,
+                  :UpdateStatusMetrics, :TotaldeviceUpdates,
+                  :TotaldeviceUpdatesActive, :TotaldeviceUpdatesComplete,
+                  :TotaldeviceUpdatesInProgress, :TotalJobs, :TotalJobsComplete,
+                  :TotalJobsInProgress, :TotalJobsPercentComplete,
+                  :TotalSupportTasks, :TotalSupportTasksActive, :TotalTasks,
+                  :TotalTasksBlocked, :TotalTasksCanceled, :TotalTasksComplete,
+                  :TotalTasksFailed, :TotalTasksInProgress, :TotalTasksSuccess,
+                  :TotalUpdateTasksActive, :TotalUpdateTasks, :result,
+                  :messages, :id, :text
+  end
+end

data/lib/xclarity_client/mixins/manage_request_mixin.rb

@@ -0,0 +1,54 @@
+module XClarityClient
+  #
+  # Exposes ManageRequestManagement features
+  #
+  module Mixins::ManageRequestMixin
+    def fetch_manage_request(job_id)
+      ManageRequestManagement.new(@config).fetch_manage_request(job_id)
+    end
+
+    def get_job_progress(dji, discovery_job_progress)
+      discovery_result = DiscoverRequestManagement.new(@config)\
+                                                  .monitor_discover_request(dji)
+      discovery_result.map do |req|
+        req.instance_variables.each do |attr|
+          value = req.instance_variable_get(attr)
+          discovery_job_progress = value if attr.id2name.eql?('@progress')
+        end
+      end
+      { :discovery_job_progress => discovery_job_progress,
+        :discovery_result       => discovery_result }
+    end
+
+    def get_discovery_result(discovery_job_id)
+      discovery_job_id = discovery_job_id[:location].split('/')[3]
+      discovery_job_progress = 0
+      return false if discovery_job_id.nil?
+      while discovery_job_progress < 100
+        sleep 30
+        opts = get_job_progress(discovery_job_id, discovery_job_progress)
+        discovery_job_progress = opts[:discovery_job_progress]
+      end
+      opts[:discovery_result]
+    end
+
+    def update_manage_request(manage_request, force, discovery_result)
+      ManageRequestManagement.new(@config)\
+                             .update_manage_request(manage_request,
+                                                    force,
+                                                    discovery_result)
+    end
+
+    def manage_discovered_devices(manage_request, force)
+      discovery_job_id = DiscoverRequestManagement.new(@config)\
+                                                  .discover_manageable_devices(
+                                                    manage_request[:ip_address]
+                                                  )
+      d_res = get_discovery_result(discovery_job_id)
+      raise 'manageable device Discovery failed' unless d_res
+      update_manage_request(manage_request, force, d_res)
+      ManageRequestManagement.new(@config)\
+                             .manage_discovered_devices(manage_request)
+    end
+  end
+end

data/lib/xclarity_client/mixins/mixins.rb

@@ -34,5 +34,7 @@ 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/manage_request_mixin'
 require 'xclarity_client/mixins/update_repo_mixin'
+require 'xclarity_client/mixins/update_comp_mixin'
 require 'xclarity_client/mixins/user_mixin'

data/lib/xclarity_client/mixins/update_comp_mixin.rb

@@ -0,0 +1,37 @@
+module XClarityClient
+  #
+  # Exposes UpdateCompManagement features
+  #
+  module Mixins::UpdateCompMixin
+    def discover_firmware_update_status
+      UpdateCompManagement.new(@config).fetch_all
+    end
+
+    def discover_updatable_device_comp
+      UpdateCompManagement.new(@config).updatable_device_comp
+    end
+
+    def apply_firmware_update(opts, activation_mode = nil,
+                              force_update_mode = nil, onerror_mode = nil)
+      UpdateCompManagement.new(@config).apply_firmware_update(opts,
+                                                              activation_mode,
+                                                              force_update_mode,
+                                                              onerror_mode)
+    end
+
+    def cancel_firmware_update(server = nil, switch = nil, storage = nil,
+                               cmm = nil)
+      UpdateCompManagement.new(@config).cancel_firmware_update(server,
+                                                               switch,
+                                                               storage,
+                                                               cmm)
+    end
+
+    def modify_power_state(server = nil, switch = nil, storage = nil, cmm = nil)
+      UpdateCompManagement.new(@config).modify_power_state(server,
+                                                           switch,
+                                                           storage,
+                                                           cmm)
+    end
+  end
+end

data/lib/xclarity_client/services/manage_request_management.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+module XClarityClient
+  # manage request management class
+  class ManageRequestManagement < Services::XClarityService
+    manages_endpoint ManageRequest
+
+    def manage_discovered_devices(manage_request)
+      @connection.do_post(ManageRequest::BASE_URI,
+                          JSON.generate([manage_request]))
+    end
+
+    def populate_manage_req_with_security_descriptor(manage_request, val)
+      security_descriptor = {}
+      val = val['securityDescriptor']
+      security_descriptor[:managedAuthEnabled] = val['managedAuthSupported']
+      security_descriptor[:managedAuthSupported] = val['managedAuthSupported']
+      res = security_descriptor[:managedAuthEnabled]
+      security_descriptor[:storedCredentials] = val['storedCredentials'] if res
+      manage_request[:securityDescriptor] = security_descriptor
+    end
+
+    def parse_manage_request(manage_request, val)
+      return false unless val.kind_of?(Array) && !val.empty?
+      manage_request[:managementPorts] = val[0]['managementPorts']
+      manage_request[:type] = val[0]['type']
+      manage_request[:uuid] = val[0]['uuid']
+      discovery_ip_addr = val[0]['ipAddresses'][0]
+      manage_request[:ipAddresses] = [discovery_ip_addr]
+      manage_request[:os] = val[0]['os'] if val[0]['type'] == 'Rackswitch'
+      populate_manage_req_with_security_descriptor(manage_request, val[0])
+    end
+
+    def populate_manage_request_with_discovery_res(discovery_result,
+                                                   manage_request)
+      discovery_result.map do |req|
+        req.instance_variables.each do |attr|
+          val = req.instance_variable_get(attr)
+          parse_manage_request(manage_request, val)
+        end
+      end
+    end
+
+    def update_manage_request(manage_request, force, discovery_result)
+      populate_manage_request_with_discovery_res(discovery_result,
+                                                 manage_request)
+      manage_request[:forceManage] = true if force.casecmp('true')
+    end
+
+    def fetch_manage_request(job_id)
+      response = @connection.do_get(ManageRequest::BASE_URI + '/jobs/' + job_id)
+      return [] unless response.success?
+      body = JSON.parse(response.body)
+      body = { ManageRequest::LIST_NAME => body } if body.kind_of?(Array)
+      mrql = ManageRequest::LIST_NAME
+      body = { ManageRequest::LIST_NAME => [body] } unless body.key?(mrql)
+      body[ManageRequest::LIST_NAME].map do |resource_params|
+        ManageRequest.new(resource_params)
+      end
+    end
+  end
+end

data/lib/xclarity_client/services/services.rb

@@ -34,6 +34,8 @@ require 'xclarity_client/services/scalable_complex_management'
 require 'xclarity_client/services/switch_management'
 require 'xclarity_client/services/storage_management'
 require 'xclarity_client/services/unmanage_request_management'
+require 'xclarity_client/services/manage_request_management'
 require 'xclarity_client/services/update_repo_management'
+require 'xclarity_client/services/update_comp_management'
 require 'xclarity_client/services/user_management'
 require 'xclarity_client/services/virtual_appliance_management'

data/lib/xclarity_client/services/update_comp_management.rb

@@ -0,0 +1,111 @@
+require 'json'
+
+module XClarityClient
+  # update component management class
+  class UpdateCompManagement < Services::XClarityService
+    manages_endpoint UpdateComp
+
+    def updatable_device_comp
+      response = @connection.do_get(UpdateComp::BASE_URI\
+                                    + '?action=getComponents')
+      return [] unless response.success?
+      body = JSON.parse(response.body)
+      body = { UpdateComp::LIST_NAME => body } if body.kind_of?(Array)
+      j = body.key?(UpdateComp::LIST_NAME)
+      body = { UpdateComp::LIST_NAME => [body] } unless j
+      body[UpdateComp::LIST_NAME].map do |resource_params|
+        UpdateComp.new(resource_params)
+      end
+    end
+
+    def apply_firmware_update(opts, activation_mode, force_update_mode,
+                              onerror_mode)
+      validate_arguments(activation_mode, force_update_mode, onerror_mode)
+
+      uri = create_uri(activation_mode, force_update_mode, onerror_mode)
+
+      apply_req = create_req_json(opts['server'], opts['switch'],
+                                  opts['storage'], opts['cmm'])
+      response = @connection.do_put(UpdateComp::BASE_URI + '?action=apply'\
+                                    + uri, apply_req)
+      response.body
+    end
+
+    def cancel_firmware_update(server, switch, storage, cmm)
+      cancel_req = create_req_json(server, switch, storage, cmm)
+      response = @connection.do_put(UpdateComp::BASE_URI\
+                                    + '?action=cancelApply',
+                                    cancel_req)
+      response.body
+    end
+
+    def modify_power_state(server, switch, storage, cmm)
+      power_state_req = create_req_json(server, switch, storage, cmm)
+      response = @connection.do_put(UpdateComp::BASE_URI + '?action=powerState',
+                                    power_state_req)
+      response.body
+    end
+
+    def validate_activation_mode(activation_mode)
+      if !activation_mode.nil? && !activation_mode.casecmp('immediate').zero? &&
+         !activation_mode.casecmp('delayed').zero?
+
+        raise 'Invalid argument specified. Operation apply_firmware_update'\
+               + ' can have activationMode as either immediare or delayed.'
+      end
+    end
+
+    def validate_forceupdate_mode(forceupdate_mode)
+      if !forceupdate_mode.nil? && !forceupdate_mode.casecmp('true').zero? &&
+         !forceupdate_mode.casecmp('false').zero?
+
+        raise 'Invalid argument specified. Value for forceUpdateMode on'\
+              + ' operation apply_firmware_update should have a value'\
+              + ' of either true or false'
+      end
+    end
+
+    def validate_onerror_mode(onerror_mode)
+      if !onerror_mode.nil? && !onerror_mode.eql?('stopOnError') &&
+         !onerror_mode.eql?('stopdeviceOnError') &&
+         !onerror_mode.eql?('continueOnError')
+
+        raise 'Invalid argument specified. Operation apply_firmware_update'\
+              + " should have onErrorMode as : 'stopOnError' or"\
+              + " 'stopdeviceOnError' or 'continueOnError'"
+      end
+    end
+
+    def validate_arguments(activation_mode, forceupdate_mode, onerror_mode)
+      validate_activation_mode(activation_mode)
+      validate_forceupdate_mode(forceupdate_mode)
+      validate_onerror_mode(onerror_mode)
+    end
+
+    # splitted create_uri just to fix codeclimate error
+    def add_uri(force_update_mode, onerror_mode, uri)
+      fmode = force_update_mode.nil?
+      uri += '&forceUpdateMode=' + force_update_mode unless fmode
+      uri += '&onErrorMode=' + onerror_mode unless onerror_mode.nil?
+      uri
+    end
+
+    def create_uri(activation_mode, force_update_mode, onerror_mode)
+      uri = ''
+      amode = activation_mode.nil?
+      uri += '&activationMode=' + activation_mode unless amode
+      add_uri(force_update_mode, onerror_mode, uri)
+    end
+
+    def create_req_json(server, switch, storage, cmm)
+      server_json = JSON.generate(:ServerList => server)
+      switch_json = JSON.generate(:SwitchList => switch)
+      storage_json = JSON.generate(:StorageList => storage)
+      cmm_json = JSON.generate(:CMMList => cmm)
+
+      req_json = "{\"DeviceList\": [#{server_json},#{switch_json},"\
+                 + "#{storage_json},#{cmm_json}]}"
+      req_json
+    end
+  end
+end

data/lib/xclarity_client/version.rb

@@ -1,3 +1,3 @@
 module XClarityClient
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xclarity_client
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Manasa Rao
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,6 +204,7 @@ files:
 - docs/apib/fan_muxes.apib
 - docs/apib/ffdc.apib
 - docs/apib/jobs.apib
+- docs/apib/manage_request.apib
 - docs/apib/node.apib
 - docs/apib/node_bmc.apib
 - docs/apib/persisted_result.apib
@@ -213,6 +214,7 @@ files:
 - docs/apib/storages.apib
 - docs/apib/switches.apib
 - docs/apib/unmanage_request.apib
+- docs/apib/update_comp.apib
 - docs/apib/update_repo.apib
 - docs/apib/users.apib
 - example/simple.rb
@@ -242,6 +244,7 @@ files:
 - lib/xclarity_client/endpoints/globalsettings.rb
 - lib/xclarity_client/endpoints/hostplatform.rb
 - lib/xclarity_client/endpoints/job.rb
+- lib/xclarity_client/endpoints/manage_request.rb
 - lib/xclarity_client/endpoints/node.rb
 - lib/xclarity_client/endpoints/osimage.rb
 - lib/xclarity_client/endpoints/persisted_result.rb
@@ -252,6 +255,7 @@ files:
 - lib/xclarity_client/endpoints/storage.rb
 - lib/xclarity_client/endpoints/switch.rb
 - lib/xclarity_client/endpoints/unmanage_request.rb
+- lib/xclarity_client/endpoints/update_comp.rb
 - lib/xclarity_client/endpoints/update_repo.rb
 - lib/xclarity_client/endpoints/user.rb
 - lib/xclarity_client/endpoints/xclarity_endpoint.rb
@@ -279,6 +283,7 @@ files:
 - lib/xclarity_client/mixins/global_setting_mixin.rb
 - lib/xclarity_client/mixins/host_platform_mixin.rb
 - lib/xclarity_client/mixins/job_mixin.rb
+- lib/xclarity_client/mixins/manage_request_mixin.rb
 - lib/xclarity_client/mixins/mixins.rb
 - lib/xclarity_client/mixins/node_mixin.rb
 - lib/xclarity_client/mixins/os_image_mixin.rb
@@ -290,6 +295,7 @@ files:
 - lib/xclarity_client/mixins/storage_mixin.rb
 - lib/xclarity_client/mixins/switch_mixin.rb
 - lib/xclarity_client/mixins/unmanage_request_mixin.rb
+- lib/xclarity_client/mixins/update_comp_mixin.rb
 - lib/xclarity_client/mixins/update_repo_mixin.rb
 - lib/xclarity_client/mixins/user_mixin.rb
 - lib/xclarity_client/schemas.rb
@@ -311,6 +317,7 @@ files:
 - lib/xclarity_client/services/globalsettings_management.rb
 - lib/xclarity_client/services/hostplatform_management.rb
 - lib/xclarity_client/services/job_management.rb
+- lib/xclarity_client/services/manage_request_management.rb
 - lib/xclarity_client/services/mixins/endpoint_manager_mixin.rb
 - lib/xclarity_client/services/mixins/list_name_interpreter_mixin.rb
 - lib/xclarity_client/services/mixins/power_action_sender_mixin.rb
@@ -326,6 +333,7 @@ files:
 - lib/xclarity_client/services/storage_management.rb
 - lib/xclarity_client/services/switch_management.rb
 - lib/xclarity_client/services/unmanage_request_management.rb
+- lib/xclarity_client/services/update_comp_management.rb
 - lib/xclarity_client/services/update_repo_management.rb
 - lib/xclarity_client/services/user_management.rb
 - lib/xclarity_client/services/virtual_appliance_management.rb