1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/HostInterface.v1_3_2.json", 3 "$ref": "#/definitions/HostInterface", 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 "Oem": { 27 "$ref": "#/definitions/OemActions", 28 "description": "The available OEM-specific actions for this resource.", 29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.", 30 "versionAdded": "v1_1_0" 31 } 32 }, 33 "type": "object" 34 }, 35 "AuthenticationMode": { 36 "enum": [ 37 "AuthNone", 38 "BasicAuth", 39 "RedfishSessionAuth", 40 "OemAuth" 41 ], 42 "enumDescriptions": { 43 "AuthNone": "Requests without any sort of authentication are allowed.", 44 "BasicAuth": "Requests using HTTP Basic authentication are allowed.", 45 "OemAuth": "Requests using OEM authentication mechanisms are allowed.", 46 "RedfishSessionAuth": "Requests using Redfish session authentication are allowed." 47 }, 48 "type": "string" 49 }, 50 "CredentialBootstrapping": { 51 "additionalProperties": false, 52 "description": "The credential bootstrapping settings for this interface.", 53 "longDescription": "This type shall contain settings for the Redfish Host Interface Specification-defined 'credential bootstrapping via IPMI commands' feature for this interface.", 54 "patternProperties": { 55 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 56 "description": "This property shall specify a valid odata or Redfish property.", 57 "type": [ 58 "array", 59 "boolean", 60 "integer", 61 "number", 62 "null", 63 "object", 64 "string" 65 ] 66 } 67 }, 68 "properties": { 69 "EnableAfterReset": { 70 "description": "An indication of whether credential bootstrapping is enabled after a reset for this interface.", 71 "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.", 72 "readonly": false, 73 "type": [ 74 "boolean", 75 "null" 76 ], 77 "versionAdded": "v1_3_0" 78 }, 79 "Enabled": { 80 "description": "An indication of whether credential bootstrapping is enabled for this interface.", 81 "longDescription": "This property shall indicate whether credential bootstrapping is enabled for this interface.", 82 "readonly": false, 83 "type": [ 84 "boolean", 85 "null" 86 ], 87 "versionAdded": "v1_3_0" 88 }, 89 "RoleId": { 90 "description": "The role used for the bootstrap account created for this interface.", 91 "longDescription": "This property shall contain the `Id` property of the `Role` resource that is used for the bootstrap account created for this interface.", 92 "readonly": false, 93 "type": "string", 94 "versionAdded": "v1_3_0" 95 } 96 }, 97 "type": "object" 98 }, 99 "HostInterface": { 100 "additionalProperties": false, 101 "description": "The `HostInterface` schema contains properties associated with a Redfish host interface. A Redfish host interface is a connection between host software and a Redfish service.", 102 "longDescription": "This resource shall represent a Redfish host interface as part of the Redfish Specification.", 103 "patternProperties": { 104 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 105 "description": "This property shall specify a valid odata or Redfish property.", 106 "type": [ 107 "array", 108 "boolean", 109 "integer", 110 "number", 111 "null", 112 "object", 113 "string" 114 ] 115 } 116 }, 117 "properties": { 118 "@odata.context": { 119 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 120 }, 121 "@odata.etag": { 122 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 123 }, 124 "@odata.id": { 125 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 126 }, 127 "@odata.type": { 128 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 129 }, 130 "Actions": { 131 "$ref": "#/definitions/Actions", 132 "description": "The available actions for this resource.", 133 "longDescription": "This property shall contain the available actions for this resource.", 134 "versionAdded": "v1_1_0" 135 }, 136 "AuthNoneRoleId": { 137 "description": "The role when no authentication on this interface is used.", 138 "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 be absent if `AuthNone` is not supported by the service for the `AuthenticationModes` property.", 139 "readonly": false, 140 "type": "string", 141 "versionAdded": "v1_2_0" 142 }, 143 "AuthenticationModes": { 144 "description": "The authentication modes available on this interface.", 145 "items": { 146 "$ref": "#/definitions/AuthenticationMode" 147 }, 148 "longDescription": "This property shall contain an array consisting of the authentication modes allowed on this interface.", 149 "readonly": false, 150 "type": "array" 151 }, 152 "CredentialBootstrapping": { 153 "$ref": "#/definitions/CredentialBootstrapping", 154 "description": "The credential bootstrapping settings for this interface.", 155 "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.", 156 "versionAdded": "v1_3_0" 157 }, 158 "Description": { 159 "anyOf": [ 160 { 161 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 162 }, 163 { 164 "type": "null" 165 } 166 ], 167 "readonly": true 168 }, 169 "ExternallyAccessible": { 170 "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`.", 171 "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`.", 172 "readonly": true, 173 "type": [ 174 "boolean", 175 "null" 176 ] 177 }, 178 "FirmwareAuthEnabled": { 179 "deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.", 180 "description": "An indication of whether this firmware authentication is enabled for this interface.", 181 "longDescription": "This property shall indicate whether firmware authentication is enabled for this interface.", 182 "readonly": false, 183 "type": [ 184 "boolean", 185 "null" 186 ], 187 "versionDeprecated": "v1_3_0" 188 }, 189 "FirmwareAuthRoleId": { 190 "deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.", 191 "description": "The Redfish role used for firmware authentication on this interface.", 192 "longDescription": "This property shall contain the `Id` property of the `Role` resource that is configured for firmware authentication on this interface.", 193 "readonly": false, 194 "type": "string", 195 "versionDeprecated": "v1_3_0" 196 }, 197 "HostEthernetInterfaces": { 198 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection", 199 "description": "A link to the collection of network interface controllers or cards (NICs) that a computer system uses to communicate with this host interface.", 200 "longDescription": "This property shall contain a link to a resource collection of type `EthernetInterfaceCollection` that computer systems use as the host interface to this manager.", 201 "readonly": true 202 }, 203 "HostInterfaceType": { 204 "anyOf": [ 205 { 206 "$ref": "#/definitions/HostInterfaceType" 207 }, 208 { 209 "type": "null" 210 } 211 ], 212 "description": "The host interface type for this interface.", 213 "longDescription": "This property shall contain the host interface type for this interface.", 214 "readonly": true 215 }, 216 "Id": { 217 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 218 "readonly": true 219 }, 220 "InterfaceEnabled": { 221 "description": "An indication of whether this interface is enabled.", 222 "longDescription": "This property shall indicate whether this interface is enabled.", 223 "readonly": false, 224 "type": [ 225 "boolean", 226 "null" 227 ] 228 }, 229 "KernelAuthEnabled": { 230 "deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.", 231 "description": "An indication of whether this kernel authentication is enabled for this interface.", 232 "longDescription": "This property shall indicate whether kernel authentication is enabled for this interface.", 233 "readonly": false, 234 "type": [ 235 "boolean", 236 "null" 237 ], 238 "versionDeprecated": "v1_3_0" 239 }, 240 "KernelAuthRoleId": { 241 "deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.", 242 "description": "The Redfish role used for kernel authentication on this interface.", 243 "longDescription": "This property shall contain the `Id` property of the `Role` resource that is configured for kernel authentication on this interface.", 244 "readonly": false, 245 "type": "string", 246 "versionDeprecated": "v1_3_0" 247 }, 248 "Links": { 249 "$ref": "#/definitions/Links", 250 "description": "The links to other resources that are related to this resource.", 251 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 252 }, 253 "ManagerEthernetInterface": { 254 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface", 255 "description": "A link to a single network interface controllers or cards (NIC) that this manager uses for network communication with this host interface.", 256 "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.", 257 "readonly": true 258 }, 259 "Name": { 260 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 261 "readonly": true 262 }, 263 "NetworkProtocol": { 264 "$ref": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.json#/definitions/ManagerNetworkProtocol", 265 "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.", 266 "longDescription": "This property shall contain a link to a resource of type `ManagerNetworkProtocol` that represents the network services for this manager.", 267 "readonly": true 268 }, 269 "Oem": { 270 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 271 "description": "The OEM extension property.", 272 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 273 }, 274 "Status": { 275 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 276 "description": "The status and health of the resource and its subordinate or dependent resources.", 277 "longDescription": "This property shall contain any status or health properties of the resource." 278 } 279 }, 280 "required": [ 281 "@odata.id", 282 "@odata.type", 283 "Id", 284 "Name" 285 ], 286 "type": "object" 287 }, 288 "HostInterfaceType": { 289 "enum": [ 290 "NetworkHostInterface" 291 ], 292 "enumDescriptions": { 293 "NetworkHostInterface": "This interface is a network host interface." 294 }, 295 "type": "string" 296 }, 297 "Links": { 298 "additionalProperties": false, 299 "description": "The links to other resources that are related to this resource.", 300 "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.", 301 "patternProperties": { 302 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 303 "description": "This property shall specify a valid odata or Redfish property.", 304 "type": [ 305 "array", 306 "boolean", 307 "integer", 308 "number", 309 "null", 310 "object", 311 "string" 312 ] 313 } 314 }, 315 "properties": { 316 "AuthNoneRole": { 317 "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", 318 "description": "The link to the Redfish role that contains the privileges on this host interface when no authentication is performed.", 319 "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.", 320 "readonly": true, 321 "versionAdded": "v1_2_0" 322 }, 323 "ComputerSystems": { 324 "description": "An array of links to the computer systems connected to this host interface.", 325 "items": { 326 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem" 327 }, 328 "longDescription": "This property shall contain an array of links to resources of type `ComputerSystem` that are connected to this host interface.", 329 "readonly": true, 330 "type": "array" 331 }, 332 "ComputerSystems@odata.count": { 333 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 334 }, 335 "CredentialBootstrappingRole": { 336 "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", 337 "description": "The link to the role that contains the privileges for the bootstrap account created for this interface.", 338 "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.", 339 "readonly": true, 340 "versionAdded": "v1_3_0" 341 }, 342 "FirmwareAuthRole": { 343 "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", 344 "deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.", 345 "description": "The link to the Redfish role that has firmware authentication privileges on this host interface.", 346 "longDescription": "This property shall contain a link to a resource of type `Role`, and should link to the resource identified by property `FirmwareAuthRoleId`.", 347 "readonly": true, 348 "versionDeprecated": "v1_3_0" 349 }, 350 "KernelAuthRole": { 351 "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", 352 "deprecated": "This property has been deprecated in favor of newer methods of negotiating credentials.", 353 "description": "The link to the Redfish role defining privileges for this host interface when using kernel authentication.", 354 "longDescription": "This property shall contain a link to a resource of type `Role`, and should link to the resource identified by property `KernelAuthRoleId`.", 355 "readonly": true, 356 "versionDeprecated": "v1_3_0" 357 }, 358 "Oem": { 359 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 360 "description": "The OEM extension property.", 361 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 362 } 363 }, 364 "type": "object" 365 }, 366 "OemActions": { 367 "additionalProperties": true, 368 "description": "The available OEM-specific actions for this resource.", 369 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 370 "patternProperties": { 371 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 372 "description": "This property shall specify a valid odata or Redfish property.", 373 "type": [ 374 "array", 375 "boolean", 376 "integer", 377 "number", 378 "null", 379 "object", 380 "string" 381 ] 382 } 383 }, 384 "properties": {}, 385 "type": "object" 386 } 387 }, 388 "language": "en", 389 "owningEntity": "DMTF", 390 "release": "2020.3", 391 "title": "#HostInterface.v1_3_2.HostInterface" 392}