blob: e7f02ba880b95105e9818c9ecb95996569f692fe [file] [log] [blame]
Michael Walsh1b0ceb22017-05-31 16:03:01 -05001*** Settings ***
2Resource ../lib/utils.robot
3Resource ../lib/connection_client.robot
4Resource ../lib/boot_utils.robot
George Keishing58e47232018-02-12 10:35:15 -06005Library ../lib/gen_misc.py
George Keishingbf724772018-02-21 08:57:16 -06006Library ../lib/utils.py
Tony Lee9f6b2042020-04-27 20:20:43 +08007Library ../lib/bmc_network_utils.py
Michael Walsh1b0ceb22017-05-31 16:03:01 -05008
9*** Variables ***
10# MAC input from user.
11${MAC_ADDRESS} ${EMPTY}
12
13
14*** Keywords ***
15
Michael Walsh1b0ceb22017-05-31 16:03:01 -050016Check And Reset MAC
17 [Documentation] Update BMC with user input MAC address.
18 [Arguments] ${mac_address}=${MAC_ADDRESS}
19
20 # Description of argument(s):
21 # mac_address The mac address (e.g. 00:01:6c:80:02:28).
22
Tony Lee8094d382020-04-02 13:14:47 +080023 ${active_channel_config}= Get Active Channel Config
24 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
25
Michael Walsh1b0ceb22017-05-31 16:03:01 -050026 Should Not Be Empty ${mac_address}
27 Open Connection And Log In
Joy Onyerikwu9b668972018-05-22 19:10:43 -050028 ${bmc_mac_addr} ${stderr} ${rc}= BMC Execute Command
Tony Lee8094d382020-04-02 13:14:47 +080029 ... cat /sys/class/net/${ethernet_interface}/address
Michael Walsh1b0ceb22017-05-31 16:03:01 -050030 Run Keyword If '${mac_address.lower()}' != '${bmc_mac_addr.lower()}'
31 ... Set MAC Address
32
Michael Walsh1b0ceb22017-05-31 16:03:01 -050033
Michael Walsh1b0ceb22017-05-31 16:03:01 -050034Set MAC Address
35 [Documentation] Update eth0 with input MAC address.
36 [Arguments] ${mac_address}=${MAC_ADDRESS}
37
38 # Description of argument(s):
39 # mac_address The mac address (e.g. 00:01:6c:80:02:28).
40
Tony Lee8094d382020-04-02 13:14:47 +080041 ${active_channel_config}= Get Active Channel Config
42 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
43
Michael Walsh1b0ceb22017-05-31 16:03:01 -050044 Write fw_setenv ethaddr ${mac_address}
45 OBMC Reboot (off)
Sunil Md1c4f272017-07-07 09:03:24 -050046
47 # Take SSH session post BMC reboot.
48 Open Connection And Log In
Joy Onyerikwu9b668972018-05-22 19:10:43 -050049 ${bmc_mac_addr} ${stderr} ${rc}= BMC Execute Command
Tony Lee8094d382020-04-02 13:14:47 +080050 ... cat /sys/class/net/${ethernet_interface}/address
Michael Walsh1b0ceb22017-05-31 16:03:01 -050051 Should Be Equal ${bmc_mac_addr} ${mac_address} ignore_case=True
52
Prashanth Kattie79c5402017-06-08 07:40:49 -050053
54Get BMC IP Info
55 [Documentation] Get system IP address and prefix length.
56
Prashanth Kattie79c5402017-06-08 07:40:49 -050057
58 # Get system IP address and prefix length details using "ip addr"
59 # Sample Output of "ip addr":
60 # 1: eth0: <BROADCAST,MULTIAST> mtu 1500 qdisc mq state UP qlen 1000
61 # link/ether xx:xx:xx:xx:xx:xx brd ff:ff:ff:ff:ff:ff
62 # inet xx.xx.xx.xx/24 brd xx.xx.xx.xx scope global eth0
63
Tony Lee412c6682020-04-01 17:34:30 +080064 ${active_channel_config}= Get Active Channel Config
65 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
Joy Onyerikwu9b668972018-05-22 19:10:43 -050066 ${cmd_output} ${stderr} ${rc}= BMC Execute Command
Tony Lee412c6682020-04-01 17:34:30 +080067 ... /sbin/ip addr | grep ${ethernet_interface}
Prashanth Kattie79c5402017-06-08 07:40:49 -050068
69 # Get line having IP address details.
70 ${lines}= Get Lines Containing String ${cmd_output} inet
71
72 # List IP address details.
73 @{ip_components}= Split To Lines ${lines}
74
75 @{ip_data}= Create List
76
77 # Get all IP addresses and prefix lengths on system.
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -050078 FOR ${ip_component} IN @{ip_components}
79 @{if_info}= Split String ${ip_component}
80 ${ip_n_prefix}= Get From List ${if_info} 1
81 Append To List ${ip_data} ${ip_n_prefix}
82 END
Prashanth Kattie79c5402017-06-08 07:40:49 -050083
84 [Return] ${ip_data}
85
86Get BMC Route Info
87 [Documentation] Get system route info.
88
Prashanth Kattie79c5402017-06-08 07:40:49 -050089
90 # Sample output of "ip route":
91 # default via xx.xx.xx.x dev eth0
92 # xx.xx.xx.0/23 dev eth0 src xx.xx.xx.xx
93 # xx.xx.xx.0/24 dev eth0 src xx.xx.xx.xx
94
Joy Onyerikwu9b668972018-05-22 19:10:43 -050095 ${cmd_output} ${stderr} ${rc}= BMC Execute Command
96 ... /sbin/ip route
Prashanth Kattie79c5402017-06-08 07:40:49 -050097
98 [Return] ${cmd_output}
99
George Keishing02651f02018-04-11 02:07:16 -0500100# TODO: openbmc/openbmc-test-automation#1331
Prashanth Kattie79c5402017-06-08 07:40:49 -0500101Get BMC MAC Address
102 [Documentation] Get system MAC address.
103
Prashanth Kattie79c5402017-06-08 07:40:49 -0500104
105 # Sample output of "ip addr | grep ether":
106 # link/ether xx.xx.xx.xx.xx.xx brd ff:ff:ff:ff:ff:ff
107
Tony Lee8094d382020-04-02 13:14:47 +0800108 ${active_channel_config}= Get Active Channel Config
109 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
110
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500111 ${cmd_output} ${stderr} ${rc}= BMC Execute Command
Tony Lee8094d382020-04-02 13:14:47 +0800112 ... /sbin/ip addr | grep ${ethernet_interface} -A 1 | grep ether
Prashanth Kattie79c5402017-06-08 07:40:49 -0500113
Prashanth Katti9819b162017-12-12 05:38:59 -0600114 # Split the line and return MAC address.
115 # Split list data:
116 # link/ether | xx:xx:xx:xx:xx:xx | brd | ff:ff:ff:ff:ff:ff
117
118 @{words}= Split String ${cmd_output}
119
120 [Return] ${words[1]}
Prashanth Katti40fb8ca2017-07-25 06:47:23 -0500121
George Keishing02651f02018-04-11 02:07:16 -0500122
123Get BMC MAC Address List
124 [Documentation] Get system MAC address
125
126 # Sample output of "ip addr | grep ether":
127 # link/ether xx.xx.xx.xx.xx.xx brd ff:ff:ff:ff:ff:ff
128
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500129 ${cmd_output} ${stderr} ${rc}= BMC Execute Command
130 ... /sbin/ip addr | grep ether
George Keishing02651f02018-04-11 02:07:16 -0500131
132 # Split the line and return MAC address.
133 # Split list data:
134 # link/ether | xx:xx:xx:xx:xx:xx | brd | ff:ff:ff:ff:ff:ff
135 # link/ether | xx:xx:xx:xx:xx:xx | brd | ff:ff:ff:ff:ff:ff
136
137 ${mac_list}= Create List
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500138 @{lines}= Split To Lines ${cmd_output}
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500139 FOR ${line} IN @{lines}
140 @{words}= Split String ${line}
141 Append To List ${mac_list} ${words[1]}
142 END
George Keishing02651f02018-04-11 02:07:16 -0500143
144 [Return] ${mac_list}
145
Prashanth Katti40fb8ca2017-07-25 06:47:23 -0500146Get BMC Hostname
147 [Documentation] Get BMC hostname.
148
Prashanth Kattic068faa2019-04-16 00:57:22 -0500149 # Sample output of "hostname":
150 # test_hostname
Prashanth Katti40fb8ca2017-07-25 06:47:23 -0500151
Prashanth Kattic068faa2019-04-16 00:57:22 -0500152 ${output} ${stderr} ${rc}= BMC Execute Command hostname
Prashanth Katti40fb8ca2017-07-25 06:47:23 -0500153
154 [Return] ${output}
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500155
shrsuman123fdc51d22020-08-18 06:51:09 -0500156Get FW_Env MAC Address
157 [Documentation] Get FW_Env MAC address.
158
159 # Sample output of "fw_printenv | grep ethaddr"
160 # ethaddr=xx:xx:xx:xx:xx:xx:xx
161
162 ${cmd_output} ${stderr} ${rc}= BMC Execute Command
163 ... /sbin/fw_printenv | grep ethaddr
164
165 # Split the line and return MAC address.
166 # Split list data:
167 # ethaddr | xx:xx:xx:xx:xx:xx:xx
168
169 @{words}= Split String ${cmd_output} =
170
171 [Return] ${words[1]}
172
173
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500174Get List Of IP Address Via REST
175 [Documentation] Get list of IP address via REST.
176 [Arguments] @{ip_uri_list}
177
178 # Description of argument(s):
179 # ip_uri_list List of IP objects.
180 # Example:
181 # "data": [
182 # "/xyz/openbmc_project/network/eth0/ipv4/e9767624",
183 # "/xyz/openbmc_project/network/eth0/ipv4/31f4ce8b"
184 # ],
185
186 ${ip_list}= Create List
187
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500188 FOR ${ip_uri} IN @{ip_uri_list}
189 ${ip_addr}= Read Attribute ${ip_uri} Address
190 Append To List ${ip_list} ${ip_addr}
191 END
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500192
193 [Return] @{ip_list}
194
195Delete IP And Object
196 [Documentation] Delete IP and object.
197 [Arguments] ${ip_addr} @{ip_uri_list}
198
199 # Description of argument(s):
200 # ip_addr IP address to be deleted.
201 # ip_uri_list List of IP object URIs.
202
203 # Find IP object having this IP address.
204
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500205 FOR ${ip_uri} IN @{ip_uri_list}
206 ${ip_addr1}= Read Attribute ${ip_uri} Address
207 Run Keyword If '${ip_addr}' == '${ip_addr1}' Exit For Loop
208 END
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500209
210 # If the given IP address is not configured, return.
211 # Otherwise, delete the IP and object.
212
213 Run Keyword And Return If '${ip_addr}' != '${ip_addr1}'
214 ... Pass Execution IP address to be deleted is not configured.
215
216 Run Keyword And Ignore Error OpenBMC Delete Request ${ip_uri}
217
218 # After any modification on network interface, BMC restarts network
Prashanth Katti549c63a2018-07-17 06:13:37 -0500219 # module, wait until it is reachable. Then wait 15 seconds for new
220 # configuration to be updated on BMC.
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500221
Prashanth Katti549c63a2018-07-17 06:13:37 -0500222 Wait For Host To Ping ${OPENBMC_HOST} ${NETWORK_TIMEOUT}
223 ... ${NETWORK_RETRY_TIME}
224 Sleep 15s
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500225
226 # Verify whether deleted IP address is removed from BMC system.
227
228 ${ip_data}= Get BMC IP Info
Prashanth Katti160faf62017-09-07 01:05:56 -0500229 Should Not Contain Match ${ip_data} ${ip_addr}*
Prashanth Katti90f9ff22017-08-11 06:17:12 -0500230 ... msg=IP address not deleted.
Prashanth Kattidf2e4fdf2018-02-07 07:04:13 -0600231
George Keishing58e47232018-02-12 10:35:15 -0600232Get First Non Pingable IP From Subnet
233 [Documentation] Find first non-pingable IP from the subnet and return it.
234 [Arguments] ${host}=${OPENBMC_HOST}
Prashanth Kattidf2e4fdf2018-02-07 07:04:13 -0600235
236 # Description of argument(s):
George Keishing58e47232018-02-12 10:35:15 -0600237 # host Any valid host name or IP address
238 # (e.g. "machine1" or "9.xx.xx.31").
Prashanth Kattidf2e4fdf2018-02-07 07:04:13 -0600239
George Keishing58e47232018-02-12 10:35:15 -0600240 # Non-pingable IP is unused IP address in the subnet.
shrsuman1237ba02f32021-08-26 04:50:56 -0500241 ${host_name} ${ip_addr}= Get Host Name IP ${host}
Prashanth Kattidf2e4fdf2018-02-07 07:04:13 -0600242
243 # Split IP address into network part and host part.
244 # IP address will have 4 octets xx.xx.xx.xx.
245 # Sample output after split:
246 # split_ip [xx.xx.xx, xx]
247
248 ${split_ip}= Split String From Right ${ip_addr} . 1
249 # First element in list is Network part.
250 ${network_part}= Get From List ${split_ip} 0
251
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500252 FOR ${octet4} IN RANGE 1 255
253 ${new_ip}= Catenate ${network_part}.${octet4}
254 ${status}= Run Keyword And Return Status Ping Host ${new_ip}
255 # If IP is non-pingable, return it.
256 Return From Keyword If '${status}' == 'False' ${new_ip}
257 END
Prashanth Kattidf2e4fdf2018-02-07 07:04:13 -0600258
George Keishing58e47232018-02-12 10:35:15 -0600259 Fail msg=No non-pingable IP could be found in subnet ${network_part}.
Prashanth Kattidf2e4fdf2018-02-07 07:04:13 -0600260
George Keishingbf724772018-02-21 08:57:16 -0600261
262Validate MAC On BMC
263 [Documentation] Validate MAC on BMC.
264 [Arguments] ${mac_addr}
265
266 # Description of argument(s):
267 # mac_addr MAC address of the BMC.
268
269 ${system_mac}= Get BMC MAC Address
shrsuman123fdc51d22020-08-18 06:51:09 -0500270 ${mac_new_addr}= Truncate MAC Address ${system_mac} ${mac_addr}
George Keishingbf724772018-02-21 08:57:16 -0600271
shrsuman123fdc51d22020-08-18 06:51:09 -0500272 ${status}= Compare MAC Address ${system_mac} ${mac_new_addr}
George Keishingbf724772018-02-21 08:57:16 -0600273 Should Be True ${status}
shrsuman123fdc51d22020-08-18 06:51:09 -0500274 ... msg=MAC address ${system_mac} does not match ${mac_new_addr}.
275
276Validate MAC On FW_Env
277 [Documentation] Validate MAC on FW_Env.
278 [Arguments] ${mac_addr}
279
280 # Description of argument(s):
281 # mac_addr MAC address of the BMC.
282
283 ${fw_env_addr}= Get FW_Env MAC Address
284 ${mac_new_addr}= Truncate MAC Address ${fw_env_addr} ${mac_addr}
285
286 ${status}= Compare MAC Address ${fw_env_addr} ${mac_new_addr}
287 Should Be True ${status}
288 ... msg=MAC address ${fw_env_addr} does not match ${mac_new_addr}.
289
290Truncate MAC Address
Anves Kumar rayankula0b9efea2021-05-28 08:52:28 -0500291 [Documentation] Truncates and returns user provided MAC address.
shrsuman123fdc51d22020-08-18 06:51:09 -0500292 [Arguments] ${sys_mac_addr} ${user_mac_addr}
Anves Kumar rayankula0b9efea2021-05-28 08:52:28 -0500293
shrsuman123fdc51d22020-08-18 06:51:09 -0500294 # Description of argument(s):
295 # sys_mac_addr MAC address of the BMC.
296 # user_mac_addr user provided MAC address.
297
298 ${mac_byte}= Set Variable ${0}
299 @{user_mac_list}= Split String ${user_mac_addr} :
300 @{sys_mac_list}= Split String ${sys_mac_addr} :
301 ${user_new_mac_list} Create List
302
303 # Truncate extra bytes and bits from MAC address
304 FOR ${mac_item} IN @{sys_mac_list}
305 ${invalid_mac_byte} = Get Regexp Matches ${user_mac_list}[${mac_byte}] [^A-Za-z0-9]+
306 Return From Keyword If ${invalid_mac_byte} ${user_mac_addr}
307 ${mac_int} = Convert To Integer ${user_mac_list}[${mac_byte}] 16
308 ${user_mac_len} = Get Length ${user_mac_list}
Anves Kumar rayankula0b9efea2021-05-28 08:52:28 -0500309 ${user_mac_byte}= Run Keyword IF
310 ... ${mac_int} >= ${256} Truncate MAC Bits ${user_mac_list}[${mac_byte}]
311 ... ELSE Set Variable ${user_mac_list}[${mac_byte}]
shrsuman123fdc51d22020-08-18 06:51:09 -0500312
313 Append To List ${user_new_mac_list} ${user_mac_byte}
314 ${mac_byte} = Set Variable ${mac_byte + 1}
315 Exit For Loop If '${mac_byte}' == '${user_mac_len}'
316
317 END
318 ${user_new_mac_string}= Evaluate ":".join(${user_new_mac_list})
319 [Return] ${user_new_mac_string}
320
321Truncate MAC Bits
Anves Kumar rayankula0b9efea2021-05-28 08:52:28 -0500322 [Documentation] Truncates user provided MAC address byte to bits.
shrsuman123fdc51d22020-08-18 06:51:09 -0500323 [Arguments] ${user_mac_addr_byte}
Anves Kumar rayankula0b9efea2021-05-28 08:52:28 -0500324
shrsuman123fdc51d22020-08-18 06:51:09 -0500325 # Description of argument(s):
326 # user_mac_addr_byte user provided MAC address byte to truncate bits
327
328 ${user_mac_addr_int}= Convert To List ${user_mac_addr_byte}
329 ${user_mac_addr_byte}= Get Slice From List ${user_mac_addr_int} 0 2
330 ${user_mac_addr_byte_string}= Evaluate "".join(${user_mac_addr_byte})
331 [Return] ${user_mac_addr_byte_string}
George Keishingbf724772018-02-21 08:57:16 -0600332
Daniel Gonzalezbfd8aff2018-03-27 10:20:37 -0600333
334Run Build Net
335 [Documentation] Run build_net to preconfigure the ethernet interfaces.
336
337 OS Execute Command build_net help y y
Gunnar Mills7732c7e2018-08-14 11:54:24 -0500338 # Run pingum to check if the "build_net" was run correctly done.
Daniel Gonzalezbfd8aff2018-03-27 10:20:37 -0600339 ${output} ${stderr} ${rc}= OS Execute Command pingum
Prashanth Katti549c63a2018-07-17 06:13:37 -0500340 Should Contain ${output} All networks ping Ok
Sushil Singhf661a102019-06-04 00:52:48 -0500341
342
343Configure Hostname
344 [Documentation] Configure hostname on BMC via Redfish.
345 [Arguments] ${hostname}
346
347 # Description of argument(s):
348 # hostname A hostname value which is to be configured on BMC.
349
Anves Kumar rayankula1cc996d2021-05-31 01:14:19 -0500350 ${active_channel_config}= Get Active Channel Config
351 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
352
Sushil Singhf661a102019-06-04 00:52:48 -0500353 ${data}= Create Dictionary HostName=${hostname}
Anves Kumar rayankula1cc996d2021-05-31 01:14:19 -0500354 Redfish.patch ${REDFISH_NW_ETH_IFACE}${ethernet_interface} body=&{data}
George Keishing5041d6d2020-01-14 12:19:06 -0600355 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sushil Singhf661a102019-06-04 00:52:48 -0500356
Naman Navin Hegde53691452019-07-30 00:22:37 -0500357
358Verify IP On BMC
359 [Documentation] Verify IP on BMC.
360 [Arguments] ${ip}
361
362 # Description of argument(s):
363 # ip IP address to be verified (e.g. "10.7.7.7").
364
365 # Get IP address details on BMC using IP command.
366 @{ip_data}= Get BMC IP Info
367 Should Contain Match ${ip_data} ${ip}/*
368 ... msg=IP address does not exist.
369
370
371Verify Gateway On BMC
372 [Documentation] Verify gateway on BMC.
373 [Arguments] ${gateway_ip}=0.0.0.0
374
375 # Description of argument(s):
376 # gateway_ip Gateway IP address.
377
378 ${route_info}= Get BMC Route Info
379
380 # If gateway IP is empty or 0.0.0.0 it will not have route entry.
381
382 Run Keyword If '${gateway_ip}' == '0.0.0.0'
383 ... Pass Execution Gateway IP is "0.0.0.0".
384 ... ELSE
385 ... Should Contain ${route_info} ${gateway_ip}
386 ... msg=Gateway IP address not matching.
387
388
389Get BMC DNS Info
390 [Documentation] Get system DNS info.
391
392
393 # Sample output of "resolv.conf":
394 # ### Generated manually via dbus settings ###
395 # nameserver 8.8.8.8
396
397 ${cmd_output} ${stderr} ${rc}= BMC Execute Command
398 ... cat /etc/resolv.conf
399
400 [Return] ${cmd_output}
401
402
403CLI Get Nameservers
404 [Documentation] Get the nameserver IPs from /etc/resolv.conf and return as a list.
405
406 # Example of /etc/resolv.conf data:
407 # nameserver x.x.x.x
408 # nameserver y.y.y.y
409
410 ${stdout} ${stderr} ${rc}= BMC Execute Command egrep nameserver /etc/resolv.conf | cut -f2- -d ' '
411 ${nameservers}= Split String ${stdout}
412
413 [Return] ${nameservers}
Anvesh Kumar Rayankulaada25db2020-02-19 01:29:17 -0600414
415
416Get Network Configuration
417 [Documentation] Get network configuration.
418 # Sample output:
419 #{
420 # "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
421 # "@odata.id": "/redfish/v1/Managers/bmc/EthernetInterfaces/eth0",
422 # "@odata.type": "#EthernetInterface.v1_2_0.EthernetInterface",
423 # "Description": "Management Network Interface",
424 # "IPv4Addresses": [
425 # {
426 # "Address": "169.254.xx.xx",
427 # "AddressOrigin": "IPv4LinkLocal",
428 # "Gateway": "0.0.0.0",
429 # "SubnetMask": "255.255.0.0"
430 # },
431 # {
432 # "Address": "xx.xx.xx.xx",
433 # "AddressOrigin": "Static",
434 # "Gateway": "xx.xx.xx.1",
435 # "SubnetMask": "xx.xx.xx.xx"
436 # }
437 # ],
438 # "Id": "eth0",
439 # "MACAddress": "xx:xx:xx:xx:xx:xx",
440 # "Name": "Manager Ethernet Interface",
441 # "SpeedMbps": 0,
442 # "VLAN": {
443 # "VLANEnable": false,
444 # "VLANId": 0
445 # }
shrsuman1237ba02f32021-08-26 04:50:56 -0500446 [Arguments] ${network_active_channel}=${CHANNEL_NUMBER}
Tony Lee412c6682020-04-01 17:34:30 +0800447
shrsuman1237ba02f32021-08-26 04:50:56 -0500448 # Description of argument(s):
449 # network_active_channel Ethernet channel number (eg. 1 or 2)
450
Tony Lee9f6b2042020-04-27 20:20:43 +0800451 ${active_channel_config}= Get Active Channel Config
shrsuman1237ba02f32021-08-26 04:50:56 -0500452 ${resp}= Redfish.Get
453 ... ${REDFISH_NW_ETH_IFACE}${active_channel_config['${network_active_channel}']['name']}
Tony Lee412c6682020-04-01 17:34:30 +0800454
Anvesh Kumar Rayankulaada25db2020-02-19 01:29:17 -0600455 @{network_configurations}= Get From Dictionary ${resp.dict} IPv4StaticAddresses
456 [Return] @{network_configurations}
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600457
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500458
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600459Add IP Address
460 [Documentation] Add IP Address To BMC.
461 [Arguments] ${ip} ${subnet_mask} ${gateway}
462 ... ${valid_status_codes}=${HTTP_OK}
463
464 # Description of argument(s):
465 # ip IP address to be added (e.g. "10.7.7.7").
466 # subnet_mask Subnet mask for the IP to be added
467 # (e.g. "255.255.0.0").
468 # gateway Gateway for the IP to be added (e.g. "10.7.7.1").
469 # valid_status_codes Expected return code from patch operation
470 # (e.g. "200"). See prolog of rest_request
471 # method in redfish_plus.py for details.
472
473 ${empty_dict}= Create Dictionary
474 ${ip_data}= Create Dictionary Address=${ip}
475 ... SubnetMask=${subnet_mask} Gateway=${gateway}
476
477 ${patch_list}= Create List
478 ${network_configurations}= Get Network Configuration
479 ${num_entries}= Get Length ${network_configurations}
480
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500481 FOR ${INDEX} IN RANGE 0 ${num_entries}
482 Append To List ${patch_list} ${empty_dict}
483 END
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600484
Anves Kumar rayankula53b80302021-05-21 01:50:03 -0500485 ${valid_status_codes}= Run Keyword If '${valid_status_codes}' == '${HTTP_OK}'
486 ... Set Variable ${HTTP_OK},${HTTP_NO_CONTENT}
487 ... ELSE Set Variable ${valid_status_codes}
488
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600489 # We need not check for existence of IP on BMC while adding.
490 Append To List ${patch_list} ${ip_data}
491 ${data}= Create Dictionary IPv4StaticAddresses=${patch_list}
492
Tony Lee412c6682020-04-01 17:34:30 +0800493 ${active_channel_config}= Get Active Channel Config
494 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
495
496 Redfish.patch ${REDFISH_NW_ETH_IFACE}${ethernet_interface} body=&{data}
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600497 ... valid_status_codes=[${valid_status_codes}]
498
Anves Kumar rayankula53b80302021-05-21 01:50:03 -0500499 Return From Keyword If '${valid_status_codes}' != '${HTTP_OK},${HTTP_NO_CONTENT}'
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600500
501 # Note: Network restart takes around 15-18s after patch request processing.
502 Sleep ${NETWORK_TIMEOUT}s
503 Wait For Host To Ping ${OPENBMC_HOST} ${NETWORK_TIMEOUT}
504
505 Verify IP On BMC ${ip}
506 Validate Network Config On BMC
507
508
509Delete IP Address
510 [Documentation] Delete IP Address Of BMC.
511 [Arguments] ${ip} ${valid_status_codes}=${HTTP_OK}
512
513 # Description of argument(s):
514 # ip IP address to be deleted (e.g. "10.7.7.7").
515 # valid_status_codes Expected return code from patch operation
516 # (e.g. "200"). See prolog of rest_request
517 # method in redfish_plus.py for details.
518
519 ${empty_dict}= Create Dictionary
520 ${patch_list}= Create List
521
522 @{network_configurations}= Get Network Configuration
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500523 FOR ${network_configuration} IN @{network_configurations}
524 Run Keyword If '${network_configuration['Address']}' == '${ip}'
525 ... Append To List ${patch_list} ${null}
526 ... ELSE Append To List ${patch_list} ${empty_dict}
527 END
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600528
529 ${ip_found}= Run Keyword And Return Status List Should Contain Value
530 ... ${patch_list} ${null} msg=${ip} does not exist on BMC
531 Pass Execution If ${ip_found} == ${False} ${ip} does not exist on BMC
532
533 # Run patch command only if given IP is found on BMC
534 ${data}= Create Dictionary IPv4StaticAddresses=${patch_list}
535
Tony Lee412c6682020-04-01 17:34:30 +0800536 ${active_channel_config}= Get Active Channel Config
537 ${ethernet_interface}= Set Variable ${active_channel_config['${CHANNEL_NUMBER}']['name']}
538
539 Redfish.patch ${REDFISH_NW_ETH_IFACE}${ethernet_interface} body=&{data}
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600540 ... valid_status_codes=[${valid_status_codes}]
541
542 # Note: Network restart takes around 15-18s after patch request processing
543 Sleep ${NETWORK_TIMEOUT}s
544 Wait For Host To Ping ${OPENBMC_HOST} ${NETWORK_TIMEOUT}
545
546 ${delete_status}= Run Keyword And Return Status Verify IP On BMC ${ip}
547 Run Keyword If '${valid_status_codes}' == '${HTTP_OK}'
548 ... Should Be True '${delete_status}' == '${False}'
549 ... ELSE Should Be True '${delete_status}' == '${True}'
550
551 Validate Network Config On BMC
552
553
554Validate Network Config On BMC
555 [Documentation] Check that network info obtained via redfish matches info
556 ... obtained via CLI.
557
558 @{network_configurations}= Get Network Configuration
559 ${ip_data}= Get BMC IP Info
Anvesh Kumar Rayankulae354c1c2020-03-09 06:01:13 -0500560 FOR ${network_configuration} IN @{network_configurations}
561 Should Contain Match ${ip_data} ${network_configuration['Address']}/*
562 ... msg=IP address does not exist.
563 END
564
565
566Create VLAN
567 [Documentation] Create a VLAN.
568 [Arguments] ${id} ${interface}=eth0 ${expected_result}=valid
569
570 # Description of argument(s):
571 # id The VLAN ID (e.g. '53').
572 # interface The physical interface for the VLAN(e.g. 'eth0').
573 # expected_result Expected status of VLAN configuration.
574
575 @{data_vlan_id}= Create List ${interface} ${id}
576 ${data}= Create Dictionary data=@{data_vlan_id}
577 ${resp}= OpenBMC Post Request ${vlan_resource} data=${data}
578 ${resp.status_code}= Convert To String ${resp.status_code}
579 ${status}= Run Keyword And Return Status
580 ... Valid Value resp.status_code ["${HTTP_OK}"]
581
582 Run Keyword If '${expected_result}' == 'error'
583 ... Should Be Equal ${status} ${False}
584 ... msg=Configuration of an invalid VLAN ID Failed.
585 ... ELSE
586 ... Should Be Equal ${status} ${True}
587 ... msg=Configuration of a valid VLAN ID Failed.
588
589 Sleep ${NETWORK_TIMEOUT}s
590
591
592Configure Network Settings On VLAN
593 [Documentation] Configure network settings.
594 [Arguments] ${id} ${ip_addr} ${prefix_len} ${gateway_ip}=${gateway}
595 ... ${expected_result}=valid ${interface}=eth0
596
597 # Description of argument(s):
598 # id The VLAN ID (e.g. '53').
599 # ip_addr IP address of VLAN Interface.
600 # prefix_len Prefix length of VLAN Interface.
601 # gateway_ip Gateway IP address of VLAN Interface.
602 # expected_result Expected status of network setting configuration.
603 # interface Physical Interface on which the VLAN is defined.
604
605 @{ip_parm_list}= Create List ${network_resource}
606 ... ${ip_addr} ${prefix_len} ${gateway_ip}
607
608 ${data}= Create Dictionary data=@{ip_parm_list}
609
610 Run Keyword And Ignore Error OpenBMC Post Request
611 ... ${NETWORK_MANAGER}${interface}_${id}/action/IP data=${data}
612
613 # After any modification on network interface, BMC restarts network
614 # module, wait until it is reachable. Then wait 15 seconds for new
615 # configuration to be updated on BMC.
616
617 Wait For Host To Ping ${OPENBMC_HOST} ${NETWORK_TIMEOUT}
618 ... ${NETWORK_RETRY_TIME}
619 Sleep ${NETWORK_TIMEOUT}s
620
621 # Verify whether new IP address is populated on BMC system.
622 # It should not allow to configure invalid settings.
623 ${status}= Run Keyword And Return Status
624 ... Verify IP On BMC ${ip_addr}
625
626 Run Keyword If '${expected_result}' == 'error'
627 ... Should Be Equal ${status} ${False}
628 ... msg=Configuration of invalid IP Failed.
629 ... ELSE
630 ... Should Be Equal ${status} ${True}
631 ... msg=Configuration of valid IP Failed.
Prashanth Katti3dc8cc32020-03-04 11:11:01 -0600632
Prashanth Kattib478d902020-05-08 10:05:32 -0500633
634Get BMC Default Gateway
635 [Documentation] Get system default gateway.
636
637 ${route_info}= Get BMC Route Info
638
639 ${lines}= Get Lines Containing String ${route_info} default via
640 @{gateway_list}= Split To Lines ${lines}
641
642 # Extract first default gateway and return.
643 @{default_gw}= Split String ${gateway_list[0]}
644
645 [Return] ${default_gw[2]}
Anves Kumar rayankula55d51922021-07-01 06:37:00 -0500646
647
648Validate Hostname On BMC
649 [Documentation] Verify that the hostname read via Redfish is the same as the
650 ... hostname configured on system.
651 [Arguments] ${hostname}
652
653 # Description of argument(s):
654 # hostname A hostname value which is to be compared to the hostname
655 # configured on system.
656
657 ${sys_hostname}= Get BMC Hostname
658 Should Be Equal ${sys_hostname} ${hostname}
659 ... ignore_case=True msg=Hostname does not exist.