跳到主要内容

PATCH - Update SNMPv3 Trap User

Use the PATCH method to update user description in SNMPv3TrapUsers resource for Redfish service.

Request URL​

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

Request body​

Field

Type

Description

UserName

StringThe user name for the account.

AuthenticationProtocol

StringNone, HMAC_SHA96, HMAC128_SHA224, HMAC192_SHA256, HMAC256_SHA384, HMAC384_SHA512

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.

Note
Should be empty if AuthenticationProtocol is “None”

EncryptionProtocol

String

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

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.

Note
Should be empty if AuthenticationProtocol is “None”

AuthenticationKeySet

BooleanIndicates if the AuthenticationKey property is set.

EncryptionKeySet

BooleanIndicates if the EncryptionKey property is set.

Addresses

Array

Length: 1~3

Item should be an IP address or Domain or empty string.

Should contain at least one valid IP address or Domain.

Response body​

It responds the created subscription resource, refer the response body of Event subscription with GET method.

Status code​

HTTP Status CodeError Message ID
201Created
400BadRequest, PropertyValueNotInList
500InternalError