usm.snmp-trap

User security model

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • moduleId

The id of the linked snmp-trap module

type

string

  • userSecurityModel

The security model for SNMPv3

oneOf

authPriv

authNoPriv

noAuthNoPriv

additionalProperties

False

authPriv

type

object

properties

  • type

type

string

enum

authPriv

default

authPriv

  • securityName

Security Named used by the agent to send its SNMP Trap (this value is used as recommended as userName)

type

string

  • authenticationProtocol

Authentication protocol to use for a specific user

AuthenticationProtocol

  • privProtocol

Privacy protocol to use for a specific user

PrivProtocol

additionalProperties

False

AuthenticationProtocol

type

object

properties

  • type

Type authentication protocol used for SNMP session

type

string

enum

MD5, SHA, HMAC_128_SHA_224, HMAC_192_SHA_256, HMAC_256_SHA_384, HMAC_384_SHA_512

  • passwordProvider

Secret password for authentication

oneOf

PLAINTEXT

SECRET

additionalProperties

False

PLAINTEXT

type

object

properties

  • type

type

string

enum

PLAINTEXT

default

PLAINTEXT

  • password

The password to use in plaintext. It can be for example thisIs@TestPassword123.

type

string

additionalProperties

False

SECRET

type

object

properties

  • type

type

string

enum

SECRET

default

SECRET

  • secretPath

The path of the secret containing the password. This is a path to the secret containing the password.

type

string

additionalProperties

False

PrivProtocol

type

object

properties

  • type

Type privacy protocol used for SNMP session

type

string

enum

DES, AES_128, IDEA, AES_192, AES_256, AES_128_W_3_DES_KEY_EXT, AES_192_W_3_DES_KEY_EXT, AES_256_W_3_DES_KEY_EXT

  • passwordProvider

Secret password used for privacy

oneOf

PLAINTEXT

SECRET

additionalProperties

False

authNoPriv

type

object

properties

  • type

type

string

enum

authNoPriv

default

authNoPriv

  • securityName

Security Named used by the agent to send its SNMP Trap (this value is used as recommended as userName)

type

string

  • authenticationProtocol

Authentication protocol to use for a specific user

AuthenticationProtocol

additionalProperties

False

noAuthNoPriv

type

object

properties

  • type

type

string

enum

noAuthNoPriv

default

noAuthNoPriv

  • securityName

Security Named used by the agent to send its SNMP Trap (this value is used as recommended as userName)

type

string

additionalProperties

False