snmp.update¶
Update SNMP Service Configuration.
The v3_* settings are valid and enforced only when v3 is enabled.
Enabling v3 requires v3_username, v3_authtype, and v3_password. Disabling v3 alone retains the v3 user settings in the private config but removes the public config entry, blocking v3 access. Disabling v3 and clearing v3_username additionally removes the user from the private config.
No Additional Items
Tuple Validation
Parameter 1: snmp_update
snmp_update
Type: objectSNMPUpdateArgs parameters.
No Additional PropertiesLocation
Type: stringA comment describing the physical location of the server.
Contact
Contact information for the system administrator (email or name).
Must match regular expression:
^[-_a-zA-Z0-9\s]*$
Traps
Type: booleanWhether SNMP traps are enabled.
V3
Type: booleanWhether SNMP version 3 is enabled. Enabling version 3 also requires username, authtype and password.
Community
Type: stringSNMP 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: stringUsername 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: stringPassword 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.
Must be one of:
- null
- "AES"
- "DES"
V3 Privpassphrase
Privacy passphrase for SNMP version 3 encryption. This field is required when privproto is set.
Loglevel
Type: integerLogging 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: stringAdditional SNMP daemon configuration options. Manual settings should be used with caution as they may render the SNMP service non-functional.
Zilstat
Type: booleanWhether to enable ZFS dataset statistics collection for SNMP.
SNMPEntry
Type: objectThe updated SNMP service configuration.
No Additional PropertiesLocation
Type: stringA comment describing the physical location of the server.
Contact
Contact information for the system administrator (email or name).
Must match regular expression:
^[-_a-zA-Z0-9\s]*$
Traps
Type: booleanWhether SNMP traps are enabled.
V3
Type: booleanWhether 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: stringUsername 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: stringPassword 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.
Must be one of:
- null
- "AES"
- "DES"
V3 Privpassphrase
Default: nullPrivacy passphrase for SNMP version 3 encryption. This field is required when privproto is set.
Loglevel
Type: integerLogging 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: stringAdditional SNMP daemon configuration options. Manual settings should be used with caution as they may render the SNMP service non-functional.
Zilstat
Type: booleanWhether to enable ZFS dataset statistics collection for SNMP.
Id
Type: integerPlaceholder identifier. Not used as there is only one.
Required roles: SYSTEM_GENERAL_WRITE