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