Replace OPENBMC with BMC in the code
Changes:
- OPENBMC is a generic term used, whereas
the correct term to use is BMC. Updating
in all code and documentation.
Tested:
- Ran with the changes from the sandbox
Change-Id: Ide2d26f94a7f824005776e53105f199ac56fd980
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/ffdc/README.md b/ffdc/README.md
index 8484d51..6dc7c2e 100755
--- a/ffdc/README.md
+++ b/ffdc/README.md
@@ -16,7 +16,7 @@
-c, --config TEXT YAML Configuration file for log collection. [default:
<local path>/openbmc-test-automation/ffdc/ffdc_config.yaml]
-l, --location TEXT Location to save logs [default: /tmp]
- -t, --type TEXT OS type of the remote (targeting) host. OPENBMC, RHEL,
+ -t, --type TEXT OS type of the remote (targeting) host. BMC, RHEL,
UBUNTU, SLES, AIX
-rp, --protocol TEXT Select protocol to communicate with remote host.
[default: ALL]
diff --git a/ffdc/collect_ffdc.py b/ffdc/collect_ffdc.py
index 523373a..caf2b4d 100644
--- a/ffdc/collect_ffdc.py
+++ b/ffdc/collect_ffdc.py
@@ -53,7 +53,7 @@
"-t",
"--type",
help=(
- "OS type of the remote (targeting) host. OPENBMC, RHEL, UBUNTU,"
+ "OS type of the remote (targeting) host. BMC, RHEL, UBUNTU,"
" SLES, AIX"
),
)
diff --git a/ffdc/docs/yaml_syntax_rules.md b/ffdc/docs/yaml_syntax_rules.md
index 415048d..6fcecd7 100644
--- a/ffdc/docs/yaml_syntax_rules.md
+++ b/ffdc/docs/yaml_syntax_rules.md
@@ -39,8 +39,8 @@
Generic syntax usage:
```
-OPENBMC:
- OPENBMC_LOGS:
+BMC:
+ BMC_LOGS:
COMMANDS:
- 'peltool -l >/tmp/PEL_logs_list.json'
FILES:
@@ -78,7 +78,7 @@
Example of using plugin in YAML (Refer plugin documentation)
```
-OPENBMC:
+BMC:
REDFISH_LOGS:
COMMANDS
- plugin:
diff --git a/ffdc/ffdc_collector.py b/ffdc/ffdc_collector.py
index 0f89581..c1cb2a7 100644
--- a/ffdc/ffdc_collector.py
+++ b/ffdc/ffdc_collector.py
@@ -325,10 +325,10 @@
Setting logger with __name__ will add the trace
Example:
- INFO:ffdc_collector: System Type: OPENBMC
+ INFO:ffdc_collector: System Type: BMC
Currently, set to empty purposely to log as
- System Type: OPENBMC
+ System Type: BMC
Parameters:
log_level_attr (str): The log level for the logger
@@ -1183,7 +1183,7 @@
Returns:
str: IPMI LAN service executed output.
"""
- if self.target_type == "OPENBMC":
+ if self.target_type == "BMC":
ipmi_parm = (
"ipmitool -I lanplus -C 17 -U "
+ self.username
diff --git a/ffdc/ffdc_config.yaml b/ffdc/ffdc_config.yaml
index 7290a7f..6c3c6cc 100644
--- a/ffdc/ffdc_config.yaml
+++ b/ffdc/ffdc_config.yaml
@@ -11,47 +11,46 @@
# and is listed in FILES to be collected.
#
-# Commands and Files to collect for a given OpenBMC system.
-OPENBMC:
+# Commands and Files to collect for a given remote system.
+BMC:
# Commands and File to take snapshot of linux based system.
- # Filename is <OS>_general.txt, where <OS> is in [OPENBMC, RHEL, UBUNTU]
+ # Filename is <OS>_general.txt, where <OS> is in [BMC, RHEL, UBUNTU]
GENERAL:
COMMANDS:
- "rm -rf /tmp/*BMC_* /tmp/PEL_* /tmp/pldm* /tmp/PLDM* /tmp/GUARD*
/tmp/fan_* /tmp/DEVTREE /tmp/bmcweb_*"
- 'echo "++++++++++ cat /etc/os-release ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "cat /etc/os-release >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "cat /etc/os-release >> /tmp/BMC_general.txt"
- 'echo -e "\n++++++++++ cat /etc/timestamp ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "cat /etc/timestamp >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "cat /etc/timestamp >> /tmp/BMC_general.txt"
- 'echo -e "\n++++++++++ uname -a ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "uname -a >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "uname -a >> /tmp/BMC_general.txt"
- 'echo -e "\n++++++++++ cat /etc/timestamp ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "cat /etc/timestamp >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "cat /etc/timestamp >> /tmp/BMC_general.txt"
- 'echo -e "\n++++++++++ uptime;cat /proc/uptime ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "uptime >> /tmp/OPENBMC_general.txt"
- - "cat /proc/uptime >> /tmp/OPENBMC_general.txt"
- - 'echo -e "\n++++++++++ df -hT ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "df -hT >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "uptime >> /tmp/BMC_general.txt"
+ - "cat /proc/uptime >> /tmp/BMC_general.txt"
+ - 'echo -e "\n++++++++++ df -hT ++++++++++" >> /tmp/BMC_general.txt'
+ - "df -hT >> /tmp/BMC_general.txt"
- 'echo -e "\n++++++++++ date;/sbin/hwclock --show ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "date >> /tmp/OPENBMC_general.txt"
- - "/sbin/hwclock --show >> /tmp/OPENBMC_general.txt"
- - "/usr/bin/timedatectl >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "date >> /tmp/BMC_general.txt"
+ - "/sbin/hwclock --show >> /tmp/BMC_general.txt"
+ - "/usr/bin/timedatectl >> /tmp/BMC_general.txt"
- 'echo -e "\n++++++++++ /usr/bin/obmcutil state ++++++++++" >>
- /tmp/OPENBMC_general.txt'
- - "/usr/bin/obmcutil state >> /tmp/OPENBMC_general.txt"
+ /tmp/BMC_general.txt'
+ - "/usr/bin/obmcutil state >> /tmp/BMC_general.txt"
FILES:
- - "/tmp/OPENBMC_general.txt"
+ - "/tmp/BMC_general.txt"
PROTOCOL:
- "SSH"
- OPENBMC_LOGS:
+ BMC_LOGS:
COMMANDS:
- "cat /sys/class/watchdog/watchdog1/bootstatus
>/tmp/BMC_flash_side.txt"
@@ -129,7 +128,7 @@
PROTOCOL:
- "SCP"
- # URLs and Files for OPENBMC redfish
+ # URLs and Files for BMC redfish
# URLs and Files are one-to-one corresponding.
# File contains the data returned from 'redfishtool GET URL'
REDFISH_LOGS:
diff --git a/lib/ffdc_cli_robot_script.py b/lib/ffdc_cli_robot_script.py
index d31aa2d..638fd53 100644
--- a/lib/ffdc_cli_robot_script.py
+++ b/lib/ffdc_cli_robot_script.py
@@ -76,7 +76,7 @@
dict_of_parms = {}
# When method is invoked with no parm,
# use robot variables
- # OPENBMC_HOST, OPENBMC_USERNAME, OPENBMC_PASSWORD, OPENBMC (type)
+ # OPENBMC_HOST, OPENBMC_USERNAME, OPENBMC_PASSWORD, BMC (type)
dict_of_parms["OPENBMC_HOST"] = robotBuildIn().get_variable_value(
"${OPENBMC_HOST}", default=None
)
@@ -95,7 +95,7 @@
dict_of_parms["IPMI_PORT"] = robotBuildIn().get_variable_value(
"${IPMI_PORT}", default=623
)
- dict_of_parms["REMOTE_TYPE"] = "OPENBMC"
+ dict_of_parms["REMOTE_TYPE"] = "BMC"
run_ffdc_collector(dict_of_parms)
@@ -104,7 +104,7 @@
# When method is invoked with user defined dictionary,
# dictionary keys has the following format
# xx_HOST; xx_USERNAME, xx_PASSWORD, xx_TYPE
- # where xx is one of OPENBMC, OS, or os_type LINUX/UBUNTU/AIX
+ # where xx is one of BMC, OS, or os_type LINUX/UBUNTU/AIX
run_ffdc_collector(**kwargs)
@@ -218,7 +218,7 @@
# If original ffdc request is for BMC,
# attempt to also collect ffdc for HOST_OS if possible.
- if remote_type.upper() == "OPENBMC":
+ if remote_type.upper() == "BMC":
os_host = robotBuildIn().get_variable_value(
"${OS_HOST}", default=None
)