blob: c12f52a19093a3b5a310899db66abfa5520538d1 [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 Keishingfbeaecc2016-08-16 05:24:31 -050026# AUTH_SUFFIX here is derived from variables.py
George Keishingf00dde02023-11-28 08:40:11 +053027${AUTH_URI} https://${OPENBMC_HOST}${AUTH_SUFFIX}
George Keishingfbb92272023-11-20 11:42:32 +053028${OPENBMC_USERNAME} root
29${OPENBMC_PASSWORD} ${EMPTY}
Anusha Dathatri18f69a62023-04-24 02:44:55 -050030${OPENBMC_ADMIN_USERNAME} admin
George Keishing294c2672023-11-16 14:30:23 +053031${OPENBMC_ADMIN_PASSWORD} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080032
George Keishingde7e0452022-02-01 07:04:41 -060033# For users privilege admin or sudo.
George Keishingf00dde02023-11-28 08:40:11 +053034${USER_TYPE} ${EMPTY}
George Keishing2104d5f2022-01-31 04:33:30 -060035
George Keishingf00dde02023-11-28 08:40:11 +053036${MANAGER_ID} bmc
37${CHASSIS_ID} chassis
Yi Huc32434a2024-01-11 17:33:10 -080038${SYSTEM_ID} system
Tony Lee2b975822021-04-01 11:15:00 +080039
Tony Lee05aa70b2021-01-28 19:18:27 +080040# MTLS_ENABLED indicates whether mTLS is enabled.
George Keishingf00dde02023-11-28 08:40:11 +053041${MTLS_ENABLED} False
Tony Lee05aa70b2021-01-28 19:18:27 +080042# Valid mTLS certificate for authentication.
George Keishingf00dde02023-11-28 08:40:11 +053043${VALID_CERT} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080044# Path of mTLS certificates directory.
George Keishingf00dde02023-11-28 08:40:11 +053045${CERT_DIR_PATH} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080046
George Keishingf00dde02023-11-28 08:40:11 +053047${IPMI_USERNAME} root
48# Assign BMC password as default. User can input using -v option to key in
49# IPMI password if different.
50${IPMI_PASSWORD} ${OPENBMC_PASSWORD}
51
Chris Austenb29d2e82016-06-07 12:25:35 -050052${OPENBMC_REBOOT_TIMEOUT} ${10}
George Keishing283ae8a2023-12-06 10:20:23 +053053
Rahul Maheshwarica2d6872017-03-17 01:48:24 -050054# IPMI_COMMAND here is set to "External" by default. User
55# can override to "Dbus" from command line.
George Keishing283ae8a2023-12-06 10:20:23 +053056${IPMI_COMMAND} External
57
George Keishing39967eb2018-04-30 11:36:23 -050058# IPMI chipher default.
George Keishing283ae8a2023-12-06 10:20:23 +053059${IPMI_CIPHER_LEVEL} ${17}
60
George Keishing75f55dc2021-03-29 10:48:09 -050061# IPMI timeout default.
George Keishing283ae8a2023-12-06 10:20:23 +053062${IPMI_TIMEOUT} ${3}
63${GEN_ID_BYTE_1} ${20}
64${GEN_ID_BYTE_2} ${00}
Chris Austenb29d2e82016-06-07 12:25:35 -050065
George Keishing26206722021-11-17 01:29:53 -060066# Log default path for IPMI SOL.
67${IPMI_SOL_LOG_FILE} ${EXECDIR}${/}logs${/}sol_${OPENBMC_HOST}
68
chithrag0f0bd532022-04-05 09:49:53 +000069# IPMI SOL console output types/parameters to verify.
70${SOL_BIOS_OUTPUT} ${EMPTY}
71${SOL_LOGIN_OUTPUT} ${EMPTY}
72
Chris Austenb29d2e82016-06-07 12:25:35 -050073# PDU related parameters
74${PDU_TYPE} ${EMPTY}
75${PDU_IP} ${EMPTY}
76${PDU_USERNAME} ${EMPTY}
77${PDU_PASSWORD} ${EMPTY}
78${PDU_SLOT_NO} ${EMPTY}
79
George Keishing4d6c1da2016-07-15 05:51:22 -050080# User define input SSH and HTTPS related parameters
Michael Walsh73a86ac2019-11-08 14:24:09 -060081${SSH_PORT} 22
82${HTTPS_PORT} 443
George Keishinge33ad1d2019-12-09 11:17:36 -060083${IPMI_PORT} 623
George Keishing088166c2019-12-13 08:11:28 -060084${HOST_SOL_PORT} 2200
George Keishingbeec26d2016-11-09 06:57:28 -060085${OPENBMC_SERIAL_HOST} ${EMPTY}
86${OPENBMC_SERIAL_PORT} ${EMPTY}
Jorge Cisnerosf196b242022-09-09 15:46:15 +000087${OPENBMC_CONSOLE_CLIENT} ${EMPTY}
George Keishing4d6c1da2016-07-15 05:51:22 -050088
Michael Walsh49ab0f42016-07-20 11:44:33 -050089# OS related parameters.
90${OS_HOST} ${EMPTY}
91${OS_USERNAME} ${EMPTY}
92${OS_PASSWORD} ${EMPTY}
93${OS_WAIT_TIMEOUT} ${15*60}
94
Prashanth Katti01293ef2017-02-16 08:20:20 -060095# Networking related parameters
Prashanth Kattibcb7d612019-08-09 06:04:10 -050096${NETWORK_PORT} 80
97${PACKET_TYPE} tcp
98${ICMP_PACKETS} icmp
99${NETWORK_RETRY_TIME} 6
100${NETWORK_TIMEOUT} 18
101${ICMP_TIMESTAMP_REQUEST} 13
102${ICMP_ECHO_REQUEST} 8
Tony Lee7c5f4b22019-12-06 17:21:31 +0800103${CHANNEL_NUMBER} 1
kothais01f95fc2023-11-01 14:12:51 +0000104${SECONDARY_CHANNEL_NUMBER} 2
Prashanth Katti2f80bf12021-06-17 07:43:25 -0500105${TCP_PACKETS} tcp
Megha G N903ebe92023-09-07 00:47:07 -0500106${TCP_CONNECTION} tcp-connect
Prashanth Katti2f80bf12021-06-17 07:43:25 -0500107${ICMP_NETMASK_REQUEST} 17
108${REDFISH_INTERFACE} 443
Prashanth Kattib18762b2021-06-21 07:55:52 -0500109${SYN_PACKETS} SYN
110${RESET_PACKETS} RST
111${FIN_PACKETS} FIN
112${SYN_ACK_RESET} SAR
113${ALL_FLAGS} ALL
George Keishing283ae8a2023-12-06 10:20:23 +0530114
Tony Lee374a5382021-08-09 19:22:44 +0800115# Used to set BMC static IPv4 configuration.
116${STATIC_IP} 10.10.10.10
117${NETMASK} 255.255.255.0
118${GATEWAY} 10.10.10.10
Prashanth Kattibcb7d612019-08-09 06:04:10 -0500119
George Keishinga126e212017-03-24 08:07:17 -0500120# BMC debug tarball parameter
121${DEBUG_TARBALL_PATH} ${EMPTY}
122
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500123# Upload Image parameters
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500124${TFTP_SERVER} ${EMPTY}
125${PNOR_TFTP_FILE_NAME} ${EMPTY}
126${BMC_TFTP_FILE_NAME} ${EMPTY}
127${IMAGE_FILE_PATH} ${EMPTY}
128${ALTERNATE_IMAGE_FILE_PATH} ${EMPTY}
129${PNOR_IMAGE_FILE_PATH} ${EMPTY}
130${BMC_IMAGE_FILE_PATH} ${EMPTY}
131${BAD_IMAGES_DIR_PATH} ${EMPTY}
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500132${SKIP_UPDATE_IF_ACTIVE} false
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500133
Charles Paul Hofer862685c2017-09-19 17:09:19 -0500134# Parameters for doing N-1 and N+1 code updates.
135${N_MINUS_ONE_IMAGE_FILE_PATH} ${EMPTY}
136${N_PLUS_ONE_IMAGE_FILE_PATH} ${EMPTY}
137
Andrew Geissleraad05302017-09-13 22:20:34 +0000138# The caller must set this to the string "true" in order to delete images. The
139# code is picky.
Charles Paul Hofer2c731642017-08-03 18:13:27 -0500140${DELETE_OLD_PNOR_IMAGES} false
Charles Paul Hofer51b54c02017-09-13 22:13:49 -0500141${DELETE_OLD_GUARD_FILE} false
Charles Paul Hofer2c731642017-08-03 18:13:27 -0500142
George Keishing830211e2017-07-19 08:44:07 -0500143# Caller can specify a value for LAST_KNOWN_GOOD_VERSION to indicate that if
144# the machine already has that version on it, the update should be skipped.
145${LAST_KNOWN_GOOD_VERSION} ${EMPTY}
146
George Keishing3e28ea32017-12-19 03:13:52 -0600147# By default field mode is disabled.
148${FIELD_MODE} ${False}
149
Sivas SRRe4c1e852018-09-26 23:36:35 -0500150# LDAP related variables.
151${LDAP_BASE_DN} ${EMPTY}
152${LDAP_BIND_DN} ${EMPTY}
153${LDAP_SERVER_HOST} ${EMPTY}
154${LDAP_SECURE_MODE} ${EMPTY}
155${LDAP_BIND_DN_PASSWORD} ${EMPTY}
156${LDAP_SEARCH_SCOPE} ${EMPTY}
157${LDAP_TYPE} ${EMPTY}
158${LDAP_USER} ${EMPTY}
159${LDAP_USER_PASSWORD} ${EMPTY}
Nagarjun B1b821612021-12-06 22:52:04 +0530160${GROUP_PRIVILEGE} ${EMPTY}
161${GROUP_NAME} ${EMPTY}
162${LDAP_SERVER_URI} ldap://${LDAP_SERVER_HOST}
Sivas SRRe4c1e852018-09-26 23:36:35 -0500163
Peter D Phan5e56f522021-12-20 13:19:41 -0600164# General tool variables
165# FFDC_DEFAULT == 1; use Default FFDC methods
166${FFDC_DEFAULT} ${1}
167
ganesanb3937eaa2023-04-15 10:24:38 +0000168# NTP Server Address
169# NTP Address needs to be given as an list.
170# For example,
171# 1 NTP Address - 14.139.60.103
172# 2 NTP Address - 14.139.60.103 14.139.60.106
173@{NTP_SERVER_ADDRESSES} ${EMPTY}
174
manimozhik5beee8a2023-11-08 18:55:34 +0000175# Client related parameters
176${CLIENT_PASSWORD} ${EMPTY}
ganesanb3937eaa2023-04-15 10:24:38 +0000177
Nagarjun Be4f518d2023-07-24 20:40:32 +0530178# Task Service related variables.
179${TASK_JSON_FILE_PATH} data/task_state.json
180
181
Chris Austenb29d2e82016-06-07 12:25:35 -0500182*** Keywords ***
George Keishing283ae8a2023-12-06 10:20:23 +0530183
Chris Austenb29d2e82016-06-07 12:25:35 -0500184Get Inventory Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500185 [Documentation] Get inventory schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500186 [Arguments] ${machine}
George Keishing409df052024-01-17 22:36:14 +0530187 RETURN &{INVENTORY}[${machine}]
Chris Austenb29d2e82016-06-07 12:25:35 -0500188
189Get Inventory Items Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500190 [Documentation] Get inventory items schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500191 [Arguments] ${machine}
George Keishing409df052024-01-17 22:36:14 +0530192 RETURN &{INVENTORY_ITEMS}[${machine}]
Chris Austenb29d2e82016-06-07 12:25:35 -0500193
194Get Sensor Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500195 [Documentation] Get sensors schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500196 [Arguments] ${machine}
George Keishing409df052024-01-17 22:36:14 +0530197 RETURN &{SENSORS}[${machine}]