blob: ce27917649d376dbd8004de2d449f68447d5396e [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 Keishing6ceba1c2020-11-25 08:10:23 -060016# Transition REST vs Redfish ONLY temporary changes for stagging
17# automation infrastructure change and for continuity.
George Keishingd86e45c2021-03-19 07:38:14 -050018${REDFISH_SUPPORT_TRANS_STATE} ${0}
19
20# By default Delete all Redfish session per boot run.
21${REDFISH_DELETE_SESSIONS} ${1}
George Keishing6ceba1c2020-11-25 08:10:23 -060022
George Keishingf00dde02023-11-28 08:40:11 +053023${OPENBMC_MODEL} ${EMPTY}
24${OPENBMC_HOST} ${EMPTY}
25${DBUS_PREFIX} ${EMPTY}
26${PORT} ${EMPTY}
George Keishing283ae8a2023-12-06 10:20:23 +053027
George Keishingfbeaecc2016-08-16 05:24:31 -050028# AUTH_SUFFIX here is derived from variables.py
George Keishingf00dde02023-11-28 08:40:11 +053029${AUTH_URI} https://${OPENBMC_HOST}${AUTH_SUFFIX}
George Keishingfbb92272023-11-20 11:42:32 +053030${OPENBMC_USERNAME} root
31${OPENBMC_PASSWORD} ${EMPTY}
Anusha Dathatri18f69a62023-04-24 02:44:55 -050032${OPENBMC_ADMIN_USERNAME} admin
George Keishing294c2672023-11-16 14:30:23 +053033${OPENBMC_ADMIN_PASSWORD} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080034
George Keishingde7e0452022-02-01 07:04:41 -060035# For users privilege admin or sudo.
George Keishingf00dde02023-11-28 08:40:11 +053036${USER_TYPE} ${EMPTY}
George Keishing2104d5f2022-01-31 04:33:30 -060037
George Keishingf00dde02023-11-28 08:40:11 +053038${MANAGER_ID} bmc
39${CHASSIS_ID} chassis
Tony Lee2b975822021-04-01 11:15:00 +080040
Tony Lee05aa70b2021-01-28 19:18:27 +080041# MTLS_ENABLED indicates whether mTLS is enabled.
George Keishingf00dde02023-11-28 08:40:11 +053042${MTLS_ENABLED} False
Tony Lee05aa70b2021-01-28 19:18:27 +080043# Valid mTLS certificate for authentication.
George Keishingf00dde02023-11-28 08:40:11 +053044${VALID_CERT} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080045# Path of mTLS certificates directory.
George Keishingf00dde02023-11-28 08:40:11 +053046${CERT_DIR_PATH} ${EMPTY}
Tony Lee05aa70b2021-01-28 19:18:27 +080047
George Keishingf00dde02023-11-28 08:40:11 +053048${IPMI_USERNAME} root
49# Assign BMC password as default. User can input using -v option to key in
50# IPMI password if different.
51${IPMI_PASSWORD} ${OPENBMC_PASSWORD}
52
Chris Austenb29d2e82016-06-07 12:25:35 -050053${OPENBMC_REBOOT_TIMEOUT} ${10}
George Keishing283ae8a2023-12-06 10:20:23 +053054
Rahul Maheshwarica2d6872017-03-17 01:48:24 -050055# IPMI_COMMAND here is set to "External" by default. User
56# can override to "Dbus" from command line.
George Keishing283ae8a2023-12-06 10:20:23 +053057${IPMI_COMMAND} External
58
George Keishing39967eb2018-04-30 11:36:23 -050059# IPMI chipher default.
George Keishing283ae8a2023-12-06 10:20:23 +053060${IPMI_CIPHER_LEVEL} ${17}
61
George Keishing75f55dc2021-03-29 10:48:09 -050062# IPMI timeout default.
George Keishing283ae8a2023-12-06 10:20:23 +053063${IPMI_TIMEOUT} ${3}
64${GEN_ID_BYTE_1} ${20}
65${GEN_ID_BYTE_2} ${00}
Chris Austenb29d2e82016-06-07 12:25:35 -050066
George Keishing26206722021-11-17 01:29:53 -060067# Log default path for IPMI SOL.
68${IPMI_SOL_LOG_FILE} ${EXECDIR}${/}logs${/}sol_${OPENBMC_HOST}
69
chithrag0f0bd532022-04-05 09:49:53 +000070# IPMI SOL console output types/parameters to verify.
71${SOL_BIOS_OUTPUT} ${EMPTY}
72${SOL_LOGIN_OUTPUT} ${EMPTY}
73
Chris Austenb29d2e82016-06-07 12:25:35 -050074# PDU related parameters
75${PDU_TYPE} ${EMPTY}
76${PDU_IP} ${EMPTY}
77${PDU_USERNAME} ${EMPTY}
78${PDU_PASSWORD} ${EMPTY}
79${PDU_SLOT_NO} ${EMPTY}
80
George Keishing4d6c1da2016-07-15 05:51:22 -050081# User define input SSH and HTTPS related parameters
Michael Walsh73a86ac2019-11-08 14:24:09 -060082${SSH_PORT} 22
83${HTTPS_PORT} 443
George Keishinge33ad1d2019-12-09 11:17:36 -060084${IPMI_PORT} 623
George Keishing088166c2019-12-13 08:11:28 -060085${HOST_SOL_PORT} 2200
George Keishingbeec26d2016-11-09 06:57:28 -060086${OPENBMC_SERIAL_HOST} ${EMPTY}
87${OPENBMC_SERIAL_PORT} ${EMPTY}
Jorge Cisnerosf196b242022-09-09 15:46:15 +000088${OPENBMC_CONSOLE_CLIENT} ${EMPTY}
George Keishing4d6c1da2016-07-15 05:51:22 -050089
Michael Walsh49ab0f42016-07-20 11:44:33 -050090# OS related parameters.
91${OS_HOST} ${EMPTY}
92${OS_USERNAME} ${EMPTY}
93${OS_PASSWORD} ${EMPTY}
94${OS_WAIT_TIMEOUT} ${15*60}
95
Prashanth Katti01293ef2017-02-16 08:20:20 -060096# Networking related parameters
Prashanth Kattibcb7d612019-08-09 06:04:10 -050097${NETWORK_PORT} 80
98${PACKET_TYPE} tcp
99${ICMP_PACKETS} icmp
100${NETWORK_RETRY_TIME} 6
101${NETWORK_TIMEOUT} 18
102${ICMP_TIMESTAMP_REQUEST} 13
103${ICMP_ECHO_REQUEST} 8
Tony Lee7c5f4b22019-12-06 17:21:31 +0800104${CHANNEL_NUMBER} 1
kothais01f95fc2023-11-01 14:12:51 +0000105${SECONDARY_CHANNEL_NUMBER} 2
Prashanth Katti2f80bf12021-06-17 07:43:25 -0500106${TCP_PACKETS} tcp
Megha G N903ebe92023-09-07 00:47:07 -0500107${TCP_CONNECTION} tcp-connect
Prashanth Katti2f80bf12021-06-17 07:43:25 -0500108${ICMP_NETMASK_REQUEST} 17
109${REDFISH_INTERFACE} 443
Prashanth Kattib18762b2021-06-21 07:55:52 -0500110${SYN_PACKETS} SYN
111${RESET_PACKETS} RST
112${FIN_PACKETS} FIN
113${SYN_ACK_RESET} SAR
114${ALL_FLAGS} ALL
George Keishing283ae8a2023-12-06 10:20:23 +0530115
Tony Lee374a5382021-08-09 19:22:44 +0800116# Used to set BMC static IPv4 configuration.
117${STATIC_IP} 10.10.10.10
118${NETMASK} 255.255.255.0
119${GATEWAY} 10.10.10.10
Prashanth Kattibcb7d612019-08-09 06:04:10 -0500120
George Keishinga126e212017-03-24 08:07:17 -0500121# BMC debug tarball parameter
122${DEBUG_TARBALL_PATH} ${EMPTY}
123
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500124# Upload Image parameters
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500125${TFTP_SERVER} ${EMPTY}
126${PNOR_TFTP_FILE_NAME} ${EMPTY}
127${BMC_TFTP_FILE_NAME} ${EMPTY}
128${IMAGE_FILE_PATH} ${EMPTY}
129${ALTERNATE_IMAGE_FILE_PATH} ${EMPTY}
130${PNOR_IMAGE_FILE_PATH} ${EMPTY}
131${BMC_IMAGE_FILE_PATH} ${EMPTY}
132${BAD_IMAGES_DIR_PATH} ${EMPTY}
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500133${SKIP_UPDATE_IF_ACTIVE} false
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500134
Charles Paul Hofer862685c2017-09-19 17:09:19 -0500135# Parameters for doing N-1 and N+1 code updates.
136${N_MINUS_ONE_IMAGE_FILE_PATH} ${EMPTY}
137${N_PLUS_ONE_IMAGE_FILE_PATH} ${EMPTY}
138
Andrew Geissleraad05302017-09-13 22:20:34 +0000139# The caller must set this to the string "true" in order to delete images. The
140# code is picky.
Charles Paul Hofer2c731642017-08-03 18:13:27 -0500141${DELETE_OLD_PNOR_IMAGES} false
Charles Paul Hofer51b54c02017-09-13 22:13:49 -0500142${DELETE_OLD_GUARD_FILE} false
Charles Paul Hofer2c731642017-08-03 18:13:27 -0500143
George Keishing830211e2017-07-19 08:44:07 -0500144# Caller can specify a value for LAST_KNOWN_GOOD_VERSION to indicate that if
145# the machine already has that version on it, the update should be skipped.
146${LAST_KNOWN_GOOD_VERSION} ${EMPTY}
147
George Keishing3e28ea32017-12-19 03:13:52 -0600148# By default field mode is disabled.
149${FIELD_MODE} ${False}
150
Sivas SRRe4c1e852018-09-26 23:36:35 -0500151# LDAP related variables.
152${LDAP_BASE_DN} ${EMPTY}
153${LDAP_BIND_DN} ${EMPTY}
154${LDAP_SERVER_HOST} ${EMPTY}
155${LDAP_SECURE_MODE} ${EMPTY}
156${LDAP_BIND_DN_PASSWORD} ${EMPTY}
157${LDAP_SEARCH_SCOPE} ${EMPTY}
158${LDAP_TYPE} ${EMPTY}
159${LDAP_USER} ${EMPTY}
160${LDAP_USER_PASSWORD} ${EMPTY}
Nagarjun B1b821612021-12-06 22:52:04 +0530161${GROUP_PRIVILEGE} ${EMPTY}
162${GROUP_NAME} ${EMPTY}
163${LDAP_SERVER_URI} ldap://${LDAP_SERVER_HOST}
Sivas SRRe4c1e852018-09-26 23:36:35 -0500164
Peter D Phan5e56f522021-12-20 13:19:41 -0600165# General tool variables
166# FFDC_DEFAULT == 1; use Default FFDC methods
167${FFDC_DEFAULT} ${1}
168
ganesanb3937eaa2023-04-15 10:24:38 +0000169# NTP Server Address
170# NTP Address needs to be given as an list.
171# For example,
172# 1 NTP Address - 14.139.60.103
173# 2 NTP Address - 14.139.60.103 14.139.60.106
174@{NTP_SERVER_ADDRESSES} ${EMPTY}
175
manimozhik5beee8a2023-11-08 18:55:34 +0000176# Client related parameters
177${CLIENT_PASSWORD} ${EMPTY}
ganesanb3937eaa2023-04-15 10:24:38 +0000178
Nagarjun Be4f518d2023-07-24 20:40:32 +0530179# Task Service related variables.
180${TASK_JSON_FILE_PATH} data/task_state.json
181
182
Chris Austenb29d2e82016-06-07 12:25:35 -0500183*** Keywords ***
George Keishing283ae8a2023-12-06 10:20:23 +0530184
Chris Austenb29d2e82016-06-07 12:25:35 -0500185Get Inventory Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500186 [Documentation] Get inventory schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500187 [Arguments] ${machine}
188 [Return] &{INVENTORY}[${machine}]
189
190Get Inventory Items Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500191 [Documentation] Get inventory items schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500192 [Arguments] ${machine}
193 [Return] &{INVENTORY_ITEMS}[${machine}]
194
195Get Sensor Schema
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500196 [Documentation] Get sensors schema.
Chris Austenb29d2e82016-06-07 12:25:35 -0500197 [Arguments] ${machine}
198 [Return] &{SENSORS}[${machine}]