snmp.update

Update SNMP Service Configuration.

— Rules —

Enabling v3:

requires v3_username, v3_authtype and v3_password

Disabling v3:

By itself will retain the v3 user settings and config in the ‘private’ config, but remove the entry in the public config to block v3 access by that user.

Disabling v3 and clearing the v3_username:

This will do the actions described in ‘Disabling v3’ and take the extra step to remove the user from the ‘private’ config.

The ‘v3_*’ settings are valid and enforced only when ‘v3’ is enabled

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: snmp_update

snmp_update

Type: object

SNMPUpdateArgs parameters.

 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

SNMP community string for v1/v2c access. Allows letters and numbers: a-zA-Z0-9 special characters: !$%&()+-_={}[]<>,.? and spaces. Notable excluded characters: # / \ @

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


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.

SNMPEntry

Type: object

The updated SNMP service configuration.

 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 and numbers: a-zA-Z0-9 special characters: !$%&()+-_={}[]<>,.? and spaces. Notable excluded characters: # / \ @

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_WRITE