1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/Circuit.v1_8_0.json", 3 "$ref": "#/definitions/Circuit", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "description": "The available actions for this resource.", 10 "longDescription": "This type shall contain the available actions for this resource.", 11 "patternProperties": { 12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 13 "description": "This property shall specify a valid odata or Redfish property.", 14 "type": [ 15 "array", 16 "boolean", 17 "integer", 18 "number", 19 "null", 20 "object", 21 "string" 22 ] 23 } 24 }, 25 "properties": { 26 "#Circuit.BreakerControl": { 27 "$ref": "#/definitions/BreakerControl" 28 }, 29 "#Circuit.PowerControl": { 30 "$ref": "#/definitions/PowerControl" 31 }, 32 "#Circuit.ResetMetrics": { 33 "$ref": "#/definitions/ResetMetrics" 34 }, 35 "Oem": { 36 "$ref": "#/definitions/OemActions", 37 "description": "The available OEM-specific actions for this resource.", 38 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 39 } 40 }, 41 "type": "object" 42 }, 43 "BreakerControl": { 44 "additionalProperties": false, 45 "description": "This action attempts to reset the circuit breaker.", 46 "longDescription": "This action shall control the state of the circuit breaker or over-current protection device.", 47 "parameters": { 48 "PowerState": { 49 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerState", 50 "description": "The desired power state of the circuit if the breaker is reset successfully.", 51 "longDescription": "This parameter shall contain the desired power state of the circuit." 52 } 53 }, 54 "patternProperties": { 55 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 56 "description": "This property shall specify a valid odata or Redfish property.", 57 "type": [ 58 "array", 59 "boolean", 60 "integer", 61 "number", 62 "null", 63 "object", 64 "string" 65 ] 66 } 67 }, 68 "properties": { 69 "target": { 70 "description": "Link to invoke action", 71 "format": "uri-reference", 72 "type": "string" 73 }, 74 "title": { 75 "description": "Friendly action name", 76 "type": "string" 77 } 78 }, 79 "type": "object" 80 }, 81 "Circuit": { 82 "additionalProperties": false, 83 "description": "This `Circuit` schema contains the definition for an electrical circuit.", 84 "longDescription": "This resource shall be used to represent an electrical circuit for a Redfish implementation.", 85 "patternProperties": { 86 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 87 "description": "This property shall specify a valid odata or Redfish property.", 88 "type": [ 89 "array", 90 "boolean", 91 "integer", 92 "number", 93 "null", 94 "object", 95 "string" 96 ] 97 } 98 }, 99 "properties": { 100 "@odata.context": { 101 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 102 }, 103 "@odata.etag": { 104 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 105 }, 106 "@odata.id": { 107 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 108 }, 109 "@odata.type": { 110 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 111 }, 112 "Actions": { 113 "$ref": "#/definitions/Actions", 114 "description": "The available actions for this resource.", 115 "longDescription": "This property shall contain the available actions for this resource." 116 }, 117 "BreakerState": { 118 "anyOf": [ 119 { 120 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/BreakerStates" 121 }, 122 { 123 "type": "null" 124 } 125 ], 126 "description": "The state of the overcurrent protection device.", 127 "longDescription": "This property shall contain the state of the overcurrent protection device.", 128 "readonly": true 129 }, 130 "CircuitType": { 131 "anyOf": [ 132 { 133 "$ref": "#/definitions/CircuitType" 134 }, 135 { 136 "type": "null" 137 } 138 ], 139 "description": "The type of circuit.", 140 "longDescription": "This property shall contain the type of circuit.", 141 "readonly": true 142 }, 143 "ConfigurationLocked": { 144 "description": "Indicates whether the configuration is locked.", 145 "longDescription": "This property shall indicate whether modification requests to this resource are not permitted. If `true`, services shall reject modification requests to other properties in this resource.", 146 "readonly": false, 147 "type": "boolean", 148 "versionAdded": "v1_5_0" 149 }, 150 "CriticalCircuit": { 151 "description": "Designates if this is a critical circuit.", 152 "longDescription": "This property shall indicate whether the circuit is designated as a critical circuit, and therefore is excluded from autonomous logic that could affect the state of the circuit. The value shall be `true` if the circuit is deemed critical, and `false` if the circuit is not critical.", 153 "readonly": false, 154 "type": [ 155 "boolean", 156 "null" 157 ] 158 }, 159 "CurrentAmps": { 160 "anyOf": [ 161 { 162 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 163 }, 164 { 165 "type": "null" 166 } 167 ], 168 "description": "The current (A) for this single-phase circuit.", 169 "excerptCopy": "SensorCurrentExcerpt", 170 "longDescription": "This property shall contain the current, in ampere units, for this single-phase circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`. This property shall not appear in resource instances representing poly-phase circuits." 171 }, 172 "Description": { 173 "anyOf": [ 174 { 175 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 176 }, 177 { 178 "type": "null" 179 } 180 ], 181 "readonly": true 182 }, 183 "ElectricalConsumerNames": { 184 "description": "An array of names of downstream devices that are powered by this circuit.", 185 "items": { 186 "type": [ 187 "string", 188 "null" 189 ] 190 }, 191 "longDescription": "This property shall contain an array of user-assigned identifying strings that describe downstream devices that are powered by this circuit.", 192 "readonly": false, 193 "type": "array", 194 "versionAdded": "v1_4_0" 195 }, 196 "ElectricalContext": { 197 "anyOf": [ 198 { 199 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/ElectricalContext" 200 }, 201 { 202 "type": "null" 203 } 204 ], 205 "description": "The combination of current-carrying conductors.", 206 "longDescription": "This property shall contain the combination of current-carrying conductors that distribute power.", 207 "readonly": true 208 }, 209 "ElectricalSourceManagerURI": { 210 "description": "The URI of the management interface for the upstream electrical source connection for this circuit.", 211 "format": "uri-reference", 212 "longDescription": "This property shall contain a URI to the management application or device that provides monitoring or control of the upstream electrical source that provides power to this circuit. If a value has not been assigned by a user, the value of this property shall be an empty string.", 213 "readonly": false, 214 "type": "string", 215 "versionAdded": "v1_4_0" 216 }, 217 "ElectricalSourceName": { 218 "description": "The name of the upstream electrical source, such as a circuit or outlet, connected to this circuit.", 219 "longDescription": "This property shall contain a string that identifies the upstream electrical source, such as the name of a circuit or outlet, that provides power to this circuit. If a value has not been assigned by a user, the value of this property shall be an empty string.", 220 "readonly": false, 221 "type": "string", 222 "versionAdded": "v1_4_0" 223 }, 224 "EnergykWh": { 225 "anyOf": [ 226 { 227 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 228 }, 229 { 230 "type": "null" 231 } 232 ], 233 "description": "The energy (kWh) for this circuit.", 234 "excerptCopy": "SensorEnergykWhExcerpt", 235 "longDescription": "This property shall contain the total energy, in kilowatt-hour units, for this circuit that represents the `Total` `ElectricalContext` sensor when multiple energy sensors exist for this circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`." 236 }, 237 "FrequencyHz": { 238 "anyOf": [ 239 { 240 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 241 }, 242 { 243 "type": "null" 244 } 245 ], 246 "description": "The frequency (Hz) for this circuit.", 247 "excerptCopy": "SensorExcerpt", 248 "longDescription": "This property shall contain the frequency, in hertz units, for this circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Frequency`." 249 }, 250 "Id": { 251 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 252 "readonly": true 253 }, 254 "IndicatorLED": { 255 "anyOf": [ 256 { 257 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/IndicatorLED" 258 }, 259 { 260 "type": "null" 261 } 262 ], 263 "deprecated": "This property has been deprecated in favor of the `LocationIndicatorActive` property.", 264 "description": "The state of the indicator LED, which identifies the circuit.", 265 "longDescription": "This property shall contain the indicator light state for the indicator light associated with this circuit.", 266 "readonly": false, 267 "versionDeprecated": "v1_1_0" 268 }, 269 "Links": { 270 "$ref": "#/definitions/Links", 271 "description": "The links to other resources that are related to this resource.", 272 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 273 }, 274 "LocationIndicatorActive": { 275 "description": "An indicator allowing an operator to physically locate this resource.", 276 "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.", 277 "readonly": false, 278 "type": [ 279 "boolean", 280 "null" 281 ], 282 "versionAdded": "v1_1_0" 283 }, 284 "Name": { 285 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 286 "readonly": true 287 }, 288 "NominalFrequencyHz": { 289 "description": "The nominal frequency (Hz) for this circuit.", 290 "longDescription": "This property shall contain the nominal frequency for this circuit, in hertz units.", 291 "readonly": true, 292 "type": [ 293 "number", 294 "null" 295 ], 296 "versionAdded": "v1_8_0" 297 }, 298 "NominalVoltage": { 299 "anyOf": [ 300 { 301 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/NominalVoltageType" 302 }, 303 { 304 "type": "null" 305 } 306 ], 307 "description": "The nominal voltage for this circuit.", 308 "longDescription": "This property shall contain the nominal voltage for this circuit, in volt units.", 309 "readonly": true 310 }, 311 "Oem": { 312 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 313 "description": "The OEM extension property.", 314 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 315 }, 316 "PhaseWiringType": { 317 "anyOf": [ 318 { 319 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PhaseWiringType" 320 }, 321 { 322 "type": "null" 323 } 324 ], 325 "description": "The number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires).", 326 "longDescription": "This property shall contain the number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires).", 327 "readonly": true 328 }, 329 "PlugType": { 330 "anyOf": [ 331 { 332 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PlugType" 333 }, 334 { 335 "type": "null" 336 } 337 ], 338 "description": "The type of plug according to NEMA, IEC, or regional standards.", 339 "longDescription": "This property shall contain the type of physical plug used for this circuit, as defined by IEC, NEMA, or regional standards.", 340 "readonly": true 341 }, 342 "PolyPhaseCurrentAmps": { 343 "anyOf": [ 344 { 345 "$ref": "#/definitions/CurrentSensors" 346 }, 347 { 348 "type": "null" 349 } 350 ], 351 "description": "The current readings for this circuit.", 352 "longDescription": "This property shall contain the current sensors for this circuit. For single-phase circuits, this property shall contain a duplicate copy of the current sensor referenced in the `CurrentAmps` property, if present. For poly-phase circuits, this property should contain multiple current sensor readings used to fully describe the circuit." 353 }, 354 "PolyPhaseEnergykWh": { 355 "anyOf": [ 356 { 357 "$ref": "#/definitions/EnergySensors" 358 }, 359 { 360 "type": "null" 361 } 362 ], 363 "description": "The energy readings for this circuit.", 364 "longDescription": "This property shall contain the energy sensors for this circuit. For single-phase circuits, this property shall contain a duplicate copy of the energy sensor referenced in the `EnergykWh` property, if present. For poly-phase circuits, this property should contain multiple energy sensor readings used to fully describe the circuit." 365 }, 366 "PolyPhasePowerWatts": { 367 "anyOf": [ 368 { 369 "$ref": "#/definitions/PowerSensors" 370 }, 371 { 372 "type": "null" 373 } 374 ], 375 "description": "The power readings for this circuit.", 376 "longDescription": "This property shall contain the power sensors for this circuit. For single-phase circuits, this property shall contain a duplicate copy of the power sensor referenced in the `PowerWatts` property, if present. For poly-phase circuits, this property should contain multiple power sensor readings used to fully describe the circuit." 377 }, 378 "PolyPhaseVoltage": { 379 "anyOf": [ 380 { 381 "$ref": "#/definitions/VoltageSensors" 382 }, 383 { 384 "type": "null" 385 } 386 ], 387 "description": "The voltage readings for this circuit.", 388 "longDescription": "This property shall contain the voltage sensors for this circuit. For single-phase circuits, this property shall contain a duplicate copy of the voltage sensor referenced in the `Voltage` property, if present. For poly-phase circuits, this property should contain multiple voltage sensor readings used to fully describe the circuit." 389 }, 390 "PowerControlLocked": { 391 "description": "Indicates whether power control requests are locked.", 392 "longDescription": "This property shall indicate whether requests to the `PowerControl` action are locked. If `true`, services shall reject requests to the `PowerControl` action.", 393 "readonly": false, 394 "type": "boolean", 395 "versionAdded": "v1_5_0" 396 }, 397 "PowerCycleDelaySeconds": { 398 "description": "The number of seconds to delay power on after a `PowerControl` action to cycle power. Zero seconds indicates no delay.", 399 "longDescription": "This property shall contain the number of seconds to delay power on after a `PowerControl` action to cycle power. The value `0` shall indicate no delay to power on.", 400 "readonly": false, 401 "type": [ 402 "number", 403 "null" 404 ] 405 }, 406 "PowerEnabled": { 407 "description": "Indicates if the circuit can be powered.", 408 "longDescription": "This property shall indicate the power enable state of the circuit. The value `true` shall indicate that the circuit can be powered on, and `false` shall indicate that the circuit cannot be powered.", 409 "readonly": true, 410 "type": [ 411 "boolean", 412 "null" 413 ] 414 }, 415 "PowerLoadPercent": { 416 "anyOf": [ 417 { 418 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 419 }, 420 { 421 "type": "null" 422 } 423 ], 424 "description": "The power load (percent) for this circuit.", 425 "excerptCopy": "SensorExcerpt", 426 "longDescription": "This property shall contain the power load, in percent units, for this circuit that represents the `Total` `ElectricalContext` for this circuit.", 427 "versionAdded": "v1_3_0" 428 }, 429 "PowerOffDelaySeconds": { 430 "description": "The number of seconds to delay power off after a `PowerControl` action. Zero seconds indicates no delay to power off.", 431 "longDescription": "This property shall contain the number of seconds to delay power off after a `PowerControl` action. The value `0` shall indicate no delay to power off.", 432 "readonly": false, 433 "type": [ 434 "number", 435 "null" 436 ] 437 }, 438 "PowerOnDelaySeconds": { 439 "description": "The number of seconds to delay power up after a power cycle or a `PowerControl` action. Zero seconds indicates no delay to power up.", 440 "longDescription": "This property shall contain the number of seconds to delay power up after a power cycle or a `PowerControl` action. The value `0` shall indicate no delay to power up.", 441 "readonly": false, 442 "type": [ 443 "number", 444 "null" 445 ] 446 }, 447 "PowerRestoreDelaySeconds": { 448 "description": "The number of seconds to delay power on after power has been restored. Zero seconds indicates no delay.", 449 "longDescription": "This property shall contain the number of seconds to delay power on after a power fault. The value `0` shall indicate no delay to power on.", 450 "readonly": false, 451 "type": [ 452 "number", 453 "null" 454 ] 455 }, 456 "PowerRestorePolicy": { 457 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerRestorePolicyTypes", 458 "description": "The desired power state of the circuit when power is restored after a power loss.", 459 "longDescription": "This property shall contain the desired `PowerState` of the circuit when power is applied. The value `LastState` shall return the circuit to the `PowerState` it was in when power was lost.", 460 "readonly": false 461 }, 462 "PowerState": { 463 "anyOf": [ 464 { 465 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/PowerState" 466 }, 467 { 468 "type": "null" 469 } 470 ], 471 "description": "The power state of the circuit.", 472 "longDescription": "This property shall contain the power state of the circuit.", 473 "readonly": true 474 }, 475 "PowerStateInTransition": { 476 "description": "Indicates whether the power state is undergoing a delayed transition.", 477 "longDescription": "This property shall indicate whether the `PowerState` property will undergo a transition between on and off states due to a configured delay. The transition may be due to the configuration of the power on, off, or restore delay properties. If `true`, the `PowerState` property will transition at the conclusion of a configured delay.", 478 "readonly": true, 479 "type": "boolean", 480 "versionAdded": "v1_5_0" 481 }, 482 "PowerWatts": { 483 "anyOf": [ 484 { 485 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 486 }, 487 { 488 "type": "null" 489 } 490 ], 491 "description": "The power (W) for this circuit.", 492 "excerptCopy": "SensorPowerExcerpt", 493 "longDescription": "This property shall contain the total power, in watt units, for this circuit that represents the `Total` `ElectricalContext` sensor when multiple power sensors exist for this circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`." 494 }, 495 "RatedCurrentAmps": { 496 "description": "The rated maximum current allowed for this circuit.", 497 "longDescription": "This property shall contain the rated maximum current for this circuit, in ampere units, after any required de-rating, due to safety agency or other regulatory requirements, has been applied.", 498 "minimum": 0, 499 "readonly": true, 500 "type": [ 501 "number", 502 "null" 503 ], 504 "units": "A" 505 }, 506 "Status": { 507 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 508 "description": "The status and health of the resource and its subordinate or dependent resources.", 509 "longDescription": "This property shall contain any status or health properties of the resource." 510 }, 511 "UnbalancedCurrentPercent": { 512 "anyOf": [ 513 { 514 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 515 }, 516 { 517 "type": "null" 518 } 519 ], 520 "description": "The current imbalance (percent) between phases.", 521 "excerptCopy": "SensorExcerpt", 522 "longDescription": "This property shall contain the current imbalance, in percent units, between phases in a poly-phase circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Percent`.", 523 "versionAdded": "v1_5_0" 524 }, 525 "UnbalancedVoltagePercent": { 526 "anyOf": [ 527 { 528 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 529 }, 530 { 531 "type": "null" 532 } 533 ], 534 "description": "The voltage imbalance (percent) between phases.", 535 "excerptCopy": "SensorExcerpt", 536 "longDescription": "This property shall contain the voltage imbalance, in percent units, between phases in a poly-phase circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Percent`.", 537 "versionAdded": "v1_5_0" 538 }, 539 "UserLabel": { 540 "description": "A user-assigned label.", 541 "longDescription": "This property shall contain a user-assigned label used to identify this resource. If a value has not been assigned by a user, the value of this property shall be an empty string.", 542 "readonly": false, 543 "type": "string", 544 "versionAdded": "v1_4_0" 545 }, 546 "Voltage": { 547 "anyOf": [ 548 { 549 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 550 }, 551 { 552 "type": "null" 553 } 554 ], 555 "description": "The voltage (V) for this single-phase circuit.", 556 "excerptCopy": "SensorVoltageExcerpt", 557 "longDescription": "This property shall contain the voltage, in volt units, for this single-phase circuit. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not appear in resource instances representing poly-phase circuits." 558 }, 559 "VoltageType": { 560 "anyOf": [ 561 { 562 "$ref": "#/definitions/VoltageType" 563 }, 564 { 565 "type": "null" 566 } 567 ], 568 "description": "The type of voltage applied to the circuit.", 569 "longDescription": "This property shall contain the type of voltage applied to the circuit.", 570 "readonly": true 571 } 572 }, 573 "required": [ 574 "@odata.id", 575 "@odata.type", 576 "Id", 577 "Name" 578 ], 579 "type": "object" 580 }, 581 "CircuitType": { 582 "enum": [ 583 "Mains", 584 "Branch", 585 "Subfeed", 586 "Feeder", 587 "Bus" 588 ], 589 "enumDescriptions": { 590 "Branch": "A branch (output) circuit.", 591 "Bus": "An electrical bus circuit.", 592 "Feeder": "A feeder (output) circuit.", 593 "Mains": "A mains input or utility circuit.", 594 "Subfeed": "A subfeed (output) circuit." 595 }, 596 "enumVersionAdded": { 597 "Bus": "v1_3_0" 598 }, 599 "type": "string" 600 }, 601 "CurrentSensors": { 602 "additionalProperties": false, 603 "description": "The current sensors for this circuit.", 604 "longDescription": "This type shall contain properties that describe current sensor readings for a circuit.", 605 "patternProperties": { 606 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 607 "description": "This property shall specify a valid odata or Redfish property.", 608 "type": [ 609 "array", 610 "boolean", 611 "integer", 612 "number", 613 "null", 614 "object", 615 "string" 616 ] 617 } 618 }, 619 "properties": { 620 "Line1": { 621 "anyOf": [ 622 { 623 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 624 }, 625 { 626 "type": "null" 627 } 628 ], 629 "description": "Line 1 current (A).", 630 "excerptCopy": "SensorCurrentExcerpt", 631 "longDescription": "This property shall contain the line current, in ampere units, for L1. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`. This property shall not be present if the equipment does not include an L1 measurement." 632 }, 633 "Line2": { 634 "anyOf": [ 635 { 636 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 637 }, 638 { 639 "type": "null" 640 } 641 ], 642 "description": "Line 2 current (A).", 643 "excerptCopy": "SensorCurrentExcerpt", 644 "longDescription": "This property shall contain the line current, in ampere units, for L2. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`. This property shall not be present if the equipment does not include an L2 measurement." 645 }, 646 "Line3": { 647 "anyOf": [ 648 { 649 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 650 }, 651 { 652 "type": "null" 653 } 654 ], 655 "description": "Line 3 current (A).", 656 "excerptCopy": "SensorCurrentExcerpt", 657 "longDescription": "This property shall contain the line current, in ampere units, for L3. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`. This property shall not be present if the equipment does not include an L3 measurement." 658 }, 659 "Neutral": { 660 "anyOf": [ 661 { 662 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 663 }, 664 { 665 "type": "null" 666 } 667 ], 668 "description": "Neutral line current (A).", 669 "excerptCopy": "SensorCurrentExcerpt", 670 "longDescription": "This property shall contain the line current, in ampere units, for the Neutral line. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Current`. This property shall not be present if the equipment does not include a Neutral line measurement." 671 } 672 }, 673 "type": "object" 674 }, 675 "EnergySensors": { 676 "additionalProperties": false, 677 "description": "The energy readings for this circuit.", 678 "longDescription": "This type shall contain properties that describe energy sensor readings for a circuit.", 679 "patternProperties": { 680 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 681 "description": "This property shall specify a valid odata or Redfish property.", 682 "type": [ 683 "array", 684 "boolean", 685 "integer", 686 "number", 687 "null", 688 "object", 689 "string" 690 ] 691 } 692 }, 693 "properties": { 694 "Line1ToLine2": { 695 "anyOf": [ 696 { 697 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 698 }, 699 { 700 "type": "null" 701 } 702 ], 703 "description": "The Line 1 to Line 2 energy (kWh) for this circuit.", 704 "excerptCopy": "SensorEnergykWhExcerpt", 705 "longDescription": "This property shall contain the energy, in kilowatt-hour units, between L1 and L2. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`. This property shall not be present if the equipment does not include an L1-L2 measurement." 706 }, 707 "Line1ToNeutral": { 708 "anyOf": [ 709 { 710 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 711 }, 712 { 713 "type": "null" 714 } 715 ], 716 "description": "The Line 1 to Neutral energy (kWh) for this circuit.", 717 "excerptCopy": "SensorEnergykWhExcerpt", 718 "longDescription": "This property shall contain the energy, in kilowatt-hour units, between L1 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`. This property shall not be present if the equipment does not include an L1-Neutral measurement." 719 }, 720 "Line2ToLine3": { 721 "anyOf": [ 722 { 723 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 724 }, 725 { 726 "type": "null" 727 } 728 ], 729 "description": "The Line 2 to Line 3 energy (kWh) for this circuit.", 730 "excerptCopy": "SensorEnergykWhExcerpt", 731 "longDescription": "This property shall contain the energy, in kilowatt-hour units, between L2 and L3. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`. This property shall not be present if the equipment does not include an L2-L3 measurement." 732 }, 733 "Line2ToNeutral": { 734 "anyOf": [ 735 { 736 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 737 }, 738 { 739 "type": "null" 740 } 741 ], 742 "description": "The Line 2 to Neutral energy (kWh) for this circuit.", 743 "excerptCopy": "SensorEnergykWhExcerpt", 744 "longDescription": "This property shall contain the energy, in kilowatt-hour units, between L2 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`. This property shall not be present if the equipment does not include an L2-Neutral measurement." 745 }, 746 "Line3ToLine1": { 747 "anyOf": [ 748 { 749 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 750 }, 751 { 752 "type": "null" 753 } 754 ], 755 "description": "The Line 3 to Line 1 energy (kWh) for this circuit.", 756 "excerptCopy": "SensorEnergykWhExcerpt", 757 "longDescription": "This property shall contain the energy, in kilowatt-hour units, between L3 and L1. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`. This property shall not be present if the equipment does not include an L3-L1 measurement." 758 }, 759 "Line3ToNeutral": { 760 "anyOf": [ 761 { 762 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 763 }, 764 { 765 "type": "null" 766 } 767 ], 768 "description": "The Line 3 to Neutral energy (kWh) for this circuit.", 769 "excerptCopy": "SensorEnergykWhExcerpt", 770 "longDescription": "This property shall contain the energy, in kilowatt-hour units, between L3 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`. This property shall not be present if the equipment does not include an L3-Neutral measurement." 771 } 772 }, 773 "type": "object" 774 }, 775 "Links": { 776 "additionalProperties": false, 777 "description": "The links to other resources that are related to this resource.", 778 "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.", 779 "patternProperties": { 780 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 781 "description": "This property shall specify a valid odata or Redfish property.", 782 "type": [ 783 "array", 784 "boolean", 785 "integer", 786 "number", 787 "null", 788 "object", 789 "string" 790 ] 791 } 792 }, 793 "properties": { 794 "BranchCircuit": { 795 "anyOf": [ 796 { 797 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/Circuit" 798 }, 799 { 800 "type": "null" 801 } 802 ], 803 "description": "A reference to the branch circuit related to this circuit.", 804 "longDescription": "This property shall contain a link to a resource of type `Circuit` that represents the branch circuit associated with this circuit.", 805 "readonly": true 806 }, 807 "DistributionCircuits": { 808 "description": "An array of links to the circuits powered by this circuit.", 809 "items": { 810 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/Circuit" 811 }, 812 "longDescription": "This property shall contain an array of links to resources of type `Circuit` that represent the circuits powered by this circuit.", 813 "readonly": false, 814 "type": "array", 815 "versionAdded": "v1_4_0" 816 }, 817 "DistributionCircuits@odata.count": { 818 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 819 }, 820 "Oem": { 821 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 822 "description": "The OEM extension property.", 823 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 824 }, 825 "Outlets": { 826 "description": "An array of references to the outlets contained by this circuit.", 827 "items": { 828 "$ref": "http://redfish.dmtf.org/schemas/v1/Outlet.json#/definitions/Outlet" 829 }, 830 "longDescription": "This property shall contain an array of links to resources of type `Outlet` that represent the outlets associated with this circuit.", 831 "readonly": true, 832 "type": "array" 833 }, 834 "Outlets@odata.count": { 835 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 836 }, 837 "PowerOutlet": { 838 "anyOf": [ 839 { 840 "$ref": "http://redfish.dmtf.org/schemas/v1/Outlet.json#/definitions/Outlet" 841 }, 842 { 843 "type": "null" 844 } 845 ], 846 "description": "A link to the power outlet that provides power to this circuit.", 847 "longDescription": "This property shall contain a link to a resource of type `Outlet` that represents the outlet that provides power to this circuit.", 848 "readonly": false, 849 "versionAdded": "v1_4_0" 850 }, 851 "SourceCircuit": { 852 "anyOf": [ 853 { 854 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/Circuit" 855 }, 856 { 857 "type": "null" 858 } 859 ], 860 "description": "A link to the circuit that provides power to this circuit.", 861 "longDescription": "This property shall contain a link to a resource of type `Circuit` that represents the circuit that provides power to this circuit. This property should be used when the power source is not represented by an Outlet resource, such as a feeder circuit.", 862 "readonly": false, 863 "versionAdded": "v1_4_0" 864 } 865 }, 866 "type": "object" 867 }, 868 "OemActions": { 869 "additionalProperties": true, 870 "description": "The available OEM-specific actions for this resource.", 871 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 872 "patternProperties": { 873 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 874 "description": "This property shall specify a valid odata or Redfish property.", 875 "type": [ 876 "array", 877 "boolean", 878 "integer", 879 "number", 880 "null", 881 "object", 882 "string" 883 ] 884 } 885 }, 886 "properties": {}, 887 "type": "object" 888 }, 889 "PowerControl": { 890 "additionalProperties": false, 891 "description": "This action turns the circuit on or off.", 892 "longDescription": "This action shall control the power state of the circuit.", 893 "parameters": { 894 "PowerState": { 895 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerState", 896 "description": "The desired power state of the circuit.", 897 "longDescription": "This parameter shall contain the desired power state of the circuit." 898 } 899 }, 900 "patternProperties": { 901 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 902 "description": "This property shall specify a valid odata or Redfish property.", 903 "type": [ 904 "array", 905 "boolean", 906 "integer", 907 "number", 908 "null", 909 "object", 910 "string" 911 ] 912 } 913 }, 914 "properties": { 915 "target": { 916 "description": "Link to invoke action", 917 "format": "uri-reference", 918 "type": "string" 919 }, 920 "title": { 921 "description": "Friendly action name", 922 "type": "string" 923 } 924 }, 925 "type": "object" 926 }, 927 "PowerSensors": { 928 "additionalProperties": false, 929 "description": "This property contains the power sensors.", 930 "longDescription": "This type shall contain properties that describe power sensor readings for a circuit.", 931 "patternProperties": { 932 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 933 "description": "This property shall specify a valid odata or Redfish property.", 934 "type": [ 935 "array", 936 "boolean", 937 "integer", 938 "number", 939 "null", 940 "object", 941 "string" 942 ] 943 } 944 }, 945 "properties": { 946 "Line1ToLine2": { 947 "anyOf": [ 948 { 949 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 950 }, 951 { 952 "type": "null" 953 } 954 ], 955 "description": "The Line 1 to Line 2 power (W) for this circuit.", 956 "excerptCopy": "SensorPowerExcerpt", 957 "longDescription": "This property shall contain the power, in watt units, between L1 and L2. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`. This property shall not be present if the equipment does not include an L1-L2 measurement." 958 }, 959 "Line1ToNeutral": { 960 "anyOf": [ 961 { 962 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 963 }, 964 { 965 "type": "null" 966 } 967 ], 968 "description": "The Line 1 to Neutral power (W) for this circuit.", 969 "excerptCopy": "SensorPowerExcerpt", 970 "longDescription": "This property shall contain the power, in watt units, between L1 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`. This property shall not be present if the equipment does not include an L1-Neutral measurement." 971 }, 972 "Line2ToLine3": { 973 "anyOf": [ 974 { 975 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 976 }, 977 { 978 "type": "null" 979 } 980 ], 981 "description": "The Line 2 to Line 3 power (W) for this circuit.", 982 "excerptCopy": "SensorPowerExcerpt", 983 "longDescription": "This property shall contain the power, in watt units, between L2 and L3. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`. This property shall not be present if the equipment does not include an L2-L3 measurement." 984 }, 985 "Line2ToNeutral": { 986 "anyOf": [ 987 { 988 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 989 }, 990 { 991 "type": "null" 992 } 993 ], 994 "description": "The Line 2 to Neutral power (W) for this circuit.", 995 "excerptCopy": "SensorPowerExcerpt", 996 "longDescription": "This property shall contain the power, in watt units, between L2 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`. This property shall not be present if the equipment does not include an L2-Neutral measurement." 997 }, 998 "Line3ToLine1": { 999 "anyOf": [ 1000 { 1001 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 1002 }, 1003 { 1004 "type": "null" 1005 } 1006 ], 1007 "description": "The Line 3 to Line 1 power (W) for this circuit.", 1008 "excerptCopy": "SensorPowerExcerpt", 1009 "longDescription": "This property shall contain the power, in watt units, between L3 and L1. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`. This property shall not be present if the equipment does not include an L3-L1 measurement." 1010 }, 1011 "Line3ToNeutral": { 1012 "anyOf": [ 1013 { 1014 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 1015 }, 1016 { 1017 "type": "null" 1018 } 1019 ], 1020 "description": "The Line 3 to Neutral power (W) for this circuit.", 1021 "excerptCopy": "SensorPowerExcerpt", 1022 "longDescription": "This property shall contain the power, in watt units, between L3 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`. This property shall not be present if the equipment does not include an L3-Neutral measurement." 1023 } 1024 }, 1025 "type": "object" 1026 }, 1027 "ResetMetrics": { 1028 "additionalProperties": false, 1029 "description": "This action resets metrics related to this circuit.", 1030 "longDescription": "This action shall reset any time intervals or counted values for this circuit.", 1031 "parameters": {}, 1032 "patternProperties": { 1033 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1034 "description": "This property shall specify a valid odata or Redfish property.", 1035 "type": [ 1036 "array", 1037 "boolean", 1038 "integer", 1039 "number", 1040 "null", 1041 "object", 1042 "string" 1043 ] 1044 } 1045 }, 1046 "properties": { 1047 "target": { 1048 "description": "Link to invoke action", 1049 "format": "uri-reference", 1050 "type": "string" 1051 }, 1052 "title": { 1053 "description": "Friendly action name", 1054 "type": "string" 1055 } 1056 }, 1057 "type": "object" 1058 }, 1059 "VoltageSensors": { 1060 "additionalProperties": false, 1061 "description": "The voltage readings for this circuit.", 1062 "longDescription": "This type shall contain properties that describe voltage sensor readings for a circuit.", 1063 "patternProperties": { 1064 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1065 "description": "This property shall specify a valid odata or Redfish property.", 1066 "type": [ 1067 "array", 1068 "boolean", 1069 "integer", 1070 "number", 1071 "null", 1072 "object", 1073 "string" 1074 ] 1075 } 1076 }, 1077 "properties": { 1078 "Line1ToLine2": { 1079 "anyOf": [ 1080 { 1081 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 1082 }, 1083 { 1084 "type": "null" 1085 } 1086 ], 1087 "description": "The Line 1 to Line 2 voltage (V) for this circuit.", 1088 "excerptCopy": "SensorVoltageExcerpt", 1089 "longDescription": "This property shall contain the line-to-line voltage, in volt units, between L1 and L2. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not be present if the equipment does not include an L1-L2 measurement." 1090 }, 1091 "Line1ToNeutral": { 1092 "anyOf": [ 1093 { 1094 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 1095 }, 1096 { 1097 "type": "null" 1098 } 1099 ], 1100 "description": "The Line 1 to Neutral voltage (V) for this circuit.", 1101 "excerptCopy": "SensorVoltageExcerpt", 1102 "longDescription": "This property shall contain the line-to-line voltage, in volt units, between L1 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not be present if the equipment does not include an L1-Neutral measurement." 1103 }, 1104 "Line2ToLine3": { 1105 "anyOf": [ 1106 { 1107 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 1108 }, 1109 { 1110 "type": "null" 1111 } 1112 ], 1113 "description": "The Line 2 to Line 3 voltage (V) for this circuit.", 1114 "excerptCopy": "SensorVoltageExcerpt", 1115 "longDescription": "This property shall contain the line-to-line voltage, in volt units, between L2 and L3. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not be present if the equipment does not include an L2-L3 measurement." 1116 }, 1117 "Line2ToNeutral": { 1118 "anyOf": [ 1119 { 1120 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 1121 }, 1122 { 1123 "type": "null" 1124 } 1125 ], 1126 "description": "The Line 2 to Neutral voltage (V) for this circuit.", 1127 "excerptCopy": "SensorVoltageExcerpt", 1128 "longDescription": "This property shall contain the line-to-line voltage, in volt units, between L2 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not be present if the equipment does not include an L2-Neutral measurement." 1129 }, 1130 "Line3ToLine1": { 1131 "anyOf": [ 1132 { 1133 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 1134 }, 1135 { 1136 "type": "null" 1137 } 1138 ], 1139 "description": "The Line 3 to Line 1 voltage (V) for this circuit.", 1140 "excerptCopy": "SensorVoltageExcerpt", 1141 "longDescription": "This property shall contain the line-to-line voltage, in volt units, between L3 and L1. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not be present if the equipment does not include an L3-L1 measurement." 1142 }, 1143 "Line3ToNeutral": { 1144 "anyOf": [ 1145 { 1146 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 1147 }, 1148 { 1149 "type": "null" 1150 } 1151 ], 1152 "description": "The Line 3 to Neutral voltage (V) for this circuit.", 1153 "excerptCopy": "SensorVoltageExcerpt", 1154 "longDescription": "This property shall contain the line-to-line voltage, in volt units, between L3 and Neutral. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Voltage`. This property shall not be present if the equipment does not include an L3-Neutral measurement." 1155 } 1156 }, 1157 "type": "object" 1158 }, 1159 "VoltageType": { 1160 "enum": [ 1161 "AC", 1162 "DC" 1163 ], 1164 "enumDescriptions": { 1165 "AC": "Alternating Current (AC) circuit.", 1166 "DC": "Direct Current (DC) circuit." 1167 }, 1168 "type": "string" 1169 } 1170 }, 1171 "language": "en", 1172 "owningEntity": "DMTF", 1173 "release": "2024.1", 1174 "title": "#Circuit.v1_8_0.Circuit" 1175}