Skip to main content

GET – SNMPv3 Trap Users

Use the GET method to retrieve the properties SNMPv3TrapUser resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/SNMP/SNMPv3TrapUsers/{Id}

Request body​

None

Response body​

Field

Type

Description

Id

StringSNMPv3 Trap User id value.

Name

StringSNMPv3 Trap User id value.

Description

StringThis resource is used to represent an account for SNMPV3 trap for a Redfish implementation.

UserName

StringThe user name for the account.

AuthenticationKey

String
This property shall contain the key for SNMPv3 authentication.

  • The value shall be “null” in responses.

  • This property accepts a passphrase or a hex-encoded key.

  • If the string starts with “Passphrase:”, the remainder of the string shall be the passphrase and shall be converted to the key as described in the “Password to Key Algorithm” section of RFC3414.

  • If the string starts with “Hex:”, then the remainder of the string shall be the key encoded in hexadecimal notation.

  • If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the “Password to Key Algorithm” section of RFC3414.

  • The passphrase can contain any printable characters except for the double quotation mark.

AuthenticationKeySet

BooleanIndicates if the AuthenticationKey property is set.

AuthenticationProtocol

String

The authentication protocol for SNMPv3.

None, HMAC_SHA96, HMAC128_SHA224, HMAC192_SHA256, HMAC256_SHA384, HMAC384_SHA512

EncryptionKey

String
This property shall contain the key for SNMPv3 encryption.

  • The value shall be “null” in responses.

  • This property accepts a passphrase or a hex-encoded key.

  • If the string starts with “Passphrase:”, the remainder of the string shall be the passphrase and shall be converted to the key as described in the “Password to Key Algorithm” section of RFC3414.

  • If the string starts with “Hex:”, then the remainder of the string shall be the key encoded in hexadecimal notation.

  • If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the “Password to Key Algorithm” section of RFC3414.

  • The passphrase can contain any printable characters except for the double quotation mark.

EncryptionKeySet

BooleanIndicates if the EncryptionKey property is set.

EncryptionProtocol

String

The encryption protocol for SNMPv3.

None, CBC_DES, CFB128_AES128, AES192, AES256, AES192C, AES256C

Addresses

ArrayIndicates IP address or hostname (maximum of 63 characters in each field)
Note
Supports one element only

Status code​

HTTP Status CodeError Message ID
500InternalError