19f9da122SGeorge Keishing# CLI options for log collector
29f9da122SGeorge Keishing
39f9da122SGeorge Keishing```
49f9da122SGeorge Keishing$ python3 collect_ffdc.py -h
59f9da122SGeorge KeishingUsage: collect_ffdc.py [OPTIONS]
69f9da122SGeorge Keishing
79f9da122SGeorge Keishing  Stand alone CLI to generate and collect FFDC from the selected target.
89f9da122SGeorge Keishing
99f9da122SGeorge KeishingOptions:
109f9da122SGeorge Keishing  -r, --remote TEXT     Hostname/IP of the remote host
119f9da122SGeorge Keishing  -u, --username TEXT   Username of the remote host.
129f9da122SGeorge Keishing  -p, --password TEXT   Password of the remote host.
139f9da122SGeorge Keishing  -c, --config TEXT     YAML Configuration file for log collection.  [default:
149f9da122SGeorge Keishing                        <local path>/openbmc-test-automation/ffdc/ffdc_config.yaml]
159f9da122SGeorge Keishing  -l, --location TEXT   Location to save logs  [default: /tmp]
169f9da122SGeorge Keishing  -t, --type TEXT       OS type of the remote (targeting) host. OPENBMC, RHEL,
179f9da122SGeorge Keishing                        UBUNTU, SLES, AIX
189f9da122SGeorge Keishing  -rp, --protocol TEXT  Select protocol to communicate with remote host.
199f9da122SGeorge Keishing                        [default: ALL]
209f9da122SGeorge Keishing  -e, --env_vars TEXT   Environment variables e.g: {'var':value}
21*b40200eeSGeorge Keishing  -ec, --econfig TEXT   Predefine environment variables, refer
22*b40200eeSGeorge Keishing                        en_vars_template.yaml
239f9da122SGeorge Keishing  --log_level TEXT      Log level (CRITICAL, ERROR, WARNING, INFO, DEBUG)
249f9da122SGeorge Keishing                        [default: INFO]
259f9da122SGeorge Keishing  -h, --help            Show this message and exit.
269f9da122SGeorge Keishing```
279f9da122SGeorge Keishing
289f9da122SGeorge Keishing# Tools and packages dependencies
299f9da122SGeorge Keishing
309f9da122SGeorge Keishing```
319f9da122SGeorge Keishing   Python          3.6.12 or latter
329f9da122SGeorge Keishing   PyYAML           5.4.1
339f9da122SGeorge Keishing   click            8.0.1
349f9da122SGeorge Keishing   paramiko         2.7.2
359f9da122SGeorge Keishing   redfishtool      1.1.1
369f9da122SGeorge Keishing   ipmitool         1.8.18
379f9da122SGeorge Keishing```
38