Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 1 | *** Settings *** |
| 2 | Library Collections |
| 3 | Library String |
George Keishing | fbd6700 | 2022-08-01 11:24:03 -0500 | [diff] [blame] | 4 | Library RequestsLibrary |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 5 | Library OperatingSystem |
| 6 | Variables ../data/variables.py |
| 7 | |
| 8 | *** Variables *** |
George Keishing | 633b9ce | 2018-05-31 01:24:52 -0500 | [diff] [blame] | 9 | |
George Keishing | 1e2fbee | 2021-03-19 11:19:29 -0500 | [diff] [blame] | 10 | # By default power, support x86 as well. |
| 11 | ${PLATFORM_ARCH_TYPE} power |
| 12 | |
George Keishing | 985659a | 2021-06-23 02:52:13 -0500 | [diff] [blame] | 13 | # FFDC Redfish OEM path /<oem>/v1/ |
| 14 | ${OEM_REDFISH_PATH} ${EMPTY} |
| 15 | |
George Keishing | ad92024 | 2023-12-14 17:14:33 +0530 | [diff] [blame] | 16 | ${REDFISH_SUPPORT_TRANS_STATE} ${1} |
George Keishing | d86e45c | 2021-03-19 07:38:14 -0500 | [diff] [blame] | 17 | |
| 18 | # By default Delete all Redfish session per boot run. |
| 19 | ${REDFISH_DELETE_SESSIONS} ${1} |
George Keishing | 6ceba1c | 2020-11-25 08:10:23 -0600 | [diff] [blame] | 20 | |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 21 | ${OPENBMC_MODEL} ${EMPTY} |
| 22 | ${OPENBMC_HOST} ${EMPTY} |
| 23 | ${DBUS_PREFIX} ${EMPTY} |
| 24 | ${PORT} ${EMPTY} |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 25 | |
George Keishing | fbeaecc | 2016-08-16 05:24:31 -0500 | [diff] [blame] | 26 | # AUTH_SUFFIX here is derived from variables.py |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 27 | ${AUTH_URI} https://${OPENBMC_HOST}${AUTH_SUFFIX} |
George Keishing | fbb9227 | 2023-11-20 11:42:32 +0530 | [diff] [blame] | 28 | ${OPENBMC_USERNAME} root |
| 29 | ${OPENBMC_PASSWORD} ${EMPTY} |
Anusha Dathatri | 18f69a6 | 2023-04-24 02:44:55 -0500 | [diff] [blame] | 30 | ${OPENBMC_ADMIN_USERNAME} admin |
George Keishing | 294c267 | 2023-11-16 14:30:23 +0530 | [diff] [blame] | 31 | ${OPENBMC_ADMIN_PASSWORD} ${EMPTY} |
Tony Lee | 05aa70b | 2021-01-28 19:18:27 +0800 | [diff] [blame] | 32 | |
George Keishing | de7e045 | 2022-02-01 07:04:41 -0600 | [diff] [blame] | 33 | # For users privilege admin or sudo. |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 34 | ${USER_TYPE} ${EMPTY} |
George Keishing | 2104d5f | 2022-01-31 04:33:30 -0600 | [diff] [blame] | 35 | |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 36 | ${MANAGER_ID} bmc |
| 37 | ${CHASSIS_ID} chassis |
Tony Lee | 2b97582 | 2021-04-01 11:15:00 +0800 | [diff] [blame] | 38 | |
Tony Lee | 05aa70b | 2021-01-28 19:18:27 +0800 | [diff] [blame] | 39 | # MTLS_ENABLED indicates whether mTLS is enabled. |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 40 | ${MTLS_ENABLED} False |
Tony Lee | 05aa70b | 2021-01-28 19:18:27 +0800 | [diff] [blame] | 41 | # Valid mTLS certificate for authentication. |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 42 | ${VALID_CERT} ${EMPTY} |
Tony Lee | 05aa70b | 2021-01-28 19:18:27 +0800 | [diff] [blame] | 43 | # Path of mTLS certificates directory. |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 44 | ${CERT_DIR_PATH} ${EMPTY} |
Tony Lee | 05aa70b | 2021-01-28 19:18:27 +0800 | [diff] [blame] | 45 | |
George Keishing | f00dde0 | 2023-11-28 08:40:11 +0530 | [diff] [blame] | 46 | ${IPMI_USERNAME} root |
| 47 | # Assign BMC password as default. User can input using -v option to key in |
| 48 | # IPMI password if different. |
| 49 | ${IPMI_PASSWORD} ${OPENBMC_PASSWORD} |
| 50 | |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 51 | ${OPENBMC_REBOOT_TIMEOUT} ${10} |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 52 | |
Rahul Maheshwari | ca2d687 | 2017-03-17 01:48:24 -0500 | [diff] [blame] | 53 | # IPMI_COMMAND here is set to "External" by default. User |
| 54 | # can override to "Dbus" from command line. |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 55 | ${IPMI_COMMAND} External |
| 56 | |
George Keishing | 39967eb | 2018-04-30 11:36:23 -0500 | [diff] [blame] | 57 | # IPMI chipher default. |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 58 | ${IPMI_CIPHER_LEVEL} ${17} |
| 59 | |
George Keishing | 75f55dc | 2021-03-29 10:48:09 -0500 | [diff] [blame] | 60 | # IPMI timeout default. |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 61 | ${IPMI_TIMEOUT} ${3} |
| 62 | ${GEN_ID_BYTE_1} ${20} |
| 63 | ${GEN_ID_BYTE_2} ${00} |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 64 | |
George Keishing | 2620672 | 2021-11-17 01:29:53 -0600 | [diff] [blame] | 65 | # Log default path for IPMI SOL. |
| 66 | ${IPMI_SOL_LOG_FILE} ${EXECDIR}${/}logs${/}sol_${OPENBMC_HOST} |
| 67 | |
chithrag | 0f0bd53 | 2022-04-05 09:49:53 +0000 | [diff] [blame] | 68 | # IPMI SOL console output types/parameters to verify. |
| 69 | ${SOL_BIOS_OUTPUT} ${EMPTY} |
| 70 | ${SOL_LOGIN_OUTPUT} ${EMPTY} |
| 71 | |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 72 | # PDU related parameters |
| 73 | ${PDU_TYPE} ${EMPTY} |
| 74 | ${PDU_IP} ${EMPTY} |
| 75 | ${PDU_USERNAME} ${EMPTY} |
| 76 | ${PDU_PASSWORD} ${EMPTY} |
| 77 | ${PDU_SLOT_NO} ${EMPTY} |
| 78 | |
George Keishing | 4d6c1da | 2016-07-15 05:51:22 -0500 | [diff] [blame] | 79 | # User define input SSH and HTTPS related parameters |
Michael Walsh | 73a86ac | 2019-11-08 14:24:09 -0600 | [diff] [blame] | 80 | ${SSH_PORT} 22 |
| 81 | ${HTTPS_PORT} 443 |
George Keishing | e33ad1d | 2019-12-09 11:17:36 -0600 | [diff] [blame] | 82 | ${IPMI_PORT} 623 |
George Keishing | 088166c | 2019-12-13 08:11:28 -0600 | [diff] [blame] | 83 | ${HOST_SOL_PORT} 2200 |
George Keishing | beec26d | 2016-11-09 06:57:28 -0600 | [diff] [blame] | 84 | ${OPENBMC_SERIAL_HOST} ${EMPTY} |
| 85 | ${OPENBMC_SERIAL_PORT} ${EMPTY} |
Jorge Cisneros | f196b24 | 2022-09-09 15:46:15 +0000 | [diff] [blame] | 86 | ${OPENBMC_CONSOLE_CLIENT} ${EMPTY} |
George Keishing | 4d6c1da | 2016-07-15 05:51:22 -0500 | [diff] [blame] | 87 | |
Michael Walsh | 49ab0f4 | 2016-07-20 11:44:33 -0500 | [diff] [blame] | 88 | # OS related parameters. |
| 89 | ${OS_HOST} ${EMPTY} |
| 90 | ${OS_USERNAME} ${EMPTY} |
| 91 | ${OS_PASSWORD} ${EMPTY} |
| 92 | ${OS_WAIT_TIMEOUT} ${15*60} |
| 93 | |
Prashanth Katti | 01293ef | 2017-02-16 08:20:20 -0600 | [diff] [blame] | 94 | # Networking related parameters |
Prashanth Katti | bcb7d61 | 2019-08-09 06:04:10 -0500 | [diff] [blame] | 95 | ${NETWORK_PORT} 80 |
| 96 | ${PACKET_TYPE} tcp |
| 97 | ${ICMP_PACKETS} icmp |
| 98 | ${NETWORK_RETRY_TIME} 6 |
| 99 | ${NETWORK_TIMEOUT} 18 |
| 100 | ${ICMP_TIMESTAMP_REQUEST} 13 |
| 101 | ${ICMP_ECHO_REQUEST} 8 |
Tony Lee | 7c5f4b2 | 2019-12-06 17:21:31 +0800 | [diff] [blame] | 102 | ${CHANNEL_NUMBER} 1 |
kothais | 01f95fc | 2023-11-01 14:12:51 +0000 | [diff] [blame] | 103 | ${SECONDARY_CHANNEL_NUMBER} 2 |
Prashanth Katti | 2f80bf1 | 2021-06-17 07:43:25 -0500 | [diff] [blame] | 104 | ${TCP_PACKETS} tcp |
Megha G N | 903ebe9 | 2023-09-07 00:47:07 -0500 | [diff] [blame] | 105 | ${TCP_CONNECTION} tcp-connect |
Prashanth Katti | 2f80bf1 | 2021-06-17 07:43:25 -0500 | [diff] [blame] | 106 | ${ICMP_NETMASK_REQUEST} 17 |
| 107 | ${REDFISH_INTERFACE} 443 |
Prashanth Katti | b18762b | 2021-06-21 07:55:52 -0500 | [diff] [blame] | 108 | ${SYN_PACKETS} SYN |
| 109 | ${RESET_PACKETS} RST |
| 110 | ${FIN_PACKETS} FIN |
| 111 | ${SYN_ACK_RESET} SAR |
| 112 | ${ALL_FLAGS} ALL |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 113 | |
Tony Lee | 374a538 | 2021-08-09 19:22:44 +0800 | [diff] [blame] | 114 | # Used to set BMC static IPv4 configuration. |
| 115 | ${STATIC_IP} 10.10.10.10 |
| 116 | ${NETMASK} 255.255.255.0 |
| 117 | ${GATEWAY} 10.10.10.10 |
Prashanth Katti | bcb7d61 | 2019-08-09 06:04:10 -0500 | [diff] [blame] | 118 | |
George Keishing | a126e21 | 2017-03-24 08:07:17 -0500 | [diff] [blame] | 119 | # BMC debug tarball parameter |
| 120 | ${DEBUG_TARBALL_PATH} ${EMPTY} |
| 121 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 122 | # Upload Image parameters |
Charles Paul Hofer | c1fa2bc | 2017-08-18 16:44:03 -0500 | [diff] [blame] | 123 | ${TFTP_SERVER} ${EMPTY} |
| 124 | ${PNOR_TFTP_FILE_NAME} ${EMPTY} |
| 125 | ${BMC_TFTP_FILE_NAME} ${EMPTY} |
| 126 | ${IMAGE_FILE_PATH} ${EMPTY} |
| 127 | ${ALTERNATE_IMAGE_FILE_PATH} ${EMPTY} |
| 128 | ${PNOR_IMAGE_FILE_PATH} ${EMPTY} |
| 129 | ${BMC_IMAGE_FILE_PATH} ${EMPTY} |
| 130 | ${BAD_IMAGES_DIR_PATH} ${EMPTY} |
Charles Paul Hofer | b7842a5 | 2017-09-22 10:11:33 -0500 | [diff] [blame] | 131 | ${SKIP_UPDATE_IF_ACTIVE} false |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 132 | |
Charles Paul Hofer | 862685c | 2017-09-19 17:09:19 -0500 | [diff] [blame] | 133 | # Parameters for doing N-1 and N+1 code updates. |
| 134 | ${N_MINUS_ONE_IMAGE_FILE_PATH} ${EMPTY} |
| 135 | ${N_PLUS_ONE_IMAGE_FILE_PATH} ${EMPTY} |
| 136 | |
Andrew Geissler | aad0530 | 2017-09-13 22:20:34 +0000 | [diff] [blame] | 137 | # The caller must set this to the string "true" in order to delete images. The |
| 138 | # code is picky. |
Charles Paul Hofer | 2c73164 | 2017-08-03 18:13:27 -0500 | [diff] [blame] | 139 | ${DELETE_OLD_PNOR_IMAGES} false |
Charles Paul Hofer | 51b54c0 | 2017-09-13 22:13:49 -0500 | [diff] [blame] | 140 | ${DELETE_OLD_GUARD_FILE} false |
Charles Paul Hofer | 2c73164 | 2017-08-03 18:13:27 -0500 | [diff] [blame] | 141 | |
George Keishing | 830211e | 2017-07-19 08:44:07 -0500 | [diff] [blame] | 142 | # Caller can specify a value for LAST_KNOWN_GOOD_VERSION to indicate that if |
| 143 | # the machine already has that version on it, the update should be skipped. |
| 144 | ${LAST_KNOWN_GOOD_VERSION} ${EMPTY} |
| 145 | |
George Keishing | 3e28ea3 | 2017-12-19 03:13:52 -0600 | [diff] [blame] | 146 | # By default field mode is disabled. |
| 147 | ${FIELD_MODE} ${False} |
| 148 | |
Sivas SRR | e4c1e85 | 2018-09-26 23:36:35 -0500 | [diff] [blame] | 149 | # LDAP related variables. |
| 150 | ${LDAP_BASE_DN} ${EMPTY} |
| 151 | ${LDAP_BIND_DN} ${EMPTY} |
| 152 | ${LDAP_SERVER_HOST} ${EMPTY} |
| 153 | ${LDAP_SECURE_MODE} ${EMPTY} |
| 154 | ${LDAP_BIND_DN_PASSWORD} ${EMPTY} |
| 155 | ${LDAP_SEARCH_SCOPE} ${EMPTY} |
| 156 | ${LDAP_TYPE} ${EMPTY} |
| 157 | ${LDAP_USER} ${EMPTY} |
| 158 | ${LDAP_USER_PASSWORD} ${EMPTY} |
Nagarjun B | 1b82161 | 2021-12-06 22:52:04 +0530 | [diff] [blame] | 159 | ${GROUP_PRIVILEGE} ${EMPTY} |
| 160 | ${GROUP_NAME} ${EMPTY} |
| 161 | ${LDAP_SERVER_URI} ldap://${LDAP_SERVER_HOST} |
Sivas SRR | e4c1e85 | 2018-09-26 23:36:35 -0500 | [diff] [blame] | 162 | |
Peter D Phan | 5e56f52 | 2021-12-20 13:19:41 -0600 | [diff] [blame] | 163 | # General tool variables |
| 164 | # FFDC_DEFAULT == 1; use Default FFDC methods |
| 165 | ${FFDC_DEFAULT} ${1} |
| 166 | |
ganesanb | 3937eaa | 2023-04-15 10:24:38 +0000 | [diff] [blame] | 167 | # NTP Server Address |
| 168 | # NTP Address needs to be given as an list. |
| 169 | # For example, |
| 170 | # 1 NTP Address - 14.139.60.103 |
| 171 | # 2 NTP Address - 14.139.60.103 14.139.60.106 |
| 172 | @{NTP_SERVER_ADDRESSES} ${EMPTY} |
| 173 | |
manimozhik | 5beee8a | 2023-11-08 18:55:34 +0000 | [diff] [blame] | 174 | # Client related parameters |
| 175 | ${CLIENT_PASSWORD} ${EMPTY} |
ganesanb | 3937eaa | 2023-04-15 10:24:38 +0000 | [diff] [blame] | 176 | |
Nagarjun B | e4f518d | 2023-07-24 20:40:32 +0530 | [diff] [blame] | 177 | # Task Service related variables. |
| 178 | ${TASK_JSON_FILE_PATH} data/task_state.json |
| 179 | |
| 180 | |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 181 | *** Keywords *** |
George Keishing | 283ae8a | 2023-12-06 10:20:23 +0530 | [diff] [blame] | 182 | |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 183 | Get Inventory Schema |
Joy Onyerikwu | f4a807b | 2018-06-20 08:43:54 -0500 | [diff] [blame] | 184 | [Documentation] Get inventory schema. |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 185 | [Arguments] ${machine} |
| 186 | [Return] &{INVENTORY}[${machine}] |
| 187 | |
| 188 | Get Inventory Items Schema |
Joy Onyerikwu | f4a807b | 2018-06-20 08:43:54 -0500 | [diff] [blame] | 189 | [Documentation] Get inventory items schema. |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 190 | [Arguments] ${machine} |
| 191 | [Return] &{INVENTORY_ITEMS}[${machine}] |
| 192 | |
| 193 | Get Sensor Schema |
Joy Onyerikwu | f4a807b | 2018-06-20 08:43:54 -0500 | [diff] [blame] | 194 | [Documentation] Get sensors schema. |
Chris Austen | b29d2e8 | 2016-06-07 12:25:35 -0500 | [diff] [blame] | 195 | [Arguments] ${machine} |
| 196 | [Return] &{SENSORS}[${machine}] |