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  -c, --config TEXT     YAML Configuration file for log collection.  [default:
14                        <local path>/openbmc-test-automation/ffdc/ffdc_config.yaml]
15  -l, --location TEXT   Location to save logs  [default: /tmp]
16  -t, --type TEXT       OS type of the remote (targeting) host. OPENBMC, RHEL,
17                        UBUNTU, SLES, AIX
18  -rp, --protocol TEXT  Select protocol to communicate with remote host.
19                        [default: ALL]
20  -e, --env_vars TEXT   Environment variables e.g: {'var':value}
21  -ec, --econfig TEXT   Predefine environment variables, refer
22                        en_vars_template.yaml
23  --log_level TEXT      Log level (CRITICAL, ERROR, WARNING, INFO, DEBUG)
24                        [default: INFO]
25  -h, --help            Show this message and exit.
26```
27
28# Tools and packages dependencies
29
30```
31   Python          3.6.12 or latter
32   PyYAML           5.4.1
33   click            8.0.1
34   paramiko         2.7.2
35   redfishtool      1.1.1
36   ipmitool         1.8.18
37```
38