GET – SNMP Protocol
Use the GET method to retrieve Oem SNMP properties definition in a BMC.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/SNMP
Request body
None
Response body
| Field | Type | Description | |||
|---|---|---|---|---|---|
| Id | String | “SNMP” | |||
| Name | String | “SNMP Protocol” | |||
| Description | String | This resource is used to represent SNMP protocol for the manager for a Redfish implementation. | |||
| SNMPTraps | Object | Expanded | |||
| SNMPv1TrapEnabled | Boolean | Indicates if SNMPv1 trap is enabled. | |||
| ProtocolEnabled | Boolean | Indicates if SNMPv3 trap is enabled | |||
| Port | Number | Trap port. | |||
| AlertRecipient | Object | Expanded. | |||
| Targets | Array | Items: object Item count: {0…N}, N is 1 Note Current design N is 1. | |||
| Targets[N] | Object | Expanded | |||
| Addresses | Array | Host for SNMPv1 | |||
| CommunityNames | Array | Community Name for SNMPv1 | |||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"Id": "SNMP",
"Name": "SNMP Protocol",
"SNMPv3Agent": {
"Links": {
"UsersSNMPv3Settings": {
"@odata.id": "/redfish/v1/AccountService/Accounts"
}
},
"Location": "",
"Port": 161,
"ProtocolEnabled": false,
"ContactPerson": ""
},
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/SNMP",
"CommunityNames": [
null
],
"@odata.etag": "\"60031ede1a38272aeb0\"",
"SNMPTraps": {
"SNMPv1TrapEnabled": false,
"AlertRecipient": {
"WarningEvents": {
"Enabled": false,
"AcceptedEvents": []
},
"SystemEvents": {
"Enabled": false,
"AcceptedEvents": []
},
"CriticalEvents": {
"Enabled": false,
"AcceptedEvents": []
}
},
"Targets": [
{
"Addresses": [
null
]
}
],
"ProtocolEnabled": false,
"Port": 162
},
"@odata.type": "#LenovoSNMPProtocol.v1_0_0.LenovoSNMPProtocol",
"Description": "This resource is used to represent SNMP protocol for the manager for a Redfish implementation."
}
Give documentation feedback