vpd-tool/include/vpd_tool.hpp

15  * The class provides API's to,
29      * For a given object path of a FRU, this API returns the following
38      * If FRU's "Present" property is false, this API returns an empty JSON.
39      * Note: The caller of this API should handle empty JSON.
46      * @brief API to populate FRU JSON.
48      * The API will create FRUs JSON, which will have property value pairs for
61      * @brief API to populate JSON for an interface.
63      * The API will create interface JSON, which will have property value pairs
80      * API to get any property of a FRU in JSON format. Given an object path,
81      * interface and property name, this API does a D-Bus read property on PIM
82      * to get the value of that property and returns it in JSON format. This API
83      * returns empty JSON in case of failure. The caller of the API must check
102      * Given a FRU path, and parsed System Config JSON, this API returns the
103      * "type" property for the FRU in JSON format. This API gets
109      * format, otherwise returns empty JSON. The caller of this API should
118      * Given a FRU's object path, this API checks if the FRU is present in the
128      * @brief An API to get backup-restore config JSON of the system.
130      * API gets this file by prasing system config JSON file and reading
136      * Note: The caller of this API should verify, is received JSON object is
150      * @brief API to update source and destination keyword's value.
152      * API fetches source and destination keyword's value,
155      * inventory object path, API sends the request to Inventory.Manager DBus
156      * service. Otherwise if its a hardware path, API sends the request to
166      * @brief API to print system VPD keyword's information.
168      * The API prints source and destination keyword's information in the table
176      * @brief API to update keyword's value.
178      * API iterates the given JSON object for all record-keyword pairs, if there
179      * is any mismatch between source and destination keyword's value, API calls
180      * the utils::writeKeyword API to update keyword's value.
182      * Note: writeKeyword API, internally updates primary, backup, redundant
195      * @brief API to handle more option for fix system VPD command.
204      * @brief API to get VPD value of keyword in BIOS Config Manager.
206      * For a given record and keyword, this API gets the associated BIOS
227      * API to read VPD keyword's value from the given input path.
249      * For a given object path of a FRU, this API dumps the following properties
263      * @brief API to fix system VPD keywords.
265      * The API to fix the system VPD keywords. Mainly used when there
279      * API to update VPD keyword's value to the given input path.
307      * This API resets specific System VPD keywords to default value. The
326      * This API dumps specific properties of all the inventory objects to
347      * API clears the inventory persisted data and restarts the phosphor