1If your platform requires the entity container map, you can provide a json file
2of the format:
3
4```
5[
6  {
7     "id" : 1,
8     "containerEntityId" : 2,
9     "containerEntityInstance" : 3,
10     "isList" : false,
11     "isLinked" : false,
12     "entities" : [
13         {"id" : 1, "instance" : 2},
14         {"id" : 1, "instance" : 3},
15         {"id" : 1, "instance" : 4},
16         {"id" : 1, "instance" : 5}
17     ]
18  }
19]
20```
21
22as part of your `phosphor-ipmi-config`
23
24The above json is identical to the original YAML documented below:
25
26```
27# This record has:
28# Container Entity Id and Container Entity Instance = (0x13, 0x81)
29# Contained Entity Id and Contained Entity Instance = (0x0A, 0x1),
30# (0x0A, 0x3), (0x0A, 0x5), (0x0A, 0x7)
31# Entity Record id is the key
320x01:
33  # Container entity contains other entities
34  # Entity Id and entity Instance for the container entity
35  containerEntityId: 0x13
36  containerEntityInstance: 0x81
37  # A record can have contained entities as a four entry list or as upto
38  # two ranges of entity instances; this record has contained entities
39  # as a four entry list
40  isList: "true"
41  # Records can be linked if necessary to extend the number of contained
42  # entities within a container entity; this record is not linked
43  isLinked: "false"
44  entityId1: 0x0A
45  entityInstance1: 0x1
46  entityId2: 0x0A
47  entityInstance2: 0x3
48  entityId3: 0x0A
49  entityInstance3: 0x5
50  entityId4: 0x0A
51  entityInstance4: 0x7
52
53# The below two records have:
54# Container Entity Id and Container Entity Instance = (0x18, 0x2)
55# Contained Entity Id and Contained Entity Instance = (0x1D, 0x1),
56# (0x1D, 0x4), (0x1D, 0x6), (0x2B, 0x1), (0x2B, 0x3), (0x0F, 0x1),
57# (0x0F, 0x3), (0x10, 0x5)
580x02:
59  containerEntityId: 0x18
60  containerEntityInstance: 0x2
61  # This record  has contained entities as a four entry list
62  isList: "true"
63  # This record is linked with the below record; this record and the
64  # below record have the same container entity Id and container entity
65  # instance;
66  isLinked: "true"
67  entityId1: 0x1D
68  entityInstance1: 0x1
69  entityId2: 0x1D
70  entityInstance2: 0x4
71  entityId3: 0x1D
72  entityInstance3: 0x6
73  entityId4: 0x2B
74  entityInstance4: 0x1
75
760x03:
77  containerEntityId: 0x18
78  containerEntityInstance: 0x2
79  # This record  has contained entities as a four entry list
80  isList: "true"
81  # This record is linked with the above record; this record and the
82  # above record have the same container entity Id and container entity
83  # instance
84  isLinked: "true"
85  entityId1: 0x2B
86  entityInstance1: 0x3
87  entityId2: 0x0F
88  entityInstance2: 0x1
89  entityId3: 0x0F
90  entityInstance3: 0x3
91  entityId4: 0x10
92  entityInstance4: 0x5
93
94# This record has:
95# Container Entity Id and Container Entity Instance = (0x1E, 0x1)
96# Contained Entity Id and Contained Entity Instance = (0x20, 0x1),
97# (0x20, 0x2), (0x20, 0x3), (0x20, 0x7), (0x20, 0x8), (0x20, 0x9)
980x04:
99  containerEntityId: 0x1E
100  containerEntityInstance: 0x1
101  # This record has contained entities as two ranges of entity instances
102  isList: "false"
103  # This record is not linked
104  isLinked: "false"
105  entityId1: 0x20
106  entityInstance1: 0x1
107  entityId2: 0x20
108  entityInstance2: 0x3
109  entityId3: 0x20
110  entityInstance3: 0x7
111  entityId4: 0x20
112  entityInstance4: 0x9
113
114# The below two records have:
115# Container Entity Id and Container Entity Instance = (0x1E, 0x3)
116# Contained Entity Id and Contained Entity Instance = (0x20, 0x1),
117# (0x20, 0x2), (0x20, 0x3), (0x20, 0x6), (0x20, 0x7), (0x20, 0x8),
118# (0x20, 0xA), (0x20, 0xB), (0x20, 0xD), (0x20, 0xE), (0x20, 0xF)
1190x05:
120  containerEntityId: 0x1E
121  containerEntityInstance: 0x03
122  # This record has contained entities as two ranges of entity instances
123  isList: "false"
124  # This record is linked with the below record; this record and the
125  # below record have the same container entity Id and container entity
126  # instance;
127  isLinked: "true"
128  entityId1: 0x20
129  entityInstance1: 0x1
130  entityId2: 0x20
131  entityInstance2: 0x3
132  entityId3: 0x20
133  entityInstance3: 0x6
134  entityId4: 0x20
135  entityInstance4: 0x8
136
1370x06:
138  containerEntityId: 0x1E
139  containerEntityInstance: 0x03
140  # This record has contained entities as two ranges of entity instances
141  isList: "false"
142  # This record is linked with the above record; this record and the
143  # above record have the same container entity Id and container entity
144  # instance;
145  isLinked: "true"
146  entityId1: 0x20
147  entityInstance1: 0xA
148  entityId2: 0x20
149  entityInstance2: 0xB
150  entityId3: 0x20
151  entityInstance3: 0xD
152  entityId4: 0x20
153  entityInstance4: 0xF
154```
155