xref: /openbmc/phosphor-power/phosphor-power-sequencer/docs/config_file/template_variable_values.md (revision d1312fca296a458b0bb7e7d44c650285ee01bec6)
1# template_variable_values
2
3## Description
4
5Template variable values for a specific chassis.
6
7In a multiple chassis system, two or more of the [chassis](chassis.md) may have
8the same hardware design.
9
10A [chassis template](chassis_template.md) can be used to avoid duplicate data.
11The chassis template defines the power sequencers, GPIOs, and voltage rails in a
12chassis. One or more property values in the template contain variables, such as
13`${chassis_number}`, to support chassis-specific values.
14
15Each chassis using a template must specify values for each template variable.
16For example, the value of `${chassis_number}` is "1" for the first chassis and
17"2" for the second chassis.
18
19All chassis variable values are specified as a string (surrounded by double
20quotes). If the property value where the variable occurs has a different data
21type, such as number, the string will be converted to the required type.
22
23## Properties
24
25| Name                                  | Required | Type   | Description                                             |
26| :------------------------------------ | :------: | :----- | :------------------------------------------------------ |
27| Variable 1 name (see [notes](#notes)) |   yes    | string | Value of the template variable with the specified name. |
28| Variable 2 name (see [notes](#notes)) |   yes    | string | Value of the template variable with the specified name. |
29| ...                                   |          |        |                                                         |
30| Variable N name (see [notes](#notes)) |   yes    | string | Value of the template variable with the specified name. |
31
32### Notes
33
34- The variable names are defined in the chassis template, such as
35  "chassis_number" and "sequencer_bus_number".
36- The variable name must be specified without the "$", "{", and "}" characters.
37
38## Example
39
40```json
41{
42  "chassis_number": "2",
43  "sequencer_bus_number": "13"
44}
45```
46