blob: 6cb75262e71743dc449996588a1e577402865a23 [file] [log] [blame]
Sridevi Ramesh0047de82019-02-01 06:33:08 -06001*** Settings ***
George Keishingb10eaca2019-02-24 05:07:30 -06002Documentation BMC and host redfish utility keywords.
Sridevi Ramesh0047de82019-02-01 06:33:08 -06003
George Keishing2db7bca2019-02-14 13:03:08 -06004Resource resource.robot
Sridevi Ramesh0047de82019-02-01 06:33:08 -06005Resource bmc_redfish_resource.robot
6
7
8*** Keywords ***
9
10Redfish Power Operation
George Keishingb10eaca2019-02-24 05:07:30 -060011 [Documentation] Do Redfish host power operation.
Sridevi Ramesh0047de82019-02-01 06:33:08 -060012 [Arguments] ${reset_type}
Sushil Singhb910d892021-11-17 05:34:29 -060013
Sridevi Ramesh0047de82019-02-01 06:33:08 -060014 # Description of arguments:
15 # reset_type Type of power operation.
16 # (e.g. On/ForceOff/GracefulRestart/GracefulShutdown)
17
18 # Example:
19 # "Actions": {
20 # "#ComputerSystem.Reset": {
21 # "ResetType@Redfish.AllowableValues": [
22 # "On",
23 # "ForceOff",
George Keishingeeb526c2020-03-03 07:39:44 -060024 # "ForceOn",
25 # "ForceRestart",
Sridevi Ramesh0047de82019-02-01 06:33:08 -060026 # "GracefulRestart",
27 # "GracefulShutdown"
George Keishingeeb526c2020-03-03 07:39:44 -060028 # "PowerCycle",
29 # "Nmi"
Sridevi Ramesh0047de82019-02-01 06:33:08 -060030 # ],
George Keishing2deec3c2019-02-26 09:20:10 -060031 # "target": "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset"
32 # }
33 # }
Sridevi Ramesh0047de82019-02-01 06:33:08 -060034
Yi Huc32434a2024-01-11 17:33:10 -080035 ${target}= redfish_utils.Get Target Actions /redfish/v1/Systems/${SYSTEM_ID}/ ComputerSystem.Reset
Sridevi Ramesh0047de82019-02-01 06:33:08 -060036 ${payload}= Create Dictionary ResetType=${reset_type}
Michael Walsh213feb32019-03-08 14:44:31 -060037 ${resp}= Redfish.Post ${target} body=&{payload}
George Keishing8a86c692024-03-29 09:52:25 +053038 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sridevi Ramesh0047de82019-02-01 06:33:08 -060039
40
George Keishingb10eaca2019-02-24 05:07:30 -060041Redfish BMC Reset Operation
42 [Documentation] Do Redfish BMC reset operation.
Sushil Singhb910d892021-11-17 05:34:29 -060043 [Arguments] ${reset_type}=GracefulRestart
Sridevi Ramesh0047de82019-02-01 06:33:08 -060044
George Keishingb10eaca2019-02-24 05:07:30 -060045 # Example:
46 # "Actions": {
47 # "#Manager.Reset": {
48 # "ResetType@Redfish.AllowableValues": [
Sushil Singhb910d892021-11-17 05:34:29 -060049 # "GracefulRestart",
50 # "ForceRestart"
George Keishingb10eaca2019-02-24 05:07:30 -060051 # ],
ganesanb4d430282023-04-27 14:33:23 +000052 # "target": "/redfish/v1/Managers/${MANAGER_ID}/Actions/Manager.Reset"
George Keishingb10eaca2019-02-24 05:07:30 -060053 # }
54
ganesanb4d430282023-04-27 14:33:23 +000055 ${target}= redfish_utils.Get Target Actions /redfish/v1/Managers/${MANAGER_ID}/ Manager.Reset
Sushil Singhb910d892021-11-17 05:34:29 -060056 ${payload}= Create Dictionary ResetType=${reset_type}
George Keishing07fb41f2020-06-16 08:09:19 -050057 Redfish.Post ${target} body=&{payload}
George Keishingcaa718b2019-03-10 00:08:33 -060058
59
Anvesh Kumar Rayankula0296f1d2019-12-17 03:33:16 -060060Reset BIOS Via Redfish
61 [Documentation] Do BIOS reset through Redfish.
62
Yi Huc32434a2024-01-11 17:33:10 -080063 ${target}= redfish_utils.Get Target Actions /redfish/v1/Systems/${SYSTEM_ID}/Bios/ Bios.ResetBios
Anvesh Kumar Rayankula0296f1d2019-12-17 03:33:16 -060064 Redfish.Post ${target} valid_status_codes=[${HTTP_OK}]
65
66
Sushil Singh87e984c2020-10-20 01:43:47 -050067Redfish Delete Session
68 [Documentation] Redfish delete session.
69 [Arguments] ${session_info}
70
71 # Description of argument(s):
72 # session_info Session information are stored in dictionary.
73
74 # ${session_info} = {
75 # 'SessionIDs': 'XXXXXXXXX',
76 # 'ClientID': 'XXXXXX',
77 # 'SessionToken': 'XXXXXXXXX',
78 # 'SessionResp': session response from redfish login
79 # }
80
81 # SessionIDs : Session IDs
82 # ClientID : Client ID
83 # SessionToken : Session token
84 # SessionResp : Response of creating an redfish login session
85
86 Redfish.Delete /redfish/v1/SessionService/Sessions/${session_info["SessionIDs"]}
87
88
89Redfish Delete List Of Session
90 [Documentation] Redfish delete session from list of session records, individual session information
91 ... are stored in dictionary.
92 [Arguments] ${session_info_list}
93
94 # Description of argument(s):
95 # session_info_list List contains individual session record are stored in dictionary.
96
97 # ${session_info_list} = [{
98 # 'SessionIDs': 'XXXXXXXXX',
99 # 'ClientID': 'XXXXXX',
100 # 'SessionToken': 'XXXXXXXXX',
101 # 'SessionResp': session response from redfish login
102 # }]
103
104 # SessionIDs : Session IDs
105 # ClientID : Client ID
106 # SessionToken : Session token
107 # SessionResp : Response of creating an redfish login session
108
109 FOR ${session_record} IN @{session_info_list}
110 Redfish.Delete /redfish/v1/SessionService/Sessions/${session_record["SessionIDs"]}
111 END
112
113
George Keishingcaa718b2019-03-10 00:08:33 -0600114Delete All Redfish Sessions
115 [Documentation] Delete all active redfish sessions.
116
Sagar Ananded737652023-01-10 02:00:31 -0600117 ${saved_session_info}= Redfish_Utils.Get Redfish Session Info
George Keishingcaa718b2019-03-10 00:08:33 -0600118
119 ${resp_list}= Redfish_Utils.Get Member List
120 ... /redfish/v1/SessionService/Sessions
121
122 # Remove the current login session from the list.
123 Remove Values From List ${resp_list} ${saved_session_info["location"]}
124
George Keishing3612f3a2022-04-21 11:21:53 -0500125 # Remove session with client_id populated from the list.
126 ${client_id_list}= Get Session With Client Id ${resp_list}
127 Log To Console Client sessions skip list: ${client_id_list}
128 FOR ${client_session} IN @{client_id_list}
129 Remove Values From List ${resp_list} ${client_session}
130 END
131
Marissa Garza20ccfc72020-06-19 12:51:10 -0500132 FOR ${session} IN @{resp_list}
George Keishing74c1c852020-12-09 09:03:55 -0600133 Run Keyword And Ignore Error Redfish.Delete ${session}
Marissa Garza20ccfc72020-06-19 12:51:10 -0500134 END
Michael Walshcf163322019-05-22 16:56:17 -0500135
Sushil Singh87e984c2020-10-20 01:43:47 -0500136
George Keishing3612f3a2022-04-21 11:21:53 -0500137Get Session With Client Id
George Keishingf9babff2023-08-16 18:40:22 +0530138 [Documentation] Iterate through the active sessions and return sessions
139 ... populated with Context.
George Keishing3612f3a2022-04-21 11:21:53 -0500140 [Arguments] ${session_list}
141
142 # Description of argument(s):
143 # session_list Active session list from SessionService.
144
George Keishingf9babff2023-08-16 18:40:22 +0530145 # "@odata.type": "#Session.v1_5_0.Session",
146 # "ClientOriginIPAddress": "xx.xx.xx.xx",
147 # "Context": "MYID-01"
George Keishing3612f3a2022-04-21 11:21:53 -0500148
149 ${client_id_sessions}= Create List
150 FOR ${session} IN @{session_list}
151 ${resp}= Redfish.Get ${session} valid_status_codes=[200,404]
George Keishingf9babff2023-08-16 18:40:22 +0530152 # This prevents dictionary KeyError exception when the Context
153 # attribute is not populated in generic session response.
154 ${context_var}= Get Variable Value ${resp.dict["Context"]} ${EMPTY}
George Keishingd2bcbf72023-09-15 22:44:02 +0530155 # Handle backward compatibility for OEM.
156 ${oem_var}= Get Variable Value ${resp.dict["Oem"]["OpenBMC"]["ClientID"]} ${EMPTY}
George Keishingf9babff2023-08-16 18:40:22 +0530157 Run Keyword If '${context_var}' != '${EMPTY}'
George Keishing3612f3a2022-04-21 11:21:53 -0500158 ... Append To List ${client_id_sessions} ${session}
George Keishingd2bcbf72023-09-15 22:44:02 +0530159 Run Keyword If '${oem_var}' != '${EMPTY}'
160 ... Append To List ${client_id_sessions} ${session}
George Keishing3612f3a2022-04-21 11:21:53 -0500161 END
162
163 [Return] ${client_id_sessions}
164
165
Michael Walshcf163322019-05-22 16:56:17 -0500166Get Valid FRUs
167 [Documentation] Return a dictionary containing all of the valid FRU records for the given fru_type.
168 [Arguments] ${fru_type}
169
170 # NOTE: A valid FRU record will have a "State" key of "Enabled" and a "Health" key of "OK".
171
172 # Description of argument(s):
173 # fru_type The type of fru (e.g. "Processors", "Memory", etc.).
174
175 ${fru_records}= Redfish_Utils.Enumerate Request
Yi Huc32434a2024-01-11 17:33:10 -0800176 ... /redfish/v1/Systems/${SYSTEM_ID}/${fru_type} return_json=0
Michael Walshe256a4f2019-05-29 10:49:06 -0500177 ${fru_records}= Filter Struct ${fru_records} [('State', 'Enabled'), ('Health', 'OK')]
Michael Walshcf163322019-05-22 16:56:17 -0500178
179 [Return] ${fru_records}
180
181
182Get Num Valid FRUs
183 [Documentation] Return the number of valid FRU records for the given fru_type.
184 [Arguments] ${fru_type}
185
186 # Description of argument(s):
187 # fru_type The type of fru (e.g. "Processors", "Memory", etc.).
188
189 ${fru_records}= Get Valid FRUs ${fru_type}
190 ${num_valid_frus}= Get length ${fru_records}
191
192 [Return] ${num_valid_frus}
Marissa Garzad76b1422019-09-13 16:31:54 -0500193
194
195Verify Valid Records
196 [Documentation] Verify all records retrieved with the given arguments are valid.
197 [Arguments] ${record_type} ${redfish_uri} ${reading_type}
198
199 # Description of Argument(s):
200 # record_type The sensor record type (e.g. "PowerSupplies")
201 # redfish_uri The power supply URI (e.g. /redfish/v1/Chassis/chassis/Power)
202 # reading_type The power watt readings (e.g. "PowerInputWatts")
203
204 # A valid record will have "State" key "Enabled" and "Health" key "OK".
205 ${records}= Redfish.Get Attribute ${redfish_uri} ${record_type}
206
207 Rprint Vars records
208
209 # Example output:
210 # records:
211 # [0]:
212 # [@odata.id]: /redfish/v1/Chassis/chassis/Power#/PowerControl/0
213 # [@odata.type]: #Power.v1_0_0.PowerControl
214 # [MemberId]: 0
215 # [Name]: Chassis Power Control
216 # [PowerConsumedWatts]: 264.0
217 # [PowerLimit]:
218 # [LimitInWatts]: None
219 # [PowerMetrics]:
220 # [AverageConsumedWatts]: 325
221 # [IntervalInMin]: 3
222 # [MaxConsumedWatts]: 538
223 # [Status]:
224 # [Health]: OK
225 # [State]: Enabled
226
227 ${invalid_records}= Filter Struct ${records}
228 ... [('Health', '^OK$'), ('State', '^Enabled$'), ('${reading_type}', '')] regex=1 invert=1
229 Valid Length invalid_records max_length=0
Marissa Garzafdee1b02019-09-20 14:52:12 -0500230
231 [Return] ${records}
Vijayff2c0bc2020-02-03 00:05:45 -0600232
233
234Redfish Create User
235 [Documentation] Redfish create user.
236 [Arguments] ${user_name} ${password} ${role_id} ${enabled} ${force}=${False}
237
238 # Description of argument(s):
239 # user_name The user name to be created.
240 # password The password to be assigned.
241 # role_id The role ID of the user to be created.
242 # (e.g. "Administrator", "Operator", etc.).
243 # enabled Indicates whether the username being created.
244 # should be enabled (${True}, ${False}).
245 # force Delete user account and re-create if force is True.
246
247 ${curr_role}= Run Keyword And Ignore Error Get User Role ${user_name}
248 # Ex: ${curr_role} = ('PASS', 'Administrator')
249
250 ${user_exists}= Run Keyword And Return Status Should Be Equal As Strings ${curr_role}[0] PASS
251
252 # Delete user account when force is True.
253 Run Keyword If ${force} == ${True} Redfish.Delete ${REDFISH_ACCOUNTS_URI}${user_name}
254 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NOT_FOUND}]
255
256 # Create specified user when force is True or User does not exist.
257 ${payload}= Create Dictionary
258 ... UserName=${user_name} Password=${password} RoleId=${role_id} Enabled=${enabled}
259
260 Run Keyword If ${force} == ${True} or ${user_exists} == ${False}
261 ... Redfish.Post ${REDFISH_ACCOUNTS_URI} body=&{payload}
262 ... valid_status_codes=[${HTTP_CREATED}]
263
264
265Get User Role
266 [Documentation] Get User Role.
267 [Arguments] ${user_name}
268
269 # Description of argument(s):
270 # user_name User name to get it's role.
271
272 ${role_config}= Redfish_Utils.Get Attribute
273 ... ${REDFISH_ACCOUNTS_URI}${user_name} RoleId
274
275 [Return] ${role_config}
276
277
278Create Users With Different Roles
279 [Documentation] Create users with different roles.
280 [Arguments] ${users} ${force}=${False}
281
282 # Description of argument(s):
George Keishing9bfdf8a2024-04-19 11:09:07 +0530283 # users Dictionary of roles and user credentials to be created.
Vijayff2c0bc2020-02-03 00:05:45 -0600284 # Ex: {'Administrator': '[admin_user, TestPwd123]', 'Operator': '[operator_user, TestPwd123]'}
285 # force Delete given user account if already exists when force is True.
286
287 FOR ${role} IN @{users}
288 Redfish Create User ${users['${role}'][0]} ${users['${role}']}[1] ${role} ${True} ${force}
289 END
290
Vijay39373152020-02-14 08:08:20 -0600291
292Delete BMC Users Via Redfish
293 [Documentation] Delete BMC users via redfish.
294 [Arguments] ${users}
295
296 # Description of argument(s):
297 # users Dictionary of roles and user credentials to be deleted.
298
299 FOR ${role} IN @{users}
300 Redfish.Delete /redfish/v1/AccountService/Accounts/${users['${role}'][0]}
301 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NOT_FOUND}]
302 END
303
Anves Kumar rayankula7ed1ae82021-02-03 04:19:46 -0600304
305Expire And Update New Password Via Redfish
306 [Documentation] Expire and change password and verify using password.
307 [Arguments] ${username} ${password} ${new_password}
308
309 # Description of argument(s):
310 # username The username to be used to login to the BMC.
311 # password The password to be used to login to the BMC.
312 # new_password The new password to be used to update password.
313
314 # Expire admin password using ssh.
Sushil Singh39848ba2022-08-10 05:49:32 -0500315 Open Connection And Log In ${OPENBMC_USERNAME} ${OPENBMC_PASSWORD}
Anves Kumar rayankula7ed1ae82021-02-03 04:19:46 -0600316 ${output} ${stderr} ${rc}= BMC Execute Command passwd --expire ${username}
Brian Ma45aa8812022-02-24 14:55:28 +0800317 Should Contain Any ${output} password expiry information changed
318 ... password changed
Anves Kumar rayankula7ed1ae82021-02-03 04:19:46 -0600319
320 # Verify user password expired using Redfish
321 Verify User Password Expired Using Redfish ${username} ${password}
322
323 # Change user password.
Brian Ma45aa8812022-02-24 14:55:28 +0800324 Redfish.Patch /redfish/v1/AccountService/Accounts/${username}
Anves Kumar rayankula7ed1ae82021-02-03 04:19:46 -0600325 ... body={'Password': '${new_password}'}
326 Redfish.Logout
327
328
329Verify User Password Expired Using Redfish
330 [Documentation] Checking whether user password expired or not using redfish.
Sushil Singh473cf7d2023-03-09 04:24:07 -0600331 [Arguments] ${username} ${password} ${expected_result}=${True}
Anves Kumar rayankula7ed1ae82021-02-03 04:19:46 -0600332
333 # Description of argument(s):
334 # username The username to be used to login to the BMC.
335 # password The password to be used to login to the BMC.
336
Anves Kumar rayankula7ed1ae82021-02-03 04:19:46 -0600337 Redfish.Login ${username} ${password}
338 ${resp}= Redfish.Get /redfish/v1/AccountService/Accounts/${username}
339 Should Be Equal ${resp.dict["PasswordChangeRequired"]} ${expected_result}
340
Prashanth Kattib3d1c7a2021-12-09 03:51:08 -0600341
342Is BMC LastResetTime Changed
343 [Documentation] Return fail if BMC last reset time is not changed.
344 [Arguments] ${reset_time}
345
346 # Description of argument(s):
347 # reset_time Last BMC reset time.
348
349 ${last_reset_time}= Get BMC Last Reset Time
350 Should Not Be Equal ${last_reset_time} ${reset_time}
351
352
353Redfish BMC Reboot
354 [Documentation] Use Redfish API reboot BMC and wait for BMC ready.
355
356 # Get BMC last reset time for compare
357 ${last_reset_time}= Get BMC Last Reset Time
358
359 # Reboot BMC by Redfish API
360 Redfish BMC Reset Operation
361
362 # Wait for BMC real reboot and Redfish API ready
363 Wait Until Keyword Succeeds 3 min 10 sec Is BMC LastResetTime Changed ${last_reset_time}
364
365
366Get BMC Last Reset Time
367 [Documentation] Return BMC LastResetTime.
368
ganesanb4d430282023-04-27 14:33:23 +0000369 ${last_reset_time}= Redfish.Get Attribute /redfish/v1/Managers/${MANAGER_ID} LastResetTime
Prashanth Kattib3d1c7a2021-12-09 03:51:08 -0600370
371 [Return] ${last_reset_time}