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 | |||
|---|---|---|---|---|---|
Id | String | “NetworkProtocol”. | |||
Name | String | “Manager Network Protocol”. | |||
Description | String | The resource is used to represent the network service settings for the manager for a Redfish implementation. | |||
HostName | String | The DNS Host Name of this manager, without any domain information. | |||
FQDN | String | This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name. | |||
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. | |||
SNMP | Object | Settings for this Manager's SNMP support. | |||
Port | Number | Indicates the protocol port. | |||
EngineId | Object | The engine ID. | |||
ArchitectureId | String | The architecture identifier. | |||
PrivateEnterpriseId | String | The private enterprise ID. | |||
EnableSNMPv3 | Boolean | Indicates if access via SNMPv3 is enabled. | |||
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. | |||
HTTP | Object | Settings for this Manager's HTTP protocol support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. Fixed value “true”. | |||
Port | Number | Indicates the protocol port. | |||
HTTPS | Object | Settings for this Manager's HTTPS protocol support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. | |||
Port | Number | Indicates the protocol port. | |||
Certificates | Link | The value of this property shall be a reference to a collection of certificates. | |||
VirtualMedia | Object | Settings for this Manager's Virtual Media support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. Fixed value “true”. | |||
Port | Number | Indicates the protocol port. | |||
KVMIP | Object | Settings for this Manager's KVM-IP protocol support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. Fixed value “true”. | |||
Port | Number | Indicates the protocol port. | |||
SSH | Object | Settings for this Manager's SSH (Secure Shell) protocol support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. | |||
Port | Number | Indicates the protocol port. | |||
IPMI | Object | Settings for this Manager's IPMI-over-LAN protocol support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled. | |||
Port | Number | Indicates the protocol port. Fixed port “623” | |||
SSDP | Object | Settings for this Manager's SSDP support. | |||
ProtocolEnabled | Boolean | Indicates if the protocol is enabled or disabled.Fixed value “true”. | |||
Port | Number | Indicates the protocol port. Fixed port “1900” | |||
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” | |||
NotifyIPv6Scope | String | Indicates the scope for the IPv6 Notify messages for SSDP. Fixed value “Organization” | |||
Status | Object | Expanded | |||
State | String | “Enabled” | |||
Health | “OK” | ||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"FQDN": "XCC-7Z60-1325476891.lenovo.com",
"HostName": "XCC-7Z60-1325476891",
"SSDP": {
"NotifyTTL": 2,
"Port": 1900,
"NotifyIPv6Scope": "Organization",
"ProtocolEnabled": true,
"NotifyMulticastIntervalSeconds": 60
},
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Id": "NetworkProtocol",
"DHCPv6": {
"ProtocolEnabled": true
},
"@odata.etag": "\"d822f21401ff31db011af\"",
"IPMI": {
"ProtocolEnabled": true,
"Port": 623
},
"SSH": {
"ProtocolEnabled": true,
"Port": 22
},
"KVMIP": {
"ProtocolEnabled": true,
"Port": 3900
},
"HTTPS": {
"ProtocolEnabled": true,
"Port": 443,
"Certificates": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates"
}
},
"HTTP": {
"ProtocolEnabled": true,
"Port": 80
},
"Name": "Manager Network Protocol",
"SNMP": {
"EngineId": {
"ArchitectureId": "04 58 43 43 2D 37 5A 36 30 2D 31 33 32 35 34 37 36 38 39 31",
"PrivateEnterpriseId": "80 00 1f 88"
},
"Port": 161,
"EnableSNMPv3": true
},
"VirtualMedia": {
"ProtocolEnabled": true,
"Port": 3900
},
"@odata.type": "#ManagerNetworkProtocol.v1_6_0.ManagerNetworkProtocol",
"NTP": {
"ProtocolEnabled": true,
"NTPServers": [
"10.10.10.1",
"10.10.10.2",
"10.10.10.3",
""
]
},
"DHCP": {
"ProtocolEnabled": true
},
"Oem": {
"Lenovo": {
"SMTPClient": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/SMTPClient"
},
"CimOverHTTPS": {
"BackendEnabled": false,
"ProtocolEnabled": false,
"Port": 5989
},
"SLP": {
"Port": 427,
"MulticastAddress": "239.255.255.253",
"ProtocolEnabled": true,
"AddressType": "Multicast"
},
"OpenPorts": [
"22",
"68",
"80",
"115",
"123",
"161",
"427",
"443",
"546",
"623",
"1900",
"3900"
],
"@odata.type": "#LenovoManagerNetworkProtocol.v1_0_0.LenovoManagerNetworkProtocolProperties",
"DNS": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/DNS"
},
"LDAPClient": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/LDAPClient"
},
"SNMP": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/SNMP"
},
"WebOverHTTPS": {
"ProtocolEnabled": true
}
}
},
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",
"Description": "The resource is used to represent the network service settings for the manager for a Redfish implementation."
}