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
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/HostInterface.v1_3_0.json",
"$ref": "#/definitions/HostInterface",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2020 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": {
"Oem": {
"$ref": "#/definitions/OemActions",
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This property shall contain the available OEM-specific actions for this Resource.",
"versionAdded": "v1_1_0"
}
},
"type": "object"
},
"AuthenticationMode": {
"enum": [
"AuthNone",
"BasicAuth",
"RedfishSessionAuth",
"OemAuth"
],
"enumDescriptions": {
"AuthNone": "Requests without any sort of authentication are allowed.",
"BasicAuth": "Requests using HTTP Basic Authentication are allowed.",
"OemAuth": "Requests using OEM authentication mechanisms are allowed.",
"RedfishSessionAuth": "Requests using Redfish Session Authentication are allowed."
},
"type": "string"
},
"CredentialBootstrapping": {
"additionalProperties": false,
"description": "The credential bootstrapping settings for this interface.",
"longDescription": "This type shall contain settings for the Redfish Host Interface Specification-defined 'credential bootstrapping via IPMI commands' feature for this interface.",
"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": {
"EnableAfterReset": {
"description": "An indication of whether credential bootstrapping is enabled after a reset for this interface.",
"longDescription": "This property shall indicate whether credential bootstrapping is enabled after a reset for this interface. If `true`, services shall set the Enabled property to `true` after a reset of the host or the service.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_3_0"
},
"Enabled": {
"description": "An indication of whether credential bootstrapping is enabled for this interface.",
"longDescription": "This property shall indicate whether credential bootstrapping is enabled for this interface.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionAdded": "v1_3_0"
},
"RoleId": {
"description": "The role used for the bootstrap account created for this interface.",
"longDescription": "This property shall contain the Id property of the role resource that is used for the bootstrap account created for this interface.",
"readonly": false,
"type": "string",
"versionAdded": "v1_3_0"
}
},
"type": "object"
},
"HostInterface": {
"additionalProperties": false,
"description": "The properties associated with a Host Interface. A Host Interface is a connection between host software and a Redfish Service.",
"longDescription": "This Resource shall represent a Host Interface as part of the Redfish Specification.",
"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.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this Resource.",
"longDescription": "This property shall contain the available actions for this Resource.",
"versionAdded": "v1_1_0"
},
"AuthNoneRoleId": {
"description": "The role when no authentication on this interface is used.",
"longDescription": "This property shall contain the Id property of the Role Resource that is used when no authentication on this interface is performed. This property shall contain absent if AuthNone is not supported by the service for the AuthenticationModes property.",
"readonly": false,
"type": "string",
"versionAdded": "v1_2_0"
},
"AuthenticationModes": {
"description": "The authentication modes available on this interface.",
"items": {
"$ref": "#/definitions/AuthenticationMode"
},
"longDescription": "This property shall contain an array consisting of the authentication modes allowed on this interface.",
"readonly": false,
"type": "array"
},
"CredentialBootstrapping": {
"$ref": "#/definitions/CredentialBootstrapping",
"description": "The credential bootstrapping settings for this interface.",
"longDescription": "This property shall contain settings for the Redfish Host Interface Specification-defined 'credential bootstrapping via IPMI commands' feature for this interface. This property shall be absent if credential bootstrapping is not supported by the service.",
"versionAdded": "v1_3_0"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"ExternallyAccessible": {
"description": "An indication of whether external entities can access this interface. External entities are non-host entities. For example, if the host and manager are connected through a switch and the switch also exposes an external port on the system, external clients can also use the interface, and this property value is `true`.",
"longDescription": "This property shall indicate whether external entities can access this interface. External entities are non-host entities. For example, if the host and manager are connected through a switch and the switch also exposes an external port on the system, external clients can also use the interface, and this property value is `true`.",
"readonly": true,
"type": [
"boolean",
"null"
]
},
"FirmwareAuthEnabled": {
"deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.",
"description": "An indication of whether this firmware authentication is enabled for this interface.",
"longDescription": "This property shall indicate whether firmware authentication is enabled for this interface.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionDeprecated": "v1_3_0"
},
"FirmwareAuthRoleId": {
"deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.",
"description": "The Role used for firmware authentication on this interface.",
"longDescription": "This property shall contain the Id property of the Role Resource that is configured for firmware authentication on this interface.",
"readonly": false,
"type": "string",
"versionDeprecated": "v1_3_0"
},
"HostEthernetInterfaces": {
"$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection",
"description": "A link to the collection of network interface controllers or cards (NICs) that a computer system uses to communicate with this Host Interface.",
"longDescription": "This property shall contain a link to a Resource Collection of type EthernetInterface that computer systems use as the Host Interface to this manager.",
"readonly": true
},
"HostInterfaceType": {
"anyOf": [
{
"$ref": "#/definitions/HostInterfaceType"
},
{
"type": "null"
}
],
"description": "The Host Interface type for this interface.",
"longDescription": "This property shall contain an enumeration that describes the type of the interface.",
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"InterfaceEnabled": {
"description": "An indication of whether this interface is enabled.",
"longDescription": "This property shall indicate whether this interface is enabled.",
"readonly": false,
"type": [
"boolean",
"null"
]
},
"KernelAuthEnabled": {
"deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.",
"description": "An indication of whether this kernel authentication is enabled for this interface.",
"longDescription": "This property shall indicate whether kernel authentication is enabled for this interface.",
"readonly": false,
"type": [
"boolean",
"null"
],
"versionDeprecated": "v1_3_0"
},
"KernelAuthRoleId": {
"deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.",
"description": "The Role used for kernel authentication on this interface.",
"longDescription": "This property shall contain the Id property of the Role Resource that is configured for kernel authentication on this interface.",
"readonly": false,
"type": "string",
"versionDeprecated": "v1_3_0"
},
"Links": {
"$ref": "#/definitions/Links",
"description": "The links to other Resources that are related to this Resource.",
"longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource."
},
"ManagerEthernetInterface": {
"$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface",
"description": "A link to a single network interface controllers or cards (NIC) that this manager uses for network communication with this Host Interface.",
"longDescription": "This property shall contain a link to a Resource of type EthernetInterface that represents the network interface that this manager uses as the Host Interface.",
"readonly": true
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"NetworkProtocol": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.json#/definitions/ManagerNetworkProtocol",
"description": "A link to the network services and their settings that the manager controls. In this property, clients find configuration options for the network and network services.",
"longDescription": "This property shall contain a link to a Resource of type ManagerNetworkProtocol that represents the network services for this manager.",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
},
"Status": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
"description": "The status and health of the Resource and its subordinate or dependent Resources.",
"longDescription": "This property shall contain any status or health properties of the Resource."
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"HostInterfaceType": {
"enum": [
"NetworkHostInterface"
],
"enumDescriptions": {
"NetworkHostInterface": "This interface is a Network Host Interface."
},
"type": "string"
},
"Links": {
"additionalProperties": false,
"description": "References to other Resources related to this Resource.",
"longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to 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": {
"AuthNoneRole": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role",
"description": "The link to the Redfish Role that contains the privileges on this Host Interface when no authentication is performed.",
"longDescription": "This property shall contain a link to a Resource of type Role, and should link to the Resource identified by property AuthNoneRoleId. This property shall be absent if AuthNone is not supported by the service for the AuthenticationModes property.",
"readonly": true,
"versionAdded": "v1_2_0"
},
"ComputerSystems": {
"description": "An array of links to the computer systems connected to this Host Interface.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
},
"longDescription": "This property shall contain an array of links to Resources of the ComputerSystem type that are connected to this Host Interface.",
"readonly": true,
"type": "array"
},
"ComputerSystems@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
},
"CredentialBootstrappingRole": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role",
"description": "The link to the role that contains the privileges for the bootstrap account created for this interface.",
"longDescription": "This property shall contain a link to a resource of type Role, and should link to the resource identified by the RoleId property within CredentialBootstrapping. This property shall be absent if the Redfish Host Interface Specification-defined 'credential bootstrapping via IPMI commands' feature is not supported by the service.",
"readonly": true,
"versionAdded": "v1_3_0"
},
"FirmwareAuthRole": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role",
"deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.",
"description": "The link to the Redfish Role that has firmware authentication privileges on this Host Interface.",
"longDescription": "This property shall contain a link to a Resource of type Role, and should link to the Resource identified by property FirmwareAuthRoleId.",
"readonly": true,
"versionDeprecated": "v1_3_0"
},
"KernelAuthRole": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role",
"deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.",
"description": "The link to the Redfish Role defining privileges for this Host Interface when using kernel authentication.",
"longDescription": "This property shall contain a link to a Resource of type Role, and should link to the Resource identified by property KernelAuthRoleId.",
"readonly": true,
"versionDeprecated": "v1_3_0"
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
"description": "The OEM extension property.",
"longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"description": "The available OEM-specific actions for this Resource.",
"longDescription": "This type shall contain the available OEM-specific 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"
}
},
"owningEntity": "DMTF",
"release": "2020.3",
"title": "#HostInterface.v1_3_0.HostInterface"
}
|
