xref: /openbmc/phosphor-settingsd/README.txt (revision 62b55f35)
1*62b55f35SSergey SolominHow to use 'query' in the YAML file
2*62b55f35SSergey Solomin'query' contains information for settings_manager.py to search for
3*62b55f35SSergey Solominand match inventory objects:
4*62b55f35SSergey Solomin
5*62b55f35SSergey Solominquery:
6*62b55f35SSergey Solomin    name: type
7*62b55f35SSergey Solomin    keyregex: "dimm"
8*62b55f35SSergey Solomin    subtree: "/org/openbmc/inventory"
9*62b55f35SSergey Solomin    matchregex: "/(dimm\d*)$"
10*62b55f35SSergey Solomin
11*62b55f35SSergey SolominIn the example above setting_manager.py will explore all existing
12*62b55f35SSergey Solominobjects at /org/openbmc/inventory that relate to the 'dimm' main
13*62b55f35SSergey Solomincategory in the YAML file.
14*62b55f35SSergey SolominThe 'matchregex' will identify all objects with names that start with 'dimm',
15*62b55f35SSergey Solominfollowed by any number of digits. The name should be at the end of the path.
16*62b55f35SSergey Solominsettings_manager.py will create a corresponding object with the same name,
17*62b55f35SSergey Solominwhich is a group (dimm\d*).
18