blob: 4ea0ea54b68ff0ed4ce3389028f08b6cc69fe3c6 [file] [log] [blame]
Gunnar Mills09b9d452020-02-11 13:27:39 -06001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: OutletGroup v1.0.0 -->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2018-2019 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24 <edmx:Include Namespace="Resource"/>
25 <edmx:Include Namespace="Resource.v1_0_0"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Sensor_v1.xml">
28 <edmx:Include Namespace="Sensor"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Circuit_v1.xml">
31 <edmx:Include Namespace="Circuit"/>
32 </edmx:Reference>
33 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Outlet_v1.xml">
34 <edmx:Include Namespace="Outlet"/>
35 </edmx:Reference>
36
37 <edmx:DataServices>
38
39 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OutletGroup">
40 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41
42 <EntityType Name="OutletGroup" BaseType="Resource.v1_0_0.Resource" Abstract="true">
43 <Annotation Term="OData.Description" String="This is the schema definition for an electrical outlet group."/>
44 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent an electrical outlet group for a Redfish implementation."/>
45 <Annotation Term="Capabilities.InsertRestrictions">
46 <Record>
47 <PropertyValue Property="Insertable" Bool="false"/>
48 </Record>
49 </Annotation>
50 <Annotation Term="Capabilities.UpdateRestrictions">
51 <Record>
52 <PropertyValue Property="Updatable" Bool="true"/>
53 <Annotation Term="OData.Description" String="Outlet group properties can be updated to change limits, exceptions and other writable properties."/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Capabilities.DeleteRestrictions">
57 <Record>
58 <PropertyValue Property="Deletable" Bool="true"/>
59 <Annotation Term="OData.Description" String="Some implementations may allow outlet groups to be deleted."/>
60 </Record>
61 </Annotation>
62 <Annotation Term="Redfish.Uris">
63 <Collection>
64 <String>/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/OutletGroups/{OutletGroupId}</String>
65 <String>/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/OutletGroups/{OutletGroupId}</String>
66 </Collection>
67 </Annotation>
68 </EntityType>
69
70 <Action Name="PowerControl" IsBound="true">
71 <Parameter Name="OutletGroup" Type="OutletGroup.v1_0_0.Actions"/>
72 <Parameter Name="PowerState" Type="OutletGroup.PowerState">
73 <Annotation Term="OData.Description" String="The desired power state of the outlet group."/>
74 <Annotation Term="OData.LongDescription" String="This parameter shall contain the desired power state of the OutletGroup."/>
75 </Parameter>
76 <Annotation Term="OData.Description" String="This action turns the outlet group on or off."/>
77 <Annotation Term="OData.LongDescription" String="This action shall control the power state of the outlet group."/>
78 </Action>
79
80 <Action Name="ResetMetrics" IsBound="true">
81 <Parameter Name="OutletGroup" Type="OutletGroup.v1_0_0.Actions"/>
82 <Annotation Term="OData.Description" String="This action resets metrics related to this outlet group."/>
83 <Annotation Term="OData.LongDescription" String="This action shall reset any time intervals or counted values for this outlet group."/>
84 </Action>
85
86 <EnumType Name="PowerState">
87 <Member Name="On">
88 <Annotation Term="OData.Description" String="The outlet group is powered on."/>
89 </Member>
90 <Member Name="Off">
91 <Annotation Term="OData.Description" String="The outlet group is powered off."/>
92 </Member>
93 </EnumType>
94
95 </Schema>
96
97 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OutletGroup.v1_0_0">
98 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
99 <Annotation Term="Redfish.Release" String="2019.4"/>
100
101 <EntityType Name="OutletGroup" BaseType="OutletGroup.OutletGroup">
102 <Property Name="Status" Type="Resource.Status" Nullable="false">
103 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
104 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
105 </Property>
106 <Property Name="CreatedBy" Type="Edm.String">
107 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
108 <Annotation Term="OData.Description" String="The creator of this outlet group."/>
109 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the person or application that created this outlet group."/>
110 </Property>
111 <Property Name="PowerOnDelaySeconds" Type="Edm.Decimal">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
113 <Annotation Term="OData.Description" String="The number of seconds to delay power up after a power cycle or a PowerControl action. Zero seconds indicates no delay to power up."/>
114 <Annotation Term="OData.LongDescription" String="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."/>
115 </Property>
116 <Property Name="PowerOffDelaySeconds" Type="Edm.Decimal">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
118 <Annotation Term="OData.Description" String="The number of seconds to delay power off after a PowerControl action. Zero seconds indicates no delay to power off."/>
119 <Annotation Term="OData.LongDescription" String="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."/>
120 </Property>
121 <Property Name="PowerCycleDelaySeconds" Type="Edm.Decimal">
122 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
123 <Annotation Term="OData.Description" String="The number of seconds to delay power on after a PowerControl action to cycle power. Zero seconds indicates no delay."/>
124 <Annotation Term="OData.LongDescription" String="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."/>
125 </Property>
126 <Property Name="PowerRestoreDelaySeconds" Type="Edm.Decimal">
127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
128 <Annotation Term="OData.Description" String="The number of seconds to delay power on after power has been restored. Zero seconds indicates no delay."/>
129 <Annotation Term="OData.LongDescription" String="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."/>
130 </Property>
131 <Property Name="PowerRestorePolicy" Type="Circuit.PowerRestorePolicyTypes" Nullable="false">
132 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
133 <Annotation Term="OData.Description" String="The desired power state of the outlet group when power is restored after a power loss."/>
134 <Annotation Term="OData.LongDescription" String="This property shall contain the desired PowerState of the outlet group when power is applied. The value `LastState` shall return the outlet group to the PowerState it was in when power was lost."/>
135 </Property>
136 <Property Name="PowerState" Type="Resource.PowerState">
137 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
138 <Annotation Term="OData.Description" String="The power state of the outlet group."/>
139 <Annotation Term="OData.LongDescription" String="This property shall contain the power state of the outlet group."/>
140 </Property>
141 <Property Name="PowerEnabled" Type="Edm.Boolean">
142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
143 <Annotation Term="OData.Description" String="Indicates if the outlet group can be powered."/>
144 <Annotation Term="OData.LongDescription" String="This property shall contain the power enable state of the outlet group. True shall indicate that the group may be powered on, and false shall indicate that the group cannot be powered."/>
145 </Property>
146
147 <NavigationProperty Name="PowerWatts" Type="Sensor.Sensor">
148 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
149 <Annotation Term="Redfish.ExcerptCopy" String="Power"/>
150 <Annotation Term="OData.Description" String="The power reading for this outlet group."/>
151 <Annotation Term="OData.LongDescription" String="This property shall contain the total power, measured in Watts, for this outlet group, that represents the `Total` ElectricalContext sensor when multiple power sensors exist for this outlet group."/>
152 </NavigationProperty>
153 <NavigationProperty Name="EnergykWh" Type="Sensor.Sensor">
154 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
155 <Annotation Term="Redfish.ExcerptCopy" String="EnergykWh"/>
156 <Annotation Term="OData.Description" String="The energy reading for this outlet group."/>
157 <Annotation Term="OData.LongDescription" String="This property shall contain the total energy, measured in kilowatt-hours (kW.h), for this outlet group, that represents the `Total` ElectricalContext sensor when multiple energy sensors exist for this outlet group."/>
158 </NavigationProperty>
159
160 <Property Name="Links" Type="OutletGroup.v1_0_0.Links" Nullable="false">
161 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
162 <Annotation Term="OData.LongDescription" String="This property shall contain links to resources that are related to but are not contained by or subordinate to this resource."/>
163 </Property>
164 <Property Name="Actions" Type="OutletGroup.v1_0_0.Actions" Nullable="false">
165 <Annotation Term="OData.Description" String="The available actions for this resource."/>
166 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
167 </Property>
168 </EntityType>
169
170 <ComplexType Name="Links" BaseType="Resource.Links">
171 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
172 <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by or subordinate to this resource."/>
173 <NavigationProperty Name="Outlets" Type="Collection(Outlet.Outlet)" ContainsTarget="true">
174 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
175 <Annotation Term="OData.Description" String="The set of outlets in this outlet group."/>
176 <Annotation Term="OData.LongDescription" String="This property shall be an array of links to resources of type Outlet that represent the outlets in this outlet group."/>
177 <Annotation Term="OData.AutoExpandReferences"/>
178 </NavigationProperty>
179 </ComplexType>
180
181 <ComplexType Name="Actions">
182 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
183 <Annotation Term="OData.Description" String="The available actions for this resource."/>
184 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
185 <Property Name="Oem" Type="OutletGroup.v1_0_0.OemActions" Nullable="false">
186 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
187 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
188 </Property>
189 </ComplexType>
190
191 <ComplexType Name="OemActions">
192 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
193 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
194 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
195 </ComplexType>
196
197 </Schema>
198
199 </edmx:DataServices>
200</edmx:Edmx>