1. Types
  2. appliance
  3. techpreview
  4. monitoring
  5. snmp

appliance techpreview monitoring snmp: SNMP config read only

SNMP_config_read_only 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'.

Representations:

{
    "authentication": "none",
    "communities": [
        "string",
        "string"
    ],
    "enable": true,
    "engineid": "string",
    "loglevel": "string",
    "notraps": [
        "string",
        "string"
    ],
    "pid": "string",
    "port": 1,
    "privacy": "AES128",
    "remoteusers": [
        {
            "auth_key": "string",
            "authentication": "none",
            "engineid": "string",
            "priv_key": "string",
            "privacy": "AES128",
            "sec_level": "none",
            "username": "string"
        },
        {
            "auth_key": "string",
            "authentication": "none",
            "engineid": "string",
            "priv_key": "string",
            "privacy": "AES128",
            "sec_level": "none",
            "username": "string"
        }
    ],
    "syscontact": "string",
    "syslocation": "string",
    "targets": [
        {
            "community": "string",
            "ip": "string",
            "port": 1
        },
        {
            "community": "string",
            "ip": "string",
            "port": 1
        }
    ],
    "users": [
        {
            "auth_key": "string",
            "priv_key": "string",
            "sec_level": "none",
            "username": "string"
        },
        {
            "auth_key": "string",
            "priv_key": "string",
            "sec_level": "none",
            "username": "string"
        }
    ],
    "v3targets": [
        {
            "ip": "string",
            "port": 1,
            "sec_level": "none",
            "type": "inform",
            "user": "string"
        },
        {
            "ip": "string",
            "port": 1,
            "sec_level": "none",
            "type": "inform",
            "user": "string"
        }
    ]
}
<?xml version="1.0" ?>
<ns0:SNMPConfigReadOnly xmlns:ns0="http://vmware.com/appliance/techpreview/monitoring/snmp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <port>1</port>
  <v3targets-array>
    <array-item>
      <port>1</port>
      <sec_level>none</sec_level>
      <type>inform</type>
      <user>string</user>
      <ip>string</ip>
    </array-item>
    <array-item>
      <port>1</port>
      <sec_level>none</sec_level>
      <type>inform</type>
      <user>string</user>
      <ip>string</ip>
    </array-item>
  </v3targets-array>
  <loglevel>string</loglevel>
  <users-array>
    <array-item>
      <username>string</username>
      <priv_key>string</priv_key>
      <sec_level>none</sec_level>
      <auth_key>string</auth_key>
    </array-item>
    <array-item>
      <username>string</username>
      <priv_key>string</priv_key>
      <sec_level>none</sec_level>
      <auth_key>string</auth_key>
    </array-item>
  </users-array>
  <communities-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </communities-array>
  <enable>true</enable>
  <privacy>AES128</privacy>
  <pid>string</pid>
  <notraps-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </notraps-array>
  <syscontact>string</syscontact>
  <engineid>string</engineid>
  <authentication>none</authentication>
  <remoteusers-array>
    <array-item>
      <engineid>string</engineid>
      <username>string</username>
      <authentication>none</authentication>
      <priv_key>string</priv_key>
      <privacy>AES128</privacy>
      <sec_level>none</sec_level>
      <auth_key>string</auth_key>
    </array-item>
    <array-item>
      <engineid>string</engineid>
      <username>string</username>
      <authentication>none</authentication>
      <priv_key>string</priv_key>
      <privacy>AES128</privacy>
      <sec_level>none</sec_level>
      <auth_key>string</auth_key>
    </array-item>
  </remoteusers-array>
  <syslocation>string</syslocation>
  <targets-array>
    <array-item>
      <port>1</port>
      <community>string</community>
      <ip>string</ip>
    </array-item>
    <array-item>
      <port>1</port>
      <community>string</community>
      <ip>string</ip>
    </array-item>
  </targets-array>
</ns0:SNMPConfigReadOnly>

Attributes:

Name Type Description
Required
authentication string Set the default authentication protocol. Values can be none, MD5, or SHA1.

Defines SNMP authentication protocols Value is one of:
none: NONE
SHA1: SHA1
MD5: MD5
communities string[] Set up to ten communities, each of no more than 64 characters long. The format is: community1[,community2,...]. This setting overwrites any previous settings.
enable boolean Set enable to true/false
engineid string Set SNMPv3 engine ID.
loglevel string System Agent syslog logging level: debug|info|warning|error.
notraps string[] Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent. Use 'reset' to clear the setting.
port long Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.
privacy string Set the default privacy protocol.

Defines SNMP privacy protocols Value is one of:
AES128: AES128
none: NONE
syscontact string System contact string as presented in sysContact.0. Up to 255 characters long.
syslocation string System location string as presented in sysLocation.0. Up to 255 characters long.
targets SNM_pv1_trap_target[] Set up to three targets to which to send SNMPv1 traps.
users SNMP_user[] Set up to five local users.
remoteusers SNMP_remote_user[] Set up remote users.
v3targets SNM_pv3_target[] Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,...].
pid string Set up pid