Skip to content

Commit 77bf382

Browse files
committed
Update documentation for iLO 5 1.20
1 parent 0b9bd80 commit 77bf382

15 files changed

+9860
-3674
lines changed

iLO5_Redfish_Reference.html

+3,426-1,310
Large diffs are not rendered by default.

iLO5_Redfish_Reference.md

+2,122-929
Large diffs are not rendered by default.

iLO5_Redfish_Reference_OAS3.yaml

+2,020-469
Large diffs are not rendered by default.

source/ilo5/index.html.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ includes:
1616
- ilo5_performingaction
1717
- ilo5_adaptation
1818
- ilo5_accountservice
19+
- ilo5_time
1920
- ilo5_exampleuse
2021
- ilo5_updateservicedoc
2122
- ilo5_biosdoc

source/includes/_ilo4_authentication.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L
3737

3838
```python
3939
import sys
40-
import ilorest
40+
import redfish
4141

4242
# When running remotely connect using the iLO address, iLO account name,
4343
# and password to send https requests
@@ -46,7 +46,7 @@ login_account = "admin"
4646
login_password = "password"
4747

4848
## Create a REDFISH object
49-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
49+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
5050
password=login_password, default_prefix='/redfish/v1')
5151

5252
# Login into the server and create a session
@@ -65,7 +65,7 @@ curl -H "Content-Type: application/json" -H "OData-Version: 4.0" -X POST --data
6565
```
6666

6767
```python
68-
import ilorest
68+
import redfish
6969

7070
# When running remotely connect using the iLO address, iLO account name,
7171
# and password to send https requests
@@ -74,7 +74,7 @@ login_account = "admin"
7474
login_password = "password"
7575

7676
## Create a REDFISH object
77-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
77+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
7878
password=login_password, default_prefix='/redfish/v1')
7979

8080
# Login into the server and create a session
@@ -158,7 +158,7 @@ curl -X "DELETE" https://{iLO}/redfish/v1/SessionService/Sessions/{item}/ -u adm
158158
```
159159

160160
```python
161-
import ilorest
161+
import redfish
162162

163163
# When running remotely connect using the iLO address, iLO account name,
164164
# and password to send https requests
@@ -167,7 +167,7 @@ login_account = "admin"
167167
login_password = "password"
168168

169169
## Create a REDFISH object
170-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
170+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
171171
password=login_password, default_prefix='/redfish/v1')
172172

173173
# Login into the server and create a session

source/includes/_ilo4_exampleuse.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ curl https://{iLO}/rest/v1/systems/1/bios/BaseConfigs/ -i --insecure -u username
107107

108108
```python
109109
import sys
110-
import ilorest
110+
import redfish
111111

112112
# When running remotely connect using the iLO address, iLO account name,
113113
# and password to send https requests
@@ -116,7 +116,7 @@ login_account = "admin"
116116
login_password = "password"
117117

118118
## Create a REDFISH object
119-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
119+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
120120
password=login_password, default_prefix='/redfish/v1')
121121

122122
# Login into the server and create a session

source/includes/_ilo4_navigating.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L
2525

2626
```python
2727
import sys
28-
import ilorest
28+
import redfish
2929

3030
# When running remotely connect using the iLO address, iLO account name,
3131
# and password to send https requests
@@ -34,7 +34,7 @@ login_account = "admin"
3434
login_password = "password"
3535

3636
## Create a REDFISH object
37-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
37+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
3838
password=login_password, default_prefix='/redfish/v1')
3939

4040
# Login into the server and create a session
@@ -76,7 +76,7 @@ curl https://{host}/redfish/v1/systems/{item}/ -i --insecure -u username:passwor
7676

7777
```python
7878
import sys
79-
import ilorest
79+
import redfish
8080

8181
# When running remotely connect using the iLO address, iLO account name,
8282
# and password to send https requests
@@ -85,7 +85,7 @@ login_account = "admin"
8585
login_password = "password"
8686

8787
## Create a REDFISH object
88-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
88+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
8989
password=login_password, default_prefix='/redfish/v1')
9090

9191
# Login into the server and create a session
@@ -135,7 +135,7 @@ curl https://{host}/redfish/v1/chassis/{item}/ -i --insecure -u username:passwor
135135

136136
```python
137137
import sys
138-
import ilorest
138+
import redfish
139139

140140
# When running remotely connect using the iLO address, iLO account name,
141141
# and password to send https requests
@@ -144,7 +144,7 @@ login_account = "admin"
144144
login_password = "password"
145145

146146
## Create a REDFISH object
147-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
147+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
148148
password=login_password, default_prefix='/redfish/v1')
149149

150150
# Login into the server and create a session
@@ -195,7 +195,7 @@ curl https://{host}/redfish/v1/managers/{item}/ -i --insecure -u username:passwo
195195

196196
```python
197197
import sys
198-
import ilorest
198+
import redfish
199199

200200
# When running remotely connect using the iLO address, iLO account name,
201201
# and password to send https requests
@@ -204,7 +204,7 @@ login_account = "admin"
204204
login_password = "password"
205205

206206
## Create a REDFISH object
207-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
207+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
208208
password=login_password, default_prefix='/redfish/v1')
209209

210210
# Login into the server and create a session

source/includes/_ilo5_authentication.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ curl https://{iLO}/redfish/v1/systems/ -i --insecure -u username:password -L
3030

3131
```python
3232
import sys
33-
import ilorest
33+
import redfish
3434

3535
# When running remotely connect using the iLO address, iLO account name,
3636
# and password to send https requests
@@ -39,7 +39,7 @@ login_account = "admin"
3939
login_password = "password"
4040

4141
## Create a REDFISH object
42-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
42+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
4343
password=login_password, default_prefix='/redfish/v1')
4444

4545
# Login into the server and create a session
@@ -58,7 +58,7 @@ curl -H "Content-Type: application/json" -H "OData-Version: 4.0" -X POST --data
5858
```
5959

6060
```python
61-
import ilorest
61+
import redfish
6262

6363
# When running remotely connect using the iLO address, iLO account name,
6464
# and password to send https requests
@@ -67,7 +67,7 @@ login_account = "admin"
6767
login_password = "password"
6868

6969
## Create a REDFISH object
70-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
70+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
7171
password=login_password, default_prefix='/redfish/v1')
7272

7373
# Login into the server and create a session
@@ -145,7 +145,7 @@ curl -X "DELETE" https://{iLO}/redfish/v1/SessionService/Sessions/{item}/ -u adm
145145
```
146146

147147
```python
148-
import ilorest
148+
import redfish
149149

150150
# When running remotely connect using the iLO address, iLO account name,
151151
# and password to send https requests
@@ -154,7 +154,7 @@ login_account = "admin"
154154
login_password = "password"
155155

156156
## Create a REDFISH object
157-
REDFISH_OBJ = ilorest.redfish_client(base_url=iLO_host,username=login_account, \
157+
REDFISH_OBJ = redfish.RedfishClient(base_url=iLO_host,username=login_account, \
158158
password=login_password, default_prefix='/redfish/v1')
159159

160160
# Login into the server and create a session

source/includes/_ilo5_introduction.md

+38
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,44 @@ With modern scripting languages, you can easily write simple REST clients for RE
88

99
iLO 5's Redfish conformance details are available in this document in the "**iLO 5 Adaptation Guide**" section.
1010

11+
## iLO 5 2.10 New Features and Changes
12+
### Redfish Features and Fixes
13+
* ComputerSystem (`/redfish/v1/Systems/{id}`) and sub-resources
14+
* Added `GracefulShutdown` to the `ComputerSystem` `ResetType` list - this performs a virtual button press if the system is on and does nothing if the system of off.
15+
* Added Redfish `BootOptions` for boot order management
16+
* Changed `ResetBios` action to not require a `ResetType` property to conform to the Redfish standard action, which is parameterless. NOTE: The Redfish client must still supply and empty JSON object `{}` as a request body.
17+
* Added `Status/HealthRollup` to `ComputerSystem` - this has the same value as `Health` and is provided for compatibility.
18+
* Added `InterfaceEnabled` to all host `EthernetInterfaces`
19+
* Chassis (`/redfish/v1/Chassis/{id}`)
20+
* Added `IndicatorLED` property to `Chassis`
21+
* Added `PowerState` to `Chassis` resource
22+
* Added `AssetTag`
23+
* Manager (`/redfish/v1/Managers/{id}`)
24+
* Added `GracefulRestart` and `ForceRestart` `ResetType` allowable values to Manager (iLO reset)
25+
* Added `DateTime` and `DateTimeLocalOffset`
26+
* Added `Model`
27+
* Added `Status/Health`
28+
* NVMe Drives
29+
* Added support for `Drive::PCIeInterface` information for NVMe drives (when data is available)
30+
* Added `DurableName` and `DurableNameFormat` to NVMe `Drive` resources
31+
* Other
32+
* Added `ClearingLogic` to iLO Redfish Events registry
33+
* Added and/or modified the descriptions of many schema for conformity
34+
* Updated message registries to conform to MessageRegistry.v1_2_0 schema
35+
* Updated the Base registry messages to include newer messages from Redfish standard Base registry.
36+
* Changed schema items with ```"format": "uri"``` to ```"format": "uri-reference"``` to match Redfish 2019.1
37+
* Removed X_HP-CHRP-Service-Version HTTP header in responses
38+
* Added `[email protected]` to `UpdateService`
39+
* Changed some properties in the API to not trigger Redfish events when they change to reduce event chattiness
40+
41+
### HPE OEM Features
42+
* Added new OEM actions to ComputerSystem to enable special modes on reboot
43+
* `ServerIntelligentDiagnosticsMode`
44+
* `RestoreManufacturingDefaults`
45+
* `ServerSafeMode`
46+
* `RestoreSystemDefaults`
47+
* Added the ability to set `EndOfPostDelaySeconds` to > 255 seconds. When PATCHed >255, it is internally converted to whole minutes (rounded up) and reported as the rounded seconds on GET. This enables a client to support up to 15300 seconds (255 minutes).
48+
1149
## iLO 5 1.40 New Features and Changes
1250

1351
iLO 5 1.40 adds support for several Redfish features:

0 commit comments

Comments
 (0)