blob: 0b3f690b3a333800b0b411d51a9bf8063de6786c [file] [log] [blame]
Ed Tanous710adfc2017-10-24 17:04:52 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: HostInterface 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 2014-2016 Distributed Management Task Force, Inc. (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/ComputerSystem_v1.xml">
28 <edmx:Include Namespace="ComputerSystem"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/EthernetInterface_v1.xml">
31 <edmx:Include Namespace="EthernetInterface"/>
32 </edmx:Reference>
33 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection_v1.xml">
34 <edmx:Include Namespace="EthernetInterfaceCollection"/>
35 </edmx:Reference>
36 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol_v1.xml">
37 <edmx:Include Namespace="ManagerNetworkProtocol"/>
38 </edmx:Reference>
39 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Role_v1.xml">
40 <edmx:Include Namespace="Role"/>
41 </edmx:Reference>
42
43 <edmx:DataServices>
44
45 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="HostInterface">
46
47 <EntityType Name="HostInterface" BaseType="Resource.v1_0_0.Resource" Abstract="true">
48 <Annotation Term="OData.Description" String="Contains the properties needed to describe and configure a single, Host Interface."/>
49 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent Host Interface resources as part of the Redfish specification."/>
50 <Annotation Term="Capabilities.InsertRestrictions">
51 <Record>
52 <PropertyValue Property="Insertable" Bool="false"/>
53 </Record>
54 </Annotation>
55 <Annotation Term="Capabilities.UpdateRestrictions">
56 <Record>
57 <PropertyValue Property="Updatable" Bool="true"/>
58 <Annotation Term="OData.Description" String="A Host Interface can be updated to change authentication settings and other writable properties."/>
59 </Record>
60 </Annotation>
61 <Annotation Term="Capabilities.DeleteRestrictions">
62 <Record>
63 <PropertyValue Property="Deletable" Bool="false"/>
64 </Record>
65 </Annotation>
66 </EntityType>
67
68 </Schema>
69
70 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="HostInterface.v1_0_0">
71
72 <EntityType Name="HostInterface" BaseType="HostInterface.HostInterface">
73 <Annotation Term="OData.Description" String="This schema defines a Host Interface resource."/>
74 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent Host Interface resources as part of the Redfish specification."/>
75 <Property Name="HostInterfaceType" Type="HostInterface.v1_0_0.HostInterfaceType">
76 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
77 <Annotation Term="OData.Description" String="This indicates the Host Interface type for this interface."/>
78 <Annotation Term="OData.LongDescription" String="The value of this property shall be an enumeration describing type of the interface."/>
79 </Property>
80 <Property Name="Status" Type="Resource.Status"/>
81 <Property Name="InterfaceEnabled" Type="Edm.Boolean">
82 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
83 <Annotation Term="OData.Description" String="This indicates whether this interface is enabled."/>
84 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this interface is enabled."/>
85 </Property>
86 <Property Name="ExternallyAccessible" Type="Edm.Boolean">
87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
88 <Annotation Term="OData.Description" String="This indicates whether this interface is accessible by external entities."/>
89 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this interface is accessible by external (non-host) entities."/>
90 </Property>
91 <Property Name="AuthenticationModes" Type="Collection(HostInterface.v1_0_0.AuthenticationMode)" Nullable="false">
92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
93 <Annotation Term="OData.Description" String="This indicates the authentication modes available on this interface."/>
94 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array consisting of the authentication modes allowed on this interface."/>
95 </Property>
96 <Property Name="KernelAuthRoleId" Type="Edm.String" Nullable="false">
97 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
98 <Annotation Term="OData.Description" String="This property contains the Role for kernel authentication on this interface."/>
99 <Annotation Term="OData.LongDescription" String="The value of this property shall be the ID of the Role resource that is configured for kernel authentication on this interface."/>
100 </Property>
101 <Property Name="KernelAuthEnabled" Type="Edm.Boolean">
102 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
103 <Annotation Term="OData.Description" String="This indicates whether this kernel authentication is enabled for this interface."/>
104 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether kernel authentication for this interface is enabled."/>
105 </Property>
106 <Property Name="FirmwareAuthRoleId" Type="Edm.String" Nullable="false">
107 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
108 <Annotation Term="OData.Description" String="This property contains the Role for firmware authentication on this interface."/>
109 <Annotation Term="OData.LongDescription" String="The value of this property shall be the ID of the Role resource that is configured for firmware authentication on this interface."/>
110 </Property>
111 <Property Name="FirmwareAuthEnabled" Type="Edm.Boolean">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
113 <Annotation Term="OData.Description" String="This indicates whether this firmware authentication is enabled for this interface."/>
114 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether firmware authentication for this interface is enabled."/>
115 </Property>
116
117 <NavigationProperty Name="HostEthernetInterfaces" Type="EthernetInterfaceCollection.EthernetInterfaceCollection" Nullable="false">
118 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
119 <Annotation Term="OData.Description" String="This is a reference to a collection of NICs that Computer Systems use for network communication with this Host Interface."/>
120 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a collection of type EthernetInterfaceCollection that Computer Systems use as the Host Interface to this Manager."/>
121 <Annotation Term="OData.AutoExpandReferences"/>
122 </NavigationProperty>
123 <NavigationProperty Name="ManagerEthernetInterface" Type="EthernetInterface.EthernetInterface" Nullable="false">
124 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
125 <Annotation Term="OData.Description" String="This is a reference to a single NIC that this Manager uses for network communication with this Host Interface."/>
126 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type EthernetInterface which represents the network interface used by this Manager as the HostInterface."/>
127 <Annotation Term="OData.AutoExpandReferences"/>
128 </NavigationProperty>
129 <NavigationProperty Name="NetworkProtocol" Type="ManagerNetworkProtocol.ManagerNetworkProtocol" Nullable="false">
130 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
131 <Annotation Term="OData.Description" String="This is a reference to the network services and their settings that the Manager controls. It is here that clients will find network configuration options as well as network services."/>
132 <Annotation Term="OData.LongDescription" String="The value of this property shall contain a reference to a resource of type ManagerNetworkProtocol which represents the network services for this Manager."/>
133 <Annotation Term="OData.AutoExpandReferences"/>
134 </NavigationProperty>
135
136 <Property Name="Links" Type="HostInterface.v1_0_0.Links" Nullable="false">
137 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
138 <Annotation Term="OData.LongDescription" String="The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."/>
139 </Property>
140 </EntityType>
141
142 <EnumType Name="HostInterfaceType">
143 <Member Name="NetworkHostInterface">
144 <Annotation Term="OData.Description" String="This interface is a Network Host Interface."/>
145 </Member>
146 </EnumType>
147
148 <EnumType Name="AuthenticationMode">
149 <Member Name="AuthNone">
150 <Annotation Term="OData.Description" String="Requests without any sort of authentication are allowed."/>
151 </Member>
152 <Member Name="BasicAuth">
153 <Annotation Term="OData.Description" String="Requests using HTTP Basic Authentication are allowed."/>
154 </Member>
155 <Member Name="RedfishSessionAuth">
156 <Annotation Term="OData.Description" String="Requests using Redfish Session Authentication are allowed."/>
157 </Member>
158 <Member Name="OemAuth">
159 <Annotation Term="OData.Description" String="Requests using OEM authentication mechanisms are allowed."/>
160 </Member>
161 </EnumType>
162
163 <ComplexType Name="Links" BaseType="Resource.Links">
164 <NavigationProperty Name="ComputerSystems" Type="Collection(ComputerSystem.ComputerSystem)" Nullable="false">
165 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
166 <Annotation Term="OData.Description" String="An array of references to the Computer Systems connected to this Host Interface."/>
167 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of references to resources of type ComputerSystem that are connected to this HostInterface."/>
168 <Annotation Term="OData.AutoExpandReferences"/>
169 </NavigationProperty>
170 <NavigationProperty Name="KernelAuthRole" Type="Role.Role" Nullable="false">
171 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
172 <Annotation Term="OData.Description" String="A reference to the Role object defining Privileges for this Host Interface when using kernel authentication."/>
173 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a Role object instance, and should reference the object identified by property KernelAuthRoleId."/>
174 <Annotation Term="OData.AutoExpandReferences"/>
175 </NavigationProperty>
176 <NavigationProperty Name="FirmwareAuthRole" Type="Role.Role" Nullable="false">
177 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
178 <Annotation Term="OData.Description" String="A reference to the Role object defining Privileges for this Host Interface when using firmware authentication."/>
179 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a Role object instance, and should reference the object identified by property FirmwareAuthRoleId."/>
180 <Annotation Term="OData.AutoExpandReferences"/>
181 </NavigationProperty>
182 </ComplexType>
183
184 </Schema>
185
186 </edmx:DataServices>
187</edmx:Edmx>