Skip to main content

SNMP Configuration API

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to Device Configuration APIs.

Description​

The VAPIX SNMP Configuration API makes it possible to configure the SNMP settings on the device. There are three different versions of SNMP that can be configured. Version 1 and 2 share some settings that are applied to both versions. These settings include configuration of what kind of trap messages to receive.

Authentication​

For detailed information on how to authenticate requests to this API, please refer to Authentication.

Use cases​

General SNMP settings​

General settings that affect all the versions of SNMP.

Set the property snmp.v1.enabled to true to enable SNMP, to false to turn it off. By default SNMP is turned off.

Use the property snmp.v1.transportProtocol to set what transport protocol SNMP should use. Valid values are tcp or udp. Default value is udp.

Example:

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1" \
  --data '{
    "data": {
        "enabled": true,
        "transportProtocol": "tcp"
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Get number of times SNMP has started​

Use the property snmp.v1.engineBoots to get the number of times SNMP has started.

Example:

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/engineBoots"
200 OK
Content-Type: application/json

{
    "status": "success",
    "data": 1
}

Manage DSCP for SNMP traffic​

Configure DSCP used for SNMP traffic by getting or setting the property #snmp.v1.dscp.

Example:

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/snmp/v1/dscp
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": 0
}
curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --http1.1 \
  --header "Content-Type: application/json" \
  http://my-device/config/rest/snmp/v1/dscp \
  --data '{
    "data": 1
}'
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success"
}

Settings for SNMP V1​

SNMP V1 share settings with SNMP V2. See Common settings for SNMP V1 and V2 for more information about the settings.

Enable SNMP V1​

To enable SNMP V1, set the property snmp.v1.snmpV1.enabled to true.

Example:

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV1/enabled" \
  --data '{
    "data": true
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Settings for SNMP V2​

SNMP V2 share settings with SNMP V1. See Common settings for SNMP V1 and V2 for more information about the settings.

Enable SNMP V2​

To enable SNMP V2, set the property snmp.v1.snmpV2.enabled to true.

Example:

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV2/enabled" \
  --data '{
    "data": true
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Common settings for SNMP V1 and V2​

These settings are applied to both SNMP V1 and V2.

Set the common SNMP settings​

  • To receive trap messages from the device, use snmp.v1.snmpV1V2Common.address to set the address of the management server.
  • To set the community name for read operations, modify the property snmp.v1.snmpV1V2Common.readCommunity. Default value is public.
  • To set the community name for write operations, modify the property snmp.v1.snmpV1V2Common.writeCommunity. Default value is write.

Example:

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV1V2Common" \
  --data '{
    "data": {
        "address": "0.0.0.0",
        "readCommunity": "string",
        "writeCommunity": "string"
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}
  • To enable trap reporting, set the property snmp.v1.snmpV1V2Common.trap.enabled to true. To turn it off set it to false. Default value is false.
  • An SNMP community is the group of devices and management station running SNMP. Community names are used to identify groups. Modify the property snmp.v1.snmpV1V2Common.trap.community to set the community to use when sending a trap message to the management system.
  • To enable trap messages when authentication fails, set the property snmp.v1.snmpV1V2Common.trap.authFailEnabled to true. To turn it off set it to false. Default value is false.
  • To enable trap messages when the device is rebooted or restarted, set the property snmp.v1.snmpV1V2Common.trap.coldStartEnabled to true. To turn it off set the property to false. Default value is false.
  • To enable trap messages when a link changes from down to up, set the property snmp.v1.snmpV1V2Common.trap.linkUpEnabled to true. To turn it off set the property to false. Default value is false.
  • To enable trap messages when a link changes from up to down, set the property snmp.v1.snmpV1V2Common.trap.linkDownEnabled to true. To turn it off set the property to false. Default value is false.

Example:

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV1V2Common/trap" \
  --data '{
    "data": {
        "authFailEnabled": true,
        "coldStartEnabled": true,
        "community": "string",
        "enabled": true,
        "linkUpEnabled": true,
        "linkDownEnabled": true
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Get all common settings for SNMP V1 and V2​

Use snmp.v1.snmpV1V2Common to get all the common settings for SNMP V1 and V2. The response includes if trap messages are enabled and what kind of trap messages are enabled.

Example:

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV1V2Common"
200 OK
Content-Type: application/json

{
    "status": "success",
    "data": [
        {
            "address": "0.0.0.0",
            "readCommunity": "public",
            "trap": {
                "authFailEnabled": true,
                "coldStartEnabled": true,
                "community": "public",
                "enabled": true,
                "linkUpEnabled": true
            },
            "writeCommunity": "write"
        }
    ]
}

Settings for SNMP V3​

  • To enable SNMP V3, set the property snmp.v1.snmpV3.enabled to true. Set it to false to turn it off. Default value is false.
  • "initial user"
    • The userPasswd, userPasswdSet, and userEncryption properties under snmp.v1.snmpV3 apply only to the initial setup of the SNMP V3 "initial" user.
    • You must first configure the "initial" user before SNMP V3 user management becomes available. Then you can manage the "initial" user and other users through the snmp.v1.snmpV3.users collection.
    • "initial" user can't be deleted.
    • "initial" user must stay "authPriv".
    • "initial" user's access must be "readWrite".
  • userPasswd
    • Sets the authentication password for the "initial" user.
    • When you set a valid password, userPasswdSet automatically changes to true.
    • The authentication password is also used as the encryption password for the "initial" user setup.
  • userPasswdSet
    • Legacy password-set indicator. This property is writable only for backward compatibility. The default value is false.
    • This property works as a status flag, not a control switch. Setting it to false doesn't remove or disable the "initial" user.
  • userEncryption
    • Sets the encryption algorithm for the "initial" user. Accepts either of these values: AES-128, AES-256.
  • supportedEncryption
    • Read-only property that lists the supported encryption algorithms: AES-128, AES-256.

Example:

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV3" \
  --data '{
    "data": {
        "enabled": true,
        "userPasswd": "password"
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}

Manage SNMP V3 users​

After the initial setup for "initial" user, you can manage several SNMP V3 users using the snmp.v1.snmpV3.users collection. Each user is uniquely identified by their username. The username must start with a letter or underscore and may contain only letters, digits, underscores, and hyphens.

  • To set the authentication algorithm for a user, set the property snmp.v1.snmpV3.users.userAuthentication to either "SHA-256" or "SHA-512".
  • To set the authentication passphrase for a user, set the property snmp.v1.snmpV3.users.authPassphrase.
  • To set the encryption algorithm for a user, set the property snmp.v1.snmpV3.users.userEncryption to either "AES-128" or "AES-256".
  • To set the encryption passphrase for a user, set the property snmp.v1.snmpV3.users.encryptPassphrase.
  • To set the security level for a user, set the property snmp.v1.snmpV3.users.securityLevel to either "authNoPriv" or "authPriv".
    • For an authPriv user, omit encryptPassphrase to reuse the authentication passphrase for encryption, or include it to configure a distinct encryption passphrase.
    • An authNoPriv user doesn't use an encryption passphrase, so encryptPassphrase must be omitted. If provided, it is rejected.
  • To set the access rights for a user, set the property snmp.v1.snmpV3.users.access to either "readOnly" or "readWrite". The property is optional in ADD and SET requests, but a user always has a non-null access value.
Add a user with authentication and encryption (authPriv)​
curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV3/users" \
  --data '{
    "data": {
        "username": "happy_user",
        "userAuthentication": "SHA-256",
        "authPassphrase": "auth-passphrase",
        "userEncryption": "AES-256",
        "encryptPassphrase": "priv-passphrase",
        "securityLevel": "authPriv",
        "access": "readWrite"
    }
}'
201 Created
Content-Type: application/json

{
    "status": "success"
}
Add an authentication-only user (authNoPriv)​
curl --request POST \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV3/users" \
  --data '{
    "data": {
        "username": "pink_user",
        "userAuthentication": "SHA-512",
        "authPassphrase": "auth-passphrase",
        "securityLevel": "authNoPriv",
        "access": "readOnly"
    }
}'
201 Created
Content-Type: application/json

{
    "status": "success"
}
Update a user​

To change a user's authentication algorithm or passphrase, include authPassphrase in the update. Its value becomes the user's new authentication passphrase; it doesn't need to be the user's current passphrase.

Include authPassphrase when changing the encryption algorithm, encryption passphrase, or security level because these changes recreate the user that requires their authentication passphrase.

Set securityLevel to "authNoPriv" to remove encryption, or set it to "authPriv" to enable encryption. When enabling encryption, omit encryptPassphrase to reuse the supplied authentication passphrase, or include it to configure a distinct encryption passphrase.

Encryption passphrases are not retained after user reconciliation. Therefore, when updating the authentication passphrase of an existing authPriv user that uses a distinct encryption passphrase, include encryptPassphrase again to retain distinct credentials. If it is omitted, the supplied authentication passphrase is also used as the new encryption passphrase.

curl --request PATCH \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV3/users/happy_user" \
  --data '{
    "data": {
        "userAuthentication": "SHA-512",
        "authPassphrase": "new-auth-passphrase",
        "securityLevel": "authNoPriv",
        "access": "readOnly"
    }
}'
200 OK
Content-Type: application/json

{
    "status": "success"
}
Get a user​

The passphrases aren't included in the response.

curl --request GET \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV3/users/happy_user"
200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "username": "happy_user",
        "userAuthentication": "SHA-512",
        "userEncryption": "AES-256",
        "securityLevel": "authNoPriv",
        "access": "readOnly"
    }
}
Remove a user​

The "initial" user can't be removed.

curl --request DELETE \
  --anyauth \
  --user "<username>:<password>" \
  --header "Content-Type: application/json" \
  "http://<servername>/config/rest/snmp/v1/snmpV3/users/pink_user"
200 OK
Content-Type: application/json

{
    "status": "success"
}

Structure​

snmp.v1 (Root Entity)
    ├── dscp (Property)
    ├── enabled (Property)
    ├── engineBoots (Property)
    ├── transportProtocol (Property)
    ├── snmpV1 (Entity)
        ├── enabled (Property)
    ├── snmpV1V2Common (Entity)
        ├── address (Property)
        ├── readCommunity (Property)
        ├── writeCommunity (Property)
        ├── trap (Entity)
            ├── authFailEnabled (Property)
            ├── coldStartEnabled (Property)
            ├── community (Property)
            ├── enabled (Property)
            ├── linkDownEnabled (Property)
            ├── linkUpEnabled (Property)
    ├── snmpV2 (Entity)
        ├── enabled (Property)
    ├── snmpV3 (Entity)
        ├── enabled (Property)
        ├── supportedEncryption (Property)
        ├── userEncryption (Property)
        ├── userPasswd (Property)
        ├── userPasswdSet (Property)
        ├── users (Entity Collection)
            ├── access (Property)
            ├── authPassphrase (Property)
            ├── encryptPassphrase (Property)
            ├── securityLevel (Property)
            ├── userAuthentication (Property)
            ├── userEncryption (Property)
            ├── username (Property)

Entities​

snmp.v1​

  • Description: SNMP Root Entity
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: enabled, engineBoots, transportProtocol, snmpV1V2Common, snmpV1, snmpV2, snmpV3, ntcip
  • Attributes
    • Dynamic Support: No
Properties​
dscp​
  • Description: The DSCP value used for QoS
  • Datatype: DscpType
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
enabled​
  • Description: Status of snmpd service
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
engineBoots​
  • Description: Number of times snmpd has been started
  • Datatype: EngineBootsType
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
transportProtocol​
  • Description: Transport Protocol string
  • Datatype: TransportProtocolEnum
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
ntcip_supported​
  • Description:
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.ntcip​

  • Description: NTCIP support
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: enabled
  • Attributes
    • Dynamic Support: Yes
Properties​
enabled​
  • Description: Status of NTCIP support
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.snmpV1​

  • Description: V1 snmp support
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: enabled
  • Attributes
    • Dynamic Support: No
Properties​
enabled​
  • Description: Status of V1 snmp support
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.snmpV1V2Common​

  • Description: Entity that has common properties for snmp V1 and V2c
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: readCommunity, writeCommunity, address, trap
  • Attributes
    • Dynamic Support: No
Properties​
address​
  • Description: Trap Address
  • Datatype: TrapAddressType
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
readCommunity​
  • Description: Read Community string
  • Datatype: CommunityNameType
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
writeCommunity​
  • Description: Write Community string
  • Datatype: CommunityNameType
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.snmpV1V2Common.trap​

  • Description: Trap
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: authFailEnabled, coldStartEnabled, community, enabled, linkUpEnabled, linkDownEnabled
  • Attributes
    • Dynamic Support: No
Properties​
authFailEnabled​
  • Description: Status of trap auth fail
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
coldStartEnabled​
  • Description: Status of trap coldstart
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
community​
  • Description: Trap Community
  • Datatype: CommunityNameType
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
enabled​
  • Description: Status of Trap usage
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
linkDownEnabled​
  • Description: Status of trap link down
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
linkUpEnabled​
  • Description: Status of trap link up
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.snmpV2​

  • Description: V2c snmp support
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: enabled
  • Attributes
    • Dynamic Support: No
Properties​
enabled​
  • Description: Status of V2c snmp support
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.snmpV3​

  • Description: V3 snmp support
  • Type: Singleton
  • Operations
    • GET
    • SET
      • Properties: enabled, userPasswd, userPasswdSet, userEncryption
  • Attributes
    • Dynamic Support: No
Properties​
enabled​
  • Description: Status of V3 snmp support
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
supportedEncryption​
  • Description: AES-128 or AES-256 encryption
  • Datatype: SupportedEncryptionTypeArray
  • Operations
    • GET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
userEncryption​
  • Description: Encryption algorithm for the SNMPv3 "initial" user
  • Datatype: UserEncryptionTypeEnum
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
userPasswd​
  • Description: Initial password for the SNMPv3 "initial" user
  • Datatype: UserPasswdType
  • Operations
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
userPasswdSet​
  • Description: Initial password-set status for the SNMPv3 "initial" user
  • Datatype: boolean
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

snmp.v1.snmpV3.users​

  • Description: SNMPv3 user collection
  • Type: Collection (Key Property: [username](#username))
  • Operations
    • GET
    • SET
      • Properties: userAuthentication, authPassphrase, userEncryption, encryptPassphrase, securityLevel, access
    • ADD (Permissions: admin)
      • Required properties: username, userAuthentication, authPassphrase, securityLevel
      • Optional properties: userEncryption, encryptPassphrase, access
    • REMOVE (Permissions: admin)
  • Attributes
    • Dynamic Support: No
Properties​
access​
  • Description: Access rights for the user
  • Datatype: AccessTypeEnum
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
authPassphrase​
  • Description: Authentication passphrase
  • Datatype: UserPasswdType
  • Operations
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
encryptPassphrase​
  • Description: Encryption passphrase
  • Datatype: UserPasswdType
  • Operations
    • SET (Permissions: admin)
  • Attributes
    • Nullable: Yes
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
securityLevel​
  • Description: Security level
  • Datatype: SecurityLevelTypeEnum
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
userAuthentication​
  • Description: User authentication
  • Datatype: UserAuthenticationTypeEnum
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
userEncryption​
  • Description: User encryption
  • Datatype: UserEncryptionTypeEnum
  • Operations
    • GET (Permissions: admin)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
username​
  • Description: User name
  • Datatype: UserNameType
  • Operations
    • GET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

Data types​

CommunityNameType​

{
    "minLength": 1,
    "maxLength": 32,
    "type": "string"
}

DscpType​

{
    "minimum": 0,
    "maximum": 63,
    "type": "integer"
}

EngineBootsType​

{
    "minimum": 0,
    "type": "integer"
}

SupportedEncryptionTypeArray​

{
    "type": "array",
    "items": {
        "type": "UserEncryptionTypeEnum"
    }
}

TransportProtocolEnum​

{
    "enum": ["tcp", "udp"],
    "type": "string"
}

TrapAddressType​

{
    "maxLength": 46,
    "type": "string"
}

UserEncryptionTypeEnum​

{
    "enum": ["AES-128", "AES-256"],
    "type": "string"
}

UserPasswdType​

{
    "minLength": 8,
    "maxLength": 50,
    "type": "string"
}

UserNameType​

{
    "maxLength": 32,
    "minLength": 1,
    "pattern": "^[a-zA-Z_][a-zA-Z0-9_-]*$",
    "type": "string"
}

UserAuthenticationTypeEnum​

{
    "enum": ["SHA-256", "SHA-512"],
    "type": "string"
}

SecurityLevelTypeEnum​

{
    "enum": ["authNoPriv", "authPriv"],
    "type": "string"
}

AccessTypeEnum​

{
    "enum": ["readOnly", "readWrite"],
    "type": "string"
}