Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
| 3 | r""" |
| 4 | See class prolog below for details. |
| 5 | """ |
| 6 | |
| 7 | import os |
| 8 | import sys |
| 9 | import yaml |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 10 | import json |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 11 | import time |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 12 | import logging |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 13 | import platform |
| 14 | from errno import EACCES, EPERM |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 15 | import subprocess |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 16 | from ssh_utility import SSHRemoteclient |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 17 | from telnet_utility import TelnetRemoteclient |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 18 | |
| 19 | |
| 20 | class FFDCCollector: |
| 21 | |
| 22 | r""" |
| 23 | Sends commands from configuration file to the targeted system to collect log files. |
| 24 | Fetch and store generated files at the specified location. |
| 25 | |
| 26 | """ |
| 27 | |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 28 | def __init__(self, |
| 29 | hostname, |
| 30 | username, |
| 31 | password, |
| 32 | ffdc_config, |
| 33 | location, |
| 34 | remote_type, |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 35 | remote_protocol, |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 36 | env_vars, |
George Keishing | 8e94f8c | 2021-07-23 15:06:32 -0500 | [diff] [blame^] | 37 | econfig, |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 38 | log_level): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 39 | r""" |
| 40 | Description of argument(s): |
| 41 | |
George Keishing | 8e94f8c | 2021-07-23 15:06:32 -0500 | [diff] [blame^] | 42 | hostname name/ip of the targeted (remote) system |
| 43 | username user on the targeted system with access to FFDC files |
| 44 | password password for user on targeted system |
| 45 | ffdc_config configuration file listing commands and files for FFDC |
| 46 | location where to store collected FFDC |
| 47 | remote_type os type of the remote host |
| 48 | remote_protocol Protocol to use to collect data |
| 49 | env_vars User define CLI env vars '{"key : "value"}' |
| 50 | econfig User define env vars YAML file |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 51 | |
| 52 | """ |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 53 | |
| 54 | self.hostname = hostname |
| 55 | self.username = username |
| 56 | self.password = password |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 57 | # This is for the env vars a user can use in YAML to load it at runtime. |
| 58 | # Example YAML: |
| 59 | # -COMMANDS: |
| 60 | # - my_command ${hostname} ${username} ${password} |
| 61 | os.environ['hostname'] = hostname |
| 62 | os.environ['username'] = username |
| 63 | os.environ['password'] = password |
| 64 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 65 | self.ffdc_config = ffdc_config |
| 66 | self.location = location + "/" + remote_type.upper() |
| 67 | self.ssh_remoteclient = None |
| 68 | self.telnet_remoteclient = None |
| 69 | self.ffdc_dir_path = "" |
| 70 | self.ffdc_prefix = "" |
| 71 | self.target_type = remote_type.upper() |
| 72 | self.remote_protocol = remote_protocol.upper() |
| 73 | self.start_time = 0 |
| 74 | self.elapsed_time = '' |
| 75 | self.logger = None |
| 76 | |
| 77 | # Set prefix values for scp files and directory. |
| 78 | # Since the time stamp is at second granularity, these values are set here |
| 79 | # to be sure that all files for this run will have same timestamps |
| 80 | # and they will be saved in the same directory. |
| 81 | # self.location == local system for now |
| 82 | self.set_ffdc_defaults() |
| 83 | |
| 84 | # Logger for this run. Need to be after set_ffdc_defaults() |
| 85 | self.script_logging(getattr(logging, log_level.upper())) |
| 86 | |
| 87 | # Verify top level directory exists for storage |
| 88 | self.validate_local_store(self.location) |
| 89 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 90 | if self.verify_script_env(): |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 91 | # Load default or user define YAML configuration file. |
| 92 | with open(self.ffdc_config, 'r') as file: |
| 93 | self.ffdc_actions = yaml.load(file, Loader=yaml.FullLoader) |
| 94 | |
| 95 | if self.target_type not in self.ffdc_actions.keys(): |
| 96 | self.logger.error( |
| 97 | "\n\tERROR: %s is not listed in %s.\n\n" % (self.target_type, self.ffdc_config)) |
| 98 | sys.exit(-1) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 99 | else: |
Peter D Phan | 8462faf | 2021-06-16 12:24:15 -0500 | [diff] [blame] | 100 | sys.exit(-1) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 101 | |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 102 | # Load ENV vars from user. |
George Keishing | aa1f848 | 2021-07-22 00:54:55 -0500 | [diff] [blame] | 103 | self.logger.info("\n\tENV: User define input YAML variables") |
| 104 | self.env_dict = {} |
| 105 | |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 106 | try: |
| 107 | if env_vars: |
George Keishing | aa1f848 | 2021-07-22 00:54:55 -0500 | [diff] [blame] | 108 | self.env_dict = json.loads(env_vars) |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 109 | |
| 110 | # Export ENV vars default. |
George Keishing | aa1f848 | 2021-07-22 00:54:55 -0500 | [diff] [blame] | 111 | for key, value in self.env_dict.items(): |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 112 | os.environ[key] = value |
George Keishing | aa1f848 | 2021-07-22 00:54:55 -0500 | [diff] [blame] | 113 | |
George Keishing | 8e94f8c | 2021-07-23 15:06:32 -0500 | [diff] [blame^] | 114 | if econfig: |
| 115 | with open(econfig, 'r') as file: |
| 116 | env_config_dict = yaml.load(file, Loader=yaml.FullLoader) |
| 117 | # Export ENV vars. |
| 118 | for key, value in env_config_dict['env_params'].items(): |
| 119 | os.environ[key] = str(value) |
| 120 | self.env_dict[key] = str(value) |
| 121 | |
George Keishing | 4885b2f | 2021-07-21 15:22:45 -0500 | [diff] [blame] | 122 | except json.decoder.JSONDecodeError as e: |
| 123 | self.logger.error("\n\tERROR: %s " % e) |
| 124 | sys.exit(-1) |
| 125 | |
George Keishing | aa1f848 | 2021-07-22 00:54:55 -0500 | [diff] [blame] | 126 | # Append default Env. |
| 127 | self.env_dict['hostname'] = self.hostname |
| 128 | self.env_dict['username'] = self.username |
| 129 | self.env_dict['password'] = self.password |
| 130 | self.logger.info(json.dumps(self.env_dict, indent=8, sort_keys=True)) |
| 131 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 132 | def verify_script_env(self): |
| 133 | |
| 134 | # Import to log version |
| 135 | import click |
| 136 | import paramiko |
| 137 | |
| 138 | run_env_ok = True |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 139 | |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 140 | redfishtool_version = self.run_redfishtool('-V').split(' ')[2].strip('\n') |
| 141 | ipmitool_version = self.run_ipmitool('-V').split(' ')[2] |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 142 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 143 | self.logger.info("\n\t---- Script host environment ----") |
| 144 | self.logger.info("\t{:<10} {:<10}".format('Script hostname', os.uname()[1])) |
| 145 | self.logger.info("\t{:<10} {:<10}".format('Script host os', platform.platform())) |
| 146 | self.logger.info("\t{:<10} {:>10}".format('Python', platform.python_version())) |
| 147 | self.logger.info("\t{:<10} {:>10}".format('PyYAML', yaml.__version__)) |
| 148 | self.logger.info("\t{:<10} {:>10}".format('click', click.__version__)) |
| 149 | self.logger.info("\t{:<10} {:>10}".format('paramiko', paramiko.__version__)) |
| 150 | self.logger.info("\t{:<10} {:>9}".format('redfishtool', redfishtool_version)) |
| 151 | self.logger.info("\t{:<10} {:>12}".format('ipmitool', ipmitool_version)) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 152 | |
Peter D Phan | 8462faf | 2021-06-16 12:24:15 -0500 | [diff] [blame] | 153 | if eval(yaml.__version__.replace('.', ',')) < (5, 4, 1): |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 154 | self.logger.error("\n\tERROR: Python or python packages do not meet minimum version requirement.") |
| 155 | self.logger.error("\tERROR: PyYAML version 5.4.1 or higher is needed.\n") |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 156 | run_env_ok = False |
| 157 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 158 | self.logger.info("\t---- End script host environment ----") |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 159 | return run_env_ok |
| 160 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 161 | def script_logging(self, |
| 162 | log_level_attr): |
| 163 | r""" |
| 164 | Create logger |
| 165 | |
| 166 | """ |
| 167 | self.logger = logging.getLogger() |
| 168 | self.logger.setLevel(log_level_attr) |
| 169 | log_file_handler = logging.FileHandler(self.ffdc_dir_path + "collector.log") |
| 170 | |
| 171 | stdout_handler = logging.StreamHandler(sys.stdout) |
| 172 | self.logger.addHandler(log_file_handler) |
| 173 | self.logger.addHandler(stdout_handler) |
| 174 | |
| 175 | # Turn off paramiko INFO logging |
| 176 | logging.getLogger("paramiko").setLevel(logging.WARNING) |
| 177 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 178 | def target_is_pingable(self): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 179 | r""" |
| 180 | Check if target system is ping-able. |
| 181 | |
| 182 | """ |
George Keishing | 0662e94 | 2021-07-13 05:12:20 -0500 | [diff] [blame] | 183 | response = os.system("ping -c 1 %s 2>&1 >/dev/null" % self.hostname) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 184 | if response == 0: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 185 | self.logger.info("\n\t[Check] %s is ping-able.\t\t [OK]" % self.hostname) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 186 | return True |
| 187 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 188 | self.logger.error( |
George Keishing | 7bf5509 | 2021-07-22 12:33:34 -0500 | [diff] [blame] | 189 | "\n\tERROR: %s is not ping-able. FFDC collection aborted.\n" % self.hostname) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 190 | sys.exit(-1) |
| 191 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 192 | def collect_ffdc(self): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 193 | r""" |
| 194 | Initiate FFDC Collection depending on requested protocol. |
| 195 | |
| 196 | """ |
| 197 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 198 | self.logger.info("\n\t---- Start communicating with %s ----" % self.hostname) |
Peter D Phan | 7610bc4 | 2021-07-06 06:31:05 -0500 | [diff] [blame] | 199 | self.start_time = time.time() |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 200 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 201 | # Find the list of target and protocol supported. |
| 202 | check_protocol_list = [] |
| 203 | config_dict = self.ffdc_actions |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 204 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 205 | for target_type in config_dict.keys(): |
| 206 | if self.target_type != target_type: |
| 207 | continue |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 208 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 209 | for k, v in config_dict[target_type].items(): |
| 210 | if config_dict[target_type][k]['PROTOCOL'][0] not in check_protocol_list: |
| 211 | check_protocol_list.append(config_dict[target_type][k]['PROTOCOL'][0]) |
Peter D Phan | bff617a | 2021-07-22 08:41:35 -0500 | [diff] [blame] | 212 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 213 | self.logger.info("\n\t %s protocol type: %s" % (self.target_type, check_protocol_list)) |
Peter D Phan | bff617a | 2021-07-22 08:41:35 -0500 | [diff] [blame] | 214 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 215 | verified_working_protocol = self.verify_protocol(check_protocol_list) |
Peter D Phan | bff617a | 2021-07-22 08:41:35 -0500 | [diff] [blame] | 216 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 217 | if verified_working_protocol: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 218 | self.logger.info("\n\t---- Completed protocol pre-requisite check ----\n") |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 219 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 220 | # Verify top level directory exists for storage |
| 221 | self.validate_local_store(self.location) |
| 222 | |
| 223 | if ((self.remote_protocol not in verified_working_protocol) and (self.remote_protocol != 'ALL')): |
| 224 | self.logger.info("\n\tWorking protocol list: %s" % verified_working_protocol) |
| 225 | self.logger.error( |
| 226 | '\tERROR: Requested protocol %s is not in working protocol list.\n' |
| 227 | % self.remote_protocol) |
| 228 | sys.exit(-1) |
| 229 | else: |
| 230 | self.generate_ffdc(verified_working_protocol) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 231 | |
| 232 | def ssh_to_target_system(self): |
| 233 | r""" |
| 234 | Open a ssh connection to targeted system. |
| 235 | |
| 236 | """ |
| 237 | |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 238 | self.ssh_remoteclient = SSHRemoteclient(self.hostname, |
| 239 | self.username, |
| 240 | self.password) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 241 | |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 242 | if self.ssh_remoteclient.ssh_remoteclient_login(): |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 243 | self.logger.info("\n\t[Check] %s SSH connection established.\t [OK]" % self.hostname) |
Peter D Phan | 733df63 | 2021-06-17 13:13:36 -0500 | [diff] [blame] | 244 | |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 245 | # Check scp connection. |
| 246 | # If scp connection fails, |
| 247 | # continue with FFDC generation but skip scp files to local host. |
| 248 | self.ssh_remoteclient.scp_connection() |
| 249 | return True |
| 250 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 251 | self.logger.info("\n\t[Check] %s SSH connection.\t [NOT AVAILABLE]" % self.hostname) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 252 | return False |
| 253 | |
| 254 | def telnet_to_target_system(self): |
| 255 | r""" |
| 256 | Open a telnet connection to targeted system. |
| 257 | """ |
| 258 | self.telnet_remoteclient = TelnetRemoteclient(self.hostname, |
| 259 | self.username, |
| 260 | self.password) |
| 261 | if self.telnet_remoteclient.tn_remoteclient_login(): |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 262 | self.logger.info("\n\t[Check] %s Telnet connection established.\t [OK]" % self.hostname) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 263 | return True |
| 264 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 265 | self.logger.info("\n\t[Check] %s Telnet connection.\t [NOT AVAILABLE]" % self.hostname) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 266 | return False |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 267 | |
George Keishing | 772c977 | 2021-06-16 23:23:42 -0500 | [diff] [blame] | 268 | def generate_ffdc(self, working_protocol_list): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 269 | r""" |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 270 | Determine actions based on remote host type |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 271 | |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 272 | Description of argument(s): |
| 273 | working_protocol_list list of confirmed working protocols to connect to remote host. |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 274 | """ |
| 275 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 276 | self.logger.info("\n\t---- Executing commands on " + self.hostname + " ----") |
| 277 | self.logger.info("\n\tWorking protocol list: %s" % working_protocol_list) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 278 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 279 | config_dict = self.ffdc_actions |
| 280 | for target_type in config_dict.keys(): |
| 281 | if self.target_type != target_type: |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 282 | continue |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 283 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 284 | self.logger.info("\n\tFFDC Path: %s " % self.ffdc_dir_path) |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 285 | self.logger.info("\tSystem Type: %s" % target_type) |
| 286 | for k, v in config_dict[target_type].items(): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 287 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 288 | if self.remote_protocol not in working_protocol_list \ |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 289 | and self.remote_protocol != 'ALL': |
| 290 | continue |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 291 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 292 | protocol = config_dict[target_type][k]['PROTOCOL'][0] |
| 293 | |
| 294 | if protocol not in working_protocol_list: |
| 295 | continue |
| 296 | |
| 297 | if protocol == 'SSH' or protocol == 'SCP': |
| 298 | if 'SSH' in working_protocol_list or 'SCP' in working_protocol_list: |
| 299 | self.protocol_ssh(target_type, k) |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 300 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 301 | self.logger.error("\n\tERROR: SSH or SCP is not available for %s." % self.hostname) |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 302 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 303 | if protocol == 'TELNET': |
| 304 | if protocol in working_protocol_list: |
| 305 | self.protocol_telnet(target_type, k) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 306 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 307 | self.logger.error("\n\tERROR: TELNET is not available for %s." % self.hostname) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 308 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 309 | if protocol == 'REDFISH': |
| 310 | if protocol in working_protocol_list: |
| 311 | self.protocol_redfish(target_type, k) |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 312 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 313 | self.logger.error("\n\tERROR: REDFISH is not available for %s." % self.hostname) |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 314 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 315 | if protocol == 'IPMI': |
| 316 | if protocol in working_protocol_list: |
| 317 | self.protocol_ipmi(target_type, k) |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 318 | else: |
Peter D Phan | d1fccd3 | 2021-07-21 06:45:54 -0500 | [diff] [blame] | 319 | self.logger.error("\n\tERROR: IPMI is not available for %s." % self.hostname) |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 320 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 321 | if protocol == 'SHELL': |
| 322 | if protocol in working_protocol_list: |
| 323 | self.protocol_shell_script(target_type, k) |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 324 | else: |
| 325 | self.logger.error("\n\tERROR: can't execute SHELL script") |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 326 | |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 327 | # Close network connection after collecting all files |
Peter D Phan | 7610bc4 | 2021-07-06 06:31:05 -0500 | [diff] [blame] | 328 | self.elapsed_time = time.strftime("%H:%M:%S", time.gmtime(time.time() - self.start_time)) |
Peter D Phan | bff617a | 2021-07-22 08:41:35 -0500 | [diff] [blame] | 329 | if self.ssh_remoteclient: |
| 330 | self.ssh_remoteclient.ssh_remoteclient_disconnect() |
| 331 | if self.telnet_remoteclient: |
| 332 | self.telnet_remoteclient.tn_remoteclient_disconnect() |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 333 | |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 334 | def protocol_ssh(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 335 | target_type, |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 336 | sub_type): |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 337 | r""" |
| 338 | Perform actions using SSH and SCP protocols. |
| 339 | |
| 340 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 341 | target_type OS Type of remote host. |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 342 | sub_type Group type of commands. |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 343 | """ |
| 344 | |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 345 | if sub_type == 'DUMP_LOGS': |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 346 | self.group_copy(self.ffdc_actions[target_type][sub_type]) |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 347 | else: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 348 | self.collect_and_copy_ffdc(self.ffdc_actions[target_type][sub_type]) |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 349 | |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 350 | def protocol_telnet(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 351 | target_type, |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 352 | sub_type): |
| 353 | r""" |
| 354 | Perform actions using telnet protocol. |
| 355 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 356 | target_type OS Type of remote host. |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 357 | """ |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 358 | self.logger.info("\n\t[Run] Executing commands on %s using %s" % (self.hostname, 'TELNET')) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 359 | telnet_files_saved = [] |
| 360 | progress_counter = 0 |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 361 | list_of_commands = self.ffdc_actions[target_type][sub_type]['COMMANDS'] |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 362 | for index, each_cmd in enumerate(list_of_commands, start=0): |
| 363 | command_txt, command_timeout = self.unpack_command(each_cmd) |
| 364 | result = self.telnet_remoteclient.execute_command(command_txt, command_timeout) |
| 365 | if result: |
| 366 | try: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 367 | targ_file = self.ffdc_actions[target_type][sub_type]['FILES'][index] |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 368 | except IndexError: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 369 | targ_file = command_txt |
| 370 | self.logger.warning( |
| 371 | "\n\t[WARN] Missing filename to store data from telnet %s." % each_cmd) |
| 372 | self.logger.warning("\t[WARN] Data will be stored in %s." % targ_file) |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 373 | targ_file_with_path = (self.ffdc_dir_path |
| 374 | + self.ffdc_prefix |
| 375 | + targ_file) |
| 376 | # Creates a new file |
| 377 | with open(targ_file_with_path, 'wb') as fp: |
| 378 | fp.write(result) |
| 379 | fp.close |
| 380 | telnet_files_saved.append(targ_file) |
| 381 | progress_counter += 1 |
| 382 | self.print_progress(progress_counter) |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 383 | self.logger.info("\n\t[Run] Commands execution completed.\t\t [OK]") |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 384 | for file in telnet_files_saved: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 385 | self.logger.info("\n\t\tSuccessfully save file " + file + ".") |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 386 | |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 387 | def protocol_redfish(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 388 | target_type, |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 389 | sub_type): |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 390 | r""" |
| 391 | Perform actions using Redfish protocol. |
| 392 | |
| 393 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 394 | target_type OS Type of remote host. |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 395 | sub_type Group type of commands. |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 396 | """ |
| 397 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 398 | self.logger.info("\n\t[Run] Executing commands to %s using %s" % (self.hostname, 'REDFISH')) |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 399 | redfish_files_saved = [] |
| 400 | progress_counter = 0 |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 401 | list_of_URL = self.ffdc_actions[target_type][sub_type]['URL'] |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 402 | for index, each_url in enumerate(list_of_URL, start=0): |
| 403 | redfish_parm = '-u ' + self.username + ' -p ' + self.password + ' -r ' \ |
| 404 | + self.hostname + ' -S Always raw GET ' + each_url |
| 405 | |
| 406 | result = self.run_redfishtool(redfish_parm) |
| 407 | if result: |
| 408 | try: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 409 | targ_file = self.get_file_list(self.ffdc_actions[target_type][sub_type])[index] |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 410 | except IndexError: |
| 411 | targ_file = each_url.split('/')[-1] |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 412 | self.logger.warning( |
| 413 | "\n\t[WARN] Missing filename to store data from redfish URL %s." % each_url) |
| 414 | self.logger.warning("\t[WARN] Data will be stored in %s." % targ_file) |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 415 | |
| 416 | targ_file_with_path = (self.ffdc_dir_path |
| 417 | + self.ffdc_prefix |
| 418 | + targ_file) |
| 419 | |
| 420 | # Creates a new file |
| 421 | with open(targ_file_with_path, 'w') as fp: |
| 422 | fp.write(result) |
| 423 | fp.close |
| 424 | redfish_files_saved.append(targ_file) |
| 425 | |
| 426 | progress_counter += 1 |
| 427 | self.print_progress(progress_counter) |
| 428 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 429 | self.logger.info("\n\t[Run] Commands execution completed.\t\t [OK]") |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 430 | |
| 431 | for file in redfish_files_saved: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 432 | self.logger.info("\n\t\tSuccessfully save file " + file + ".") |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 433 | |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 434 | def protocol_ipmi(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 435 | target_type, |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 436 | sub_type): |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 437 | r""" |
| 438 | Perform actions using ipmitool over LAN protocol. |
| 439 | |
| 440 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 441 | target_type OS Type of remote host. |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 442 | sub_type Group type of commands. |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 443 | """ |
| 444 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 445 | self.logger.info("\n\t[Run] Executing commands to %s using %s" % (self.hostname, 'IPMI')) |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 446 | ipmi_files_saved = [] |
| 447 | progress_counter = 0 |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 448 | list_of_cmd = self.get_command_list(self.ffdc_actions[target_type][sub_type]) |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 449 | for index, each_cmd in enumerate(list_of_cmd, start=0): |
| 450 | ipmi_parm = '-U ' + self.username + ' -P ' + self.password + ' -H ' \ |
Peter D Phan | d1fccd3 | 2021-07-21 06:45:54 -0500 | [diff] [blame] | 451 | + self.hostname + ' -I lanplus ' + each_cmd |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 452 | |
| 453 | result = self.run_ipmitool(ipmi_parm) |
| 454 | if result: |
| 455 | try: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 456 | targ_file = self.get_file_list(self.ffdc_actions[target_type][sub_type])[index] |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 457 | except IndexError: |
George Keishing | 6ea92b0 | 2021-07-01 11:20:50 -0500 | [diff] [blame] | 458 | targ_file = each_cmd.split('/')[-1] |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 459 | self.logger.warning("\n\t[WARN] Missing filename to store data from IPMI %s." % each_cmd) |
| 460 | self.logger.warning("\t[WARN] Data will be stored in %s." % targ_file) |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 461 | |
| 462 | targ_file_with_path = (self.ffdc_dir_path |
| 463 | + self.ffdc_prefix |
| 464 | + targ_file) |
| 465 | |
| 466 | # Creates a new file |
| 467 | with open(targ_file_with_path, 'w') as fp: |
| 468 | fp.write(result) |
| 469 | fp.close |
| 470 | ipmi_files_saved.append(targ_file) |
| 471 | |
| 472 | progress_counter += 1 |
| 473 | self.print_progress(progress_counter) |
| 474 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 475 | self.logger.info("\n\t[Run] Commands execution completed.\t\t [OK]") |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 476 | |
| 477 | for file in ipmi_files_saved: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 478 | self.logger.info("\n\t\tSuccessfully save file " + file + ".") |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 479 | |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 480 | def collect_and_copy_ffdc(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 481 | ffdc_actions_for_target_type, |
Peter D Phan | 2b8052d | 2021-06-22 10:55:41 -0500 | [diff] [blame] | 482 | form_filename=False): |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 483 | r""" |
| 484 | Send commands in ffdc_config file to targeted system. |
| 485 | |
| 486 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 487 | ffdc_actions_for_target_type commands and files for the selected remote host type. |
Peter D Phan | 2b8052d | 2021-06-22 10:55:41 -0500 | [diff] [blame] | 488 | form_filename if true, pre-pend self.target_type to filename |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 489 | """ |
| 490 | |
Peter D Phan | 2b6cb3a | 2021-07-19 06:55:42 -0500 | [diff] [blame] | 491 | # Executing commands, if any |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 492 | self.ssh_execute_ffdc_commands(ffdc_actions_for_target_type, |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 493 | form_filename) |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 494 | |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 495 | # Copying files |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 496 | if self.ssh_remoteclient.scpclient: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 497 | self.logger.info("\n\n\tCopying FFDC files from remote system %s.\n" % self.hostname) |
Peter D Phan | 2b8052d | 2021-06-22 10:55:41 -0500 | [diff] [blame] | 498 | |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 499 | # Retrieving files from target system |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 500 | list_of_files = self.get_file_list(ffdc_actions_for_target_type) |
Peter D Phan | 2b8052d | 2021-06-22 10:55:41 -0500 | [diff] [blame] | 501 | self.scp_ffdc(self.ffdc_dir_path, self.ffdc_prefix, form_filename, list_of_files) |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 502 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 503 | self.logger.info("\n\n\tSkip copying FFDC files from remote system %s.\n" % self.hostname) |
Peter D Phan | 04aca3b | 2021-06-21 10:37:18 -0500 | [diff] [blame] | 504 | |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 505 | def get_command_list(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 506 | ffdc_actions_for_target_type): |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 507 | r""" |
| 508 | Fetch list of commands from configuration file |
| 509 | |
| 510 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 511 | ffdc_actions_for_target_type commands and files for the selected remote host type. |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 512 | """ |
| 513 | try: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 514 | list_of_commands = ffdc_actions_for_target_type['COMMANDS'] |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 515 | except KeyError: |
| 516 | list_of_commands = [] |
| 517 | return list_of_commands |
| 518 | |
| 519 | def get_file_list(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 520 | ffdc_actions_for_target_type): |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 521 | r""" |
| 522 | Fetch list of commands from configuration file |
| 523 | |
| 524 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 525 | ffdc_actions_for_target_type commands and files for the selected remote host type. |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 526 | """ |
| 527 | try: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 528 | list_of_files = ffdc_actions_for_target_type['FILES'] |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 529 | except KeyError: |
| 530 | list_of_files = [] |
| 531 | return list_of_files |
| 532 | |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 533 | def unpack_command(self, |
| 534 | command): |
| 535 | r""" |
| 536 | Unpack command from config file |
| 537 | |
| 538 | Description of argument(s): |
| 539 | command Command from config file. |
| 540 | """ |
| 541 | if isinstance(command, dict): |
| 542 | command_txt = next(iter(command)) |
| 543 | command_timeout = next(iter(command.values())) |
| 544 | elif isinstance(command, str): |
| 545 | command_txt = command |
| 546 | # Default command timeout 60 seconds |
| 547 | command_timeout = 60 |
| 548 | |
| 549 | return command_txt, command_timeout |
| 550 | |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 551 | def ssh_execute_ffdc_commands(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 552 | ffdc_actions_for_target_type, |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 553 | form_filename=False): |
| 554 | r""" |
| 555 | Send commands in ffdc_config file to targeted system. |
| 556 | |
| 557 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 558 | ffdc_actions_for_target_type commands and files for the selected remote host type. |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 559 | form_filename if true, pre-pend self.target_type to filename |
| 560 | """ |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 561 | self.logger.info("\n\t[Run] Executing commands on %s using %s" |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 562 | % (self.hostname, ffdc_actions_for_target_type['PROTOCOL'][0])) |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 563 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 564 | list_of_commands = self.get_command_list(ffdc_actions_for_target_type) |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 565 | # If command list is empty, returns |
| 566 | if not list_of_commands: |
| 567 | return |
| 568 | |
| 569 | progress_counter = 0 |
| 570 | for command in list_of_commands: |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 571 | command_txt, command_timeout = self.unpack_command(command) |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 572 | |
| 573 | if form_filename: |
| 574 | command_txt = str(command_txt % self.target_type) |
| 575 | |
Peter D Phan | 2b6cb3a | 2021-07-19 06:55:42 -0500 | [diff] [blame] | 576 | cmd_exit_code, err, response = \ |
| 577 | self.ssh_remoteclient.execute_command(command_txt, command_timeout) |
| 578 | |
| 579 | if cmd_exit_code: |
| 580 | self.logger.warning( |
| 581 | "\n\t\t[WARN] %s exits with code %s." % (command_txt, str(cmd_exit_code))) |
| 582 | self.logger.warning("\t\t[WARN] %s " % err) |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 583 | |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 584 | progress_counter += 1 |
| 585 | self.print_progress(progress_counter) |
| 586 | |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 587 | self.logger.info("\n\t[Run] Commands execution completed.\t\t [OK]") |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 588 | |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 589 | def group_copy(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 590 | ffdc_actions_for_target_type): |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 591 | r""" |
| 592 | scp group of files (wild card) from remote host. |
| 593 | |
| 594 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 595 | fdc_actions_for_target_type commands and files for the selected remote host type. |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 596 | """ |
Peter D Phan | 3beb02e | 2021-07-06 13:25:17 -0500 | [diff] [blame] | 597 | |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 598 | if self.ssh_remoteclient.scpclient: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 599 | self.logger.info("\n\tCopying DUMP files from remote system %s.\n" % self.hostname) |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 600 | |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 601 | list_of_commands = self.get_command_list(ffdc_actions_for_target_type) |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 602 | # If command list is empty, returns |
| 603 | if not list_of_commands: |
| 604 | return |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 605 | |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 606 | for command in list_of_commands: |
| 607 | try: |
| 608 | filename = command.split(' ')[2] |
| 609 | except IndexError: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 610 | self.logger.info("\t\tInvalid command %s for DUMP_LOGS block." % command) |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 611 | continue |
| 612 | |
Peter D Phan | 2b6cb3a | 2021-07-19 06:55:42 -0500 | [diff] [blame] | 613 | cmd_exit_code, err, response = \ |
| 614 | self.ssh_remoteclient.execute_command(command) |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 615 | |
Peter D Phan | 2b6cb3a | 2021-07-19 06:55:42 -0500 | [diff] [blame] | 616 | # If file does not exist, code take no action. |
| 617 | # cmd_exit_code is ignored for this scenario. |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 618 | if response: |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 619 | scp_result = self.ssh_remoteclient.scp_file_from_remote(filename, self.ffdc_dir_path) |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 620 | if scp_result: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 621 | self.logger.info("\t\tSuccessfully copied from " + self.hostname + ':' + filename) |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 622 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 623 | self.logger.info("\t\tThere is no " + filename) |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 624 | |
| 625 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 626 | self.logger.info("\n\n\tSkip copying files from remote system %s.\n" % self.hostname) |
Peter D Phan | 56429a6 | 2021-06-23 08:38:29 -0500 | [diff] [blame] | 627 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 628 | def scp_ffdc(self, |
| 629 | targ_dir_path, |
Peter D Phan | 2b8052d | 2021-06-22 10:55:41 -0500 | [diff] [blame] | 630 | targ_file_prefix, |
| 631 | form_filename, |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 632 | file_list=None, |
| 633 | quiet=None): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 634 | r""" |
| 635 | SCP all files in file_dict to the indicated directory on the local system. |
| 636 | |
| 637 | Description of argument(s): |
| 638 | targ_dir_path The path of the directory to receive the files. |
| 639 | targ_file_prefix Prefix which will be pre-pended to each |
| 640 | target file's name. |
| 641 | file_dict A dictionary of files to scp from targeted system to this system |
| 642 | |
| 643 | """ |
| 644 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 645 | progress_counter = 0 |
| 646 | for filename in file_list: |
Peter D Phan | 2b8052d | 2021-06-22 10:55:41 -0500 | [diff] [blame] | 647 | if form_filename: |
| 648 | filename = str(filename % self.target_type) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 649 | source_file_path = filename |
| 650 | targ_file_path = targ_dir_path + targ_file_prefix + filename.split('/')[-1] |
| 651 | |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 652 | # If source file name contains wild card, copy filename as is. |
| 653 | if '*' in source_file_path: |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 654 | scp_result = self.ssh_remoteclient.scp_file_from_remote(source_file_path, self.ffdc_dir_path) |
Peter D Phan | babf296 | 2021-07-07 11:24:40 -0500 | [diff] [blame] | 655 | else: |
Peter D Phan | 5963d63 | 2021-07-12 09:58:55 -0500 | [diff] [blame] | 656 | scp_result = self.ssh_remoteclient.scp_file_from_remote(source_file_path, targ_file_path) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 657 | |
| 658 | if not quiet: |
| 659 | if scp_result: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 660 | self.logger.info( |
| 661 | "\t\tSuccessfully copied from " + self.hostname + ':' + source_file_path + ".\n") |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 662 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 663 | self.logger.info( |
| 664 | "\t\tFail to copy from " + self.hostname + ':' + source_file_path + ".\n") |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 665 | else: |
| 666 | progress_counter += 1 |
| 667 | self.print_progress(progress_counter) |
| 668 | |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 669 | def set_ffdc_defaults(self): |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 670 | r""" |
| 671 | Set a default value for self.ffdc_dir_path and self.ffdc_prefix. |
| 672 | Collected ffdc file will be stored in dir /self.location/hostname_timestr/. |
| 673 | Individual ffdc file will have timestr_filename. |
| 674 | |
| 675 | Description of class variables: |
| 676 | self.ffdc_dir_path The dir path where collected ffdc data files should be put. |
| 677 | |
| 678 | self.ffdc_prefix The prefix to be given to each ffdc file name. |
| 679 | |
| 680 | """ |
| 681 | |
| 682 | timestr = time.strftime("%Y%m%d-%H%M%S") |
| 683 | self.ffdc_dir_path = self.location + "/" + self.hostname + "_" + timestr + "/" |
| 684 | self.ffdc_prefix = timestr + "_" |
| 685 | self.validate_local_store(self.ffdc_dir_path) |
| 686 | |
| 687 | def validate_local_store(self, dir_path): |
| 688 | r""" |
| 689 | Ensure path exists to store FFDC files locally. |
| 690 | |
| 691 | Description of variable: |
| 692 | dir_path The dir path where collected ffdc data files will be stored. |
| 693 | |
| 694 | """ |
| 695 | |
| 696 | if not os.path.exists(dir_path): |
| 697 | try: |
George Keishing | 7b3a513 | 2021-07-13 09:24:02 -0500 | [diff] [blame] | 698 | os.makedirs(dir_path, 0o755) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 699 | except (IOError, OSError) as e: |
| 700 | # PermissionError |
| 701 | if e.errno == EPERM or e.errno == EACCES: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 702 | self.logger.error( |
George Keishing | 7bf5509 | 2021-07-22 12:33:34 -0500 | [diff] [blame] | 703 | '\tERROR: os.makedirs %s failed with PermissionError.\n' % dir_path) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 704 | else: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 705 | self.logger.error( |
George Keishing | 7bf5509 | 2021-07-22 12:33:34 -0500 | [diff] [blame] | 706 | '\tERROR: os.makedirs %s failed with %s.\n' % (dir_path, e.strerror)) |
Peter D Phan | 72ce6b8 | 2021-06-03 06:18:26 -0500 | [diff] [blame] | 707 | sys.exit(-1) |
| 708 | |
| 709 | def print_progress(self, progress): |
| 710 | r""" |
| 711 | Print activity progress + |
| 712 | |
| 713 | Description of variable: |
| 714 | progress Progress counter. |
| 715 | |
| 716 | """ |
| 717 | |
| 718 | sys.stdout.write("\r\t" + "+" * progress) |
| 719 | sys.stdout.flush() |
| 720 | time.sleep(.1) |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 721 | |
| 722 | def verify_redfish(self): |
| 723 | r""" |
| 724 | Verify remote host has redfish service active |
| 725 | |
| 726 | """ |
| 727 | redfish_parm = '-u ' + self.username + ' -p ' + self.password + ' -r ' \ |
| 728 | + self.hostname + ' -S Always raw GET /redfish/v1/' |
| 729 | return(self.run_redfishtool(redfish_parm, True)) |
| 730 | |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 731 | def verify_ipmi(self): |
| 732 | r""" |
| 733 | Verify remote host has IPMI LAN service active |
| 734 | |
| 735 | """ |
| 736 | ipmi_parm = '-U ' + self.username + ' -P ' + self.password + ' -H ' \ |
Peter D Phan | d1fccd3 | 2021-07-21 06:45:54 -0500 | [diff] [blame] | 737 | + self.hostname + ' power status -I lanplus' |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 738 | return(self.run_ipmitool(ipmi_parm, True)) |
| 739 | |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 740 | def run_redfishtool(self, |
| 741 | parms_string, |
| 742 | quiet=False): |
| 743 | r""" |
| 744 | Run CLI redfishtool |
| 745 | |
| 746 | Description of variable: |
| 747 | parms_string redfishtool subcommand and options. |
| 748 | quiet do not print redfishtool error message if True |
| 749 | """ |
| 750 | |
| 751 | result = subprocess.run(['redfishtool ' + parms_string], |
| 752 | stdout=subprocess.PIPE, |
| 753 | stderr=subprocess.PIPE, |
| 754 | shell=True, |
| 755 | universal_newlines=True) |
| 756 | |
| 757 | if result.stderr and not quiet: |
George Keishing | 7bf5509 | 2021-07-22 12:33:34 -0500 | [diff] [blame] | 758 | self.logger.error('\n\tERROR with redfishtool ' + parms_string) |
| 759 | self.logger.error('\n\t%s' % result.stderr.split('\n')) |
Peter D Phan | 0c66977 | 2021-06-24 13:52:42 -0500 | [diff] [blame] | 760 | |
| 761 | return result.stdout |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 762 | |
| 763 | def run_ipmitool(self, |
| 764 | parms_string, |
| 765 | quiet=False): |
| 766 | r""" |
| 767 | Run CLI IPMI tool. |
| 768 | |
| 769 | Description of variable: |
| 770 | parms_string ipmitool subcommand and options. |
| 771 | quiet do not print redfishtool error message if True |
| 772 | """ |
| 773 | |
| 774 | result = subprocess.run(['ipmitool -I lanplus -C 17 ' + parms_string], |
| 775 | stdout=subprocess.PIPE, |
| 776 | stderr=subprocess.PIPE, |
| 777 | shell=True, |
| 778 | universal_newlines=True) |
| 779 | |
| 780 | if result.stderr and not quiet: |
Peter D Phan | e86d9a5 | 2021-07-15 10:42:25 -0500 | [diff] [blame] | 781 | self.logger.error('\n\t\tERROR with ipmitool -I lanplus -C 17 ' + parms_string) |
| 782 | self.logger.error('\t\t' + result.stderr) |
George Keishing | eafba18 | 2021-06-29 13:44:58 -0500 | [diff] [blame] | 783 | |
| 784 | return result.stdout |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 785 | |
| 786 | def run_shell_script(self, |
| 787 | parms_string, |
| 788 | quiet=False): |
| 789 | r""" |
| 790 | Run CLI shell script tool. |
| 791 | |
| 792 | Description of variable: |
| 793 | parms_string script command options. |
| 794 | quiet do not print redfishtool error message if True |
| 795 | """ |
| 796 | |
| 797 | result = subprocess.run([parms_string], |
| 798 | stdout=subprocess.PIPE, |
| 799 | stderr=subprocess.PIPE, |
| 800 | shell=True, |
| 801 | universal_newlines=True) |
| 802 | |
| 803 | if result.stderr and not quiet: |
| 804 | self.logger.error('\n\t\tERROR executing %s' % parms_string) |
| 805 | self.logger.error('\t\t' + result.stderr) |
| 806 | |
| 807 | return result.stdout |
| 808 | |
| 809 | def protocol_shell_script(self, |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 810 | target_type, |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 811 | sub_type): |
| 812 | r""" |
| 813 | Perform SHELL script execution locally. |
| 814 | |
| 815 | Description of argument(s): |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 816 | target_type OS Type of remote host. |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 817 | sub_type Group type of commands. |
| 818 | """ |
| 819 | |
| 820 | self.logger.info("\n\t[Run] Executing commands to %s using %s" % (self.hostname, 'SHELL')) |
| 821 | shell_files_saved = [] |
| 822 | progress_counter = 0 |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 823 | list_of_cmd = self.get_command_list(self.ffdc_actions[target_type][sub_type]) |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 824 | for index, each_cmd in enumerate(list_of_cmd, start=0): |
| 825 | |
| 826 | result = self.run_shell_script(each_cmd) |
| 827 | if result: |
| 828 | try: |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 829 | targ_file = self.get_file_list(self.ffdc_actions[target_type][sub_type])[index] |
George Keishing | 04d2910 | 2021-07-16 02:05:57 -0500 | [diff] [blame] | 830 | except IndexError: |
| 831 | targ_file = each_cmd.split('/')[-1] |
| 832 | self.logger.warning("\n\t[WARN] Missing filename to store data %s." % each_cmd) |
| 833 | self.logger.warning("\t[WARN] Data will be stored in %s." % targ_file) |
| 834 | |
| 835 | targ_file_with_path = (self.ffdc_dir_path |
| 836 | + self.ffdc_prefix |
| 837 | + targ_file) |
| 838 | |
| 839 | # Creates a new file |
| 840 | with open(targ_file_with_path, 'w') as fp: |
| 841 | fp.write(result) |
| 842 | fp.close |
| 843 | shell_files_saved.append(targ_file) |
| 844 | |
| 845 | progress_counter += 1 |
| 846 | self.print_progress(progress_counter) |
| 847 | |
| 848 | self.logger.info("\n\t[Run] Commands execution completed.\t\t [OK]") |
| 849 | |
| 850 | for file in shell_files_saved: |
| 851 | self.logger.info("\n\t\tSuccessfully save file " + file + ".") |
George Keishing | f5a5750 | 2021-07-22 16:43:47 -0500 | [diff] [blame] | 852 | |
| 853 | def verify_protocol(self, protocol_list): |
| 854 | r""" |
| 855 | Perform protocol working check. |
| 856 | |
| 857 | Description of argument(s): |
| 858 | protocol_list List of protocol. |
| 859 | """ |
| 860 | |
| 861 | tmp_list = [] |
| 862 | if self.target_is_pingable(): |
| 863 | tmp_list.append("SHELL") |
| 864 | |
| 865 | for protocol in protocol_list: |
| 866 | if self.remote_protocol != 'ALL': |
| 867 | if self.remote_protocol != protocol: |
| 868 | continue |
| 869 | |
| 870 | # Only check SSH/SCP once for both protocols |
| 871 | if protocol == 'SSH' or protocol == 'SCP' and protocol not in tmp_list: |
| 872 | if self.ssh_to_target_system(): |
| 873 | tmp_list.append('SSH') |
| 874 | tmp_list.append('SCP') |
| 875 | |
| 876 | if protocol == 'TELNET': |
| 877 | if self.telnet_to_target_system(): |
| 878 | tmp_list.append(protocol) |
| 879 | |
| 880 | if protocol == 'REDFISH': |
| 881 | if self.verify_redfish(): |
| 882 | tmp_list.append(protocol) |
| 883 | self.logger.info("\n\t[Check] %s Redfish Service.\t\t [OK]" % self.hostname) |
| 884 | else: |
| 885 | self.logger.info("\n\t[Check] %s Redfish Service.\t\t [NOT AVAILABLE]" % self.hostname) |
| 886 | |
| 887 | if protocol == 'IPMI': |
| 888 | if self.verify_ipmi(): |
| 889 | tmp_list.append(protocol) |
| 890 | self.logger.info("\n\t[Check] %s IPMI LAN Service.\t\t [OK]" % self.hostname) |
| 891 | else: |
| 892 | self.logger.info("\n\t[Check] %s IPMI LAN Service.\t\t [NOT AVAILABLE]" % self.hostname) |
| 893 | |
| 894 | return tmp_list |