upload HPE scripts

example_jupyter_notebooks/Reset Ilo/reset_ilo.ipynb

@@ -0,0 +1,267 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "e2d7d850",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "# Resetting the Manager"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "88f096f8",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-info\" style=\"border-radius: 20px;\">\n",
+    "<i>Hello there.!<br></i> Welcome to <b>python-iLOrest-library</b> <br> Here is an example to <b>Resetting the Manager</b> <br> As you are here let's get it done easily.<br>\n",
+    "    To perform this u need to have <a href = \"https://libraries.io/pypi/python-ilorest-library#id3\" style = \"none\">python-ilorest-library</a> installed in your machine.<br>\n",
+    "    And please keep your username and password handy!\n",
+    "    <br>\n",
+    "    <b>Also do execute each successive cell once to avoid any errors!</b>\n",
+    "    \n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d1525f25",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "<div class=\"alert alert-block alert-success\" style=\"border-radius: 20px;\">\n",
+    "    <h1> 1.</h1>\n",
+    "Below we are importing all the necessary modules from the ilorest library!.<br>\n",
+    "    <li><a href = \"https://www.tutorialspoint.com/what-is-python-s-sys-module#:~:text=%20What%20is%20Python%27s%20Sys%20Module%20%201,%5B0%5D%20prints%20the...%205%20Output.%20%20More%20\">sys </a>\n",
+    "    </li>\n",
+    "    <li>json </li>\n",
+    "    <li> redfish </li>\n",
+    "    <li>ServerDownOrUnreachableError</li>\n",
+    "    <li>get_resource_directory</li>\n",
+    "        \n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "8ce9142d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sys\n",
+    "import json\n",
+    "from redfish import RedfishClient\n",
+    "from redfish.rest.v1 import ServerDownOrUnreachableError\n",
+    "from get_resource_directory import get_resource_directory"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b9615aea",
+   "metadata": {},
+   "source": [
+    "<div class = \"alert alert-block alert-success\" style=\"border-radius: 20px;\">\n",
+    "    <h1> 2. </h1>This is our clear_ahs_data to function overview, in the end this will clear ahs data.<br>\n",
+    "    <i>Let me give you a walk through of it!</i>\n",
+    "    <br>\n",
+    " There is a hierarchy involved in iLO Rest Api. So we are simply following the hierarchy present to change the settings.<br>\n",
+    "\n",
+    "1. In the <b>resetting a manager</b> function we are first using <b>resource_instances</b> variable to obtain information about the resource directory by using get_resource_directory module.\n",
+    "<br>\n",
+    "    \n",
+    "2. If the resource instance is not empty then the code fetches <b>information about a manager</b> from a collection of \"Managers\" resources on a target system, using a Redfish client object. It retrieves the first member's URI, and then gets more details about that specific member.\n",
+    "    <br>\n",
+    "\n",
+    "3. Else i.e; then iterates through a collection of Redfish resource instances and checks if the type of each instance is <b>#Manager</b>. If it is, the code retrieves more information about that specific instance using the Redfish client object <b>_redfishobj</b>.\n",
+    "    <br>\n",
+    "\n",
+    "4. If manager_members_respone is ture then it retrieves the URI for the <b>Reset</b> action on a specific Redfish manager using the <b>managers_members_response</b> variable, and then creates a request body containing the <b>Action</b> key with the value <b>Manager.Reset</b>. Finally, it sends a <i>POST</i>request to the retrieved URI using the Redfish client object <b>_redfishobj</b> to initiate a reset operation on the target system.\n",
+    "    <br>\n",
+    " 5.Next is to check the status of the response received from the previous <b>POST</b> request sent using the Redfish client object <b>_redfishobj</b>.\n",
+    "    <br>\n",
+    "        1.If the status is 400, it attempts to print the extended error message associated with the response.\n",
+    "    <br>\n",
+    "        2.If the response status is not 400 and not 200, an error message is printed to the standard error stream.\n",
+    "    <br>\n",
+    "        3.If the response status is 200, it indicates that the reset operation was successful. The code then prints           a success message and prints the JSON response received from the server in a formatted way.\n",
+    "    <br>\n",
+    "\n",
+    " </div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "16042277",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def reset_ilo(_redfishobj, DISABLE_RESOURCE_DIR):\n",
+    "\n",
+    "    managers_members_response = None\n",
+    "    \n",
+    "    #function get_resource_directory returns Redfish resource instances from client object.\n",
+    "    resource_instances = get_resource_directory(_redfishobj)\n",
+    "    #checking target resource is empty are not \n",
+    "    if DISABLE_RESOURCE_DIR or not resource_instances:\n",
+    "        #if we do not have a resource directory or want to force it's non use to find the\n",
+    "        #relevant URI\n",
+    "        managers_uri = _redfishobj.root.obj['Managers']['@odata.id']\n",
+    "        managers_response = _redfishobj.get(managers_uri)\n",
+    "        managers_members_uri = next(iter(managers_response.obj['Members']))['@odata.id']\n",
+    "        managers_members_response = _redfishobj.get(managers_members_uri)\n",
+    "    else:\n",
+    "        #Use Resource directory to find the relevant URI\n",
+    "        for instance in resource_instances:\n",
+    "            if '#Manager.' in instance['@odata.type']:\n",
+    "                managers_members_uri = instance['@odata.id']\n",
+    "                managers_members_response = _redfishobj.get(managers_members_uri)\n",
+    "   #checking the managers_members_response true or not\n",
+    "    if managers_members_response:\n",
+    "        reset_ilo_uri = managers_members_response.obj['Actions']['#Manager.Reset']['target']\n",
+    "        body = {'Action': 'Manager.Reset'}\n",
+    "        resp = _redfishobj.post(reset_ilo_uri, body)\n",
+    "\n",
+    "    #If iLO responds with soemthing outside of 200 or 201 then lets check the iLO extended info\n",
+    "    #error message to see what went wrong\n",
+    "    if resp.status == 400:\n",
+    "        try:\n",
+    "            print(json.dumps(resp.obj['error']['@Message.ExtendedInfo'], indent=4, sort_keys=True))\n",
+    "        except Exception as excp:\n",
+    "            sys.stderr.write(\"A response error occurred, unable to access iLO Extended Message \"\\\n",
+    "                             \"Info...\")\n",
+    "    elif resp.status != 200:\n",
+    "        sys.stderr.write(\"An http response of \\'%s\\' was returned.\\n\" % resp.status)\n",
+    "    else:\n",
+    "        print(\"Success!\\n\")\n",
+    "        print(json.dumps(resp.dict, indent=4, sort_keys=True))\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6e7543eb",
+   "metadata": {},
+   "source": [
+    "<div class = \"alert alert-block alert-success\" style=\"border-radius: 20px;\">\n",
+    "    <h1> 3. </h1>This is Main function overview.<br>\n",
+    "    <i>Let me give you a walk through of it!</i>\n",
+    "    <br>\n",
+    " There is a hierarchy involved in iLO Rest Api. So we are simply following the hierarchy present to change the settings.<br>\n",
+    "\n",
+    "1. The rest opertions are handled by redfish object which is created by RedfishClient<br>\n",
+    "<br>\n",
+    "    \n",
+    "2. <b>RedfishClient</b> class takes 3 parameters<i> iLO url, Username,Password</i> and returns a redfish object.<br>\n",
+    "    <br>\n",
+    "\n",
+    "3. Once you enter everything a redfish obejct is created with the help of RedfishClient class.<br>\n",
+    "    <br>\n",
+    "\n",
+    "4. ow we try to Login with the help of <i> REDFISHOBJ</i>, if it is successful a session is created and you are logged in, But if           Server       is not avaialbe we get an error saying \"server unreachable\"<br>\n",
+    "    <br>\n",
+    "5. Then we call <b>reset_ilo</b>function with two parameters <i> redfish object,DISABLE_RESOURCE_DIR</i>  with our redfish object and rest the settings to default.\n",
+    "    <br>\n",
+    "    \n",
+    "\n",
+    "6. REDFISHOBJ.logout() will take care of logging you out of the ilo.\n",
+    "\n",
+    " </div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "270f99bf",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if __name__ == \"__main__\":\n",
+    "    # When running on the server locally use the following commented values\n",
+    "    #SYSTEM_URL = None\n",
+    "    #LOGIN_ACCOUNT = None\n",
+    "    #LOGIN_PASSWORD = None\n",
+    "\n",
+    "    # When running remotely connect using the secured (https://) address,\n",
+    "    # account name, and password to send https requests\n",
+    "    # SYSTEM_URL acceptable examples:\n",
+    "    # \"https://10.0.0.100\"\n",
+    "    # \"https://ilo.hostname\"\n",
+    "    SYSTEM_URL = \"https://10.0.0.100\"\n",
+    "    LOGIN_ACCOUNT = \"admin\"\n",
+    "    LOGIN_PASSWORD = \"password\"\n",
+    "     # flag to force disable resource directory. Resource directory and associated operations are\n",
+    "    # intended for HPE servers.\n",
+    "    DISABLE_RESOURCE_DIR = True\n",
+    "\n",
+    "    try:\n",
+    "        # Create a Redfish client object\n",
+    "        REDFISHOBJ = RedfishClient(base_url=SYSTEM_URL, username=LOGIN_ACCOUNT, \\\n",
+    "                                                                            password=LOGIN_PASSWORD)\n",
+    "        # Login with the Redfish client\n",
+    "        REDFISHOBJ.login()\n",
+    "    except ServerDownOrUnreachableError as excp:\n",
+    "        sys.stderr.write(\"ERROR: server not reachable or does not support RedFish.\\n\")\n",
+    "        sys.exit()\n",
+    "\n",
+    "    reset_ilo(REDFISHOBJ, DISABLE_RESOURCE_DIR)\n",
+    "    REDFISHOBJ.logout()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1557bfee",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-warning\" style=\"border-radius: 20px;\">\n",
+    "<b> When running on the server locally : </b>  use the following values <br>\n",
+    "    SYSTEM_URL = None <br>\n",
+    "    LOGIN_ACCOUNT = None <br>\n",
+    "    LOGIN_PASSWORD = None <br>\n",
+    "    <b> When running remotely </b> connect using the secured (https://) address,account name, and password to send https requests <br>\n",
+    "    SYSTEM_URL acceptable examples: <br>\n",
+    "    \"https://10.0.0.100\" <br>\n",
+    "    \"https://ilo.hostname\"\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e685a623",
+   "metadata": {},
+   "source": [
+    "<div class = \"alert alert-block alert-success\" style=\"border-radius: 20px;\">In case you need help 🔗 links to relevant resources :\n",
+    "    <br>\n",
+    "    1.Python-ilorest-library:<a href = \"https://github.com/HewlettPackard/python-ilorest-library\">LINK</a><br>\n",
+    "    2.Hpe ilorest-api explorer:<a href = \"https://ilorestfulapiexplorer.ext.hpe.com/\">LINK</a><br>\n",
+    "    3.Rest api: <a href = \"https://restfulapi.net/\">LINK</a><br>\n",
+    "    \n",
+    "</div>"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}