GET – BMC network services
Use the GET method to retrieve properties definition for the network protocol in a BMC.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/Managers/1/NetworkProtocol
Request body
None
Response body
Field | Type | Description | |||
---|---|---|---|---|---|
Description | String | The resource is used to represent the network service settings for the manager for a Redfish implementation. | |||
Status | Object | Expanded. | |||
State | String | Enabled | |||
Health | String | OK | |||
HealthRollup | String | OK | |||
KVMIP | Object | Settings for this Manager's KVM-IP protocol support. | |||
Port | String | 443 | |||
ProtocolEnabled | Boolean | Indicate if the protocol is enabled or disabled. | |||
FQDN | String | This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name. | |||
Port | Number | Indicates the protocol port. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. Fixed value “true”. | |||
SNMP | Object | Settings for this Manager's SNMP support. | |||
Port | Number | Indicates the protocol port. | |||
EnableSNMPv3 | Boolean | Indicates if access via SNMPv3 is enabled. | |||
EngineId | Object | The engine ID. | |||
ArchitectureId | String | The architecture identifier. | |||
PrivateEnterpriseId | String | The private enterprise ID. | |||
SSDP | Object | Settings for this Manager's SSDP support. | |||
NotifyIPv6Scope | String | Indicates the scope for the IPv6 Notify messages for SSDP. Fixed value “Organization” | |||
NotifyMulticastIntervalSeconds | Number | Indicates how often the Multicast is done from this service for SSDP. Fixed value “60” | |||
NotifyTTL | Number | Indicates the time to live hop count for SSDPs Notify messages. Fixed value “2” | |||
Port | Number | Indicates the protocol port. Fixed port “1900” | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled.Fixed value “true”. | |||
DHCP | Object | Settings for this Manager's DHCP support. | |||
ProtocolEnabled | Boolean | Indicate if the protocol is enabled or disabled. | |||
DHCPv6 | Object | Settings for this Manager’s DHCPv6 support | |||
ProtocolEnabled | Boolean | Indicate if the protocol is enabled or disabled. | |||
HTTPS | Object | Settings for this Manager's HTTPS protocol support. | |||
Port | Number | Indicates the protocol port. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. | |||
Certificates | Link | The value of this property shall be a reference to a collection of certificates. | |||
HostName | String | The DNS Host Name of this manager, without any domain information. | |||
IPMI | Object | Settings for this Manager's IPMI-over-LAN protocol support. | |||
Port | Number | Indicates the protocol port. Fixed port “623” | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. | |||
Id | String | NetworkProtocol | |||
NTP | Object | Settings for this Manager's NTP support. | |||
NTPServers | Array | Items: string List of NTP servers IP. | |||
ProtocolEnabled | Boolean | Indicate if the protocol is enabled or disabled. | |||
Name | String | Manager Network Protocol |
Status code
HTTP Status Code | Error Message ID |
---|---|
500 | InternalError |
Example
The following example JSON response is returned:
{
"@odata.etag": "\"296476A0\"",
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",
"@odata.type": "#ManagerNetworkProtocol.v1_6_0.ManagerNetworkProtocol",
"DHCP": {
"ProtocolEnabled": true
},
"DHCPv6": {
"ProtocolEnabled": true
},
"Description": "The resource is used to represent the network service settings for the manager for a Redfish implementation.",
"FQDN": "XCC-7DGC-BHSFW2U005.labs.lenovo.com",
"HTTPS": {
"Certificates": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates"
},
"Port": 443,
"ProtocolEnabled": true
},
"HostName": "XCC-7DGC-BHSFW2U005",
"IPMI": {
"Port": 623,
"ProtocolEnabled": true
},
"Id": "NetworkProtocol",
"KVMIP": {
"Port": 443,
"ProtocolEnabled": true
},
"NTP": {
"NTPServers": [
"",
"",
"",
""
],
"ProtocolEnabled": false
},
"Name": "Manager Network Protocol",
"Oem": {
...
}
},
"SNMP": {
"EnableSNMPv3": false,
"EngineId": {
"ArchitectureId": "58 43 43 2d 37 44 47 43 2d 42 48 53 46 57 32 55 30 30 35",
"PrivateEnterpriseId": "80 00 1f 88 04"
},
"Port": 161
},
"SSDP": {
"NotifyIPv6Scope": "Organization",
"NotifyMulticastIntervalSeconds": 60,
"NotifyTTL": 2,
"Port": 1900,
"ProtocolEnabled": true
},
"SSH": {
"Port": 22,
"ProtocolEnabled": true
},
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
}
}