README.md
1# CLI options for log collector
2
3```
4$ python3 collect_ffdc.py -h
5Usage: collect_ffdc.py [OPTIONS]
6
7 Stand alone CLI to generate and collect FFDC from the selected target.
8
9Options:
10 -r, --remote TEXT Hostname/IP of the remote host
11 -u, --username TEXT Username of the remote host.
12 -p, --password TEXT Password of the remote host.
13 -port_ssh INTEGER SSH port value. [default: 22]
14 -port_https INTEGER HTTPS port value. [default: 443]
15 -port_ipmi INTEGER IPMI port value. [default: 623]
16 -c, --config TEXT YAML Configuration file for log collection. [default:
17 <local path>/openbmc-test-automation/ffdc/ffdc_config.yaml]
18 -l, --location TEXT Location to save logs [default: /tmp]
19 -t, --type TEXT OS type of the remote (targeting) host. OPENBMC, RHEL,
20 UBUNTU, SLES, AIX
21 -rp, --protocol TEXT Select protocol to communicate with remote host.
22 [default: ALL]
23 -e, --env_vars TEXT Environment variables e.g: {'var':value}
24 -ec, --econfig TEXT Predefine environment variables, refer
25 en_vars_template.yaml
26 --log_level TEXT Log level (CRITICAL, ERROR, WARNING, INFO, DEBUG)
27 [default: INFO]
28 -h, --help Show this message and exit.
29```
30
31# Tools and packages dependencies
32
33```
34 Python 3.6.12 or latter
35 PyYAML 5.4.1
36 click 8.0.1
37 paramiko 2.7.2
38 redfishtool 1.1.1
39 ipmitool 1.8.18
40```
41