snmp.config

Type: object

Type: array
No Additional Items

SnmpEntry

Type: object
No Additional Properties

Location

Type: string

A comment describing the physical location of the server.

Contact


Contact information for the system administrator (email or name).

Type: stringFormat: email
Type: string
Must match regular expression: ^[-_a-zA-Z0-9\s]*$

Traps

Type: boolean

Whether SNMP traps are enabled.

V3

Type: boolean

Whether SNMP version 3 is enabled. Enabling version 3 also requires username, authtype and password.

Community

Type: string Default: "public"

SNMP community string for v1/v2c access. Allows letters, numbers, hyphens, underscores, and spaces.

Must match regular expression: ^[-_a-zA-Z0-9\s]*$

V3 Username

Type: string

Username for SNMP version 3 authentication.

Must be at most 20 characters long

V3 Authtype

Type: enum (of string)

Authentication type for SNMP version 3 (empty string means no authentication).

Must be one of:
  • ""
  • "MD5"
  • "SHA"

V3 Password

Type: string

Password for SNMP version 3 authentication.

V3 Privproto


Privacy protocol for SNMP version 3 encryption. null means no encryption. If set, ['AES'|'DES'], a privpassphrase must be supplied.

Type: enum (of null or string)
Must be one of:
  • null
  • "AES"
  • "DES"
Type: null

V3 Privpassphrase

Default: null

Privacy passphrase for SNMP version 3 encryption. This field is required when privproto is set.

Type: string
Type: null

Loglevel

Type: integer

Logging level for SNMP daemon (0=emergency to 7=debug).

Value must be greater or equal to 0 and lesser or equal to 7

Options

Type: string

Additional SNMP daemon configuration options. Manual settings should be used with caution as they may render the SNMP service non-functional.

Zilstat

Type: boolean

Whether to enable ZFS dataset statistics collection for SNMP.

Id

Type: integer

Placeholder identifier. Not used as there is only one.


Required roles: SYSTEM_GENERAL_READ