blob: fbbb1f253dcbdc05011e63ea8090fa034d98e3da [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills262d7d42021-01-20 16:28:41 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/Manager.v1_11_0.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/Manager",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Gunnar Millsa778c022020-05-12 12:20:36 -05005 "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -05009 "description": "The available actions for this resource.",
10 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
26 "#Manager.ForceFailover": {
27 "$ref": "#/definitions/ForceFailover"
28 },
29 "#Manager.ModifyRedundancySet": {
30 "$ref": "#/definitions/ModifyRedundancySet"
31 },
32 "#Manager.Reset": {
33 "$ref": "#/definitions/Reset"
34 },
Gunnar Millsa778c022020-05-12 12:20:36 -050035 "#Manager.ResetToDefaults": {
36 "$ref": "#/definitions/ResetToDefaults"
37 },
Ed Tanous118b1c72018-09-13 13:45:51 -070038 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -080039 "$ref": "#/definitions/OemActions",
Gunnar Millsa778c022020-05-12 12:20:36 -050040 "description": "The available OEM-specific actions for this resource.",
41 "longDescription": "This property shall contain the available OEM-specific actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070042 }
43 },
44 "type": "object"
45 },
46 "CommandConnectTypesSupported": {
47 "enum": [
48 "SSH",
49 "Telnet",
50 "IPMI",
51 "Oem"
52 ],
53 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -070054 "IPMI": "The controller supports a command shell connection through the IPMI Serial Over LAN (SOL) protocol.",
55 "Oem": "The controller supports a command shell connection through an OEM-specific protocol.",
56 "SSH": "The controller supports a command shell connection through the SSH protocol.",
57 "Telnet": "The controller supports a command shell connection through the Telnet protocol."
Ed Tanous118b1c72018-09-13 13:45:51 -070058 },
59 "type": "string"
60 },
61 "CommandShell": {
62 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -070063 "description": "The information about a command shell service that this manager provides.",
64 "longDescription": "This type shall describe a command shell service for a manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -070065 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070066 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070067 "description": "This property shall specify a valid odata or Redfish property.",
68 "type": [
69 "array",
70 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080071 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070072 "number",
73 "null",
74 "object",
75 "string"
76 ]
77 }
78 },
79 "properties": {
80 "ConnectTypesSupported": {
Ed Tanouscb103132019-10-08 11:34:22 -070081 "description": "This property enumerates the command shell connection types that the implementation allows.",
Ed Tanous118b1c72018-09-13 13:45:51 -070082 "items": {
83 "$ref": "#/definitions/CommandConnectTypesSupported"
84 },
Ed Tanouscb103132019-10-08 11:34:22 -070085 "longDescription": "This property shall contain an array of the enumerations. SSH shall be included if the Secure Shell (SSH) protocol is supported. Telnet shall be included if the Telnet protocol is supported. IPMI shall be included if the IPMI Serial Over LAN (SOL) protocol is supported.",
Ed Tanous118b1c72018-09-13 13:45:51 -070086 "readonly": true,
87 "type": "array"
88 },
89 "MaxConcurrentSessions": {
Ed Tanouscb103132019-10-08 11:34:22 -070090 "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.",
91 "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -070092 "minimum": 0,
93 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -080094 "type": "integer"
Ed Tanous118b1c72018-09-13 13:45:51 -070095 },
96 "ServiceEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -070097 "description": "An indication of whether the service is enabled for this manager.",
98 "longDescription": "This property shall indicate whether the protocol for the service is enabled.",
Ed Tanous118b1c72018-09-13 13:45:51 -070099 "readonly": false,
100 "type": "boolean"
101 }
102 },
103 "type": "object"
104 },
105 "ForceFailover": {
106 "additionalProperties": false,
107 "description": "The ForceFailover action forces a failover of this manager to the manager used in the parameter.",
108 "longDescription": "This action shall perform a forced failover of the manager's redundancy to the manager supplied as a parameter.",
109 "parameters": {
110 "NewManager": {
111 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager",
Ed Tanouscb103132019-10-08 11:34:22 -0700112 "description": "The manager to which to fail over.",
113 "longDescription": "This parameter shall contain the manager to which to fail over.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700114 "requiredParameter": true
115 }
116 },
117 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700118 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700119 "description": "This property shall specify a valid odata or Redfish property.",
120 "type": [
121 "array",
122 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800123 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700124 "number",
125 "null",
126 "object",
127 "string"
128 ]
129 }
130 },
131 "properties": {
132 "target": {
133 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -0700134 "format": "uri-reference",
Ed Tanous118b1c72018-09-13 13:45:51 -0700135 "type": "string"
136 },
137 "title": {
138 "description": "Friendly action name",
139 "type": "string"
140 }
141 },
142 "type": "object"
143 },
144 "GraphicalConnectTypesSupported": {
145 "enum": [
146 "KVMIP",
147 "Oem"
148 ],
149 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700150 "KVMIP": "The controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol.",
151 "Oem": "The controller supports a graphical console connection through an OEM-specific protocol."
Ed Tanous118b1c72018-09-13 13:45:51 -0700152 },
153 "type": "string"
154 },
155 "GraphicalConsole": {
156 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700157 "description": "The information about a graphical console service that this manager provides.",
158 "longDescription": "This type shall describe a graphical console service for a manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700159 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700160 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700161 "description": "This property shall specify a valid odata or Redfish property.",
162 "type": [
163 "array",
164 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800165 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700166 "number",
167 "null",
168 "object",
169 "string"
170 ]
171 }
172 },
173 "properties": {
174 "ConnectTypesSupported": {
Ed Tanouscb103132019-10-08 11:34:22 -0700175 "description": "This property enumerates the graphical console connection types that the implementation allows.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700176 "items": {
177 "$ref": "#/definitions/GraphicalConnectTypesSupported"
178 },
Ed Tanouscb103132019-10-08 11:34:22 -0700179 "longDescription": "This property shall contain an array of the enumerations. RDP shall be included if the Remote Desktop (RDP) protocol is supported. KVMIP shall be included if a vendor-define KVM-IP protocol is supported.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700180 "readonly": true,
181 "type": "array"
182 },
183 "MaxConcurrentSessions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700184 "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.",
185 "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700186 "minimum": 0,
187 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -0800188 "type": "integer"
Ed Tanous118b1c72018-09-13 13:45:51 -0700189 },
190 "ServiceEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -0700191 "description": "An indication of whether the service is enabled for this manager.",
192 "longDescription": "This property shall indicate whether the protocol for the service is enabled.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700193 "readonly": false,
194 "type": "boolean"
195 }
196 },
197 "type": "object"
198 },
199 "Links": {
200 "additionalProperties": false,
Gunnar Millsa778c022020-05-12 12:20:36 -0500201 "description": "The links to other resources that are related to this resource.",
202 "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700203 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700204 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700205 "description": "This property shall specify a valid odata or Redfish property.",
206 "type": [
207 "array",
208 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800209 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700210 "number",
211 "null",
212 "object",
213 "string"
214 ]
215 }
216 },
217 "properties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700218 "ActiveSoftwareImage": {
219 "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory",
Gunnar Millsa778c022020-05-12 12:20:36 -0500220 "description": "The link to the software inventory resource that represents the active firmware image for this manager.",
221 "longDescription": "This property shall contain a link to a resource of type SoftwareInventory that represents the active firmware image for this manager.",
Ed Tanouscb103132019-10-08 11:34:22 -0700222 "readonly": false,
223 "versionAdded": "v1_6_0"
224 },
Gunnar Mills844b4152020-06-22 12:44:09 -0500225 "ManagedBy": {
226 "description": "The array of links to the managers responsible for managing this manager.",
227 "items": {
228 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
229 },
230 "longDescription": "This property shall contain an array of links to resources of type Manager that represent the managers for this manager.",
231 "readonly": true,
232 "type": "array",
233 "versionAdded": "v1_9_0"
234 },
235 "ManagedBy@odata.count": {
236 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
237 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700238 "ManagerForChassis": {
Ed Tanouscb103132019-10-08 11:34:22 -0700239 "description": "An array of links to the chassis this manager controls.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700240 "items": {
241 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
242 },
Ed Tanouscb103132019-10-08 11:34:22 -0700243 "longDescription": "This property shall contain an array of links to chassis over which this manager instance has control.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700244 "readonly": true,
245 "type": "array"
246 },
247 "ManagerForChassis@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700248 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700249 },
Gunnar Mills844b4152020-06-22 12:44:09 -0500250 "ManagerForManagers": {
251 "description": "An array of links to the managers that are managed by this manager.",
252 "items": {
253 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
254 },
255 "longDescription": "This property shall contain an array of links to resources of type Manager that represent the managers being managed by this manager.",
256 "readonly": true,
257 "type": "array",
258 "versionAdded": "v1_9_0"
259 },
260 "ManagerForManagers@odata.count": {
261 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
262 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700263 "ManagerForServers": {
Ed Tanouscb103132019-10-08 11:34:22 -0700264 "description": "An array of links to the systems that this manager controls.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700265 "items": {
266 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
267 },
Ed Tanouscb103132019-10-08 11:34:22 -0700268 "longDescription": "This property shall contain an array of links to computer systems over which this manager instance has control.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700269 "readonly": true,
270 "type": "array"
271 },
272 "ManagerForServers@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700273 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700274 },
275 "ManagerForSwitches": {
Ed Tanouscb103132019-10-08 11:34:22 -0700276 "description": "An array of links to the switches that this manager controls.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700277 "items": {
278 "$ref": "http://redfish.dmtf.org/schemas/v1/Switch.json#/definitions/Switch"
279 },
Ed Tanouscb103132019-10-08 11:34:22 -0700280 "longDescription": "This property shall contain an array of links to switches that this manager instance controls.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700281 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600282 "type": "array",
283 "versionAdded": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700284 },
285 "ManagerForSwitches@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700286 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700287 },
288 "ManagerInChassis": {
289 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis",
Ed Tanouscb103132019-10-08 11:34:22 -0700290 "description": "The link to the chassis where this manager is located.",
291 "longDescription": "This property shall contain a link to the chassis where this manager is located.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600292 "readonly": true,
293 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700294 },
295 "Oem": {
296 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700297 "description": "The OEM extension property.",
298 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
299 },
300 "SoftwareImages": {
301 "description": "The images that are associated with this manager.",
302 "items": {
303 "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory"
304 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500305 "longDescription": "This property shall contain an array of links to resource of type SoftwareInventory that represent the firmware images that apply to this manager.",
Ed Tanouscb103132019-10-08 11:34:22 -0700306 "readonly": true,
307 "type": "array",
308 "versionAdded": "v1_6_0"
309 },
310 "SoftwareImages@odata.count": {
311 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700312 }
313 },
314 "type": "object"
315 },
316 "Manager": {
317 "additionalProperties": false,
Gunnar Mills844b4152020-06-22 12:44:09 -0500318 "description": "In Redfish, a manager is a systems management entity that can implement or provide access to a Redfish service. Examples of managers are BMCs, enclosure managers, management controllers, and other subsystems that are assigned manageability functions. An implementation can have multiple managers, which might be directly accessible through a Redfish-defined interface.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500319 "longDescription": "This resource shall represent a management subsystem for a Redfish implementation.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700320 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700321 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700322 "description": "This property shall specify a valid odata or Redfish property.",
323 "type": [
324 "array",
325 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800326 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700327 "number",
328 "null",
329 "object",
330 "string"
331 ]
332 }
333 },
334 "properties": {
335 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -0700336 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous118b1c72018-09-13 13:45:51 -0700337 },
338 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700339 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700340 },
341 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700342 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700343 },
344 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700345 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700346 },
347 "Actions": {
348 "$ref": "#/definitions/Actions",
Gunnar Millsa778c022020-05-12 12:20:36 -0500349 "description": "The available actions for this resource.",
350 "longDescription": "The actions property shall contain the available actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700351 },
352 "AutoDSTEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -0700353 "description": "An indication of whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.",
354 "longDescription": "This property shall indicate whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700355 "readonly": false,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600356 "type": "boolean",
357 "versionAdded": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700358 },
359 "CommandShell": {
360 "$ref": "#/definitions/CommandShell",
Ed Tanouscb103132019-10-08 11:34:22 -0700361 "description": "The command shell service that this manager provides.",
362 "longDescription": "This property shall contain information about the command shell service of this manager."
Ed Tanous118b1c72018-09-13 13:45:51 -0700363 },
364 "DateTime": {
Ed Tanouscb103132019-10-08 11:34:22 -0700365 "description": "The current date and time with UTC offset that the manager uses to set or read time.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700366 "format": "date-time",
Ed Tanouscb103132019-10-08 11:34:22 -0700367 "longDescription": "This property shall represent the current DateTime value for the manager, with UTC offset, in Redfish Timestamp format.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700368 "readonly": false,
369 "type": [
370 "string",
371 "null"
372 ]
373 },
374 "DateTimeLocalOffset": {
Ed Tanouscb103132019-10-08 11:34:22 -0700375 "description": "The time offset from UTC that the DateTime property is in `+HH:MM` format.",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600376 "longDescription": "This property shall represent the offset from UTC time that the current DateTime property contains.",
Ed Tanouscb103132019-10-08 11:34:22 -0700377 "pattern": "^([-+][0-1][0-9]:[0-5][0-9])$",
Ed Tanous118b1c72018-09-13 13:45:51 -0700378 "readonly": false,
379 "type": [
380 "string",
381 "null"
382 ]
383 },
384 "Description": {
385 "anyOf": [
386 {
387 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
388 },
389 {
390 "type": "null"
391 }
392 ],
393 "readonly": true
394 },
395 "EthernetInterfaces": {
396 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700397 "description": "The link to a collection of NICs that this manager uses for network communication.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500398 "longDescription": "This property shall contain a link to a resource collection of type EthernetInterfaceCollection.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700399 "readonly": true
400 },
401 "FirmwareVersion": {
Ed Tanouscb103132019-10-08 11:34:22 -0700402 "description": "The firmware version of this manager.",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600403 "longDescription": "This property shall contain the firmware version as defined by the manufacturer for the associated manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700404 "readonly": true,
405 "type": [
406 "string",
407 "null"
408 ]
409 },
410 "GraphicalConsole": {
411 "$ref": "#/definitions/GraphicalConsole",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500412 "description": "The information about the graphical console service of this manager.",
413 "longDescription": "This property shall contain the information about the graphical console (KVM-IP) service of this manager. This property should be used to describe a service for the manager's console or operating system, not a service provided on behalf of a host operating system. Implementations representing host OS consoles, known generally as a KVM-IP feature, should use the GraphicalConsole property in ComputerSystem."
Ed Tanous118b1c72018-09-13 13:45:51 -0700414 },
415 "HostInterfaces": {
416 "$ref": "http://redfish.dmtf.org/schemas/v1/HostInterfaceCollection.json#/definitions/HostInterfaceCollection",
Gunnar Millsa778c022020-05-12 12:20:36 -0500417 "description": "The link to a collection of host interfaces that this manager uses for local host communication. Clients can find host interface configuration options and settings in this navigation property.",
418 "longDescription": "This property shall contain a link to a resource collection of type HostInterfaceCollection.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600419 "readonly": true,
420 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700421 },
422 "Id": {
423 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
424 "readonly": true
425 },
Gunnar Mills844b4152020-06-22 12:44:09 -0500426 "LastResetTime": {
427 "description": "The date and time when the manager was last reset or rebooted.",
428 "format": "date-time",
429 "longDescription": "This property shall contain the date and time when the manager last came out of a reset or was rebooted.",
430 "readonly": true,
431 "type": "string",
432 "versionAdded": "v1_9_0"
433 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700434 "Links": {
435 "$ref": "#/definitions/Links",
Gunnar Millsa778c022020-05-12 12:20:36 -0500436 "description": "The links to other resources that are related to this resource.",
Gunnar Mills844b4152020-06-22 12:44:09 -0500437 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700438 },
Gunnar Mills262d7d42021-01-20 16:28:41 -0600439 "Location": {
440 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",
441 "description": "The location of the manager.",
442 "longDescription": "This property shall contain location information of the associated manager.",
443 "versionAdded": "v1_11_0"
444 },
445 "LocationIndicatorActive": {
446 "description": "An indicator allowing an operator to physically locate this resource.",
447 "longDescription": "This property shall contain the state of the indicator used to physically identify or locate this resource. A write to this property shall update the value of IndicatorLED in this resource, if supported, to reflect the implementation of the locating function.",
448 "readonly": false,
449 "type": [
450 "boolean",
451 "null"
452 ],
453 "versionAdded": "v1_11_0"
454 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700455 "LogServices": {
456 "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700457 "description": "The link to a collection of logs that the manager uses.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500458 "longDescription": "This property shall contain a link to a resource collection of type LogServiceCollection that this manager uses.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700459 "readonly": true
460 },
461 "ManagerType": {
462 "$ref": "#/definitions/ManagerType",
Gunnar Millsa778c022020-05-12 12:20:36 -0500463 "description": "The type of manager that this resource represents.",
Ed Tanouscb103132019-10-08 11:34:22 -0700464 "longDescription": "This property shall describe the function of this manager. The `ManagementController` value shall be used if none of the other enumerations apply.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700465 "readonly": true
466 },
Gunnar Mills09b9d452020-02-11 13:27:39 -0600467 "Manufacturer": {
468 "description": "The manufacturer of this manager.",
469 "longDescription": "This property shall contain the name of the organization responsible for producing the manager. This organization might be the entity from whom the manager is purchased, but this is not necessarily true.",
470 "readonly": true,
471 "type": [
472 "string",
473 "null"
474 ],
475 "versionAdded": "v1_7_0"
476 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700477 "Model": {
Ed Tanouscb103132019-10-08 11:34:22 -0700478 "description": "The model information of this manager, as defined by the manufacturer.",
479 "longDescription": "This property shall contain the information about how the manufacturer refers to this manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700480 "readonly": true,
481 "type": [
482 "string",
483 "null"
484 ]
485 },
486 "Name": {
487 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
488 "readonly": true
489 },
490 "NetworkProtocol": {
491 "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.json#/definitions/ManagerNetworkProtocol",
Ed Tanouscb103132019-10-08 11:34:22 -0700492 "description": "The link to the network services and their settings that the manager controls.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500493 "longDescription": "This property shall contain a link to a resource of type ManagerNetworkProtocol, which represents the network services for this manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700494 "readonly": true
495 },
496 "Oem": {
497 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700498 "description": "The OEM extension property.",
499 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700500 },
Gunnar Mills09b9d452020-02-11 13:27:39 -0600501 "PartNumber": {
502 "description": "The part number of the manager.",
503 "longDescription": "This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the manager.",
504 "readonly": true,
505 "type": [
506 "string",
507 "null"
508 ],
509 "versionAdded": "v1_7_0"
510 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700511 "PowerState": {
512 "anyOf": [
513 {
514 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/PowerState"
515 },
516 {
517 "type": "null"
518 }
519 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700520 "description": "The current power state of the manager.",
521 "longDescription": "This property shall contain the power state of the manager.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600522 "readonly": true,
523 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700524 },
525 "Redundancy": {
Ed Tanous530520e2019-01-02 13:41:37 -0800526 "autoExpand": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700527 "description": "The redundancy information for the managers of this system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700528 "items": {
529 "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy"
530 },
Ed Tanouscb103132019-10-08 11:34:22 -0700531 "longDescription": "The properties in this array shall show how this manager is grouped with other managers for form redundancy sets.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700532 "type": "array"
533 },
534 "Redundancy@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700535 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous530520e2019-01-02 13:41:37 -0800536 },
537 "RemoteAccountService": {
538 "$ref": "http://redfish.dmtf.org/schemas/v1/AccountService.json#/definitions/AccountService",
Gunnar Millsa778c022020-05-12 12:20:36 -0500539 "description": "The link to the account service resource for the remote manager that this resource represents.",
540 "longDescription": "This property shall contain a link to the account service resource for the remote manager that this resource represents. This property shall only be present when providing aggregation of Redfish services.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600541 "readonly": true,
542 "versionAdded": "v1_5_0"
Ed Tanous530520e2019-01-02 13:41:37 -0800543 },
544 "RemoteRedfishServiceUri": {
Gunnar Millsa778c022020-05-12 12:20:36 -0500545 "description": "The URI of the Redfish service root for the remote manager that this resource represents.",
Ed Tanouscb103132019-10-08 11:34:22 -0700546 "format": "uri-reference",
Gunnar Millsa778c022020-05-12 12:20:36 -0500547 "longDescription": "This property shall contain the URI of the Redfish service root for the remote manager that this resource represents. This property shall only be present when providing aggregation of Redfish services.",
Ed Tanous530520e2019-01-02 13:41:37 -0800548 "readonly": true,
549 "type": [
550 "string",
551 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600552 ],
553 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700554 },
555 "SerialConsole": {
556 "$ref": "#/definitions/SerialConsole",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500557 "deprecated": "This property has been deprecated in favor of the SerialConsole property in the ComputerSystem resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700558 "description": "The serial console service that this manager provides.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500559 "longDescription": "This property shall contain information about the serial console service of this manager.",
560 "versionDeprecated": "v1_10_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700561 },
562 "SerialInterfaces": {
563 "$ref": "http://redfish.dmtf.org/schemas/v1/SerialInterfaceCollection.json#/definitions/SerialInterfaceCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700564 "description": "The link to a collection of serial interfaces that this manager uses for serial and console communication.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500565 "longDescription": "This property shall contain a link to a resource collection of type SerialInterfaceCollection, which this manager uses.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700566 "readonly": true
567 },
Gunnar Mills09b9d452020-02-11 13:27:39 -0600568 "SerialNumber": {
569 "description": "The serial number of the manager.",
570 "longDescription": "This property shall contain a manufacturer-allocated number that identifies the manager.",
571 "readonly": true,
572 "type": [
573 "string",
574 "null"
575 ],
576 "versionAdded": "v1_7_0"
577 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700578 "ServiceEntryPointUUID": {
579 "anyOf": [
580 {
581 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
582 },
583 {
584 "type": "null"
585 }
586 ],
Gunnar Millsa778c022020-05-12 12:20:36 -0500587 "description": "The UUID of the Redfish service that is hosted by this manager.",
Gunnar Mills844b4152020-06-22 12:44:09 -0500588 "longDescription": "This property shall contain the UUID of the Redfish service that is hosted by this manager. Each manager providing an entry point to the same Redfish service shall report the same UUID value, even though the name of the property might imply otherwise. This property shall not be present if this manager does not provide a Redfish service entry point.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700589 "readonly": true
590 },
Gunnar Mills262d7d42021-01-20 16:28:41 -0600591 "SparePartNumber": {
592 "description": "The spare part number of the manager.",
593 "longDescription": "This property shall contain the spare part number of the manager.",
594 "readonly": true,
595 "type": [
596 "string",
597 "null"
598 ],
599 "versionAdded": "v1_11_0"
600 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700601 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800602 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Gunnar Millsa778c022020-05-12 12:20:36 -0500603 "description": "The status and health of the resource and its subordinate or dependent resources.",
604 "longDescription": "This property shall contain any status or health properties of the resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700605 },
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500606 "TimeZoneName": {
607 "description": "The time zone of the manager.",
608 "longDescription": "This property shall contain the time zone of the manager. The time zone shall be either the 'Name' or the 'Format' for the zone as defined in the IANA Time Zone Database. The value of this property is used for display purposes, especially to enhance the display of time. A Redfish service might not be able to ensure accuracy and consistency between the DateTimeOffset property and this property. Therefore, to specify the correct time zone offset, see the DateTimeOffset property.",
609 "readonly": false,
610 "type": "string",
611 "versionAdded": "v1_10_0"
612 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700613 "UUID": {
614 "anyOf": [
615 {
616 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
617 },
618 {
619 "type": "null"
620 }
621 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700622 "description": "The UUID for this manager.",
623 "longDescription": "This property shall contain the UUID for the manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700624 "readonly": true
625 },
626 "VirtualMedia": {
627 "$ref": "http://redfish.dmtf.org/schemas/v1/VirtualMediaCollection.json#/definitions/VirtualMediaCollection",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500628 "deprecated": "This property has been deprecated in favor of the VirtualMedia property in the ComputerSystem resource.",
Ed Tanouscb103132019-10-08 11:34:22 -0700629 "description": "The link to the Virtual Media services for this particular manager.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500630 "longDescription": "This property shall contain a link to a resource collection of type VirtualMediaCollection, which this manager uses.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500631 "readonly": true,
632 "versionDeprecated": "v1_10_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700633 }
634 },
635 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800636 "@odata.id",
637 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700638 "Id",
639 "Name"
640 ],
641 "type": "object"
642 },
643 "ManagerService": {
644 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700645 "description": "The manager services, such as serial console, command shell, or graphical console service.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700646 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700647 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700648 "description": "This property shall specify a valid odata or Redfish property.",
649 "type": [
650 "array",
651 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800652 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700653 "number",
654 "null",
655 "object",
656 "string"
657 ]
658 }
659 },
660 "properties": {
661 "MaxConcurrentSessions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700662 "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.",
663 "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700664 "minimum": 0,
665 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -0800666 "type": "integer"
Ed Tanous118b1c72018-09-13 13:45:51 -0700667 },
668 "ServiceEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -0700669 "description": "An indication of whether the service is enabled for this manager.",
670 "longDescription": "This property shall indicate whether the protocol for the service is enabled.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700671 "readonly": false,
672 "type": "boolean"
673 }
674 },
675 "type": "object"
676 },
677 "ManagerType": {
678 "enum": [
679 "ManagementController",
680 "EnclosureManager",
681 "BMC",
682 "RackManager",
683 "AuxiliaryController",
684 "Service"
685 ],
686 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700687 "AuxiliaryController": "A controller that provides management functions for a particular subsystem or group of devices.",
688 "BMC": "A controller that provides management functions for a single computer system.",
689 "EnclosureManager": "A controller that provides management functions for a chassis or group of devices or systems.",
690 "ManagementController": "A controller that primarily monitors or manages the operation of a device or system.",
691 "RackManager": "A controller that provides management functions for a whole or part of a rack.",
692 "Service": "A software-based service that provides management functions."
Ed Tanous118b1c72018-09-13 13:45:51 -0700693 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600694 "enumVersionAdded": {
695 "Service": "v1_4_0"
696 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700697 "type": "string"
698 },
699 "ModifyRedundancySet": {
700 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700701 "description": "The ModifyRedundancySet operation adds members to or removes members from a redundant group of managers.",
702 "longDescription": "The ModifyRedundancySet operation shall add members to or remove members from a redundant group of managers.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700703 "parameters": {
704 "Add": {
Ed Tanouscb103132019-10-08 11:34:22 -0700705 "description": "An array of managers to add to the redundancy set.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700706 "items": {
707 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
708 },
Ed Tanouscb103132019-10-08 11:34:22 -0700709 "longDescription": "This parameter shall contain an array of managers to add to the redundancy set.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700710 "type": "array"
711 },
712 "Remove": {
Ed Tanouscb103132019-10-08 11:34:22 -0700713 "description": "An array of managers to remove from the redundancy set.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700714 "items": {
715 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
716 },
Ed Tanouscb103132019-10-08 11:34:22 -0700717 "longDescription": "This parameter shall contain an array of managers to remove from the redundancy set.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700718 "type": "array"
719 }
720 },
721 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700722 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700723 "description": "This property shall specify a valid odata or Redfish property.",
724 "type": [
725 "array",
726 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800727 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700728 "number",
729 "null",
730 "object",
731 "string"
732 ]
733 }
734 },
735 "properties": {
736 "target": {
737 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -0700738 "format": "uri-reference",
Ed Tanous118b1c72018-09-13 13:45:51 -0700739 "type": "string"
740 },
741 "title": {
742 "description": "Friendly action name",
743 "type": "string"
744 }
745 },
746 "type": "object"
747 },
748 "OemActions": {
749 "additionalProperties": true,
Gunnar Millsa778c022020-05-12 12:20:36 -0500750 "description": "The available OEM-specific actions for this resource.",
751 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700752 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700753 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700754 "description": "This property shall specify a valid odata or Redfish property.",
755 "type": [
756 "array",
757 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800758 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700759 "number",
760 "null",
761 "object",
762 "string"
763 ]
764 }
765 },
766 "properties": {},
767 "type": "object"
768 },
769 "Reset": {
770 "additionalProperties": false,
771 "description": "The reset action resets/reboots the manager.",
Ed Tanouscb103132019-10-08 11:34:22 -0700772 "longDescription": "This action shall reset the manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700773 "parameters": {
774 "ResetType": {
775 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType",
Ed Tanouscb103132019-10-08 11:34:22 -0700776 "description": "The type of reset.",
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500777 "longDescription": "This parameter shall contain the type of reset. The service can accept a request without the parameter and perform an implementation specific default reset. Services should include the @Redfish.AllowableValues annotation for this parameter to ensure compatibility with clients, even when ActionInfo has been implemented."
Ed Tanous118b1c72018-09-13 13:45:51 -0700778 }
779 },
780 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700781 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700782 "description": "This property shall specify a valid odata or Redfish property.",
783 "type": [
784 "array",
785 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800786 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700787 "number",
788 "null",
789 "object",
790 "string"
791 ]
792 }
793 },
794 "properties": {
795 "target": {
796 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -0700797 "format": "uri-reference",
Ed Tanous118b1c72018-09-13 13:45:51 -0700798 "type": "string"
799 },
800 "title": {
801 "description": "Friendly action name",
802 "type": "string"
803 }
804 },
805 "type": "object"
806 },
Gunnar Millsa778c022020-05-12 12:20:36 -0500807 "ResetToDefaults": {
808 "additionalProperties": false,
Gunnar Mills844b4152020-06-22 12:44:09 -0500809 "description": "The reset action resets the manager settings to factory defaults. This might cause the manager to reset.",
810 "longDescription": "This action shall reset the manager settings. This action might impact other resources.",
Gunnar Millsa778c022020-05-12 12:20:36 -0500811 "parameters": {
812 "ResetType": {
813 "$ref": "#/definitions/ResetToDefaultsType",
814 "description": "The type of reset to defaults.",
815 "longDescription": "This parameter shall contain the type of reset to defaults.",
816 "requiredParameter": true
817 }
818 },
819 "patternProperties": {
820 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
821 "description": "This property shall specify a valid odata or Redfish property.",
822 "type": [
823 "array",
824 "boolean",
825 "integer",
826 "number",
827 "null",
828 "object",
829 "string"
830 ]
831 }
832 },
833 "properties": {
834 "target": {
835 "description": "Link to invoke action",
836 "format": "uri-reference",
837 "type": "string"
838 },
839 "title": {
840 "description": "Friendly action name",
841 "type": "string"
842 }
843 },
844 "type": "object",
845 "versionAdded": "v1_8_0"
846 },
847 "ResetToDefaultsType": {
848 "enum": [
849 "ResetAll",
850 "PreserveNetworkAndUsers",
851 "PreserveNetwork"
852 ],
853 "enumDescriptions": {
854 "PreserveNetwork": "Reset all settings except network settings to factory defaults.",
855 "PreserveNetworkAndUsers": "Reset all settings except network and local user names/passwords to factory defaults.",
856 "ResetAll": "Reset all settings to factory defaults."
857 },
858 "type": "string"
859 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700860 "SerialConnectTypesSupported": {
861 "enum": [
862 "SSH",
863 "Telnet",
864 "IPMI",
865 "Oem"
866 ],
867 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700868 "IPMI": "The controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol.",
869 "Oem": "The controller supports a serial console connection through an OEM-specific protocol.",
870 "SSH": "The controller supports a serial console connection through the SSH protocol.",
871 "Telnet": "The controller supports a serial console connection through the Telnet protocol."
Ed Tanous118b1c72018-09-13 13:45:51 -0700872 },
873 "type": "string"
874 },
875 "SerialConsole": {
876 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700877 "description": "The information about a serial console service that this manager provides.",
878 "longDescription": "This type shall describe a serial console service for a manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700879 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700880 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700881 "description": "This property shall specify a valid odata or Redfish property.",
882 "type": [
883 "array",
884 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800885 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700886 "number",
887 "null",
888 "object",
889 "string"
890 ]
891 }
892 },
893 "properties": {
894 "ConnectTypesSupported": {
Ed Tanouscb103132019-10-08 11:34:22 -0700895 "description": "This property enumerates the serial console connection types that the implementation allows.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700896 "items": {
897 "$ref": "#/definitions/SerialConnectTypesSupported"
898 },
Ed Tanouscb103132019-10-08 11:34:22 -0700899 "longDescription": "This property shall contain an array of the enumerations. SSH shall be included if the Secure Shell (SSH) protocol is supported. Telnet shall be included if the Telnet protocol is supported. IPMI shall be included if the IPMI Serial Over LAN (SOL) protocol is supported.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700900 "readonly": true,
901 "type": "array"
902 },
903 "MaxConcurrentSessions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700904 "description": "The maximum number of service sessions, regardless of protocol, that this manager can support.",
905 "longDescription": "This property shall contain the maximum number of concurrent service sessions that this implementation supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700906 "minimum": 0,
907 "readonly": true,
Ed Tanous530520e2019-01-02 13:41:37 -0800908 "type": "integer"
Ed Tanous118b1c72018-09-13 13:45:51 -0700909 },
910 "ServiceEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -0700911 "description": "An indication of whether the service is enabled for this manager.",
912 "longDescription": "This property shall indicate whether the protocol for the service is enabled.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700913 "readonly": false,
914 "type": "boolean"
915 }
916 },
917 "type": "object"
918 }
919 },
920 "owningEntity": "DMTF",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600921 "release": "2020.4",
922 "title": "#Manager.v1_11_0.Manager"
Ed Tanous118b1c72018-09-13 13:45:51 -0700923}