blob: 550774a7f67fa21403a385f28a84ed1c5fa96fe9 [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
2Library Collections
3Library String
George Keishingfbd67002022-08-01 11:24:03 -05004Library RequestsLibrary
Chris Austenb29d2e82016-06-07 12:25:35 -05005Library OperatingSystem
6Variables ../data/variables.py
7
8*** Variables ***
George Keishing633b9ce2018-05-31 01:24:52 -05009
George Keishing1e2fbee2021-03-19 11:19:29 -050010# By default power, support x86 as well.
11${PLATFORM_ARCH_TYPE} power
12
George Keishing985659a2021-06-23 02:52:13 -050013# FFDC Redfish OEM path /<oem>/v1/
14${OEM_REDFISH_PATH} ${EMPTY}
15
George Keishingad920242023-12-14 17:14:33 +053016${REDFISH_SUPPORT_TRANS_STATE} ${1}
George Keishingd86e45c2021-03-19 07:38:14 -050017
18# By default Delete all Redfish session per boot run.
19${REDFISH_DELETE_SESSIONS} ${1}
George Keishing6ceba1c2020-11-25 08:10:23 -060020
George Keishingf00dde02023-11-28 08:40:11 +053021${OPENBMC_MODEL} ${EMPTY}
22${OPENBMC_HOST} ${EMPTY}
23${DBUS_PREFIX} ${EMPTY}
24${PORT} ${EMPTY}
George Keishing283ae8a2023-12-06 10:20:23 +053025
George Keishingf7b4e6d2025-02-24 15:20:36 +053026# BMC ethernet eth0 and eth1 for multiple interfaces.
27# By default eth0 is assigned with OPENBMC_HOST
28${OPENBMC_HOST_ETH0} ${OPENBMC_HOST}
29${OPENBMC_HOST_ETH1} ${EMPTY}
30
31
George Keishingfbeaecc2016-08-16 05:24:31 -050032# AUTH_SUFFIX here is derived from variables.py
George Keishingf00dde02023-11-28 08:40:11 +053033${AUTH_URI} https://${OPENBMC_HOST}${AUTH_SUFFIX}
George Keishingfbb92272023-11-20 11:42:32 +053034${OPENBMC_USERNAME} root
35${OPENBMC_PASSWORD} ${EMPTY}
Anusha Dathatri18f69a62023-04-24 02:44:55 -050036${OPENBMC_ADMIN_USERNAME} admin
George Keishing294c2672023-11-16 14:30:23 +053037${OPENBMC_ADMIN_PASSWORD} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080038
George Keishingde7e0452022-02-01 07:04:41 -060039# For users privilege admin or sudo.
George Keishingf00dde02023-11-28 08:40:11 +053040${USER_TYPE} ${EMPTY}
George Keishing2104d5f2022-01-31 04:33:30 -060041
George Keishingf00dde02023-11-28 08:40:11 +053042${MANAGER_ID} bmc
43${CHASSIS_ID} chassis
Yi Huc32434a2024-01-11 17:33:10 -080044${SYSTEM_ID} system
Tony Lee2b975822021-04-01 11:15:00 +080045
Tony Lee05aa70b2021-01-28 19:18:27 +080046# MTLS_ENABLED indicates whether mTLS is enabled.
George Keishingf00dde02023-11-28 08:40:11 +053047${MTLS_ENABLED} False
Tony Lee05aa70b2021-01-28 19:18:27 +080048# Valid mTLS certificate for authentication.
George Keishingf00dde02023-11-28 08:40:11 +053049${VALID_CERT} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080050# Path of mTLS certificates directory.
George Keishingf00dde02023-11-28 08:40:11 +053051${CERT_DIR_PATH} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080052
George Keishingf00dde02023-11-28 08:40:11 +053053${IPMI_USERNAME} root
54# Assign BMC password as default. User can input using -v option to key in
55# IPMI password if different.
56${IPMI_PASSWORD} ${OPENBMC_PASSWORD}
57
Chris Austenb29d2e82016-06-07 12:25:35 -050058${OPENBMC_REBOOT_TIMEOUT} ${10}
George Keishing283ae8a2023-12-06 10:20:23 +053059
Rahul Maheshwarica2d6872017-03-17 01:48:24 -050060# IPMI_COMMAND here is set to "External" by default. User
61# can override to "Dbus" from command line.
George Keishing283ae8a2023-12-06 10:20:23 +053062${IPMI_COMMAND} External
63
George Keishing39967eb2018-04-30 11:36:23 -050064# IPMI chipher default.
George Keishing283ae8a2023-12-06 10:20:23 +053065${IPMI_CIPHER_LEVEL} ${17}
66
George Keishing75f55dc2021-03-29 10:48:09 -050067# IPMI timeout default.
George Keishing283ae8a2023-12-06 10:20:23 +053068${IPMI_TIMEOUT} ${3}
69${GEN_ID_BYTE_1} ${20}
70${GEN_ID_BYTE_2} ${00}
Chris Austenb29d2e82016-06-07 12:25:35 -050071
George Keishing26206722021-11-17 01:29:53 -060072# Log default path for IPMI SOL.
73${IPMI_SOL_LOG_FILE} ${EXECDIR}${/}logs${/}sol_${OPENBMC_HOST}
74
chithrag0f0bd532022-04-05 09:49:53 +000075# IPMI SOL console output types/parameters to verify.
76${SOL_BIOS_OUTPUT} ${EMPTY}
77${SOL_LOGIN_OUTPUT} ${EMPTY}
78
Chris Austenb29d2e82016-06-07 12:25:35 -050079# PDU related parameters
80${PDU_TYPE} ${EMPTY}
81${PDU_IP} ${EMPTY}
82${PDU_USERNAME} ${EMPTY}
83${PDU_PASSWORD} ${EMPTY}
84${PDU_SLOT_NO} ${EMPTY}
85
George Keishing4d6c1da2016-07-15 05:51:22 -050086# User define input SSH and HTTPS related parameters
Michael Walsh73a86ac2019-11-08 14:24:09 -060087${SSH_PORT} 22
88${HTTPS_PORT} 443
George Keishinge33ad1d2019-12-09 11:17:36 -060089${IPMI_PORT} 623
George Keishing088166c2019-12-13 08:11:28 -060090${HOST_SOL_PORT} 2200
George Keishingbeec26d2016-11-09 06:57:28 -060091${OPENBMC_SERIAL_HOST} ${EMPTY}
92${OPENBMC_SERIAL_PORT} ${EMPTY}
Jorge Cisnerosf196b242022-09-09 15:46:15 +000093${OPENBMC_CONSOLE_CLIENT} ${EMPTY}
George Keishing4d6c1da2016-07-15 05:51:22 -050094
Michael Walsh49ab0f42016-07-20 11:44:33 -050095# OS related parameters.
96${OS_HOST} ${EMPTY}
97${OS_USERNAME} ${EMPTY}
98${OS_PASSWORD} ${EMPTY}
99${OS_WAIT_TIMEOUT} ${15*60}
100
Prashanth Katti01293ef2017-02-16 08:20:20 -0600101# Networking related parameters
Prashanth Kattibcb7d612019-08-09 06:04:10 -0500102${NETWORK_PORT} 80
103${PACKET_TYPE} tcp
104${ICMP_PACKETS} icmp
105${NETWORK_RETRY_TIME} 6
106${NETWORK_TIMEOUT} 18
107${ICMP_TIMESTAMP_REQUEST} 13
108${ICMP_ECHO_REQUEST} 8
Tony Lee7c5f4b22019-12-06 17:21:31 +0800109${CHANNEL_NUMBER} 1
kothais01f95fc2023-11-01 14:12:51 +0000110${SECONDARY_CHANNEL_NUMBER} 2
Prashanth Katti2f80bf12021-06-17 07:43:25 -0500111${TCP_PACKETS} tcp
Megha G N903ebe92023-09-07 00:47:07 -0500112${TCP_CONNECTION} tcp-connect
Prashanth Katti2f80bf12021-06-17 07:43:25 -0500113${ICMP_NETMASK_REQUEST} 17
114${REDFISH_INTERFACE} 443
Prashanth Kattib18762b2021-06-21 07:55:52 -0500115${SYN_PACKETS} SYN
116${RESET_PACKETS} RST
117${FIN_PACKETS} FIN
118${SYN_ACK_RESET} SAR
119${ALL_FLAGS} ALL
George Keishing283ae8a2023-12-06 10:20:23 +0530120
Tony Lee374a5382021-08-09 19:22:44 +0800121# Used to set BMC static IPv4 configuration.
122${STATIC_IP} 10.10.10.10
123${NETMASK} 255.255.255.0
124${GATEWAY} 10.10.10.10
Prashanth Kattibcb7d612019-08-09 06:04:10 -0500125
George Keishinga126e212017-03-24 08:07:17 -0500126# BMC debug tarball parameter
127${DEBUG_TARBALL_PATH} ${EMPTY}
128
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500129# Upload Image parameters
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500130${TFTP_SERVER} ${EMPTY}
131${PNOR_TFTP_FILE_NAME} ${EMPTY}
132${BMC_TFTP_FILE_NAME} ${EMPTY}
133${IMAGE_FILE_PATH} ${EMPTY}
134${ALTERNATE_IMAGE_FILE_PATH} ${EMPTY}
135${PNOR_IMAGE_FILE_PATH} ${EMPTY}
136${BMC_IMAGE_FILE_PATH} ${EMPTY}
137${BAD_IMAGES_DIR_PATH} ${EMPTY}
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500138${SKIP_UPDATE_IF_ACTIVE} false
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500139
Charles Paul Hofer862685c2017-09-19 17:09:19 -0500140# Parameters for doing N-1 and N+1 code updates.
141${N_MINUS_ONE_IMAGE_FILE_PATH} ${EMPTY}
142${N_PLUS_ONE_IMAGE_FILE_PATH} ${EMPTY}
143
Andrew Geissleraad05302017-09-13 22:20:34 +0000144# The caller must set this to the string "true" in order to delete images. The
145# code is picky.
Charles Paul Hofer2c731642017-08-03 18:13:27 -0500146${DELETE_OLD_PNOR_IMAGES} false
Charles Paul Hofer51b54c02017-09-13 22:13:49 -0500147${DELETE_OLD_GUARD_FILE} false
Charles Paul Hofer2c731642017-08-03 18:13:27 -0500148
George Keishing830211e2017-07-19 08:44:07 -0500149# Caller can specify a value for LAST_KNOWN_GOOD_VERSION to indicate that if
150# the machine already has that version on it, the update should be skipped.
151${LAST_KNOWN_GOOD_VERSION} ${EMPTY}
152
George Keishing3e28ea32017-12-19 03:13:52 -0600153# By default field mode is disabled.
154${FIELD_MODE} ${False}
155
Sivas SRRe4c1e852018-09-26 23:36:35 -0500156# LDAP related variables.
157${LDAP_BASE_DN} ${EMPTY}
158${LDAP_BIND_DN} ${EMPTY}
159${LDAP_SERVER_HOST} ${EMPTY}
160${LDAP_SECURE_MODE} ${EMPTY}
161${LDAP_BIND_DN_PASSWORD} ${EMPTY}
162${LDAP_SEARCH_SCOPE} ${EMPTY}
163${LDAP_TYPE} ${EMPTY}
164${LDAP_USER} ${EMPTY}
165${LDAP_USER_PASSWORD} ${EMPTY}
Nagarjun B1b821612021-12-06 22:52:04 +0530166${GROUP_PRIVILEGE} ${EMPTY}
167${GROUP_NAME} ${EMPTY}
168${LDAP_SERVER_URI} ldap://${LDAP_SERVER_HOST}
Sivas SRRe4c1e852018-09-26 23:36:35 -0500169
Peter D Phan5e56f522021-12-20 13:19:41 -0600170# General tool variables
171# FFDC_DEFAULT == 1; use Default FFDC methods
172${FFDC_DEFAULT} ${1}
173
ganesanb3937eaa2023-04-15 10:24:38 +0000174# NTP Server Address
175# NTP Address needs to be given as an list.
176# For example,
177# 1 NTP Address - 14.139.60.103
178# 2 NTP Address - 14.139.60.103 14.139.60.106
179@{NTP_SERVER_ADDRESSES} ${EMPTY}
180
manimozhik5beee8a2023-11-08 18:55:34 +0000181# Client related parameters
182${CLIENT_PASSWORD} ${EMPTY}
ganesanb3937eaa2023-04-15 10:24:38 +0000183
Nagarjun Be4f518d2023-07-24 20:40:32 +0530184# Task Service related variables.
185${TASK_JSON_FILE_PATH} data/task_state.json
186
187
Chris Austenb29d2e82016-06-07 12:25:35 -0500188*** Keywords ***
George Keishing283ae8a2023-12-06 10:20:23 +0530189
Chris Austenb29d2e82016-06-07 12:25:35 -0500190Get Inventory Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500191 [Documentation] Get inventory schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500192 [Arguments] ${machine}
George Keishing409df052024-01-17 22:36:14 +0530193 RETURN &{INVENTORY}[${machine}]
Chris Austenb29d2e82016-06-07 12:25:35 -0500194
195Get Inventory Items Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500196 [Documentation] Get inventory items schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500197 [Arguments] ${machine}
George Keishing409df052024-01-17 22:36:14 +0530198 RETURN &{INVENTORY_ITEMS}[${machine}]
Chris Austenb29d2e82016-06-07 12:25:35 -0500199
200Get Sensor Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500201 [Documentation] Get sensors schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500202 [Arguments] ${machine}
George Keishing409df052024-01-17 22:36:14 +0530203 RETURN &{SENSORS}[${machine}]