Techpreview_Monitoring_Snmp_SNMPConfigReadOnly

Snmp.SNMPConfigReadOnly structure Structure that defines the SNMP configuration, the result of get(), and never provided as input to set(). This structure differs from SNMPConfig because it contains localized keys (as defined in http://tools.ietf.org/html/rfc3826#section-1.2), instead of raw secret strings. This structure can be used to configure SNMP v1, v2c, and v3. Keep this structure in sync with vmw_snmp.py:_default_config(). Note that if a field if left empty, it is considered unset and will be ignored. Existing array elements below can be unset by sending an element with the string 'reset'. Note: This structure is restricted for VMware internal use only.

JSON Example

{
    "authentication": "string",
    "communities": [
        "string"
    ],
    "enable": false,
    "engineid": "string",
    "loglevel": "string",
    "notraps": [
        "string"
    ],
    "port": 0,
    "privacy": "string",
    "syscontact": "string",
    "syslocation": "string",
    "targets": [
        {
            "ip": "string",
            "port": 0,
            "community": "string"
        }
    ],
    "users": [
        {
            "username": "string",
            "sec_level": "string",
            "auth_key": "string",
            "priv_key": "string"
        }
    ],
    "remoteusers": [
        {
            "username": "string",
            "sec_level": "Techpreview_Monitoring_Snmp_SNMPSecLevel Object",
            "authentication": "Techpreview_Monitoring_Snmp_SNMPAuthProto Object",
            "auth_key": "string",
            "privacy": "Techpreview_Monitoring_Snmp_SNMPPrivProto Object",
            "priv_key": "string",
            "engineid": "string"
        }
    ],
    "v3targets": [
        {
            "type": "string",
            "sec_level": "Techpreview_Monitoring_Snmp_SNMPSecLevel Object",
            "ip": "string",
            "port": 0,
            "user": "string"
        }
    ],
    "pid": "string"
}

Techpreview_Monitoring_Snmp_SNMPAuthProto

authentication

Required

Snmp.SNMPAuthProto enumerated type Defines SNMP authentication protocols Note: This enumeration is restricted for VMware internal use only.
none : NONE
SHA1 : SHA1
MD5 : MD5

array of string

communities

Required

Set up to ten communities, each of no more than 64 characters long. The format is: community1[,community2,...]. This setting overwrites any previous settings.

boolean

enable

Required

Set enable to true/false

string

engineid

Required

Set SNMPv3 engine ID.

string

loglevel

Required

System Agent syslog logging level: debug|info|warning|error.

array of string

notraps

Required

Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent. Use 'reset' to clear the setting.

integer As int64

port

Required

Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.

Techpreview_Monitoring_Snmp_SNMPPrivProto

privacy

Required

Snmp.SNMPPrivProto enumerated type Defines SNMP privacy protocols Note: This enumeration is restricted for VMware internal use only.
AES128 : AES128
none : NONE

string

syscontact

Required

System contact string as presented in sysContact.0. Up to 255 characters long.

string

syslocation

Required

System location string as presented in sysLocation.0. Up to 255 characters long.

array of Techpreview_Monitoring_Snmp_SNMPv1TrapTarget

targets

Required

Set up to three targets to which to send SNMPv1 traps.

array of Techpreview_Monitoring_Snmp_SNMPUser

users

Required

Set up to five local users.

array of Techpreview_Monitoring_Snmp_SNMPRemoteUser

remoteusers

Required

Set up remote users.

array of Techpreview_Monitoring_Snmp_SNMPv3Target

v3targets

Required

Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,...].

string

pid

Required

Set up pid