GET – Host interface properties
Use the GET method to retrieve properties in HostInterface resource for a server.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/Managers/1/HostInterfaces/1
Request body
None
Response body
Field | Type | Description | ||
---|---|---|---|---|
Id | String | Uniquely identifies the resource within the collection of Chassis. Always set to “1”. | ||
Description | String | Provides a description of Host Interface resources. | ||
ExternallyAccessible | Boolean | Always set to false | ||
HostEthernetInterfaces | Link | A reference link to the collection of ethernet interfaces that the system uses for network communication with the host interface. | ||
HostInterfaceType | String | “NetworkHostInterface” | ||
InterfaceEnabled | Boolean | Indicate whether this interface is enabled. | ||
Links | Object | Expanded | ||
ComputerSystems | Array | An array of references to the computer systems connected to this host interface. | ||
ComputerSystems[0] | Link | A reference link to a resource of computer system | ||
CredentialBootstrappingRole | Link | Link to related role that contains the privileges for the bootstrap account created for this interface. This link will be generated after the bootstrap account is created by IPMI command. | ||
ManagerEthernetInterface | Link | A reference link to a single ethernet interface that the manager uses for network communication with the host interface. | ||
Name | String | The name of the host interface resource. Always set to “Host Interface”. | ||
NetworkProtocol | Link | A reference link to the network services and their settings that the manager controls. | ||
CredentialBootstrapping | Object | Expanded | ||
Enabled | Boolean | Indicate whether credential bootstrapping is enabled for this interface. | ||
EnableAfterReset | Boolean | Indicate whether credential bootstrapping is enabled after a reset for this interface. | ||
RoleId | String | “Administrator” |
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Example
The following example JSON response is returned:
{
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
},
"HostInterfaceType": "NetworkHostInterface",
"ManagerEthernetInterface": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/ToHost"
},
"Description": "This resource shall be used to represent Host Interface resources as part of the Redfish specification.",
"Id": "1",
"Name": "Host Interface",
"@odata.type": "#HostInterface.v1_3_0.HostInterface",
"@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1",
"@odata.etag": "\"62070880282227ee34a\"",
"@odata.context": "/redfish/v1/$metadata#HostInterface.HostInterface",
"HostEthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1/HostEthernetInterfaces"
},
"CredentialBootstrapping": {
"RoleId": "Administrator",
"Enabled": true,
"EnableAfterReset": true
},
"ExternallyAccessible": false,
"InterfaceEnabled": false,
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
]
}
}