1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/Sensor.v1_0_0.json",
"$ref": "#/definitions/Sensor",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
"definitions": {
"Actions": {
"additionalProperties": false,
"description": "The available actions for this resource.",
"longDescription": "This type shall contain the available actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"#Sensor.ResetStatistics": {
"$ref": "#/definitions/ResetStatistics"
},
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "This property contains the available OEM specific actions for this resource.",
"longDescription": "This property shall contain any additional OEM actions for this resource."
}
},
"type": "object"
},
"ElectricalContext": {
"enum": [
"Line1",
"Line2",
"Line3",
"Neutral",
"LineToLine",
"Line1ToLine2",
"Line2ToLine3",
"Line3ToLine1",
"LineToNeutral",
"Line1ToNeutral",
"Line2ToNeutral",
"Line3ToNeutral",
"Line1ToNeutralAndL1L2",
"Line2ToNeutralAndL1L2",
"Line2ToNeutralAndL2L3",
"Line3ToNeutralAndL3L1",
"Total"
],
"enumDescriptions": {
"Line1": "The circuits sharing L1 current-carrying conductor.",
"Line1ToLine2": "The circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Line1ToNeutral": "The circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Line1ToNeutralAndL1L2": "The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.",
"Line2": "The circuits sharing L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire. TwoPhase4Wire, or ThreePhase5Wire.",
"Line2ToLine3": "The circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.",
"Line2ToNeutral": "The circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.",
"Line2ToNeutralAndL1L2": "The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.",
"Line2ToNeutralAndL2L3": "The circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.",
"Line3": "The circuits sharing L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.",
"Line3ToLine1": "The circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.",
"Line3ToNeutral": "The circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.",
"Line3ToNeutralAndL3L1": "The circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.",
"LineToLine": "The circuit formed by two current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"LineToNeutral": "The circuit formed by a line and Neutral current-carrying conductor when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Neutral": "The grounded current-carrying return circuit of current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, or ThreePhase5Wire.",
"Total": "The circuits formed by all current-carrying conductors for any PhaseWiringType."
},
"enumLongDescriptions": {
"Line1": "This property shall contain the circuits sharing L1 current-carrying conductor when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Line1ToLine2": "This property shall contain the circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Line1ToNeutral": "This property shall contain the circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Line1ToNeutralAndL1L2": "This property shall contain the circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.",
"Line2": "This property shall contain the circuits sharing L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire. TwoPhase4Wire, or ThreePhase5Wire.",
"Line2ToLine3": "This property shall contain the circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.",
"Line2ToNeutral": "This property shall contain the circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.",
"Line2ToNeutralAndL1L2": "This property shall contain the circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.",
"Line2ToNeutralAndL2L3": "This property shall contain the circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.",
"Line3": "This property shall contain the circuits sharing L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.",
"Line3ToLine1": "This property shall contain the circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.",
"Line3ToNeutral": "This property shall contain the circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.",
"Line3ToNeutralAndL3L1": "This property shall contain the circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.",
"LineToLine": "This property shall contain the circuit formed by two current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"LineToNeutral": "This property shall contain the circuit formed by a line and Neutral current-carrying conductor when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.",
"Neutral": "This property shall contain the grounded current-carrying return circuit of current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, or ThreePhase5Wire.",
"Total": "This property shall contain the circuits formed by all current-carrying conductors for any PhaseWiringType."
},
"type": "string"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM specific actions for this resource.",
"longDescription": "This type shall contain any additional OEM actions for this resource.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"ReadingType": {
"enum": [
"Temperature",
"Humidity",
"Power",
"EnergykWh",
"EnergyJoules",
"Voltage",
"Current",
"Frequency",
"Pressure",
"LiquidLevel",
"Rotational",
"AirFlow",
"LiquidFlow",
"Barometric",
"Altitude"
],
"enumDescriptions": {
"AirFlow": "Airflow.",
"Altitude": "Altitude.",
"Barometric": "Barometric Pressure.",
"Current": "Current.",
"EnergyJoules": "Energy consumption (Joules).",
"EnergykWh": "Energy consumption (kW/h).",
"Frequency": "Frequency.",
"Humidity": "Relative Humidity.",
"LiquidFlow": "Liquid flow.",
"LiquidLevel": "Liquid level.",
"Power": "Power.",
"Pressure": "Pressure.",
"Rotational": "Rotational.",
"Temperature": "Temperature.",
"Voltage": "Voltage (AC or DC)."
},
"enumLongDescriptions": {
"AirFlow": "The value of the Reading property shall be a measurement of a volume of gas per unit of time that flows through a particular junction. The ReadingUnits shall be 'cft_i/min'.",
"Altitude": "The value of the Reading property shall be a measurement of altitude in meter units and the ReadingUnits value shall be 'm'.",
"Barometric": "the value of the Reading property shall be a measurement of barometric pressure in millimeters of a mercury column and the ReadingUnits value shall be 'mm[Hg]'.",
"Current": "The value of the Reading property shall be a measurement of the root mean square (RMS) of instantaneous current calculated over an integer number of line cycles for a circuit. Current is expressed in Amperes units and the ReadingUnits value shall be 'A'.",
"EnergyJoules": "The value of the Reading property shall indicate the energy consumption (integral of Real Power over time) of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in Joule units and the ReadingUnits value shall be 'J'. This type is used for device-level energy consumption measurements, while EnergykWh is used for large-scale consumption measurements.",
"EnergykWh": "The value of the Reading property shall indicate the energy consumption (integral of Real Power over time) of the monitored item since the sensor statistics were last reset. The value of the Reading property shall be in kilowatt-hour units and the ReadingUnits value shall be 'kW'. This type is used for large-scale energy consumption measurements, while EnergyJoules is used for device-level consumption measurements.",
"Frequency": "The value of the Reading property shall be a frequency measurement in Hertz units and the ReadingUnits value shall be 'Hz'.",
"Humidity": "The value of the Reading property shall be a relative humidity measurement in percent units and the ReadingUnits value shall be '%'.",
"LiquidFlow": "The value of the Reading property shall be a measurement of a volume of liquid per unit of time that flows through a particular junction. The ReadingUnits shall be 'L/s'.",
"LiquidLevel": "The value of the Reading property shall be a measurement of fluid height relative to a specified vertical datum and the ReadingUnits value shall be 'cm'.",
"Power": "The value of the Reading property shall be the arithmetic mean of product terms of instantaneous voltage and current values measured over integer number of line cycles for a circuit in Watt units and the ReadingUnits value shall be 'W'.",
"Pressure": "The value of the Reading property shall be a measurement of force applied perpendicular to the surface of an object per unit area over which that force is distributed. The ReadingUnits shall be 'Pa'.",
"Rotational": "The value of the Reading property shall be a measurement of rotational frequency in Revolutions per Minute unit and the ReadingUnits value shall be 'RPM'.",
"Temperature": "The value of the Reading property shall be a temperature measurement in degrees Celsius units and the ReadingUnits value shall be 'Cel'.",
"Voltage": "The value of the Reading property shall be a measurement of the root mean square (RMS) of instantaneous voltage calculated over an integer number of line cycles for a circuit. Voltage is expressed in Volts units and the ReadingUnits value shall be 'V'."
},
"type": "string"
},
"ResetStatistics": {
"additionalProperties": false,
"description": "This action is used to reset statistics related to this sensor.",
"longDescription": "This action shall perform a reset of any time intervals or counted values for this sensor.",
"parameters": {},
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"target": {
"description": "Link to invoke action",
"format": "uri",
"type": "string"
},
"title": {
"description": "Friendly action name",
"type": "string"
}
},
"type": "object"
},
"Sensor": {
"additionalProperties": false,
"description": "This schema defines a Sensor to be used in conjunction with data center equipment.",
"longDescription": "This resource shall be used to represent resources that represent the sensor data.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
},
"Accuracy": {
"description": "Estimated percent error of measured vs. actual values.",
"longDescription": "The value of this property shall be the percent error +/- of the measured vs. actual values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "The Actions property shall contain the available actions for this resource."
},
"AdjustedMaxAllowableOperatingValue": {
"description": "Adjusted maximum allowable operating value for this equipment based on the current environmental conditions present.",
"longDescription": "The value of this property shall indicate the adjusted maximum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.",
"readonly": true,
"type": [
"number",
"null"
]
},
"AdjustedMinAllowableOperatingValue": {
"description": "Adjusted minimum allowable operating value for this equipment based on the current environmental conditions present.",
"longDescription": "The value of this property shall indicate the adjusted minimum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination, and adjusted based on environmental conditions present. For example, liquid inlet temperature may be adjusted based on the available liquid pressure.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ApparentVA": {
"description": "The product of Voltage and Current for an AC circuit, in Volt-Amperes units.",
"excerpt": "SensorPower",
"longDescription": "This property shall indicate the product of VoltageRMS multiplied by CurrentRMS for a circuit. PowerApparentVA is expressed in Volt-Amperes units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"ElectricalContext": {
"anyOf": [
{
"$ref": "#/definitions/ElectricalContext"
},
{
"type": "null"
}
],
"description": "The combination of current-carrying conductors.",
"longDescription": "This property shall represent the combination of current-carrying conductors that are utilized to distribute power.",
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"LoadPercent": {
"description": "The power load utilization for this Sensor.",
"excerpt": "SensorPower",
"longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Location": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location"
},
{
"type": "null"
}
],
"description": "The location information for this Sensor.",
"longDescription": "This property shall indicate the location information of this Sensor."
},
"MaxAllowableOperatingValue": {
"description": "Maximum allowable operating value for this equipment.",
"longDescription": "The value of this property shall indicate the maximum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination.",
"readonly": true,
"type": [
"number",
"null"
]
},
"MinAllowableOperatingValue": {
"description": "Minimum allowable operating value for this equipment.",
"longDescription": "The value of this property shall indicate the minimum allowable operating value for the equipment monitored by this sensor, as specified by a standards body, manufacturer, or a combination.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"excerpt": "Sensor",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
},
"PeakReading": {
"description": "The peak reading value for this sensor.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be the peak value of the Reading for this sensor during the last interval.",
"readonly": true,
"type": [
"number",
"null"
]
},
"PeakReadingTime": {
"description": "The time at which the Peak Reading value occurred.",
"format": "date-time",
"longDescription": "The value of this property shall the timestamp when the Peak Reading value was observed.",
"readonly": true,
"type": [
"string",
"null"
]
},
"PhysicalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext"
},
{
"type": "null"
}
],
"description": "Describes the area or device to which this sensor measurement applies.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be a description of the affected component or region within the equipment to which this sensor measurement applies.",
"readonly": true
},
"PhysicalSubContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalSubContext"
},
{
"type": "null"
}
],
"description": "Describes the usage or location within a device to which this sensor measurement applies.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property is generally used to differentiate multiple sensors within the same instance of a PhysicalContext.",
"readonly": true
},
"PowerFactor": {
"description": "The power factor for this Sensor.",
"excerpt": "SensorPower",
"longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"maximum": 1,
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
]
},
"Precision": {
"description": "Number of significant digits in the Reading.",
"longDescription": "The value of this property shall specify the number of significant digits in the Reading.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReactiveVAR": {
"description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, expressed in VAR units.",
"excerpt": "SensorPower",
"longDescription": "This property shall indicate the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. PowerReactiveVAR is expressed in VAR units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Reading": {
"description": "The present value for this Sensor.",
"excerpt": "Sensor",
"longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingRangeMax": {
"description": "The maximum value of Reading possible for this Sensor.",
"longDescription": "This property shall indicate the Max Reading Range information of this Sensor. This is the range of valid readings for this sensor. Values outside this range are discarded as reading errors.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingRangeMin": {
"description": "The minimum value of Reading possible for this Sensor.",
"longDescription": "This property shall indicate the Min Reading Range information of this Sensor. This is the range of valid readings for this sensor. Values outside this range are discarded as reading errors.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingType": {
"anyOf": [
{
"$ref": "#/definitions/ReadingType"
},
{
"type": "null"
}
],
"description": "The kind of sensor being represented.",
"longDescription": "This property shall indicate the type of the sensor being represented.",
"readonly": true
},
"ReadingUnits": {
"description": "Units in which the reading and thresholds are measured.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be the units in which the sensor's reading and thresholds are measured.",
"readonly": true,
"type": [
"string",
"null"
]
},
"SensingFrequency": {
"description": "The time interval between readings of the physical sensor.",
"longDescription": "The value of this property shall the time interval between reading the physical sensor.",
"readonly": true,
"type": [
"number",
"null"
]
},
"SensorResetTime": {
"description": "The time at which the time-based properties were last reset.",
"format": "date-time",
"longDescription": "The value of this property shall be the timestamp when the time-based property values were last reset by the user or the service.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "This property describes the status and health of the resource and its children.",
"excerpt": "Sensor",
"longDescription": "This property shall contain any status or health properties of the resource."
},
"Thresholds": {
"anyOf": [
{
"$ref": "#/definitions/Thresholds"
},
{
"type": "null"
}
],
"description": "The set of thresholds defined for this sensor.",
"longDescription": "This property shall contain the set of thresholds that are used to derive a sensor's health and operational range."
},
"VoltageType": {
"anyOf": [
{
"$ref": "#/definitions/VoltageType"
},
{
"type": "null"
}
],
"description": "The voltage type (AC or DC) for this sensor.",
"longDescription": "This property shall represent the type of input voltage the sensor monitors. Please use AC for alternating current and DC for direct current.",
"readonly": true
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"SensorExcerpt": {
"additionalProperties": false,
"description": "This schema defines a Sensor to be used in conjunction with data center equipment.",
"excerpt": "Sensor",
"longDescription": "This resource shall be used to represent resources that represent the sensor data.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"DataSourceUri": {
"description": "A link to the resource that provides the data for this object.",
"excerptCopyOnly": true,
"format": "uri",
"longDescription": "This property shall contain a URI to the resource that provides the source of the schema Excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"excerpt": "Sensor",
"readonly": true
},
"PeakReading": {
"description": "The peak reading value for this sensor.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be the peak value of the Reading for this sensor during the last interval.",
"readonly": true,
"type": [
"number",
"null"
]
},
"PhysicalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext"
},
{
"type": "null"
}
],
"description": "Describes the area or device to which this sensor measurement applies.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be a description of the affected component or region within the equipment to which this sensor measurement applies.",
"readonly": true
},
"PhysicalSubContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalSubContext"
},
{
"type": "null"
}
],
"description": "Describes the usage or location within a device to which this sensor measurement applies.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property is generally used to differentiate multiple sensors within the same instance of a PhysicalContext.",
"readonly": true
},
"Reading": {
"description": "The present value for this Sensor.",
"excerpt": "Sensor",
"longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingUnits": {
"description": "Units in which the reading and thresholds are measured.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be the units in which the sensor's reading and thresholds are measured.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "This property describes the status and health of the resource and its children.",
"excerpt": "Sensor",
"longDescription": "This property shall contain any status or health properties of the resource."
}
},
"required": [
"Name"
],
"type": "object"
},
"SensorPowerExcerpt": {
"additionalProperties": false,
"description": "This schema defines a Sensor to be used in conjunction with data center equipment.",
"excerpt": "SensorPower",
"longDescription": "This resource shall be used to represent resources that represent the sensor data.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"ApparentVA": {
"description": "The product of Voltage and Current for an AC circuit, in Volt-Amperes units.",
"excerpt": "SensorPower",
"longDescription": "This property shall indicate the product of VoltageRMS multiplied by CurrentRMS for a circuit. PowerApparentVA is expressed in Volt-Amperes units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"DataSourceUri": {
"description": "A link to the resource that provides the data for this object.",
"excerptCopyOnly": true,
"format": "uri",
"longDescription": "This property shall contain a URI to the resource that provides the source of the schema Excerpt contained within this copy.",
"readonly": true,
"type": [
"string",
"null"
]
},
"LoadPercent": {
"description": "The power load utilization for this Sensor.",
"excerpt": "SensorPower",
"longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"excerpt": "Sensor",
"readonly": true
},
"PeakReading": {
"description": "The peak reading value for this sensor.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be the peak value of the Reading for this sensor during the last interval.",
"readonly": true,
"type": [
"number",
"null"
]
},
"PhysicalContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalContext"
},
{
"type": "null"
}
],
"description": "Describes the area or device to which this sensor measurement applies.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be a description of the affected component or region within the equipment to which this sensor measurement applies.",
"readonly": true
},
"PhysicalSubContext": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/PhysicalContext.json#/definitions/PhysicalSubContext"
},
{
"type": "null"
}
],
"description": "Describes the usage or location within a device to which this sensor measurement applies.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be a description of the usage or sub-region within the equipment to which this sensor measurement applies. This property is generally used to differentiate multiple sensors within the same instance of a PhysicalContext.",
"readonly": true
},
"PowerFactor": {
"description": "The power factor for this Sensor.",
"excerpt": "SensorPower",
"longDescription": "This property shall identify the quotient of PowerRealWatts and PowerApparentVA for a circuit. PowerFactor is expressed in unit-less 1/100ths. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"maximum": 1,
"minimum": 0,
"readonly": true,
"type": [
"number",
"null"
]
},
"ReactiveVAR": {
"description": "The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, expressed in VAR units.",
"excerpt": "SensorPower",
"longDescription": "This property shall indicate the arithmetic mean of product terms of instantaneous voltage and quadrature current measurements calculated over an integer number of line cycles for a circuit. PowerReactiveVAR is expressed in VAR units using the ReadingUnits value of 'V'. This property may appear in sensors of ReadingType of Power, and shall not appear in sensors of other ReadingType values.",
"readonly": true,
"type": [
"number",
"null"
]
},
"Reading": {
"description": "The present value for this Sensor.",
"excerpt": "Sensor",
"longDescription": "This property shall indicate the present value of this Sensor at the time the information request occurred.",
"readonly": true,
"type": [
"number",
"null"
]
},
"ReadingUnits": {
"description": "Units in which the reading and thresholds are measured.",
"excerpt": "Sensor",
"longDescription": "The value of this property shall be the units in which the sensor's reading and thresholds are measured.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "This property describes the status and health of the resource and its children.",
"excerpt": "Sensor",
"longDescription": "This property shall contain any status or health properties of the resource."
}
},
"required": [
"Name"
],
"type": "object"
},
"Threshold": {
"additionalProperties": false,
"description": "A threshold definition for a sensor.",
"longDescription": "This type shall contain the properties for an individual threshold for this sensor.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Activation": {
"anyOf": [
{
"$ref": "#/definitions/ThresholdActivation"
},
{
"type": "null"
}
],
"description": "The direction of crossing that activates this threshold.",
"longDescription": "This property shall indicate the direction of crossing of the Reading value for this Sensor that triggers the threshold.",
"readonly": false
},
"DwellTime": {
"description": "The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.",
"longDescription": "This property shall indicate the time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.",
"pattern": "-?P(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?",
"readonly": false,
"type": [
"string",
"null"
]
},
"Reading": {
"description": "The threshold value.",
"longDescription": "This property shall indicate the Reading value of this Sensor that triggers the threshold. The units of this property shall follow the Reading and ReadingUnits of this sensor.",
"readonly": false,
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"ThresholdActivation": {
"enum": [
"Increasing",
"Decreasing",
"Either"
],
"enumDescriptions": {
"Decreasing": "Value decreases below the threshold.",
"Either": "Value crosses the threshold in either direction.",
"Increasing": "Value increases above the threshold."
},
"enumLongDescriptions": {
"Decreasing": "This threshold is activated when the value of Reading changes from a value higher than the threshold to a value lower than the threshold.",
"Either": "This threshold is activated when either the Increasing or Decreasing conditions are met.",
"Increasing": "This threshold is activated when the value of Reading changes from a value lower than the threshold to a value higher than the threshold."
},
"type": "string"
},
"Thresholds": {
"additionalProperties": false,
"description": "The set of thresholds defined for a sensor.",
"longDescription": "This object shall contain the set of thresholds that are used to derive a sensor's health and operational range.",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"LowerCaution": {
"anyOf": [
{
"$ref": "#/definitions/Threshold"
},
{
"type": "null"
}
],
"description": "Below normal range.",
"longDescription": "The value of this property shall indicate the Reading is below the normal range. The units shall be the same units as the Reading."
},
"LowerCritical": {
"anyOf": [
{
"$ref": "#/definitions/Threshold"
},
{
"type": "null"
}
],
"description": "Below normal range but not yet fatal.",
"longDescription": "The value of this property shall indicate the Reading is below the normal range and but is not yet fatal. The units shall be the same units as the Reading."
},
"LowerFatal": {
"anyOf": [
{
"$ref": "#/definitions/Threshold"
},
{
"type": "null"
}
],
"description": "Below normal range and fatal.",
"longDescription": "The value of this property shall indicate the Reading is below the normal range and is fatal. The units shall be the same units as the Reading."
},
"UpperCaution": {
"anyOf": [
{
"$ref": "#/definitions/Threshold"
},
{
"type": "null"
}
],
"description": "Above normal range.",
"longDescription": "The value of this property shall indicate the Reading is above the normal range. The units shall be the same units as the Reading."
},
"UpperCritical": {
"anyOf": [
{
"$ref": "#/definitions/Threshold"
},
{
"type": "null"
}
],
"description": "Above normal range but not yet fatal.",
"longDescription": "The value of this property shall indicate the Reading is above the normal range and but is not yet fatal. The units shall be the same units as the Reading."
},
"UpperFatal": {
"anyOf": [
{
"$ref": "#/definitions/Threshold"
},
{
"type": "null"
}
],
"description": "Above normal range and fatal.",
"longDescription": "The value of this property shall indicate the Reading is above the normal range and is fatal. The units shall be the same units as the Reading."
}
},
"type": "object"
},
"VoltageType": {
"enum": [
"AC",
"DC"
],
"enumDescriptions": {
"AC": "Alternating Current.",
"DC": "Direct Current."
},
"type": "string"
}
},
"owningEntity": "DMTF",
"release": "2018.3",
"title": "#Sensor.v1_0_0.Sensor"
}
|
