1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/Outlet.v1_4_3.json", 3 "$ref": "#/definitions/Outlet", 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 "#Outlet.PowerControl": { 27 "$ref": "#/definitions/PowerControl" 28 }, 29 "#Outlet.ResetMetrics": { 30 "$ref": "#/definitions/ResetMetrics" 31 }, 32 "Oem": { 33 "$ref": "#/definitions/OemActions", 34 "description": "The available OEM-specific actions for this resource.", 35 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 36 } 37 }, 38 "type": "object" 39 }, 40 "CurrentSensors": { 41 "additionalProperties": false, 42 "description": "The current sensors for this outlet.", 43 "longDescription": "This type shall contain properties that describe current sensor readings for an outlet.", 44 "patternProperties": { 45 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 46 "description": "This property shall specify a valid odata or Redfish property.", 47 "type": [ 48 "array", 49 "boolean", 50 "integer", 51 "number", 52 "null", 53 "object", 54 "string" 55 ] 56 } 57 }, 58 "properties": { 59 "Line1": { 60 "anyOf": [ 61 { 62 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 63 }, 64 { 65 "type": "null" 66 } 67 ], 68 "description": "Line 1 current (A).", 69 "excerptCopy": "SensorCurrentExcerpt", 70 "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." 71 }, 72 "Line2": { 73 "anyOf": [ 74 { 75 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 76 }, 77 { 78 "type": "null" 79 } 80 ], 81 "description": "Line 2 current (A).", 82 "excerptCopy": "SensorCurrentExcerpt", 83 "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." 84 }, 85 "Line3": { 86 "anyOf": [ 87 { 88 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 89 }, 90 { 91 "type": "null" 92 } 93 ], 94 "description": "Line 3 current (A).", 95 "excerptCopy": "SensorCurrentExcerpt", 96 "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." 97 }, 98 "Neutral": { 99 "anyOf": [ 100 { 101 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 102 }, 103 { 104 "type": "null" 105 } 106 ], 107 "description": "Neutral line current (A).", 108 "excerptCopy": "SensorCurrentExcerpt", 109 "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." 110 } 111 }, 112 "type": "object" 113 }, 114 "Links": { 115 "additionalProperties": false, 116 "description": "The links to other resources that are related to this resource.", 117 "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.", 118 "patternProperties": { 119 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 120 "description": "This property shall specify a valid odata or Redfish property.", 121 "type": [ 122 "array", 123 "boolean", 124 "integer", 125 "number", 126 "null", 127 "object", 128 "string" 129 ] 130 } 131 }, 132 "properties": { 133 "BranchCircuit": { 134 "anyOf": [ 135 { 136 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/Circuit" 137 }, 138 { 139 "type": "null" 140 } 141 ], 142 "description": "A reference to the branch circuit related to this outlet.", 143 "longDescription": "This property shall contain a link to a resource of type `Circuit` that represent the branch circuit associated with this outlet.", 144 "readonly": true 145 }, 146 "Chassis": { 147 "description": "Any array of links to chassis connected to this outlet.", 148 "items": { 149 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis" 150 }, 151 "longDescription": "This property shall contain an array of links to resources of type `Chassis` that represent the chassis connected to this outlet.", 152 "readonly": false, 153 "type": "array", 154 "versionAdded": "v1_3_0" 155 }, 156 "Chassis@odata.count": { 157 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 158 }, 159 "DistributionCircuits": { 160 "description": "An array of links to mains or input circuits powered by this outlet.", 161 "items": { 162 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/Circuit" 163 }, 164 "longDescription": "This property shall contain an array of links to resources of type `Circuit` that represent the circuits powered by this outlet. This property is used to show a connection to an input circuit downstream in a power distribution chain.", 165 "readonly": false, 166 "type": "array", 167 "versionAdded": "v1_3_0" 168 }, 169 "DistributionCircuits@odata.count": { 170 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 171 }, 172 "Oem": { 173 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 174 "description": "The OEM extension property.", 175 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 176 }, 177 "PowerSupplies": { 178 "description": "An array of links to the power supplies connected to this outlet.", 179 "items": { 180 "$ref": "http://redfish.dmtf.org/schemas/v1/PowerSupply.json#/definitions/PowerSupply" 181 }, 182 "longDescription": "This property shall contain an array of links to resources of type `PowerSupply` that represent the power supplies connected to this outlet.", 183 "readonly": false, 184 "type": "array", 185 "versionAdded": "v1_3_0" 186 }, 187 "PowerSupplies@odata.count": { 188 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 189 } 190 }, 191 "type": "object" 192 }, 193 "OemActions": { 194 "additionalProperties": true, 195 "description": "The available OEM-specific actions for this resource.", 196 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 197 "patternProperties": { 198 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 199 "description": "This property shall specify a valid odata or Redfish property.", 200 "type": [ 201 "array", 202 "boolean", 203 "integer", 204 "number", 205 "null", 206 "object", 207 "string" 208 ] 209 } 210 }, 211 "properties": {}, 212 "type": "object" 213 }, 214 "Outlet": { 215 "additionalProperties": false, 216 "description": "The `Outlet` schema contains a definition for an electrical outlet.", 217 "longDescription": "This resource shall be used to represent an electrical outlet for a Redfish implementation.", 218 "patternProperties": { 219 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 220 "description": "This property shall specify a valid odata or Redfish property.", 221 "type": [ 222 "array", 223 "boolean", 224 "integer", 225 "number", 226 "null", 227 "object", 228 "string" 229 ] 230 } 231 }, 232 "properties": { 233 "@odata.context": { 234 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 235 }, 236 "@odata.etag": { 237 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 238 }, 239 "@odata.id": { 240 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 241 }, 242 "@odata.type": { 243 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 244 }, 245 "Actions": { 246 "$ref": "#/definitions/Actions", 247 "description": "The available actions for this resource.", 248 "longDescription": "This property shall contain the available actions for this resource." 249 }, 250 "ConfigurationLocked": { 251 "description": "Indicates whether the configuration is locked.", 252 "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.", 253 "readonly": false, 254 "type": "boolean", 255 "versionAdded": "v1_4_0" 256 }, 257 "CurrentAmps": { 258 "anyOf": [ 259 { 260 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorCurrentExcerpt" 261 }, 262 { 263 "type": "null" 264 } 265 ], 266 "description": "The current (A) for this single-phase outlet.", 267 "excerptCopy": "SensorCurrentExcerpt", 268 "longDescription": "This property shall contain the current, in ampere units, for this single-phase outlet. 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 outlets." 269 }, 270 "Description": { 271 "anyOf": [ 272 { 273 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 274 }, 275 { 276 "type": "null" 277 } 278 ], 279 "readonly": true 280 }, 281 "ElectricalConsumerNames": { 282 "description": "An array of names of downstream devices that are powered by this outlet.", 283 "items": { 284 "type": [ 285 "string", 286 "null" 287 ] 288 }, 289 "longDescription": "This property shall contain an array of user-assigned identifying strings that describe downstream devices that are powered by this outlet.", 290 "readonly": false, 291 "type": "array", 292 "versionAdded": "v1_3_0" 293 }, 294 "ElectricalContext": { 295 "anyOf": [ 296 { 297 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/ElectricalContext" 298 }, 299 { 300 "type": "null" 301 } 302 ], 303 "description": "The combination of current-carrying conductors.", 304 "longDescription": "This property shall contain the combination of current-carrying conductors that distribute power.", 305 "readonly": true 306 }, 307 "EnergykWh": { 308 "anyOf": [ 309 { 310 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorEnergykWhExcerpt" 311 }, 312 { 313 "type": "null" 314 } 315 ], 316 "description": "The energy (kWh) for this outlet.", 317 "excerptCopy": "SensorEnergykWhExcerpt", 318 "longDescription": "This property shall contain the total energy, in kilowatt-hour units, for this outlet that represents the `Total` `ElectricalContext` sensor when multiple energy sensors exist for this outlet. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `EnergykWh`." 319 }, 320 "FrequencyHz": { 321 "anyOf": [ 322 { 323 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 324 }, 325 { 326 "type": "null" 327 } 328 ], 329 "description": "The frequency (Hz) for this outlet.", 330 "excerptCopy": "SensorExcerpt", 331 "longDescription": "This property shall contain the frequency, in hertz units, for this outlet. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Frequency`." 332 }, 333 "Id": { 334 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 335 "readonly": true 336 }, 337 "IndicatorLED": { 338 "anyOf": [ 339 { 340 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/IndicatorLED" 341 }, 342 { 343 "type": "null" 344 } 345 ], 346 "deprecated": "This property has been deprecated in favor of the `LocationIndicatorActive` property.", 347 "description": "The state of the indicator LED, which identifies the outlet.", 348 "longDescription": "This property shall contain the indicator light state for the indicator light associated with this outlet.", 349 "readonly": false, 350 "versionDeprecated": "v1_1_0" 351 }, 352 "Links": { 353 "$ref": "#/definitions/Links", 354 "description": "The links to other resources that are related to this resource.", 355 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 356 }, 357 "LocationIndicatorActive": { 358 "description": "An indicator allowing an operator to physically locate this resource.", 359 "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.", 360 "readonly": false, 361 "type": [ 362 "boolean", 363 "null" 364 ], 365 "versionAdded": "v1_1_0" 366 }, 367 "Name": { 368 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 369 "readonly": true 370 }, 371 "NominalVoltage": { 372 "anyOf": [ 373 { 374 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/NominalVoltageType" 375 }, 376 { 377 "type": "null" 378 } 379 ], 380 "description": "The nominal voltage for this outlet.", 381 "longDescription": "This property shall contain the nominal voltage for this outlet, in volt units.", 382 "readonly": true 383 }, 384 "Oem": { 385 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 386 "description": "The OEM extension property.", 387 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 388 }, 389 "OutletType": { 390 "anyOf": [ 391 { 392 "$ref": "http://redfish.dmtf.org/schemas/v1/Outlet.json#/definitions/ReceptacleType" 393 }, 394 { 395 "type": "null" 396 } 397 ], 398 "description": "The type of receptacle according to NEMA, IEC, or regional standards.", 399 "longDescription": "This property shall contain the type of physical receptacle used for this outlet, as defined by IEC, NEMA, or regional standards.", 400 "readonly": true 401 }, 402 "PhaseWiringType": { 403 "anyOf": [ 404 { 405 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PhaseWiringType" 406 }, 407 { 408 "type": "null" 409 } 410 ], 411 "description": "The number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires).", 412 "longDescription": "This property shall contain the number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires).", 413 "readonly": true 414 }, 415 "PolyPhaseCurrentAmps": { 416 "anyOf": [ 417 { 418 "$ref": "#/definitions/CurrentSensors" 419 }, 420 { 421 "type": "null" 422 } 423 ], 424 "description": "The current readings for this outlet.", 425 "longDescription": "This property shall contain the current readings for this outlet. For single-phase outlets, this property shall contain a duplicate copy of the current sensor referenced in the `CurrentAmps` property, if present. For poly-phase outlets, this property should contain multiple current sensor readings used to fully describe the outlet." 426 }, 427 "PolyPhaseVoltage": { 428 "anyOf": [ 429 { 430 "$ref": "#/definitions/VoltageSensors" 431 }, 432 { 433 "type": "null" 434 } 435 ], 436 "description": "The voltage readings for this outlet.", 437 "longDescription": "This property shall contain the voltage readings for this outlet. For single-phase outlets, this property shall contain a duplicate copy of the voltage sensor referenced in the `Voltage` property, if present. For poly-phase outlets, this property should contain multiple voltage sensor readings used to fully describe the outlet." 438 }, 439 "PowerControlLocked": { 440 "description": "Indicates whether power control requests are locked.", 441 "longDescription": "This property shall indicate whether requests to the `PowerControl` action are locked. If `true`, services shall reject requests to the `PowerControl` action.", 442 "readonly": false, 443 "type": "boolean", 444 "versionAdded": "v1_4_0" 445 }, 446 "PowerCycleDelaySeconds": { 447 "description": "The number of seconds to delay power on after a `PowerControl` action to cycle power. Zero seconds indicates no delay.", 448 "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.", 449 "readonly": false, 450 "type": [ 451 "number", 452 "null" 453 ] 454 }, 455 "PowerEnabled": { 456 "description": "Indicates if the outlet can be powered.", 457 "longDescription": "This property shall indicate the power enable state of the outlet. The value `true` shall indicate that the outlet can be powered on, and `false` shall indicate that the outlet cannot be powered.", 458 "readonly": true, 459 "type": [ 460 "boolean", 461 "null" 462 ] 463 }, 464 "PowerLoadPercent": { 465 "anyOf": [ 466 { 467 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorExcerpt" 468 }, 469 { 470 "type": "null" 471 } 472 ], 473 "description": "The power load (percent) for this outlet.", 474 "excerptCopy": "SensorExcerpt", 475 "longDescription": "This property shall contain the power load, in percent units, for this outlet that represents the `Total` `ElectricalContext` for this outlet. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Percent`.", 476 "versionAdded": "v1_2_0" 477 }, 478 "PowerOffDelaySeconds": { 479 "description": "The number of seconds to delay power off after a `PowerControl` action. Zero seconds indicates no delay to power off.", 480 "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.", 481 "readonly": false, 482 "type": [ 483 "number", 484 "null" 485 ] 486 }, 487 "PowerOnDelaySeconds": { 488 "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.", 489 "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.", 490 "readonly": false, 491 "type": [ 492 "number", 493 "null" 494 ] 495 }, 496 "PowerRestoreDelaySeconds": { 497 "description": "The number of seconds to delay power on after power has been restored. Zero seconds indicates no delay.", 498 "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.", 499 "readonly": false, 500 "type": [ 501 "number", 502 "null" 503 ] 504 }, 505 "PowerRestorePolicy": { 506 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerRestorePolicyTypes", 507 "description": "The desired power state of the outlet when power is restored after a power loss.", 508 "longDescription": "This property shall contain the desired `PowerState` of the outlet when power is applied. The value `LastState` shall return the outlet to the `PowerState` it was in when power was lost.", 509 "readonly": false 510 }, 511 "PowerState": { 512 "anyOf": [ 513 { 514 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/PowerState" 515 }, 516 { 517 "type": "null" 518 } 519 ], 520 "description": "The power state of the outlet.", 521 "longDescription": "This property shall contain the power state of the outlet.", 522 "readonly": true 523 }, 524 "PowerStateInTransition": { 525 "description": "Indicates whether the power state is undergoing a delayed transition.", 526 "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.", 527 "readonly": true, 528 "type": "boolean", 529 "versionAdded": "v1_4_0" 530 }, 531 "PowerWatts": { 532 "anyOf": [ 533 { 534 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorPowerExcerpt" 535 }, 536 { 537 "type": "null" 538 } 539 ], 540 "description": "The power (W) for this outlet.", 541 "excerptCopy": "SensorPowerExcerpt", 542 "longDescription": "This property shall contain the total power, in watt units, for this outlet that represents the `Total` `ElectricalContext` sensor when multiple power sensors exist for this outlet. The value of the `DataSourceUri` property, if present, shall reference a resource of type `Sensor` with the `ReadingType` property containing the value `Power`." 543 }, 544 "RatedCurrentAmps": { 545 "description": "The rated maximum current allowed for this outlet.", 546 "longDescription": "This property shall contain the rated maximum current for this outlet, in ampere units, after any required de-rating, due to safety agency or other regulatory requirements, has been applied.", 547 "minimum": 0, 548 "readonly": true, 549 "type": [ 550 "number", 551 "null" 552 ], 553 "units": "A" 554 }, 555 "Status": { 556 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 557 "description": "The status and health of the resource and its subordinate or dependent resources.", 558 "longDescription": "This property shall contain any status or health properties of the resource." 559 }, 560 "UserLabel": { 561 "description": "A user-assigned label.", 562 "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.", 563 "readonly": false, 564 "type": "string", 565 "versionAdded": "v1_3_0" 566 }, 567 "Voltage": { 568 "anyOf": [ 569 { 570 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 571 }, 572 { 573 "type": "null" 574 } 575 ], 576 "description": "The voltage (V) for this single-phase outlet.", 577 "excerptCopy": "SensorVoltageExcerpt", 578 "longDescription": "This property shall contain the voltage, in volt units, for this single-phase outlet. 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 outlets." 579 }, 580 "VoltageType": { 581 "anyOf": [ 582 { 583 "$ref": "#/definitions/VoltageType" 584 }, 585 { 586 "type": "null" 587 } 588 ], 589 "description": "The type of voltage applied to the outlet.", 590 "longDescription": "This property shall contain the type of voltage applied to the outlet.", 591 "readonly": true 592 } 593 }, 594 "required": [ 595 "@odata.id", 596 "@odata.type", 597 "Id", 598 "Name" 599 ], 600 "type": "object" 601 }, 602 "PowerControl": { 603 "additionalProperties": false, 604 "description": "This action turns the outlet on or off.", 605 "longDescription": "This action shall control the power state of the outlet.", 606 "parameters": { 607 "PowerState": { 608 "$ref": "http://redfish.dmtf.org/schemas/v1/Circuit.json#/definitions/PowerState", 609 "description": "The desired power state of the outlet.", 610 "longDescription": "This parameter shall contain the desired power state of the outlet." 611 } 612 }, 613 "patternProperties": { 614 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 615 "description": "This property shall specify a valid odata or Redfish property.", 616 "type": [ 617 "array", 618 "boolean", 619 "integer", 620 "number", 621 "null", 622 "object", 623 "string" 624 ] 625 } 626 }, 627 "properties": { 628 "target": { 629 "description": "Link to invoke action", 630 "format": "uri-reference", 631 "type": "string" 632 }, 633 "title": { 634 "description": "Friendly action name", 635 "type": "string" 636 } 637 }, 638 "type": "object" 639 }, 640 "ResetMetrics": { 641 "additionalProperties": false, 642 "description": "This action resets metrics related to this outlet.", 643 "longDescription": "This action shall reset any time intervals or counted values for this outlet.", 644 "parameters": {}, 645 "patternProperties": { 646 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 647 "description": "This property shall specify a valid odata or Redfish property.", 648 "type": [ 649 "array", 650 "boolean", 651 "integer", 652 "number", 653 "null", 654 "object", 655 "string" 656 ] 657 } 658 }, 659 "properties": { 660 "target": { 661 "description": "Link to invoke action", 662 "format": "uri-reference", 663 "type": "string" 664 }, 665 "title": { 666 "description": "Friendly action name", 667 "type": "string" 668 } 669 }, 670 "type": "object" 671 }, 672 "VoltageSensors": { 673 "additionalProperties": false, 674 "description": "The voltage readings for this outlet.", 675 "longDescription": "This type shall contain properties that describe voltage sensor readings for an outlet.", 676 "patternProperties": { 677 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 678 "description": "This property shall specify a valid odata or Redfish property.", 679 "type": [ 680 "array", 681 "boolean", 682 "integer", 683 "number", 684 "null", 685 "object", 686 "string" 687 ] 688 } 689 }, 690 "properties": { 691 "Line1ToLine2": { 692 "anyOf": [ 693 { 694 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 695 }, 696 { 697 "type": "null" 698 } 699 ], 700 "description": "The Line 1 to Line 2 voltage (V) for this outlet.", 701 "excerptCopy": "SensorVoltageExcerpt", 702 "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." 703 }, 704 "Line1ToNeutral": { 705 "anyOf": [ 706 { 707 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 708 }, 709 { 710 "type": "null" 711 } 712 ], 713 "description": "The Line 1 to Neutral voltage (V) for this outlet.", 714 "excerptCopy": "SensorVoltageExcerpt", 715 "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." 716 }, 717 "Line2ToLine3": { 718 "anyOf": [ 719 { 720 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 721 }, 722 { 723 "type": "null" 724 } 725 ], 726 "description": "The Line 2 to Line 3 voltage (V) for this outlet.", 727 "excerptCopy": "SensorVoltageExcerpt", 728 "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." 729 }, 730 "Line2ToNeutral": { 731 "anyOf": [ 732 { 733 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 734 }, 735 { 736 "type": "null" 737 } 738 ], 739 "description": "The Line 2 to Neutral voltage (V) for this outlet.", 740 "excerptCopy": "SensorVoltageExcerpt", 741 "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." 742 }, 743 "Line3ToLine1": { 744 "anyOf": [ 745 { 746 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 747 }, 748 { 749 "type": "null" 750 } 751 ], 752 "description": "The Line 3 to Line 1 voltage (V) for this outlet.", 753 "excerptCopy": "SensorVoltageExcerpt", 754 "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." 755 }, 756 "Line3ToNeutral": { 757 "anyOf": [ 758 { 759 "$ref": "http://redfish.dmtf.org/schemas/v1/Sensor.json#/definitions/SensorVoltageExcerpt" 760 }, 761 { 762 "type": "null" 763 } 764 ], 765 "description": "The Line 3 to Neutral voltage (V) for this outlet.", 766 "excerptCopy": "SensorVoltageExcerpt", 767 "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." 768 } 769 }, 770 "type": "object" 771 }, 772 "VoltageType": { 773 "enum": [ 774 "AC", 775 "DC" 776 ], 777 "enumDescriptions": { 778 "AC": "Alternating Current (AC) outlet.", 779 "DC": "Direct Current (DC) outlet." 780 }, 781 "type": "string" 782 } 783 }, 784 "language": "en", 785 "owningEntity": "DMTF", 786 "release": "2021.4", 787 "title": "#Outlet.v1_4_3.Outlet" 788}