29 | For a full Redfish example click here: ex04_reset_server.py 30 |31 | 32 |
33 |36 | 37 | > alternative pre-Redfish action invocation: 38 | 39 | ```shell 40 | curl -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/rest/v1/Systems/1 -u username:password --insecure 41 | ``` 42 | 43 |Contents of data.json
34 |{"ResetType": "ForceRestart"}
35 |
44 | For a full Rest example click here: ex04_reset_server.py 45 |46 | 47 |
48 |51 | 52 | REST resources usually support HTTP GET to read the current state, and some support modification and removal with HTTP POST, PUT, PATCH, or DELETE. 53 | 54 | There are some resources that support other types of operations not easily mapped to HTTP operations. For this reason the Redfish specification defines "Actions". Actions are HTTP POST operations with a specifically formatted JSON request including the operation to perform and any parameters. For instance, it is not enough to simply tell a server to reset, but it is also necessary to specify the type of reset: cold boot, warm boot, PCI reset, etc. Actions are often used when the operation causes iLO 4 not just to update a value, but to change system state. 55 | 56 | In Redfish, the available actions that can be invoked are identified by a "target" property in the resource's "Actions" object definitions. The parameters identify the supported values with the annotation @Redfish.AllowableValues. 57 | 58 | 65 | 66 | ## Actions on HPE-specific Extensions 67 | 68 | ```shell 69 | curl -H "Content-Type: application/json" -X POST --data "@data.json" https://{iLO}/redfish/v1/Systems/1/Actions/ComputerSystem.Reset/ -u username:password --insecure 70 | ``` 71 | 72 |Contents of data.json
49 |{"Action": "Reset", "ResetType": "ForceRestart"}
50 |
73 | For a full Redfish example click here: ex04_reset_server.py 74 |75 | 76 |
77 |80 | 81 | The embedded extensions may also have Actions not specified by the Redfish standard. They are invoked in a similar way. The POST URI may include indicate the HPE specific nature of the action. 82 | 83 | The older pre-Redfish form of the Action invokation requires you to specify `"Target": "/Oem/Hp"` as one of the properties in the body of the request. 84 | 85 | It is recommended that you use the Redfish version of the action invocation. 86 | 87 | -------------------------------------------------------------------------------- /source/stylesheets/_variables.scss: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright 2008-2013 Concur Technologies, Inc. 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); you may 5 | not use this file except in compliance with the License. You may obtain 6 | a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | License for the specific language governing permissions and limitations 14 | under the License. 15 | */ 16 | 17 | 18 | //////////////////////////////////////////////////////////////////////////////// 19 | // CUSTOMIZE SLATE 20 | //////////////////////////////////////////////////////////////////////////////// 21 | // Use these settings to help adjust the appearance of Slate 22 | 23 | 24 | // BACKGROUND COLORS 25 | //////////////////// 26 | $nav-bg: #393939 !default; 27 | $examples-bg: #393939 !default; 28 | $code-bg: #292929 !default; 29 | $code-annotation-bg: #1c1c1c !default; 30 | $nav-subitem-bg: #262626 !default; 31 | $nav-active-bg: #2467af !default; 32 | $lang-select-border: #000 !default; 33 | $lang-select-bg: #222 !default; 34 | $lang-select-active-bg: $examples-bg !default; // feel free to change this to blue or something 35 | $lang-select-pressed-bg: #111 !default; // color of language tab bg when mouse is pressed 36 | $main-bg: #eaf2f6 !default; 37 | $aside-notice-bg: #8fbcd4 !default; 38 | $aside-warning-bg: #c97a7e !default; 39 | $aside-success-bg: #6ac174 !default; 40 | $search-notice-bg: #c97a7e !default; 41 | 42 | 43 | // TEXT COLORS 44 | //////////////////// 45 | $main-text: #333 !default; // main content text color 46 | $nav-text: #fff !default; 47 | $nav-active-text: #fff !default; 48 | $lang-select-text: #fff !default; // color of unselected language tab text 49 | $lang-select-active-text: #fff !default; // color of selected language tab text 50 | $lang-select-pressed-text: #fff !default; // color of language tab text when mouse is pressed 51 | 52 | 53 | // SIZES 54 | //////////////////// 55 | $nav-width: 230px !default; // width of the navbar 56 | $examples-width: 50% !default; // portion of the screen taken up by code examples 57 | $logo-margin: 20px !default; // margin between nav items and logo, ignored if search is active 58 | $main-padding: 28px !default; // padding to left and right of content & examples 59 | $nav-padding: 15px !default; // padding to left and right of navbar 60 | $nav-v-padding: 10px !default; // padding used vertically around search boxes and results 61 | $nav-indent: 10px !default; // extra padding for ToC subitems 62 | $code-annotation-padding: 13px !default; // padding inside code annotations 63 | $h1-margin-bottom: 21px !default; // padding under the largest header tags 64 | $tablet-width: 930px !default; // min width before reverting to tablet size 65 | $phone-width: $tablet-width - $nav-width !default; // min width before reverting to mobile size 66 | 67 | 68 | // FONTS 69 | //////////////////// 70 | %default-font { 71 | font-family: "Helvetica Neue", Helvetica, Arial, "Microsoft Yahei","微软雅黑", STXihei, "华文细黑", sans-serif; 72 | font-size: 13px; 73 | } 74 | 75 | %header-font { 76 | @extend %default-font; 77 | font-weight: bold; 78 | } 79 | 80 | %code-font { 81 | font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif; 82 | font-size: 12px; 83 | line-height: 1.5; 84 | } 85 | 86 | 87 | // OTHER 88 | //////////////////// 89 | $nav-active-shadow: #000 !default; 90 | $nav-footer-border-color: #666 !default; 91 | $nav-embossed-border-top: #000 !default; 92 | $nav-embossed-border-bottom: #939393 !default; 93 | $main-embossed-text-shadow: 0px 1px 0px #fff !default; 94 | $search-box-border-color: #666 !default; 95 | 96 | 97 | //////////////////////////////////////////////////////////////////////////////// 98 | // INTERNAL 99 | //////////////////////////////////////////////////////////////////////////////// 100 | // These settings are probably best left alone. 101 | 102 | %break-words { 103 | word-break: break-all; 104 | hyphens: auto; 105 | } 106 | -------------------------------------------------------------------------------- /source/javascripts/lib/_jquery.highlight.js: -------------------------------------------------------------------------------- 1 | /* 2 | * jQuery Highlight plugin 3 | * 4 | * Based on highlight v3 by Johann Burkard 5 | * http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html 6 | * 7 | * Code a little bit refactored and cleaned (in my humble opinion). 8 | * Most important changes: 9 | * - has an option to highlight only entire words (wordsOnly - false by default), 10 | * - has an option to be case sensitive (caseSensitive - false by default) 11 | * - highlight element tag and class names can be specified in options 12 | * 13 | * Usage: 14 | * // wrap every occurrance of text 'lorem' in content 15 | * // with (default options) 16 | * $('#content').highlight('lorem'); 17 | * 18 | * // search for and highlight more terms at once 19 | * // so you can save some time on traversing DOM 20 | * $('#content').highlight(['lorem', 'ipsum']); 21 | * $('#content').highlight('lorem ipsum'); 22 | * 23 | * // search only for entire word 'lorem' 24 | * $('#content').highlight('lorem', { wordsOnly: true }); 25 | * 26 | * // don't ignore case during search of term 'lorem' 27 | * $('#content').highlight('lorem', { caseSensitive: true }); 28 | * 29 | * // wrap every occurrance of term 'ipsum' in content 30 | * // with 31 | * $('#content').highlight('ipsum', { element: 'em', className: 'important' }); 32 | * 33 | * // remove default highlight 34 | * $('#content').unhighlight(); 35 | * 36 | * // remove custom highlight 37 | * $('#content').unhighlight({ element: 'em', className: 'important' }); 38 | * 39 | * 40 | * Copyright (c) 2009 Bartek Szopka 41 | * 42 | * Licensed under MIT license. 43 | * 44 | */ 45 | 46 | jQuery.extend({ 47 | highlight: function (node, re, nodeName, className) { 48 | if (node.nodeType === 3) { 49 | var match = node.data.match(re); 50 | if (match) { 51 | var highlight = document.createElement(nodeName || 'span'); 52 | highlight.className = className || 'highlight'; 53 | var wordNode = node.splitText(match.index); 54 | wordNode.splitText(match[0].length); 55 | var wordClone = wordNode.cloneNode(true); 56 | highlight.appendChild(wordClone); 57 | wordNode.parentNode.replaceChild(highlight, wordNode); 58 | return 1; //skip added node in parent 59 | } 60 | } else if ((node.nodeType === 1 && node.childNodes) && // only element nodes that have children 61 | !/(script|style)/i.test(node.tagName) && // ignore script and style nodes 62 | !(node.tagName === nodeName.toUpperCase() && node.className === className)) { // skip if already highlighted 63 | for (var i = 0; i < node.childNodes.length; i++) { 64 | i += jQuery.highlight(node.childNodes[i], re, nodeName, className); 65 | } 66 | } 67 | return 0; 68 | } 69 | }); 70 | 71 | jQuery.fn.unhighlight = function (options) { 72 | var settings = { className: 'highlight', element: 'span' }; 73 | jQuery.extend(settings, options); 74 | 75 | return this.find(settings.element + "." + settings.className).each(function () { 76 | var parent = this.parentNode; 77 | parent.replaceChild(this.firstChild, this); 78 | parent.normalize(); 79 | }).end(); 80 | }; 81 | 82 | jQuery.fn.highlight = function (words, options) { 83 | var settings = { className: 'highlight', element: 'span', caseSensitive: false, wordsOnly: false }; 84 | jQuery.extend(settings, options); 85 | 86 | if (words.constructor === String) { 87 | words = [words]; 88 | } 89 | words = jQuery.grep(words, function(word, i){ 90 | return word != ''; 91 | }); 92 | words = jQuery.map(words, function(word, i) { 93 | return word.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&"); 94 | }); 95 | if (words.length == 0) { return this; }; 96 | 97 | var flag = settings.caseSensitive ? "" : "i"; 98 | var pattern = "(" + words.join("|") + ")"; 99 | if (settings.wordsOnly) { 100 | pattern = "\\b" + pattern + "\\b"; 101 | } 102 | var re = new RegExp(pattern, flag); 103 | 104 | return this.each(function () { 105 | jQuery.highlight(this, re, settings.element, settings.className); 106 | }); 107 | }; 108 | 109 | -------------------------------------------------------------------------------- /source/includes/_ilo4_resourcedefnhdr.md: -------------------------------------------------------------------------------- 1 | ## Resource Definitions 2 | 3 | Each resource in the API has a "type" that defines its properties. See the Redfish specification for `@odata.type` for details. 4 | 5 | This section defines the supported types and lists the typical instances of each. Because this API document is applicable to all HPE servers using iLO 4, you may find variations such as: 6 | 7 | * properties implemented on one type of server and not another 8 | * resources that are read only on one type of server and not another 9 | * The number of resources of a particular type (e.g. multiple compute nodes or enclosing chassis) 10 | 11 | ## Collections 12 | 13 | Many resource types in the API are members of "collections." Collections are groups of similar resources and are typically an array of Member links. 14 | 15 | Redfish does not define a generic collection "type" (@odata.type) but all collections are identical in structure. A `ComputerSystemCollection` is identical in structure to a `ChassisCollection` although they have slightly different names. Typically, collection types are suffixed with the word collection and are recognizable by the presense of the `Members` array of links. 16 | 17 | Collections may be GET-only that may not be added to or removed from. Examples of GET-only collections are the Systems collection at `/redfish/v1/systems/`. In a typical systems collection describing physical hardware, it wouldn't make sense to be able to create or remove members using GET or DELETE. 18 | 19 | Other collections may be editable. Examples of these might be the Accounts collection at `/redfish/v1/accountservice/accounts`. The API supports the addition or removal of user accounts. To add a new member to an editable collection, perform an HTTP POST to the collection resource with a body consisting of the required JSON properties needed to create a new member (this does not necessarily require you to POST every property because many may take a unique service-assigned value or take a default value.) 20 | 21 | For more information on collections see the Redfish 1.0 DMTF standard at [http://www.dmtf.org/standards/redfish](http:// www.dmtf.org/standards/redfish) and the example Python code: [https://github.com/HewlettPackard/python-proliant-sdk](https://github.com/HewlettPackard/python-proliant-sdk). 22 | > GET https://{iLO}/redfish/v1/systems/ showing a collection response (JSON) 23 | 24 | ```json 25 | { 26 | "@odata.id": "/redfish/v1/systems/", 27 | "@odata.context": "/redfish/v1/$metadata/", 28 | "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", 29 | "Members@odata.count": 1, 30 | "Members": [ 31 | { 32 | "@odata.id": "/redfish/v1/systems/1/" 33 | } 34 | ] 35 | } 36 | ``` 37 | 38 | **Properties** 39 | 40 | > **Collection Instances**: 41 | 42 | > * `https://{iLO}/redfish/v1/AccountService/Accounts` 43 | 44 | > * `https://{iLO}/redfish/v1/Chassis` 45 | 46 | > * `https://{iLO}/redfish/v1/EventService/EventSubscriptions` 47 | 48 | > * `https://{iLO}/redfish/v1/Managers` 49 | 50 | > * `https://{iLO}/redfish/v1/Managers/{item}/EthernetInterfaces` 51 | 52 | > * `https://{iLO}/redfish/v1/Managers/{item}/FederationGroups` 53 | 54 | > * `https://{iLO}/redfish/v1/Managers/{item}/FederationPeers` 55 | 56 | > * `https://{iLO}/redfish/v1/Managers/{item}/LicenseService` 57 | 58 | > * `https://{iLO}/redfish/v1/Managers/{item}/LogServices` 59 | 60 | > * `https://{iLO}/redfish/v1/Managers/{item}/LogServices/IEL/Entries` 61 | 62 | > * `https://{iLO}/redfish/v1/Managers/{item}/VirtualMedia` 63 | 64 | > * `https://{iLO}/redfish/v1/Registries` 65 | 66 | > * `https://{iLO}/redfish/v1/Schemas` 67 | 68 | > * `https://{iLO}/redfish/v1/SessionService/Sessions` 69 | 70 | > * `https://{iLO}/redfish/v1/Systems` 71 | 72 | > * `https://{iLO}/redfish/v1/Systems/{item}/LogServices` 73 | 74 | > * `https://{iLO}/redfish/v1/Systems/{item}/LogServices/IML/Entries` 75 | 76 | > * `https://{iLO}/redfish/v1/Systems/{item}/Memory` 77 | 78 | > * `https://{iLO}/redfish/v1/Systems/{item}/NetworkAdapters` 79 | 80 | > * `https://{iLO}/redfish/v1/Systems/{item}/PCIDevices` 81 | 82 | > * `https://{iLO}/redfish/v1/Systems/{item}/PCISlots` 83 | 84 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers` 85 | 86 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives` 87 | 88 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives` 89 | 90 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures` 91 | 92 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters` 93 | 94 | ### Members@odata.count 95 | 96 | **JSONPath**: `/Members@odata.count` (read only integer) 97 | 98 | The number of members in the collection. 99 | 100 | ### Members[] 101 | 102 | **JSONPath**: `/Members` (read only array of links) 103 | 104 | The Members array consists of links (`@odata.id`) to the members of the collection. 105 | 106 | 107 | 108 | 109 | -------------------------------------------------------------------------------- /source/includes/_ilo5_resourcedefnhdr.md: -------------------------------------------------------------------------------- 1 | # Resource Definitions 2 | 3 | Each resource in the API has a "type" that defines its properties. See the Redfish specification for `@odata.type` for details. 4 | 5 | This section defines the supported types and lists the typical instances of each. Because this API document is applicable to all HPE servers using iLO 5, you may find variations such as: 6 | 7 | * properties implemented on one type of server and not another 8 | * resources that are read only on one type of server and not another 9 | * The number of resources of a particular type (for example, multiple compute nodes or enclosing chassis) 10 | 11 | ## Collections 12 | 13 | Many resource types in the API are members of "collections." Collections are groups of similar resources and are typically an array of Member links. 14 | 15 | Redfish does not define a generic collection "type" (@odata.type) but all collections are identical in structure. A `ComputerSystemCollection` is identical in structure to a `ChassisCollection` although they have slightly different names. Typically, collection types are suffixed with the word collection and are recognizable by the presence of the `Members` array of links. 16 | 17 | Collections may be GET-only that may not be added to or removed from. Examples of GET-only collections are the Systems collection at `/redfish/v1/systems/`. In a typical systems collection describing physical hardware, it wouldn't make sense to be able to create or remove members using GET or DELETE. 18 | 19 | Other collections may be editable. Examples of these might be the Accounts collection at `/redfish/v1/accountservice/accounts`. The API supports the addition or removal of user accounts. To add a new member to an editable collection, perform an HTTP POST to the collection resource with a body consisting of the required JSON properties needed to create a new member (this does not necessarily require you to POST every property because many may take a unique service-assigned value or take a default value.) 20 | 21 | For more information on collections see the Redfish 1.0 DMTF standard at [https://www.dmtf.org/standards/redfish](https://www.dmtf.org/standards/redfish) and the example Python code: [https://github.com/HewlettPackard/python-ilorest-library](https://github.com/HewlettPackard/python-ilorest-library). 22 | > GET https://{iLO}/redfish/v1/systems/ showing a collection response (JSON) 23 | 24 | ```json 25 | { 26 | "@odata.id": "/redfish/v1/systems/", 27 | "@odata.context": "/redfish/v1/$metadata/", 28 | "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", 29 | "Members@odata.count": 1, 30 | "Members": [ 31 | { 32 | "@odata.id": "/redfish/v1/systems/1/" 33 | } 34 | ] 35 | } 36 | ``` 37 | 38 | **Properties** 39 | 40 | > **Collection Instances**: 41 | 42 | > * `https://{iLO}/redfish/v1/AccountService/Accounts` 43 | 44 | > * `https://{iLO}/redfish/v1/Chassis` 45 | 46 | > * `https://{iLO}/redfish/v1/EventService/EventSubscriptions` 47 | 48 | > * `https://{iLO}/redfish/v1/Managers` 49 | 50 | > * `https://{iLO}/redfish/v1/Managers/{item}/EthernetInterfaces` 51 | 52 | > * `https://{iLO}/redfish/v1/Managers/{item}/FederationGroups` 53 | 54 | > * `https://{iLO}/redfish/v1/Managers/{item}/FederationPeers` 55 | 56 | > * `https://{iLO}/redfish/v1/Managers/{item}/LicenseService` 57 | 58 | > * `https://{iLO}/redfish/v1/Managers/{item}/LogServices` 59 | 60 | > * `https://{iLO}/redfish/v1/Managers/{item}/LogServices/IEL/Entries` 61 | 62 | > * `https://{iLO}/redfish/v1/Managers/{item}/VirtualMedia` 63 | 64 | > * `https://{iLO}/redfish/v1/Registries` 65 | 66 | > * `https://{iLO}/redfish/v1/Schemas` 67 | 68 | > * `https://{iLO}/redfish/v1/SessionService/Sessions` 69 | 70 | > * `https://{iLO}/redfish/v1/Systems` 71 | 72 | > * `https://{iLO}/redfish/v1/Systems/{item}/LogServices` 73 | 74 | > * `https://{iLO}/redfish/v1/Systems/{item}/LogServices/IML/Entries` 75 | 76 | > * `https://{iLO}/redfish/v1/Systems/{item}/Memory` 77 | 78 | > * `https://{iLO}/redfish/v1/Systems/{item}/NetworkAdapters` 79 | 80 | > * `https://{iLO}/redfish/v1/Systems/{item}/PCIDevices` 81 | 82 | > * `https://{iLO}/redfish/v1/Systems/{item}/PCISlots` 83 | 84 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers` 85 | 86 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/DiskDrives` 87 | 88 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/LogicalDrives` 89 | 90 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/ArrayControllers/{item}/StorageEnclosures` 91 | 92 | > * `https://{iLO}/redfish/v1/Systems/{item}/SmartStorage/HostBusAdapters` 93 | 94 | ### Members@odata.count 95 | 96 | **JSONPath**: `/Members@odata.count` (read only integer) 97 | 98 | The number of members in the collection. 99 | 100 | ### Members[] 101 | 102 | **JSONPath**: `/Members` (read only array of links) 103 | 104 | The Members array consists of links (`@odata.id`) to the members of the collection. 105 | 106 | 107 | 108 | 109 | -------------------------------------------------------------------------------- /source/includes/_ilo5_backupandrestore.md: -------------------------------------------------------------------------------- 1 | # iLO Backup and Restore 2 | 3 | The Backup & Restore feature allows you to restore the iLO configuration on a system with the same 4 | hardware configuration as the system that was backed up. This feature is not meant to duplicate a 5 | configuration and apply it to a different iLO system. 6 | 7 | In general, it is not expected that you will need to perform an iLO restore operation. However, there are 8 | cases in which having a backup of the configuration eases and expedites the return to a normal operating 9 | environment. 10 | 11 | As with any computer system, backing up your data is a recommended practice to minimize the impact 12 | from failures. Hewlett Packard Enterprise recommends performing a backup each time that you update 13 | the iLO firmware. 14 | 15 | You might want to restore the iLO configuration in the following situations: 16 | 17 | ## Battery failure or removal 18 | 19 | Various configuration parameters are stored in the battery-powered SRAM. Although rare, the battery 20 | can fail. In some situations, battery removal and replacement might be required. To avoid the loss of 21 | configuration information, restore the iLO configuration from a backup file after the battery is replaced. 22 | 23 | ## Reset to factory defaults 24 | 25 | In some cases, you might need to reset iLO to the factory default settings to erase settings external to 26 | iLO. Resetting iLO to the factory default settings erases the iLO configuration. To recover the iLO 27 | configuration quickly, restore the configuration from a backup file after the reset to the factory default 28 | settings is complete. 29 | 30 | ## Accidental or incorrect configuration change 31 | 32 | In some cases, the iLO configuration might be changed incorrectly, causing important settings to be 33 | lost. This situation might occur if iLO is set to the factory default settings or user accounts are deleted. 34 | To recover the original configuration, restore the configuration from a backup file. 35 | 36 | ## System board replacement 37 | 38 | If a system board replacement is required to address a hardware issue, you can use this feature to 39 | transfer the iLO configuration from the original system board to the new system board. 40 | 41 | ## Lost license key 42 | 43 | If a license key is accidentally replaced, or you reset iLO to the factory default settings, and you are 44 | not sure which key to install, you can restore the license key and other configuration settings from a 45 | backup file. 46 | 47 | ## What information is restored? 48 | 49 | The iLO configuration includes many categories such as Power, Network, Security, the User Database, 50 | and License Keys. Most configuration information is stored in the battery-powered SRAM memory device, 51 | and it can be backed up and restored. 52 | 53 | ### Information that is not restored 54 | 55 | Some information is not suitable to be restored. The information that cannot be restored is not part of the 56 | iLO configuration, but instead is related to the iLO or server system state. 57 | 58 | The following information is not backed up or restored: 59 | 60 | * Security state—Allowing a restore operation to change the iLO security state would defeat the principles of security 61 | and enforcement of security. 62 | * Integrated Management Log—To preserve information about events that occurred between the backup and the time or event that 63 | required the restore, this information is not restored. 64 | * iLO Event Log—To preserve information about events that occurred between the backup and the time or event that 65 | required the restore, this information is not restored. 66 | * Active Health System data—To preserve the information recorded during the backup and restore process, this information is not 67 | restored. 68 | * Server state information— Server power state (ON/OFF), Server UID LED states, iLO and server clock settings. 69 | 70 | 71 | ## Backing up the iLO 5 configuration 72 | 73 | > Find the information about the BackupRestoreService 74 | 75 | > GET `/redfish/v1/Managers/1/BackupRestoreService` 76 | 77 | ```json 78 | { 79 | "@odata.context": "/redfish/v1/$metadata#HpeiLOBackupRestoreService.HpeiLOBackupRestoreService", 80 | "@odata.etag": "W/\"D863AC37\"", 81 | "@odata.id": "/redfish/v1/Managers/1/BackupRestoreService", 82 | "@odata.type": "#HpeiLOBackupRestoreService.v2_2_0.HpeiLOBackupRestoreService", 83 | "Id": "BackupRestoreService", 84 | "BackupFileLocation": "/bkupdata/HPE_MXQ32200VV_20020928_0712.bak", 85 | "BackupFiles": { 86 | "@odata.id": "/redfish/v1/Managers/1/BackupRestoreService/BackupFiles" 87 | }, 88 | "HttpPushUri": "/cgi-bin/uploadRestoreFile", 89 | "Name": "Backup Restore Service" 90 | } 91 | ``` 92 | 93 | > GET the backup file based upon the `BackupFileLocation` URI 94 | 95 | > GET `/bkupdata/HPE_MXQ32200VV_20020928_0712.bak` 96 | 97 | The GET operation to the BackupFileLocation URI returns HTTP 200 with `Content Type: application/octet-stream`. This is the binary image of the backup file. 98 | 99 | ## Restoring the iLO 5 configuration 100 | 101 | > POST `/cgi-bin/uploadRestoreFile` 102 | 103 | The content type of the POST must be Form Data and include the session key 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | -------------------------------------------------------------------------------- /font-selection.json: -------------------------------------------------------------------------------- 1 | { 2 | "IcoMoonType": "selection", 3 | "icons": [ 4 | { 5 | "icon": { 6 | "paths": [ 7 | "M438.857 73.143q119.429 0 220.286 58.857t159.714 159.714 58.857 220.286-58.857 220.286-159.714 159.714-220.286 58.857-220.286-58.857-159.714-159.714-58.857-220.286 58.857-220.286 159.714-159.714 220.286-58.857zM512 785.714v-108.571q0-8-5.143-13.429t-12.571-5.429h-109.714q-7.429 0-13.143 5.714t-5.714 13.143v108.571q0 7.429 5.714 13.143t13.143 5.714h109.714q7.429 0 12.571-5.429t5.143-13.429zM510.857 589.143l10.286-354.857q0-6.857-5.714-10.286-5.714-4.571-13.714-4.571h-125.714q-8 0-13.714 4.571-5.714 3.429-5.714 10.286l9.714 354.857q0 5.714 5.714 10t13.714 4.286h105.714q8 0 13.429-4.286t6-10z" 8 | ], 9 | "attrs": [], 10 | "isMulticolor": false, 11 | "tags": [ 12 | "exclamation-circle" 13 | ], 14 | "defaultCode": 61546, 15 | "grid": 14 16 | }, 17 | "attrs": [], 18 | "properties": { 19 | "id": 100, 20 | "order": 4, 21 | "prevSize": 28, 22 | "code": 58880, 23 | "name": "exclamation-sign", 24 | "ligatures": "" 25 | }, 26 | "setIdx": 0, 27 | "iconIdx": 0 28 | }, 29 | { 30 | "icon": { 31 | "paths": [ 32 | "M585.143 786.286v-91.429q0-8-5.143-13.143t-13.143-5.143h-54.857v-292.571q0-8-5.143-13.143t-13.143-5.143h-182.857q-8 0-13.143 5.143t-5.143 13.143v91.429q0 8 5.143 13.143t13.143 5.143h54.857v182.857h-54.857q-8 0-13.143 5.143t-5.143 13.143v91.429q0 8 5.143 13.143t13.143 5.143h256q8 0 13.143-5.143t5.143-13.143zM512 274.286v-91.429q0-8-5.143-13.143t-13.143-5.143h-109.714q-8 0-13.143 5.143t-5.143 13.143v91.429q0 8 5.143 13.143t13.143 5.143h109.714q8 0 13.143-5.143t5.143-13.143zM877.714 512q0 119.429-58.857 220.286t-159.714 159.714-220.286 58.857-220.286-58.857-159.714-159.714-58.857-220.286 58.857-220.286 159.714-159.714 220.286-58.857 220.286 58.857 159.714 159.714 58.857 220.286z" 33 | ], 34 | "attrs": [], 35 | "isMulticolor": false, 36 | "tags": [ 37 | "info-circle" 38 | ], 39 | "defaultCode": 61530, 40 | "grid": 14 41 | }, 42 | "attrs": [], 43 | "properties": { 44 | "id": 85, 45 | "order": 3, 46 | "name": "info-sign", 47 | "prevSize": 28, 48 | "code": 58882 49 | }, 50 | "setIdx": 0, 51 | "iconIdx": 2 52 | }, 53 | { 54 | "icon": { 55 | "paths": [ 56 | "M733.714 419.429q0-16-10.286-26.286l-52-51.429q-10.857-10.857-25.714-10.857t-25.714 10.857l-233.143 232.571-129.143-129.143q-10.857-10.857-25.714-10.857t-25.714 10.857l-52 51.429q-10.286 10.286-10.286 26.286 0 15.429 10.286 25.714l206.857 206.857q10.857 10.857 25.714 10.857 15.429 0 26.286-10.857l310.286-310.286q10.286-10.286 10.286-25.714zM877.714 512q0 119.429-58.857 220.286t-159.714 159.714-220.286 58.857-220.286-58.857-159.714-159.714-58.857-220.286 58.857-220.286 159.714-159.714 220.286-58.857 220.286 58.857 159.714 159.714 58.857 220.286z" 57 | ], 58 | "attrs": [], 59 | "isMulticolor": false, 60 | "tags": [ 61 | "check-circle" 62 | ], 63 | "defaultCode": 61528, 64 | "grid": 14 65 | }, 66 | "attrs": [], 67 | "properties": { 68 | "id": 83, 69 | "order": 9, 70 | "prevSize": 28, 71 | "code": 58886, 72 | "name": "ok-sign" 73 | }, 74 | "setIdx": 0, 75 | "iconIdx": 6 76 | }, 77 | { 78 | "icon": { 79 | "paths": [ 80 | "M658.286 475.429q0-105.714-75.143-180.857t-180.857-75.143-180.857 75.143-75.143 180.857 75.143 180.857 180.857 75.143 180.857-75.143 75.143-180.857zM950.857 950.857q0 29.714-21.714 51.429t-51.429 21.714q-30.857 0-51.429-21.714l-196-195.429q-102.286 70.857-228 70.857-81.714 0-156.286-31.714t-128.571-85.714-85.714-128.571-31.714-156.286 31.714-156.286 85.714-128.571 128.571-85.714 156.286-31.714 156.286 31.714 128.571 85.714 85.714 128.571 31.714 156.286q0 125.714-70.857 228l196 196q21.143 21.143 21.143 51.429z" 81 | ], 82 | "width": 951, 83 | "attrs": [], 84 | "isMulticolor": false, 85 | "tags": [ 86 | "search" 87 | ], 88 | "defaultCode": 61442, 89 | "grid": 14 90 | }, 91 | "attrs": [], 92 | "properties": { 93 | "id": 2, 94 | "order": 1, 95 | "prevSize": 28, 96 | "code": 58887, 97 | "name": "icon-search" 98 | }, 99 | "setIdx": 0, 100 | "iconIdx": 7 101 | } 102 | ], 103 | "height": 1024, 104 | "metadata": { 105 | "name": "slate", 106 | "license": "SIL OFL 1.1" 107 | }, 108 | "preferences": { 109 | "showGlyphs": true, 110 | "showQuickUse": true, 111 | "showQuickUse2": true, 112 | "showSVGs": true, 113 | "fontPref": { 114 | "prefix": "icon-", 115 | "metadata": { 116 | "fontFamily": "slate", 117 | "majorVersion": 1, 118 | "minorVersion": 0, 119 | "description": "Based on FontAwesome", 120 | "license": "SIL OFL 1.1" 121 | }, 122 | "metrics": { 123 | "emSize": 1024, 124 | "baseline": 6.25, 125 | "whitespace": 50 126 | }, 127 | "resetPoint": 58880, 128 | "showSelector": false, 129 | "selector": "class", 130 | "classSelector": ".icon", 131 | "showMetrics": false, 132 | "showMetadata": true, 133 | "showVersion": true, 134 | "ie7": false 135 | }, 136 | "imagePref": { 137 | "prefix": "icon-", 138 | "png": true, 139 | "useClassSelector": true, 140 | "color": 4473924, 141 | "bgColor": 16777215 142 | }, 143 | "historySize": 100, 144 | "showCodes": true, 145 | "gridSize": 16, 146 | "showLiga": false 147 | } 148 | } 149 | -------------------------------------------------------------------------------- /source/includes/_ilo4_introduction.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | The iLO RESTful API for HPE iLO 4 is a programming interface enabling state-of-the-art server management. This document contains helpful information about how to interact with the iLO RESTful API. The iLO RESTful API uses the basic HTTP operations (GET, PUT, POST, DELETE, and PATCH) to submit or return a JSON formatted resource to or from a URI on iLO 4. 4 | 5 | With modern scripting languages, you can easily write simple REST clients for RESTful APIs. Most languages, like Python, can transform JSON into internal-data structures, like dictionaries, allowing for easy access to data. This enables you to write custom code directly to the iLO RESTful API, instead of using intermediate tools such as HPE’s HPQLOCFG or CONREP. 6 | 7 | This document has been updated with examples from iLO 4 version 2.30 firmware. 8 | 9 | ## Redfish 1.0 Conformance 10 | 11 | The iLO RESTful API was first released with iLO 4 2.00 on HPE Gen9 servers. The iLO RESTful API also functioned as the starting point for the new Redfish 1.0 DMTF standard at [http:// www.dmtf.org/standards/redfish](http://www.dmtf.org/standards/redfish) 12 | 13 | Since the introduction of the iLO RESTful API, a number of changes were introduced into the Redfish standard by the DMTF SPMF members. At a high level, the changes include: 14 | 15 | * Use of OData annotations throughout the data to communicate meta-data 16 | * Revision of Error structures 17 | * Removal or Rename of certain JSON properties 18 | * Use of different collection schema 19 | * Use of a different set of entry-point URIs (/redfish/v1/ vs. /rest/v1) 20 | 21 | iLO 4 2.30 is Redfish 1.0 conformant while remaining backward compatible with the existing iLO RESTful API. Moving forward, the iLO RESTful API will become the iLO 4 enhanced implementation of Redfish. While conforming to the Redfish 1.0 standard, the iLO RESTful API is extended with Hewlett Packard Enterprise-specific features such as BIOS configuration. You should plan to update your client code to confirm to the Redfish standard. iLO will eventually remove any properties that do not match the Redfish schema definitions (while preserving the OEM extensions.) 22 | 23 | iLO 4 2.30 achieves Redfish 1.0 conformance and backward compatibility by: 24 | 25 | 1. Mirroring the resource model at both /redfish/v1/ and /rest/v1. 26 | 1. Returning both compatibility and Redfish properties by default. 27 | 1. Returning only Redfish conformant properties (with Hewlett Packard Enterprise extensions) if the Redfish-required OData header is included in the request (`OData-Version: 4.0`). 28 | 29 | Full details on how Redfish 1.0 was implemented in iLO 4 2.30 and how it impacts clients written for previous versions is found here: [http://www.hpe.com/h20195/V2/GetDocument.aspx?docname=4AA6-1727ENW&cc=us&lc=en](http://www.hpe.com/h20195/V2/GetDocument.aspx?docname=4AA6-1727ENW&cc=us&lc=en "Redfish Implementation on HP RESTful API for HPE iLO 4 - Technical White Paper") 30 | 31 | ## REST APIs Architected using HATEOS 32 | 33 | Representational State Transfer (REST) is a web service that uses basic CRUD (Create, Read, Update, Delete, and Patch) operations performed on resources using HTTP commands such as POST, GET, PUT, PATCH, and DELETE. The iLO RESTful API is designed using a REST architecture called HATEOS (Hypermedia as the Engine of Application State). This architecture allows the client to interact with iLO through a simple fixed URL (rest/v1) and several other top-level URIs documented in the iLO Data Model. The rest of the data model is discoverable by following clearly identified “links” in the data. This has the advantage that the client does not need to know a set of fixed URLs. When you create a script to automate tasks using the iLO RESTful API, you only need to hardcode this simple URL and design the script to discover the REST API URLs that are needed to complete a task. To learn more about REST and HATEOAS concepts, see: 34 | 35 | * [http://en.wikipedia.org/wiki/Representational_state_transfer](http://en.wikipedia.org/wiki/Representational_state_transfer) 36 | * [http://en.wikipedia.org/wiki/HATEOAS](http://en.wikipedia.org/wiki/HATEOAS) 37 | 38 | ## Key benefits of the iLO RESTful API 39 | 40 | The iLO RESTful API is becoming the main management interface for iLO 4 Hewlett Packard Enterprise servers. Its feature set will become larger than the existing iLO XML API (RIBCL) and IPMI interfaces. Using the iLO RESTful API, you can take full inventory of the server, control power and reset, configure BIOS and iLO settings, fetch event logs, as well as many other functions. 41 | 42 | The iLO RESTful API follows the trend of the Internet in moving to a common pattern for new software interfaces. Many web services in a variety of industries use REST APIs because they are easy to implement, easy to consume, and offer scalability advantages over previous technologies. 43 | 44 | HPE OneView, OpenStack, and many other server management APIs are now REST APIs. Most Hewlett Packard Enterprise Management software offerings, as well as the entire Software Defined Infrastructure, are built upon REST APIs. 45 | 46 | The iLO RESTful API has the additional advantage of consistency across all present and projected server architectures. The same data model works for traditional rack-mount servers, blades, as well as newer types of systems like Moonshot. This advantage comes because the data model is designed to self-describe the service’s capabilities to the client and has room for flexibility designed in from the start 47 | 48 | -------------------------------------------------------------------------------- /source/layouts/layout.erb: -------------------------------------------------------------------------------- 1 | <%# 2 | Copyright 2008-2013 Concur Technologies, Inc. 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); you may 5 | not use this file except in compliance with the License. You may obtain 6 | a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | License for the specific language governing permissions and limitations 14 | under the License. 15 | %> 16 | <% language_tabs = current_page.data.language_tabs || [] %> 17 | 18 | 19 | 20 | 21 | 22 | 23 |Contents of data.json
78 |{"Action": "PowerButton", "PushType": "PressAndHold", "Target": "/Oem/Hp"}
79 |
70 | <%= image_tag "logo.png" %>
71 |
102 |
72 |
73 |
74 |
75 | <% if language_tabs.any? %>
76 |
77 | <% language_tabs.each do |lang| %>
78 | <% if lang.is_a? Hash %>
79 | <%= lang.values.first %>
80 | <% else %>
81 | <%= lang %>
82 | <% end %>
83 | <% end %>
84 |
85 | <% end %>
86 | <% if current_page.data.search %>
87 |
88 |
89 |
90 |
93 |
94 | <% if current_page.data.toc_footers %>
95 |
100 | <% end %>
101 |
103 |
104 |
124 |
146 |
147 |
148 |
--------------------------------------------------------------------------------
/source/javascripts/app/_lang.js:
--------------------------------------------------------------------------------
1 | //= require ../lib/_jquery
2 |
3 | /*
4 | Copyright 2008-2013 Concur Technologies, Inc.
5 |
6 | Licensed under the Apache License, Version 2.0 (the "License"); you may
7 | not use this file except in compliance with the License. You may obtain
8 | a copy of the License at
9 |
10 | http://www.apache.org/licenses/LICENSE-2.0
11 |
12 | Unless required by applicable law or agreed to in writing, software
13 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 | License for the specific language governing permissions and limitations
16 | under the License.
17 | */
18 | (function (global) {
19 | 'use strict';
20 |
21 | var languages = [];
22 |
23 | global.setupLanguages = setupLanguages;
24 | global.activateLanguage = activateLanguage;
25 |
26 | function activateLanguage(language) {
27 | if (!language) return;
28 | if (language === "") return;
29 |
30 | $(".lang-selector a").removeClass('active');
31 | $(".lang-selector a[data-language-name='" + language + "']").addClass('active');
32 | for (var i=0; i < languages.length; i++) {
33 | $(".highlight.tab-" + languages[i]).hide();
34 | $(".lang-specific." + languages[i]).hide();
35 | }
36 | $(".highlight.tab-" + language).show();
37 | $(".lang-specific." + language).show();
38 |
39 | global.toc.calculateHeights();
40 |
41 | // scroll to the new location of the position
42 | if ($(window.location.hash).get(0)) {
43 | $(window.location.hash).get(0).scrollIntoView(true);
44 | }
45 | }
46 |
47 | // parseURL and stringifyURL are from https://github.com/sindresorhus/query-string
48 | // MIT licensed
49 | // https://github.com/sindresorhus/query-string/blob/7bee64c16f2da1a326579e96977b9227bf6da9e6/license
50 | function parseURL(str) {
51 | if (typeof str !== 'string') {
52 | return {};
53 | }
54 |
55 | str = str.trim().replace(/^(\?|#|&)/, '');
56 |
57 | if (!str) {
58 | return {};
59 | }
60 |
61 | return str.split('&').reduce(function (ret, param) {
62 | var parts = param.replace(/\+/g, ' ').split('=');
63 | var key = parts[0];
64 | var val = parts[1];
65 |
66 | key = decodeURIComponent(key);
67 | // missing `=` should be `null`:
68 | // http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
69 | val = val === undefined ? null : decodeURIComponent(val);
70 |
71 | if (!ret.hasOwnProperty(key)) {
72 | ret[key] = val;
73 | } else if (Array.isArray(ret[key])) {
74 | ret[key].push(val);
75 | } else {
76 | ret[key] = [ret[key], val];
77 | }
78 |
79 | return ret;
80 | }, {});
81 | };
82 |
83 | function stringifyURL(obj) {
84 | return obj ? Object.keys(obj).sort().map(function (key) {
85 | var val = obj[key];
86 |
87 | if (Array.isArray(val)) {
88 | return val.sort().map(function (val2) {
89 | return encodeURIComponent(key) + '=' + encodeURIComponent(val2);
90 | }).join('&');
91 | }
92 |
93 | return encodeURIComponent(key) + '=' + encodeURIComponent(val);
94 | }).join('&') : '';
95 | };
96 |
97 | // gets the language set in the query string
98 | function getLanguageFromQueryString() {
99 | if (location.search.length >= 1) {
100 | var language = parseURL(location.search).language
101 | if (language) {
102 | return language;
103 | } else if (jQuery.inArray(location.search.substr(1), languages) != -1) {
104 | return location.search.substr(1);
105 | }
106 | }
107 |
108 | return false;
109 | }
110 |
111 | // returns a new query string with the new language in it
112 | function generateNewQueryString(language) {
113 | var url = parseURL(location.search);
114 | if (url.language) {
115 | url.language = language;
116 | return stringifyURL(url);
117 | }
118 | return language;
119 | }
120 |
121 | // if a button is clicked, add the state to the history
122 | function pushURL(language) {
123 | if (!history) { return; }
124 | var hash = window.location.hash;
125 | if (hash) {
126 | hash = hash.replace(/^#+/, '');
127 | }
128 | history.pushState({}, '', '?' + generateNewQueryString(language) + '#' + hash);
129 |
130 | // save language as next default
131 | localStorage.setItem("language", language);
132 | }
133 |
134 | function setupLanguages(l) {
135 | var defaultLanguage = localStorage.getItem("language");
136 |
137 | languages = l;
138 |
139 | var presetLanguage = getLanguageFromQueryString();
140 | if (presetLanguage) {
141 | // the language is in the URL, so use that language!
142 | activateLanguage(presetLanguage);
143 |
144 | localStorage.setItem("language", presetLanguage);
145 | } else if ((defaultLanguage !== null) && (jQuery.inArray(defaultLanguage, languages) != -1)) {
146 | // the language was the last selected one saved in localstorage, so use that language!
147 | activateLanguage(defaultLanguage);
148 | } else {
149 | // no language selected, so use the default
150 | activateLanguage(languages[0]);
151 | }
152 | }
153 |
154 | // if we click on a language tab, activate that language
155 | $(function() {
156 | $(".lang-selector a").on("click", function() {
157 | var language = $(this).data("language-name");
158 | pushURL(language);
159 | activateLanguage(language);
160 | return false;
161 | });
162 | window.onpopstate = function() {
163 | activateLanguage(getLanguageFromQueryString());
164 | };
165 | });
166 | })(window);
167 |
--------------------------------------------------------------------------------
/source/javascripts/lib/_energize.js:
--------------------------------------------------------------------------------
1 | /**
2 | * energize.js v0.1.0
3 | *
4 | * Speeds up click events on mobile devices.
5 | * https://github.com/davidcalhoun/energize.js
6 | */
7 |
8 | (function() { // Sandbox
9 | /**
10 | * Don't add to non-touch devices, which don't need to be sped up
11 | */
12 | if(!('ontouchstart' in window)) return;
13 |
14 | var lastClick = {},
15 | isThresholdReached, touchstart, touchmove, touchend,
16 | click, closest;
17 |
18 | /**
19 | * isThresholdReached
20 | *
21 | * Compare touchstart with touchend xy coordinates,
22 | * and only fire simulated click event if the coordinates
23 | * are nearby. (don't want clicking to be confused with a swipe)
24 | */
25 | isThresholdReached = function(startXY, xy) {
26 | return Math.abs(startXY[0] - xy[0]) > 5 || Math.abs(startXY[1] - xy[1]) > 5;
27 | };
28 |
29 | /**
30 | * touchstart
31 | *
32 | * Save xy coordinates when the user starts touching the screen
33 | */
34 | touchstart = function(e) {
35 | this.startXY = [e.touches[0].clientX, e.touches[0].clientY];
36 | this.threshold = false;
37 | };
38 |
39 | /**
40 | * touchmove
41 | *
42 | * Check if the user is scrolling past the threshold.
43 | * Have to check here because touchend will not always fire
44 | * on some tested devices (Kindle Fire?)
45 | */
46 | touchmove = function(e) {
47 | // NOOP if the threshold has already been reached
48 | if(this.threshold) return false;
49 |
50 | this.threshold = isThresholdReached(this.startXY, [e.touches[0].clientX, e.touches[0].clientY]);
51 | };
52 |
53 | /**
54 | * touchend
55 | *
56 | * If the user didn't scroll past the threshold between
57 | * touchstart and touchend, fire a simulated click.
58 | *
59 | * (This will fire before a native click)
60 | */
61 | touchend = function(e) {
62 | // Don't fire a click if the user scrolled past the threshold
63 | if(this.threshold || isThresholdReached(this.startXY, [e.changedTouches[0].clientX, e.changedTouches[0].clientY])) {
64 | return;
65 | }
66 |
67 | /**
68 | * Create and fire a click event on the target element
69 | * https://developer.mozilla.org/en/DOM/event.initMouseEvent
70 | */
71 | var touch = e.changedTouches[0],
72 | evt = document.createEvent('MouseEvents');
73 | evt.initMouseEvent('click', true, true, window, 0, touch.screenX, touch.screenY, touch.clientX, touch.clientY, false, false, false, false, 0, null);
74 | evt.simulated = true; // distinguish from a normal (nonsimulated) click
75 | e.target.dispatchEvent(evt);
76 | };
77 |
78 | /**
79 | * click
80 | *
81 | * Because we've already fired a click event in touchend,
82 | * we need to listed for all native click events here
83 | * and suppress them as necessary.
84 | */
85 | click = function(e) {
86 | /**
87 | * Prevent ghost clicks by only allowing clicks we created
88 | * in the click event we fired (look for e.simulated)
89 | */
90 | var time = Date.now(),
91 | timeDiff = time - lastClick.time,
92 | x = e.clientX,
93 | y = e.clientY,
94 | xyDiff = [Math.abs(lastClick.x - x), Math.abs(lastClick.y - y)],
95 | target = closest(e.target, 'A') || e.target, // needed for standalone apps
96 | nodeName = target.nodeName,
97 | isLink = nodeName === 'A',
98 | standAlone = window.navigator.standalone && isLink && e.target.getAttribute("href");
99 |
100 | lastClick.time = time;
101 | lastClick.x = x;
102 | lastClick.y = y;
103 |
104 | /**
105 | * Unfortunately Android sometimes fires click events without touch events (seen on Kindle Fire),
106 | * so we have to add more logic to determine the time of the last click. Not perfect...
107 | *
108 | * Older, simpler check: if((!e.simulated) || standAlone)
109 | */
110 | if((!e.simulated && (timeDiff < 500 || (timeDiff < 1500 && xyDiff[0] < 50 && xyDiff[1] < 50))) || standAlone) {
111 | e.preventDefault();
112 | e.stopPropagation();
113 | if(!standAlone) return false;
114 | }
115 |
116 | /**
117 | * Special logic for standalone web apps
118 | * See http://stackoverflow.com/questions/2898740/iphone-safari-web-app-opens-links-in-new-window
119 | */
120 | if(standAlone) {
121 | window.location = target.getAttribute("href");
122 | }
123 |
124 | /**
125 | * Add an energize-focus class to the targeted link (mimics :focus behavior)
126 | * TODO: test and/or remove? Does this work?
127 | */
128 | if(!target || !target.classList) return;
129 | target.classList.add("energize-focus");
130 | window.setTimeout(function(){
131 | target.classList.remove("energize-focus");
132 | }, 150);
133 | };
134 |
135 | /**
136 | * closest
137 | * @param {HTMLElement} node current node to start searching from.
138 | * @param {string} tagName the (uppercase) name of the tag you're looking for.
139 | *
140 | * Find the closest ancestor tag of a given node.
141 | *
142 | * Starts at node and goes up the DOM tree looking for a
143 | * matching nodeName, continuing until hitting document.body
144 | */
145 | closest = function(node, tagName){
146 | var curNode = node;
147 |
148 | while(curNode !== document.body) { // go up the dom until we find the tag we're after
149 | if(!curNode || curNode.nodeName === tagName) { return curNode; } // found
150 | curNode = curNode.parentNode; // not found, so keep going up
151 | }
152 |
153 | return null; // not found
154 | };
155 |
156 | /**
157 | * Add all delegated event listeners
158 | *
159 | * All the events we care about bubble up to document,
160 | * so we can take advantage of event delegation.
161 | *
162 | * Note: no need to wait for DOMContentLoaded here
163 | */
164 | document.addEventListener('touchstart', touchstart, false);
165 | document.addEventListener('touchmove', touchmove, false);
166 | document.addEventListener('touchend', touchend, false);
167 | document.addEventListener('click', click, true); // TODO: why does this use capture?
168 |
169 | })();
--------------------------------------------------------------------------------
/source/includes/_ilo5_securityservice.md:
--------------------------------------------------------------------------------
1 | # Security Service
2 |
3 | Server Identity (DevID) is a standard (based on IEEE 802.1AR) way to uniquely identify a server across networks. DevID is uniquely bound to a server that enables a server to prove its identity in various industry standards and protocols that authenticate, provision, and authorize communicating devices.
4 | iLO supports factory provisioned server identity (iLO IDevID) and user defined server identity (iLO LDevID). iLO also stores the system certificates (System IDevID and System IAK).
5 |
6 | Following are the different server management identities:
7 |
8 | - [iLO IDevID](#ilo-idevid)
9 | - [iLO LDevID](#ilo-ldevid)
10 | - [System IDevID certificate](#system-idevid-certificate)
11 | - [System IAK certificate](#system-iak-certificate)
12 | - [Platform certificate](#platform-certificate)
13 |
14 | ## iLO IDevID
15 |
16 | iLO can be provisioned with server identity in the factory. This factory provisioned server identity is called iLO IDevID. HPE servers can be securely on boarded into a customer network using the IDevID for 802.1X authentication. iLO IDevID has life time validity and is immutable.
17 | To instruct the HPE factory to provision a server with an IDevID, include either SKU P41905-B21 (if you do not have a TPM2.0 module) or P42104-B21 (if you have a TPM2.0 module) in your order.
18 |
19 | ### iLO IDevID features
20 |
21 | iLO does not allow you to update or delete IDevID since it is immutable.
22 | You can view the iLO IDevID certificate using the RESTful API GET command:
23 | `/redfish/v1/Managers/{@managerId}/SecurityService/iLOIDevID/Certificates/{@certId}`
24 |
25 | ## iLO LDevID
26 |
27 | IDevID can be supplemented by a user defined server identity, called iLO LDevID. iLO LDevID is unique in the administrative domain, in which the server is used. HPE servers can be securely on boarded into a customer network using the LDevID for 802.1X authentication. iLO LDevID can be used on servers that do not have iLO IDevID. LDevID helps in facilitating the enrollment (authentication and authorization of credentials) by local network administrators. iLO allows to import, view, and delete LDevID outside the factory.
28 |
29 | ## Importing LDevID certificate
30 |
31 | 1. Generate a Certificate Signing Request (CSR) for LDevID. iLO allows creation of a CSR in PEM format for LDevID using the RESTful API POST command:
32 | `/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR`
33 |
34 | ```json
35 | {
36 | "Action": "CertificateService.GenerateCSR",
37 | "CertificateCollection": {
38 | "@odata.id": "/redfish/v1/Managers/1/SecurityService/iLOLDevID/Certificates/"
39 | }
40 | }
41 | ```
42 |
43 | 2. Send this CSR to Certificate Authority to obtain a trusted certificate.
44 | 3. Import the trusted LDevID certificate into iLO. iLO allows import of LDevID certificate in PEM format using the RESTful API POST command:
45 | `/redfish/v1/Managers/{@managerId}/SecurityService/iLOLDevID/Certificates/`
46 |
47 | ```json
48 |
49 | {
50 | "CertificateType": "PEM",
51 | "CertificateString": "
105 | <%= yield %>
106 | <% current_page.data.includes && current_page.data.includes.each do |include| %>
107 | <%= partial "includes/#{include}" %>
108 | <% end %>
109 |
110 |
111 | <% if language_tabs.any? %>
112 |
123 |
113 | <% language_tabs.each do |lang| %>
114 | <% if lang.is_a? Hash %>
115 | <%= lang.values.first %>
116 | <% else %>
117 | <%= lang %>
118 | <% end %>
119 | <% end %>
120 |
121 | <% end %>
122 |
2 | 
3 |
4 | 
5 |
Slate helps you create beautiful, intelligent, responsive API documentation.
8 | 9 |
The example above was created with Slate. Check it out at lord.github.io/slate.
12 | 13 | Features 14 | ------------ 15 | 16 | * **Clean, intuitive design** — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [Paypal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even in print. 17 | 18 | * **Everything on a single page** — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy. 19 | 20 | * **Slate is just Markdown** — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks. 21 | 22 | * **Write code samples in multiple languages** — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown. 23 | 24 | * **Out-of-the-box syntax highlighting** for [over 100 languages](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers), no configuration required. 25 | 26 | * **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents. 27 | 28 | * **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere. 29 | 30 | Getting started with Slate is super easy! Simply fork this repository and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](http://lord.github.io/slate). 31 | 32 | Getting Started with Slate 33 | ------------------------------ 34 | 35 | ### Prerequisites 36 | 37 | You're going to need: 38 | 39 | - **Linux or OS X** — Windows may work, but is unsupported. 40 | - **Ruby, version 2.2.5 or newer** 41 | - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal. 42 | 43 | ### Getting Set Up 44 | 45 | 1. Fork this repository on Github. 46 | 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` 47 | 3. `cd slate` 48 | 4. Initialize and start Slate. You can either do this locally, or with Vagrant: 49 | 50 | ```shell 51 | # either run this to run locally 52 | bundle install 53 | bundle exec middleman server 54 | 55 | # OR run this to run with vagrant 56 | vagrant up 57 | ``` 58 | 59 | You can now see the docs at http://localhost:4567. Whoa! That was fast! 60 | 61 | Now that Slate is all set up on your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/lord/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/lord/slate/wiki/Deploying-Slate). 62 | 63 | If you'd prefer to use Docker, instructions are available [in the wiki](https://github.com/lord/slate/wiki/Docker). 64 | 65 | Companies Using Slate 66 | --------------------------------- 67 | 68 | * [NASA](https://api.nasa.gov) 69 | * [IBM](https://docs.cloudant.com/api.html) 70 | * [Sony](http://developers.cimediacloud.com) 71 | * [Mozilla](http://localforage.github.io/localForage/) 72 | * [Best Buy](https://bestbuyapis.github.io/api-documentation/) 73 | * [Travis-CI](https://docs.travis-ci.com/api/) 74 | * [Greenhouse](https://developers.greenhouse.io/harvest.html) 75 | * [Woocommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/) 76 | * [Appium](http://appium.io/slate/en/master) 77 | * [Dwolla](https://docs.dwolla.com/) 78 | * [Clearbit](https://clearbit.com/docs) 79 | * [Coinbase](https://developers.coinbase.com/api) 80 | * [Parrot Drones](http://developer.parrot.com/docs/bebop/) 81 | * [Fidor Bank](http://docs.fidor.de/) 82 | * [Scale](https://docs.scaleapi.com/) 83 | 84 | You can view more in [the list on the wiki](https://github.com/lord/slate/wiki/Slate-in-the-Wild). 85 | 86 | Need Help? Found a bug? 87 | -------------------- 88 | 89 | [Submit an issue](https://github.com/lord/slate/issues) to the Slate Github if you need any help. And, of course, feel free to submit pull requests with bug fixes or changes. 90 | 91 | Contributors 92 | -------------------- 93 | 94 | Slate was built by [Robert Lord](https://lord.io) while interning at [TripIt](https://www.tripit.com/). 95 | 96 | Thanks to the following people who have submitted major pull requests: 97 | 98 | - [@chrissrogers](https://github.com/chrissrogers) 99 | - [@bootstraponline](https://github.com/bootstraponline) 100 | - [@realityking](https://github.com/realityking) 101 | - [@cvkef](https://github.com/cvkef) 102 | 103 | Also, thanks to [Sauce Labs](http://saucelabs.com) for helping sponsor the project. 104 | 105 | Special Thanks 106 | -------------------- 107 | - [Middleman](https://github.com/middleman/middleman) 108 | - [jquery.tocify.js](https://github.com/gfranko/jquery.tocify.js) 109 | - [middleman-syntax](https://github.com/middleman/middleman-syntax) 110 | - [middleman-gh-pages](https://github.com/edgecase/middleman-gh-pages) 111 | - [Font Awesome](http://fortawesome.github.io/Font-Awesome/) 112 | -------------------------------------------------------------------------------- /source/includes/_ilo4_authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication and Sessions 2 | 3 | > The following shows the error displayed on `GET /redfish/v1/systems/` when no authentication is attempted: 4 | 5 | ``` 6 | 401 Forbidden 7 | ``` 8 | 9 | ```json 10 | { 11 | "@odata.type": "#ExtendedInfo.ExtendedInfo", 12 | "Messages": [ 13 | { 14 | "MessageID": "Base.0.10.NoValidSession" 15 | } 16 | ], 17 | "Type": "ExtendedError.1.0.0", 18 | "error": { 19 | "@Message.ExtendedInfo": [ 20 | { 21 | "MessageId": "Base.0.10.NoValidSession" 22 | } 23 | ], 24 | "code": "iLO.0.10.GeneralError", 25 | "message": "A general error has occurred. See ExtendedInfo for more information." 26 | } 27 | } 28 | ``` 29 | 30 | If you perform an HTTP operation on any other resource other than the root `/redfish/v1/` resource, you will receive an `HTTP 401 (Forbidden)` error indicating that you don’t have the authentication needed to access the resource. 31 | 32 | ## Basic Authentication 33 | 34 | ```shell 35 | curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L 36 | ``` 37 | 38 | ```python 39 | import sys 40 | import redfish 41 | 42 | # When running remotely connect using the iLO address, iLO account name, 43 | # and password to send https requests 44 | iLO_host = "https://{iLO}" 45 | login_account = "admin" 46 | login_password = "password" 47 | 48 | ## Create a REDFISH object 49 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 50 | password=login_password, default_prefix='/redfish/v1') 51 | 52 | # Login into the server and create a session 53 | REDFISH_OBJ.login(auth="basic") 54 | 55 | # Logout of the current session 56 | REDFISH_OBJ.logout() 57 | ``` 58 | 59 | The RESTful API allows you to use HTTP Basic Authentication using a valid iLO user name and password. 60 | 61 | ## Creating and Using Sessions 62 | 63 | ```shell 64 | curl -H "Content-Type: application/json" -H "OData-Version: 4.0" -X POST --data "@data.json" https://{iLO}/redfish/v1/SessionService/Sessions/ --insecure 65 | ``` 66 | 67 | ```python 68 | import redfish 69 | 70 | # When running remotely connect using the iLO address, iLO account name, 71 | # and password to send https requests 72 | iLO_host = "https://{iLO}" 73 | login_account = "admin" 74 | login_password = "password" 75 | 76 | ## Create a REDFISH object 77 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 78 | password=login_password, default_prefix='/redfish/v1') 79 | 80 | # Login into the server and create a session 81 | REDFISH_OBJ.login(auth="session") 82 | ``` 83 | 84 | > Contents of data.json 85 | 86 | ```json 87 | { 88 | "UserName": "26 |33 | 34 | ```shell 35 | { 36 | "@odata.type": "#ServiceRoot.v1_0_0.ServiceRoot", 37 | "Name": "Service Root", 38 | "RedfishVersion": "0.96.0", 39 | "@odata.id": "/redfish/v1/", 40 | "@odata.context": "/redfish/v1/$metadata#ServiceRoot", 41 | "Time": "2014-09-03T11:00:00+00:00", 42 | "UUID": "92384634-2938-2342-8820-489239905423", 43 | "Oem": { 44 | "Hp": { 45 | "@odata.type": "#HpiLOServiceExt.1.0.0.HpiLOServiceExt", 46 | "Manager": [{ 47 | "ManagerFirmwareVersion": "2.50", 48 | "HostName": "ILOHD53NP0108", 49 | "ManagerType": "iLO 4", 50 | "IPManager": { 51 | "ManagerUrl": { 52 | "xref": "https://16.85.178.23" 53 | }, 54 | "Name": "Management Console Information", 55 | "ManagerType": "OneView", 56 | "OvManagesiLOIP": false, 57 | "ManagerProductName": "HP OneView", 58 | "FirmwareManaged": false, 59 | "SppVersion": null, 60 | "StorageManaged": false, 61 | "iLOManaged": true, 62 | "Type": "HPQ_iLOManagerDescriptor/1.1.0", 63 | "BiosManaged": false 64 | }, 65 | "Blade": { 66 | "BayNumber": "Bay 3" 67 | }, 68 | "FQDN": "ILOHD53NP0108.americas.hpqcorp.net", 69 | "DefaultLanguage": "en", 70 | "Languages": [{ 71 | "Version": "2.50.15", 72 | "Language": "en", 73 | "TranslationName": "English" 74 | }], 75 | "ManagerFirmwareVersionPass": "15" 76 | }], 77 | "Sessions": { 78 | "LocalLoginEnabled": true, 79 | "LoginFailureDelay": 0, 80 | "LDAPAuthLicenced": true, 81 | "KerberosEnabled": false, 82 | "ServerName": "WIN-MKNP1GNHVSN", 83 | "SecurityOverride": true, 84 | "CertCommonName": "ILOHD53NP0108.americas.hpqcorp.net", 85 | "LoginHint": { 86 | "HintPOSTData": { 87 | "UserName": "username", 88 | "Password": "password" 89 | }, 90 | "Hint": "POST to /Sessions to login using the following JSON object:" 91 | }, 92 | "LDAPEnabled": false 93 | } 94 | } 95 | }, 96 | "Id": "v1", 97 | "Chassis": { 98 | "@odata.id": "/redfish/v1/chassis/" 99 | }, 100 | "Managers": { 101 | "@odata.id": "/redfish/v1/managers/" 102 | }, 103 | "Systems": { 104 | "@odata.id": "/redfish/v1/systems/" 105 | }, 106 | "Providers": { 107 | "@odata.id": "/redfish/v1/providers/" 108 | }, 109 | "Sessions": { 110 | "@odata.id": "/redfish/v1/sessions/" 111 | } 112 | } 113 | ``` 114 | 115 | Let’s perform our first GET operation using the RESTful API. We will do an HTTP GET on the iLO HTTPS port, typically port 443 (although it could be different if you have previously configured iLO to use another port). Your client should be prepared to handle the HTTPS certificate challenge. The interface is not available over open HTTP (port 80), so you must use HTTPS. 116 | 117 | Our GET operation will be against a resource at `/redfish/v1/` (with a trailing slash): 118 | 119 | It is best to perform this initial GET with a tool like the CURL or the Postman REST Client mentioned above. Later you will want to do this with your own scripting code, but for now it’s useful to see the HTTP header information exchanged using a browser. 120 | 121 | CURL is a command line utility available for many Operating Systems that enables easy access to the RESTful API. CURL is available at [http://curl.haxx.se/](http://curl.haxx.se/). Note that all the CURL examples will use a flag –insecure. This causes CURL to bypass validation of the HTTPS certificate. In real use iLO should be configured to use a user-supplied certificate and this option is not necessary. Notice also that we use the –L option to force CURL to follow HTTP redirect responses. If iLO changes URI locations for various items, it can indicate to the client where the new location is and automatically follow the new link. 122 | 123 | In JSON, there is no strong ordering of property names, so iLO may return JSON properties in any order. Likewise, iLO cannot assume the order of properties in any submitted JSON. This is why the best scripting data structure for a RESTful client is a dictionary: a simple set of unordered key/value pairs. This lack of ordering is also the reason you see embedded structure within objects (objects within objects). This allows us to keep related data together that is more logically organized, aesthetically pleasing to view, and helps avoid property name conflicts or ridiculously long property names. It also allows us to use identical blocks of JSON in many places in the data model, like status. 124 | 125 | 126 | ## HTTP Resource Operations 127 | 128 | Operation | HTTP Command | Description 129 | -------------- | -------------- | -------------- 130 | Create | POST resource URI (payload = resource data) | Creates a new resource or invokes a custom action. A synchronous POST returns the newly created resource. 131 | Read | GET resource URI | Returns the requested resource representation. 132 | Update | PATCH or PUT resource URI (payload = update data) | Updates an existing resource. You can only PATCH properties that are marked readonly = false in the schema. 133 | Delete | DELETE resource URI | Deletes the specified resource. 134 | 135 | ## HTTP Status Return Codes 136 | 137 | Return Status | Description 138 | -------------- | -------------- | -------------- 139 | 2xx | Successful operation. 140 | 308 | The resource has moved 141 | 4xx | Client-side error with message returned 142 | 5xx | iLO error with error message returned 143 | 144 | 147 | 148 | 149 | -------------------------------------------------------------------------------- /source/includes/_ilo4_navigating.md: -------------------------------------------------------------------------------- 1 | # Navigating the Data Model 2 | 3 | Unlike some simple REST service, this API is designed to be implemented on many different models of servers and other IT infrastructure devices for years to come. These devices may be quite different from one another. For this reason, the API does not specify the URIs to various resources. Do not assume the BIOS version information is always at a particular URI. 4 | 5 | This is more complex for the client, but is necessary to make sure the data model can change to accommodate various future server architectures without requiring specification changes. As an example, if the BIOS version is at `/redfish/v1/systems/1/`, and a client assumed it is always there, the client would then break when the interface is implemented on a different type of architecture with many compute nodes, each with its own BIOS version. 6 | 7 | 10 | 11 | The supported stable URIs are those referenced directly in this API reference and include: 12 | 13 | * /redfish/v1/ 14 | * /redfish/v1/systems/ 15 | * /redfish/v1/chassis/ 16 | * /redfish/v1/managers/ 17 | * /redfish/v1/sessions/ 18 | 19 | 20 | ## Iterating Collections 21 | 22 | ```shell 23 | curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L 24 | ``` 25 | 26 | ```python 27 | import sys 28 | import redfish 29 | 30 | # When running remotely connect using the iLO address, iLO account name, 31 | # and password to send https requests 32 | iLO_host = "https://{iLO}" 33 | login_account = "admin" 34 | login_password = "password" 35 | 36 | ## Create a REDFISH object 37 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 38 | password=login_password, default_prefix='/redfish/v1') 39 | 40 | # Login into the server and create a session 41 | REDFISH_OBJ.login(auth="session") 42 | 43 | # Do a GET on a given path 44 | response = REDFISH_OBJ.get("/redfish/v1/systems/", None) 45 | 46 | # Print out the response 47 | sys.stdout.write("%s\n" % response) 48 | 49 | # Logout of the current session 50 | REDFISH_OBJ.logout() 51 | ``` 52 | 53 | > JSON response example: 54 | 55 | ```json 56 | { 57 | "@odata.id": "/redfish/v1/systems/", 58 | "@odata.context": "/redfish/v1/$metadata/", 59 | "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", 60 | "Members@odata.count": 1, 61 | "Members": [ 62 | { 63 | "@odata.id": "/redfish/v1/systems/1/" 64 | } 65 | ] 66 | } 67 | ``` 68 | 69 | Many operations will require you to locate the resource you wish to use. Most of these resources are members of "collections" (arrays of similar items). The method to find collections members is consistent for compute nodes, chassis, management processors, and many other resources in the data model. 70 | 71 | ## Find a Compute Node 72 | 73 | ```shell 74 | curl https://{host}/redfish/v1/systems/{item}/ -i --insecure -u username:password -L 75 | ``` 76 | 77 | ```python 78 | import sys 79 | import redfish 80 | 81 | # When running remotely connect using the iLO address, iLO account name, 82 | # and password to send https requests 83 | iLO_host = "https://{iLO}" 84 | login_account = "admin" 85 | login_password = "password" 86 | 87 | ## Create a REDFISH object 88 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 89 | password=login_password, default_prefix='/redfish/v1') 90 | 91 | # Login into the server and create a session 92 | REDFISH_OBJ.login(auth="session") 93 | 94 | # Do a GET on a given path 95 | response = REDFISH_OBJ.get("/redfish/v1/systems/{item}/", None) 96 | 97 | # Print out the response 98 | sys.stdout.write("%s\n" % response) 99 | 100 | # Logout of the current session 101 | REDFISH_OBJ.logout() 102 | ``` 103 | 104 | > JSON response example: 105 | 106 | ```json 107 | { 108 | "@odata.context": "/redfish/v1/$metadata#Systems/Members/$entity", 109 | "@odata.id": "/redfish/v1/Systems/1/", 110 | "@odata.type": "#ComputerSystem.1.0.1.ComputerSystem", 111 | ... 112 | 113 | ... 114 | "SerialNumber": "Kappa", 115 | "Status": { 116 | "Health": "Warning", 117 | "State": "Enabled" 118 | }, 119 | "SystemType": "Physical", 120 | "UUID": "00000000-0000-614B-7070-610000000000" 121 | } 122 | ``` 123 | 124 | A Compute node represents a logical computer system with attributes such as processors, memory, BIOS, power state, firmware version, etc. To find a compute node `GET /redfish/v1/systems` and iterate the "Members" array in the returned JSON. Each member has a link to a compute node. 125 | 126 | Find a compute node by iterating the systems collection at `/redfish/v1/systems/`. 127 | 128 | You can then GET the compute node, PATCH values, or perform Actions. 129 | 130 | ## Find a Chassis 131 | 132 | ```shell 133 | curl https://{host}/redfish/v1/chassis/{item}/ -i --insecure -u username:password -L 134 | ``` 135 | 136 | ```python 137 | import sys 138 | import redfish 139 | 140 | # When running remotely connect using the iLO address, iLO account name, 141 | # and password to send https requests 142 | iLO_host = "https://{iLO}" 143 | login_account = "admin" 144 | login_password = "password" 145 | 146 | ## Create a REDFISH object 147 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 148 | password=login_password, default_prefix='/redfish/v1') 149 | 150 | # Login into the server and create a session 151 | REDFISH_OBJ.login(auth="session") 152 | 153 | # Do a GET on a given path 154 | response = REDFISH_OBJ.get("/redfish/v1/chassis/{item}/", None) 155 | 156 | # Print out the response 157 | sys.stdout.write("%s\n" % response) 158 | 159 | # Logout of the current session 160 | REDFISH_OBJ.logout() 161 | ``` 162 | 163 | > JSON response example: 164 | 165 | ```json 166 | { 167 | "@odata.context": "/redfish/v1/$metadata#Chassis/Members/$entity", 168 | "@odata.id": "/redfish/v1/Chassis/1/", 169 | "@odata.type": "#Chassis.1.0.0.Chassis", 170 | "ChassisType": "RackMount", 171 | ... 172 | 173 | ... 174 | "Status": { 175 | "Health": "Warning", 176 | "State": "Enabled" 177 | }, 178 | "Thermal": { 179 | "@odata.id": "/redfish/v1/Chassis/1/Thermal/" 180 | } 181 | } 182 | ``` 183 | 184 | A Chassis represents a physical or virtual container of compute resources with attrbutes such as FRU information, power supplies, temperature, etc. To find a chassis `GET /redfish/v1/chassis` and iterate the "Members" array in the returned JSON. Each member has a link to a chassis. 185 | 186 | Find a chassis by iterating the chassis collection at `/redfish/v1/chassis/`. 187 | 188 | You can then GET the chassis, PATCH values, or perform Actions. 189 | 190 | ## Find the iLO 4 Management Processor 191 | 192 | ```shell 193 | curl https://{host}/redfish/v1/managers/{item}/ -i --insecure -u username:password -L 194 | ``` 195 | 196 | ```python 197 | import sys 198 | import redfish 199 | 200 | # When running remotely connect using the iLO address, iLO account name, 201 | # and password to send https requests 202 | iLO_host = "https://{iLO}" 203 | login_account = "admin" 204 | login_password = "password" 205 | 206 | ## Create a REDFISH object 207 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 208 | password=login_password, default_prefix='/redfish/v1') 209 | 210 | # Login into the server and create a session 211 | REDFISH_OBJ.login(auth="session") 212 | 213 | # Do a GET on a given path 214 | response = REDFISH_OBJ.get("/redfish/v1/managers/{item}/", None) 215 | 216 | # Print out the response 217 | sys.stdout.write("%s\n" % response) 218 | 219 | # Logout of the current session 220 | REDFISH_OBJ.logout() 221 | ``` 222 | 223 | > JSON response example: 224 | 225 | ```json 226 | { 227 | "@odata.context": "/redfish/v1/$metadata#Managers/Members/$entity", 228 | "@odata.id": "/redfish/v1/Managers/1/", 229 | "@odata.type": "#Manager.1.0.0.Manager", 230 | ... 231 | 232 | ... 233 | "Status": { 234 | "State": "Enabled" 235 | }, 236 | "UUID": null, 237 | "VirtualMedia": { 238 | "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/" 239 | } 240 | } 241 | ``` 242 | 243 | A Manager represents a management processor (or "BMC") that manages chassis and compute resources. For HPE Servers, the manager is iLO 4. Managers contain attributes such as networking state and configuration, management services, security configuration, etc. To find a manager `GET /redfish/v1/managers` and iterate the "Members" array in the returned JSON. Each member has a link to a chassis. 244 | 245 | Find a manager by iterating the manager collection at `/redfish/v1/managers/`. 246 | 247 | You can then GET the manager, PATCH values, or perform Actions. 248 | 249 | -------------------------------------------------------------------------------- /source/includes/_ilo5_navigating.md: -------------------------------------------------------------------------------- 1 | # Navigating the Data Model 2 | 3 | The Redfish API is designed to be implemented on many different models of servers and other IT infrastructure devices for years to come. These devices may be quite different from one another. For this reason, the Redfish API does not specify the URIs to various resources. For example, a client cannot assume the BIOS version information is always at a particular URI. 4 | 5 | This is more complex for the client, but is necessary to make sure the data model can change to accommodate various future server architectures without requiring specification changes. As an example, if the BIOS version is at `/redfish/v1/Systems/1`, and a client assumed it is always there, the client would then break when the interface is implemented on a different type of architecture with many compute nodes, each with its own BIOS version, or on other vendor implementations. 6 | 7 | ## Redfish 1.6 (iLO 5 1.40 or later) URI Templates 8 | As of Redfish 1.6, a number of resource types have URI template specifications to be compatible with OpenAPI 3.0. Please see the Redfish 1.6 CSDL schema for details on URI templates for specific types. 9 | 10 | A client must still perform GET operations on a Redfish API service in order to discover what resources are available. For instance, just because a Chassis has a template of `/redfish/v1/Chassis/{ChassisId}` means that a client must still GET `/redfish/v1/Chassis` in order to find the valid values of `{ChassisId}`. 11 | 12 | ## Iterating Collections 13 | 14 | ```shell 15 | curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L 16 | ``` 17 | 18 | ```python 19 | import sys 20 | import redfish 21 | 22 | # When running remotely connect using the iLO address, iLO account name, 23 | # and password to send https requests 24 | iLO_host = "https://{iLO}" 25 | login_account = "admin" 26 | login_password = "password" 27 | 28 | ## Create a REDFISH object 29 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 30 | password=login_password, default_prefix='/redfish/v1') 31 | 32 | # Login into the server and create a session 33 | REDFISH_OBJ.login(auth="session") 34 | 35 | # Do a GET on a given path 36 | response = REDFISH_OBJ.get("/redfish/v1/systems/", None) 37 | 38 | # Print out the response 39 | sys.stdout.write("%s\n" % response) 40 | 41 | # Logout of the current session 42 | REDFISH_OBJ.logout() 43 | ``` 44 | 45 | > JSON response example: 46 | 47 | ```json 48 | { 49 | "@odata.id": "/redfish/v1/systems/", 50 | "@odata.context": "/redfish/v1/$metadata/", 51 | "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", 52 | "Members@odata.count": 1, 53 | "Members": [ 54 | { 55 | "@odata.id": "/redfish/v1/systems/1/" 56 | } 57 | ] 58 | } 59 | ``` 60 | 61 | Many operations will require you to locate the resource you wish to use. Most of these resources are members of "collections" (arrays of similar items). The method to find collections members is consistent for compute nodes, chassis, management processors, and many other resources in the data model. 62 | 63 | ## Find a Compute Node 64 | 65 | ```shell 66 | curl https://{host}/redfish/v1/systems/{item}/ -i --insecure -u username:password -L 67 | ``` 68 | 69 | ```python 70 | import sys 71 | import redfish 72 | 73 | # When running remotely connect using the iLO address, iLO account name, 74 | # and password to send https requests 75 | iLO_host = "https://{iLO}" 76 | login_account = "admin" 77 | login_password = "password" 78 | 79 | ## Create a REDFISH object 80 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 81 | password=login_password, default_prefix='/redfish/v1') 82 | 83 | # Login into the server and create a session 84 | REDFISH_OBJ.login(auth="session") 85 | 86 | # Do a GET on a given path 87 | response = REDFISH_OBJ.get("/redfish/v1/systems/{item}/", None) 88 | 89 | # Print out the response 90 | sys.stdout.write("%s\n" % response) 91 | 92 | # Logout of the current session 93 | REDFISH_OBJ.logout() 94 | ``` 95 | 96 | > JSON response example: 97 | 98 | ```json 99 | { 100 | "@odata.context": "/redfish/v1/$metadata#Systems/Members/$entity", 101 | "@odata.id": "/redfish/v1/Systems/1/", 102 | "@odata.type": "#ComputerSystem.1.0.1.ComputerSystem", 103 | ... 104 | 105 | ... 106 | "SerialNumber": "Kappa", 107 | "Status": { 108 | "Health": "Warning", 109 | "State": "Enabled" 110 | }, 111 | "SystemType": "Physical", 112 | "UUID": "00000000-0000-614B-7070-610000000000" 113 | } 114 | ``` 115 | 116 | A Compute node represents a logical computer system with attributes such as processors, memory, BIOS, power state, firmware version, etc. To find a compute node `GET /redfish/v1/systems` and iterate the "Members" array in the returned JSON. Each member has a link to a compute node. 117 | 118 | Find a compute node by iterating the systems collection at `/redfish/v1/systems/`. 119 | 120 | You can then GET the compute node, PATCH values, or perform Actions. 121 | 122 | ## Find a Chassis 123 | 124 | ```shell 125 | curl https://{host}/redfish/v1/chassis/{item}/ -i --insecure -u username:password -L 126 | ``` 127 | 128 | ```python 129 | import sys 130 | import redfish 131 | 132 | # When running remotely connect using the iLO address, iLO account name, 133 | # and password to send https requests 134 | iLO_host = "https://{iLO}" 135 | login_account = "admin" 136 | login_password = "password" 137 | 138 | ## Create a REDFISH object 139 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 140 | password=login_password, default_prefix='/redfish/v1') 141 | 142 | # Login into the server and create a session 143 | REDFISH_OBJ.login(auth="session") 144 | 145 | # Do a GET on a given path 146 | response = REDFISH_OBJ.get("/redfish/v1/chassis/{item}/", None) 147 | 148 | # Print out the response 149 | sys.stdout.write("%s\n" % response) 150 | 151 | # Logout of the current session 152 | REDFISH_OBJ.logout() 153 | ``` 154 | 155 | > JSON response example: 156 | 157 | ```json 158 | { 159 | "@odata.context": "/redfish/v1/$metadata#Chassis/Members/$entity", 160 | "@odata.id": "/redfish/v1/Chassis/1/", 161 | "@odata.type": "#Chassis.1.0.0.Chassis", 162 | "ChassisType": "RackMount", 163 | ... 164 | 165 | ... 166 | "Status": { 167 | "Health": "Warning", 168 | "State": "Enabled" 169 | }, 170 | "Thermal": { 171 | "@odata.id": "/redfish/v1/Chassis/1/Thermal/" 172 | } 173 | } 174 | ``` 175 | 176 | A Chassis represents a physical or virtual container of compute resources with attributes such as FRU information, power supplies, temperature, etc. To find a chassis `GET /redfish/v1/chassis` and iterate the "Members" array in the returned JSON. Each member has a link to a chassis. 177 | 178 | Find a chassis by iterating the chassis collection at `/redfish/v1/chassis/`. 179 | 180 | You can then GET the chassis, PATCH values, or perform Actions. 181 | 182 | ## Find the iLO 5 Management Processor 183 | 184 | ```shell 185 | curl https://{host}/redfish/v1/managers/{item}/ -i --insecure -u username:password -L 186 | ``` 187 | 188 | ```python 189 | import sys 190 | import redfish 191 | 192 | # When running remotely connect using the iLO address, iLO account name, 193 | # and password to send https requests 194 | iLO_host = "https://{iLO}" 195 | login_account = "admin" 196 | login_password = "password" 197 | 198 | ## Create a REDFISH object 199 | REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \ 200 | password=login_password, default_prefix='/redfish/v1') 201 | 202 | # Login into the server and create a session 203 | REDFISH_OBJ.login(auth="session") 204 | 205 | # Do a GET on a given path 206 | response = REDFISH_OBJ.get("/redfish/v1/managers/{item}/", None) 207 | 208 | # Print out the response 209 | sys.stdout.write("%s\n" % response) 210 | 211 | # Logout of the current session 212 | REDFISH_OBJ.logout() 213 | ``` 214 | 215 | > JSON response example: 216 | 217 | ```json 218 | { 219 | "@odata.context": "/redfish/v1/$metadata#Managers/Members/$entity", 220 | "@odata.id": "/redfish/v1/Managers/1/", 221 | "@odata.type": "#Manager.1.0.0.Manager", 222 | ... 223 | 224 | ... 225 | "Status": { 226 | "State": "Enabled" 227 | }, 228 | "UUID": null, 229 | "VirtualMedia": { 230 | "@odata.id": "/redfish/v1/Managers/1/VirtualMedia/" 231 | } 232 | } 233 | ``` 234 | 235 | A Manager represents a management processor (or "BMC") that manages chassis and compute resources. For HPE Gen10 Servers, the manager is iLO 5. Managers contain attributes such as networking state and configuration, management services, security configuration, etc. To find a manager `GET /redfish/v1/managers` and iterate the "Members" array in the returned JSON. Each member has a link to a chassis. 236 | 237 | Find a manager by iterating the manager collection at `/redfish/v1/managers/`. 238 | 239 | You can then GET the manager, PATCH values, or perform Actions. 240 | 241 | -------------------------------------------------------------------------------- /source/includes/_ilo5_logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | 3 | iLO 5 features a logging service that enables you to view logs of different categories. These logs are of three types - Security Logs (SL), Integrated Management Logs (IML) and iLO Event Logs (IEL). All of these logs can be accessed through Redfish. 4 | 5 | ## Security Logs 6 | 7 | The Security Logs provide a record of the security events recorded by the iLO firmware. 8 | Examples of the logged events include changes to the security configuration and security compliance issues. Other logged events include hardware intrusion, maintenance, and denial of service. 9 | The security logs provide a focused view of all recorded security events. 10 | When the security log is full, the new events overwrite the previous event in the log. 11 | 12 | ### Accessing SLs through Redfish 13 | 14 | To access the Redfish SL resource, perform `GET` on `/redfish/v1/Systems/1/LogServices/SL/`. This resource includes a link to the collection of entries `/redfish/v1/Systems/1/LogServices/SL/Entries/` and an action `/redfish/v1/Systems/1/LogServices/SL/Actions/LogService.ClearLog` to clear the SLs. Individual SLs can be accessed by performing `GET` on `/redfish/v1/Systems/1/LogServices/SL/Entries/{@SlId}`. 15 | 16 | ```shell 17 | > curl https://{iLO}/redfish/v1/systems/1/logservices/sl/entries/{SlId} -i --insecure -L 18 | ``` 19 | 20 | ```json 21 | { 22 | "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry", 23 | "@odata.etag": "W/\"89680635\"", 24 | "@odata.id": "/redfish/v1/Systems/1/LogServices/SL/Entries/3", 25 | "@odata.type": "#LogEntry.v1_1_0.LogEntry", 26 | "Id": "3", 27 | "Created": "2020-01-08T11:15:41Z", 28 | "EntryType": "Oem", 29 | "Message": "iLO detected 3 unauthorized login attempts.", 30 | "Name": "Security Log", 31 | "Oem": { 32 | "Hpe": { 33 | "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry", 34 | "@odata.type": "#HpeLogEntry.v2_3_0.HpeLogEntry", 35 | "Categories": [ 36 | "Security", 37 | "Administration" 38 | ], 39 | "Class": 56, 40 | "ClassDescription": "Denial of Service", 41 | "Code": 2, 42 | "Count": 1, 43 | "EventNumber": 3, 44 | "Severity": "Informational", 45 | "Updated": "2020-01-08T11:15:41Z", 46 | "UserAction": "Not Applicable" 47 | } 48 | }, 49 | "OemRecordFormat": "Hpe-SL", 50 | "Severity": "OK" 51 | } 52 | ``` 53 | 54 | ### Clearing SLs through Redfish Action 55 | 56 | To completely clear all SLs, perform `POST` on `https://{iLOIP}/redfish/v1/systems/1/logservices/sl/Actions/LogService.ClearLog`. 57 | 58 | **NOTE : Cleared SLs will be available in the server AHS logs.** 59 | 60 | ## Integrated Management Log 61 | 62 | The IML provides a record of historical events that have occurred on the server. Events are generated by the system ROM and by services such as the iLO drivers. Logged events include server-specific information such as health and status information, firmware updates, operating system information, and ROM-based POST codes. 63 | Entries in the IML can help you diagnose issues or identify potential issues. Preventative action might help to avoid disruption of service. 64 | When the IML is full, new events overwrite the previous event in the log. 65 | 66 | ### Examples of IML event types 67 | 68 | - Fan actions and status 69 | - Power supply actions and status 70 | - Temperature status and automatic shutdown actions 71 | - Drive failure 72 | - Firmware flash actions 73 | - Smart Storage Energy Pack status 74 | - Network actions and status 75 | 76 | ### Accessing IMLs through Redfish 77 | 78 | To access the Redfish IML resource, perform `GET` on `/redfish/v1/Systems/1/LogServices/IML/`. This resource includes a link to the collection of entries `/redfish/v1/Systems/1/LogServices/IML/Entries/` and an action `LogService.ClearLog` to clear the IMLs. Individual IMLs can be accessed by performing `GET` on `/redfish/v1/Systems/1/LogServices/IML/Entries/{@ImlId}`. 79 | 80 | ```shell 81 | > curl https://{iLO}/redfish/v1/systems/1/logservices/iml/entries/{ImlId} -i --insecure -L 82 | ``` 83 | 84 | ```json 85 | { 86 | "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry", 87 | "@odata.etag": "W/\"C18B58CC\"", 88 | "@odata.id": "/redfish/v1/Systems/1/LogServices/IML/Entries/1", 89 | "@odata.type": "#LogEntry.v1_1_0.LogEntry", 90 | "Id": "1", 91 | "Created": "0000-00-00T00:00:00Z", 92 | "EntryType": "Oem", 93 | "Message": "IML Cleared (iLO user: admin)", 94 | "Name": "Integrated Management Log", 95 | "Oem": { 96 | "Hpe": { 97 | "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry", 98 | "@odata.type": "#HpeLogEntry.v2_3_0.HpeLogEntry", 99 | "Categories": [ 100 | "Maintenance", 101 | "Administration" 102 | ], 103 | "Class": 33, 104 | "ClassDescription": "Maintenance", 105 | "Code": 1, 106 | "Count": 1, 107 | "EventNumber": 51, 108 | "Severity": "Informational", 109 | "Updated": "0000-00-00T00:00:00Z" 110 | } 111 | }, 112 | "OemRecordFormat": "Hpe-IML", 113 | "Severity": "OK" 114 | } 115 | ``` 116 | 117 | ### Repairing IMLs through Redfish PATCH 118 | 119 | To manually mark an IML event as repaired, perform a `PATCH` on `https://{iLOIP}/redfish/v1/systems/1/logservices/iml/entries/{ImlId}`. This is only supported on events that are of severity `Caution` or `Critical`. 120 | 121 | **NOTE : When events are manually marked as repaired, SNMP or REST alerts are not notified.** 122 | > PATCH /redfish/v1/systems/1/logservices/iml/entries/{ImlId} 123 | 124 | ```json 125 | { 126 | "Oem" : { 127 | "Hpe" : { 128 | "Repaired" : true 129 | } 130 | } 131 | } 132 | ``` 133 | 134 | ### Clearing IMLs through Redfish Action 135 | 136 | To completely clear all IMLs, perform `POST` on `https://{iLOIP}/redfish/v1/systems/1/logservices/iml/Actions/LogService.ClearLog`. 137 | 138 | **NOTE : Cleared IMLs are available in the server AHS logs.** 139 | 140 | ## iLO Event Log 141 | 142 | The iLO Event Log provides a record of significant events recorded by the iLO firmware. 143 | Examples of the logged events include server events such as a server power outage or a server reset. Other logged events include logins, virtual power events, clearing the log, and some configuration changes. 144 | iLO provides secure password encryption, tracking all login attempts and maintaining a record of all login failures. The **Authentication Failure Logging** setting allows you to configure logging criteria for failed authentications. The event log captures the client name for each logged entry to improve auditing capabilities in DHCP environments, and records the account name, computer name, and IP address. 145 | When the event log is full, each new event overwrites the oldest event in the log. 146 | For a list of the errors that might appear in the event log, see the error messages guide for your server. 147 | 148 | ### Accessing IELs through Redfish 149 | 150 | To access the Redfish IEL resource, perform `GET` on `/redfish/v1/Managers/1/LogServices/IEL/`. This resource includes a link to the collection of entries `/redfish/v1/Managers/1/LogServices/IEL/Entries/` and an action `/redfish/v1/Managers/1/LogServices/IEL/Actions/LogService.ClearLog` to clear the IELs. Individual IELs can be accessed by performing `GET` on `/redfish/v1/Managers/1/LogServices/IEL/Entries/{@IelId}`. 151 | 152 | ```shell 153 | > curl https://{iLO}/redfish/v1/managers/1/logservices/iel/entries/{IelId} -i --insecure -L 154 | ``` 155 | 156 | ```json 157 | { 158 | "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry", 159 | "@odata.etag": "W/\"C1EEC71D\"", 160 | "@odata.id": "/redfish/v1/Managers/1/LogServices/IEL/Entries/1", 161 | "@odata.type": "#LogEntry.v1_1_0.LogEntry", 162 | "Id": "1", 163 | "Created": "2022-02-25T05:13:01Z", 164 | "EntryType": "Oem", 165 | "Message": "Host REST login: System Administrator", 166 | "Name": "iLO Event Log", 167 | "Oem": { 168 | "Hpe": { 169 | "@odata.context": "/redfish/v1/$metadata#HpeLogEntry.HpeLogEntry", 170 | "@odata.type": "#HpeLogEntry.v2_3_0.HpeLogEntry", 171 | "Categories": [ 172 | "Security", 173 | "Administration" 174 | ], 175 | "Class": 35, 176 | "ClassDescription": "iLO 5", 177 | "Code": 1131, 178 | "Count": 11, 179 | "EventNumber": 256407, 180 | "Severity": "Informational", 181 | "Updated": "2022-02-25T05:13:11Z" 182 | } 183 | }, 184 | "OemRecordFormat": "Hpe-iLOEventLog", 185 | "Severity": "OK" 186 | } 187 | ``` 188 | 189 | ### Clearing IELs through Redfish Action 190 | 191 | To completely clear all IELs, perform `POST` on `https://{iLOIP}/redfish/v1/managers/1/logservices/iel/Actions/LogService.ClearLog`. 192 | 193 | **NOTE : Cleared IELs will still be present in the server AHS logs.** -------------------------------------------------------------------------------- /source/includes/_ilo5_securesystemerase.md: -------------------------------------------------------------------------------- 1 | # Secure Erase 2 | 3 | 6 | 7 | The secure erase process resets iLO and deletes all licenses stored there, resets BIOS settings, and deletes all AHS and warranty data stored on the system. The secure erase process also erases supported non-volatile storage data and deletes any deployment settings profiles. iLO reboots multiple times after the process is initiated. 8 | 9 | 12 | 13 | **NOTE:** Securely erasing the server can take up to a day to complete. 14 | 15 | Secure erase erases supported non-volatile storage data and returns the server to the manufacturing default state. The feature complies with specification NIST SP 800-88 Revision 1, *Guidelines for Media Sanitization*. 16 | For more information about NIST SP 800-88, see https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-88r1.pdf. 17 | Section 2.5 of the specification describes the level of sanitization. The appendix recommends minimum sanitization levels for media. 18 | Secure erase implements the NIST SP 800-88 Revision 1 Sanitization Recommendations for Purging user data and returns the server and supported components to the default state. This feature automates many of the tasks you follow in the *Statement of Volatility* document for a server. 19 | To view what was erased successfully, see [View secure erase report](#view-secure-erase-report). The process can take up to a day to fully erase and reset all user data. When you activate secure erase, iLO 5 does not allow firmware update or reset operations. **DO NOT perform any iLO 5 configuration changes until this process is completed.** 20 | 21 | ## Secure erase access methods 22 | 23 | You can initiate the secure erase process from the following products: 24 | 25 | * iLO 5 2.30 or later 26 | * Intelligent Provisioning 3.30 or later 27 | * The iLO RESTful API 28 | 29 | ## Prerequisites 30 | 31 | * User account must have all iLO 5 permissions, including `SystemRecoveryConfigPriv`. 32 | * iLO Advanced license. 33 | * Set the iLO security setting on the system maintenance switch to the OFF position. 34 | * Disconnect any FCoE, iSCSI, external SAS, and Fibre Channel storage before using secure erase. 35 | * Disable **Server Configuration Lock**. For instructions, see the *UEFI System Utilities User Guide for HPE ProLiant Gen10 Servers and HPE Synergy*. 36 | * Disable **Smart Storage Encryption**. For instructions, see the "Clearing the encryption configuration" section in the *HPE Smart Array SR Secure Encryption Installation and User Guide*. 37 | * For c-Class and Synergy users: Remove HPE OneView or Virtual Connect profiles assigned to the system. 38 | 39 | ## Process flow 40 | 41 | 1. User initiates secure erase. 42 | 2. Upon reboot, BIOS erases configuration, system time, TPM configuration and user data (drives and persistent memory). The system powers off after completion. 43 | 3. iLO 5 then erases key NVRAM and NAND data, and then automatically resets. 44 | 45 | ### Initiating secure erase through Redfish 46 | 47 | To initiate secure erase, perform a `POST` on `/redfish/v1/Systems/27 |
31 |- -i returns HTTP response headers
28 |- --insecure bypasses TLS/SSL certification verification
29 |- -L follows HTTP redirect
30 |The above command returns JSON like this:
32 |
26 |33 | 34 | ```shell 35 | 36 | { 37 | "@odata.context": "/redfish/v1/$metadata#ServiceRoot", 38 | "@odata.etag": "W/\"B869D8CC\"", 39 | "@odata.id": "/redfish/v1/", 40 | "@odata.type": "#ServiceRoot.v1_1_0.ServiceRoot", 41 | "AccountService": { 42 | "@odata.id": "/redfish/v1/AccountService/" 43 | }, 44 | "Chassis": { 45 | "@odata.id": "/redfish/v1/Chassis/" 46 | }, 47 | "EventService": { 48 | "@odata.id": "/redfish/v1/EventService/" 49 | }, 50 | "Id": "v1", 51 | "JsonSchemas": { 52 | "@odata.id": "/redfish/v1/Schemas/" 53 | }, 54 | "Links": { 55 | "Sessions": { 56 | "@odata.id": "/redfish/v1/SessionService/Sessions/" 57 | } 58 | }, 59 | "Managers": { 60 | "@odata.id": "/redfish/v1/Managers/" 61 | }, 62 | "Name": "HPE RESTful Root Service", 63 | "Oem": { 64 | "Hpe": { 65 | "@odata.type": "#HpeiLOServiceExt.v2_0_0.HpeiLOServiceExt", 66 | "Links": { 67 | "ResourceDirectory": { 68 | "@odata.id": "/redfish/v1/ResourceDirectory/" 69 | } 70 | }, 71 | "Manager": [ 72 | { 73 | "DefaultLanguage": "en", 74 | "FQDN": "edited", 75 | "HostName": "ILO", 76 | "Languages": [ 77 | { 78 | "Language": "en", 79 | "TranslationName": "English", 80 | "Version": "1.10" 81 | } 82 | ], 83 | "ManagerFirmwareVersion": "1.10", 84 | "ManagerType": "iLO 5" 85 | } 86 | ], 87 | "Moniker": { 88 | "ADVLIC": "iLO Advanced", 89 | "BMC": "iLO", 90 | "BSYS": "BladeSystem", 91 | "CLASS": "Baseboard Management Controller", 92 | "IPROV": "Intelligent Provisioning", 93 | "PRODABR": "iLO", 94 | "PRODFAM": "Integrated Lights-Out", 95 | "PRODGEN": "iLO 5", 96 | "PRODNAM": "Integrated Lights-Out 5", 97 | "PRODTAG": "HPE iLO 5", 98 | "STDLIC": "iLO Standard", 99 | "SUMGR": "Smart Update Manager", 100 | "SYSFAM": "ProLiant", 101 | "VENDABR": "HPE", 102 | "VENDNAM": "Hewlett Packard Enterprise", 103 | "WWW": "www.hpe.com", 104 | "WWWAHSV": "www.hpe.com/servers/ahsv", 105 | "WWWBMC": "www.hpe.com/info/ilo", 106 | "WWWDOC": "www.hpe.com/support/ilo-docs", 107 | "WWWERS": "www.hpe.com/services/getconnected", 108 | "WWWGLIS": "reserved for liconf URI", 109 | "WWWIOL": "www.hpe.com/info/insightonline", 110 | "WWWLIC": "www.hpe.com/info/ilo/licensing", 111 | "WWWPASS": "www.hpe.com/support/hpesc", 112 | "WWWPRV": "www.hpe.com/info/privacy", 113 | "WWWSUP": "www.hpe.com/support/ilo5", 114 | "WWWSWLIC": "www.hpe.com/software/SWLicensing" 115 | }, 116 | "Sessions": { 117 | "CertCommonName": "edited", 118 | "CertificateLoginEnabled": false, 119 | "KerberosEnabled": false, 120 | "LDAPAuthLicenced": true, 121 | "LDAPEnabled": false, 122 | "LocalLoginEnabled": true, 123 | "LoginFailureDelay": 0, 124 | "LoginHint": { 125 | "Hint": "POST to /Sessions to login using the following JSON object:", 126 | "HintPOSTData": { 127 | "Password": "password", 128 | "UserName": "username" 129 | } 130 | }, 131 | "SecurityOverride": false, 132 | "ServerName": "edited" 133 | }, 134 | "Time": "2017-04-03T05:05:01Z" 135 | } 136 | }, 137 | "RedfishVersion": "1.0.0", 138 | "Registries": { 139 | "@odata.id": "/redfish/v1/Registries/" 140 | }, 141 | "SessionService": { 142 | "@odata.id": "/redfish/v1/SessionService/" 143 | }, 144 | "Systems": { 145 | "@odata.id": "/redfish/v1/Systems/" 146 | }, 147 | "UUID": "edited", 148 | "UpdateService": { 149 | "@odata.id": "/redfish/v1/UpdateService/" 150 | } 151 | } 152 | ``` 153 | 154 | Let’s perform our first GET operation using the RESTful API. We will do an HTTP GET on the iLO HTTPS port, typically port 443 (although it could be different if you have previously configured iLO to use another port). Your client should be prepared to handle the HTTPS certificate challenge. The interface is not available over open HTTP (port 80), so you must use HTTPS. 155 | 156 | Our GET operation will be against a resource at `/redfish/v1/` (with a trailing slash): 157 | 158 | It is best to perform this initial GET with a tool like the CURL or the Postman REST Client mentioned above. Later you will want to do this with your own scripting code, but for now it’s useful to see the HTTP header information exchanged using a browser. 159 | 160 | CURL is a command line utility available for many Operating Systems that enables easy access to the RESTful API. CURL is available at [https://curl.se](https://curl.se). Note that all the CURL examples will use a flag –insecure. This causes CURL to bypass validation of the HTTPS certificate. In real use iLO should be configured to use a user-supplied certificate and this option is not necessary. Notice also that we use the –L option to force CURL to follow HTTP redirect responses. If iLO changes URI locations for various items, it can indicate to the client where the new location is and automatically follow the new link. 161 | 162 | In JSON, there is no strong ordering of property names, so iLO may return JSON properties in any order. Likewise, iLO cannot assume the order of properties in any submitted JSON. This is why the best scripting data structure for a RESTful client is a dictionary: a simple set of unordered key/value pairs. This lack of ordering is also the reason you see embedded structure within objects (objects within objects). This allows us to keep related data together that is more logically organized, aesthetically pleasing to view, and helps avoid property name conflicts or ridiculously long property names. It also allows us to use identical blocks of JSON in many places in the data model, like status. 163 | 164 | 165 | ## HTTP Resource Operations 166 | 167 | Operation | HTTP Command | Description 168 | -------------- | -------------- | -------------- 169 | Create | POST resource URI (payload = resource data) | Creates a new resource or invokes a custom action. A synchronous POST returns the newly created resource. 170 | Read | GET resource URI | Returns the requested resource representation. 171 | Update | PATCH or PUT resource URI (payload = update data) | Updates an existing resource. You can only PATCH properties that are marked readonly = false in the schema. 172 | Delete | DELETE resource URI | Deletes the specified resource. 173 | 174 | ## HTTP Status Return Codes 175 | 176 | Return Status | Description 177 | -------------- | -------------- | -------------- 178 | 2xx | Successful operation. 179 | 308 | The resource has moved 180 | 4xx | Client-side error with message returned 181 | 5xx | iLO error with error message returned 182 | 183 | 186 | 187 | 188 | --------------------------------------------------------------------------------27 |
31 |- -i returns HTTP response headers
28 |- --insecure bypasses TLS/SSL certification verification
29 |- -L follows HTTP redirect
30 |The above command returns JSON like this:
32 |