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

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: snmp_update

snmp_update

Type: object
No Additional Properties

location

Location

Type: string

contact

Contact

Any of

• Option 1
• Option 2

Type: stringFormat: email

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

traps

Traps

Type: boolean

v3

V3

Type: boolean

community

Community

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

v3_username

V3 Username

Type: string

Must be at most 20 characters long

v3_authtype

V3 Authtype

Type: enum (of string)

Must be one of:

• ""
• "MD5"
• "SHA"

v3_password

V3 Password

Type: string

v3_privproto

V3 Privproto

Any of

• Option 1
• Option 2

Type: enum (of null or string)

Must be one of:

• null
• "AES"
• "DES"

Type: null

v3_privpassphrase

V3 Privpassphrase

Any of

• Option 1
• Option 2

Type: string

Type: null

loglevel

Loglevel

Type: integer

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

options

Options

Type: string

zilstat

Zilstat

Type: boolean

Return value

SnmpEntry

Type: object
No Additional Properties

location Required

Location

Type: string

contact Required

Contact

Any of

• Option 1
• Option 2

Type: stringFormat: email

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

traps Required

Traps

Type: boolean

v3 Required

V3

Type: boolean

community

Community

Type: string Default: "public"
Must match regular expression: ^[-_a-zA-Z0-9\s]*$

v3_username Required

V3 Username

Type: string

Must be at most 20 characters long

v3_authtype Required

V3 Authtype

Type: enum (of string)

Must be one of:

• ""
• "MD5"
• "SHA"

v3_password Required

V3 Password

Type: string

v3_privproto Required

V3 Privproto

Any of

• Option 1
• Option 2

Type: enum (of null or string)

Must be one of:

• null
• "AES"
• "DES"

Type: null

v3_privpassphrase

V3 Privpassphrase

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

loglevel Required

Loglevel

Type: integer

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

options Required

Options

Type: string

zilstat Required

Zilstat

Type: boolean

id Required

Id

Type: integer

Required roles: SYSTEM_GENERAL_WRITE