xref: /openbmc/pldm/tools/visualize-pdr/README.md (revision 03b01ca8)
1# Overview
2
3The `pldmtool` for `GetPDR` command lacks to display all PDRs at once. It fetches only
4one PDR at a time. With a lot of sensors/effecters & with a lot of Host FRU pdrs
5coming in due to concurrent maintenance of the system,where the fru's are added/
6removed at runtime, it's really necessary to have a full system view.
7
8`pldm_visualise_pdrs.py` is a python script that can be used to fetch the PDR's
9from the BMC and can parse them to display a full view of available PDR's on system
10at any given point in time.
11
12# Requirements
13- Python 3.6+
14- graphviz
15    - Graphviz is open source graph visualization software. Graph visualization is
16      a way of representing structural information as diagrams of abstract graphs
17      and networks.
18    - There are standard package availabe for graphviz for both rpm based as well
19      as the debian based sytems, it can be installed using :
20
21```bash
22   RPM Distro : sudo dnf install graphviz
23   Debian Distro : sudo apt install graphviz
24   Mac Distro : brew install graphviz
25```
26- The `requirements.txt` file should list all Python libraries that the tool depend
27on, and that can be installed using:
28
29```bash
30    sudo pip3 install -r requirements.txt
31              (or)
32    pip3 install -r requirements.txt --user
33```
34# Usage
35
36```ascii
37usage: pldm_visualise_pdrs.py [-h] --bmc BMC --user USER --password PASSWORD [--port PORT]
38
39optional arguments:
40  -h, --help           show this help message and exit
41  --bmc BMC            BMC IPAddress/BMC Hostname
42  --user USER          BMC username
43  --password PASSWORD  BMC Password
44  --port PORT          BMC SSH port
45
46```
47