xref: /openbmc/phosphor-power/phosphor-power-sequencer/docs/config_file/config_file.md (revision d1312fca296a458b0bb7e7d44c650285ee01bec6)
1# config_file
2
3## Description
4
5The root (outer-most) object in the configuration file.
6
7## Properties
8
9| Name              | Required | Type                                              | Description                                                                                            |
10| :---------------- | :------: | :------------------------------------------------ | :----------------------------------------------------------------------------------------------------- |
11| comments          |    no    | array of strings                                  | One or more comment lines describing this file.                                                        |
12| chassis_templates |    no    | array of [chassis_templates](chassis_template.md) | One or more chassis templates. Templates are used to avoid duplicate data in multiple chassis systems. |
13| chassis           |   yes    | array of [chassis](chassis.md)                    | One or more chassis in the system.                                                                     |
14
15## Examples
16
17```json
18{
19  "comments": [ "Config file for a FooBar one-chassis system" ],
20  "chassis": [
21    {
22      "number": 1,
23      "inventory_path": "/xyz/openbmc_project/inventory/system/chassis",
24      "power_sequencers": [
25        ... details omitted ...
26      ]
27    }
28  ]
29}
30```
31
32```json
33{
34  "chassis_templates": [
35    {
36      "id": "standard_chassis_template",
37      "number": "${chassis_number}",
38      "inventory_path": "/xyz/openbmc_project/inventory/system/chassis${chassis_number}",
39      "power_sequencers": [
40        ... details omitted ...
41      ]
42    }
43  ],
44  "chassis": [
45    {
46      "comments": ["Chassis 1"],
47      "template_id": "standard_chassis_template",
48      "template_variable_values": {
49        "chassis_number": "1"
50      }
51    },
52    {
53      "comments": ["Chassis 2"],
54      "template_id": "standard_chassis_template",
55      "template_variable_values": {
56        "chassis_number": "2"
57      }
58    }
59  ]
60}
61```
62