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

appliance techpreview monitoring snmp: get

Return an SNMP agent configuration.

Request:

HTTP request

GET https://{server}/rest/appliance/techpreview/monitoring/snmp
No request parameters

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "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:Get-Result xmlns:ns0="http://vmware.com/appliance/techpreview/monitoring/snmp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <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>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value SNMP_config_read_only SNMP config structure.
value.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
value.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.
value.enable boolean Set enable to true/false
value.engineid string Set SNMPv3 engine ID.
value.loglevel string System Agent syslog logging level: debug|info|warning|error.
value.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.
value.port long Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.
value.privacy string Set the default privacy protocol.

Defines SNMP privacy protocols Value is one of:
AES128: AES128
none: NONE
value.syscontact string System contact string as presented in sysContact.0. Up to 255 characters long.
value.syslocation string System location string as presented in sysLocation.0. Up to 255 characters long.
value.targets SNM_pv1_trap_target[] Set up to three targets to which to send SNMPv1 traps.
value.targets[].ip string SNMP target ip
value.targets[].port long SNMP target port
value.targets[].community string SNMP target community
value.users SNMP_user[] Set up to five local users.
value.users[].username string SNMP Username
value.users[].sec_level string SNMP security level

Defines SNMP decurity levels Value is one of:
none: none
auth: auth
priv: priv
value.users[].auth_key string SNMP authorization key
value.users[].priv_key string SNMP privacy key
value.remoteusers SNMP_remote_user[] Set up remote users.
value.remoteusers[].username string SNMP Username
value.remoteusers[].sec_level string SNMP security level

Defines SNMP decurity levels Value is one of:
none: none
auth: auth
priv: priv
value.remoteusers[].authentication string SNMP authorization protocol

Defines SNMP authentication protocols Value is one of:
none: NONE
SHA1: SHA1
MD5: MD5
value.remoteusers[].auth_key string SNMP authorization key
value.remoteusers[].privacy string SNMP privacy protocol

Defines SNMP privacy protocols Value is one of:
AES128: AES128
none: NONE
value.remoteusers[].priv_key string SNMP privacy key
value.remoteusers[].engineid string SNMP v3 engine id
value.v3targets SNM_pv3_target[] Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,...].
value.v3targets[].type string SNMP target type

Defines SNMP v3 notification types Value is one of:
inform: inform
trap: trap
value.v3targets[].sec_level string SNMP security level

Defines SNMP decurity levels Value is one of:
none: none
auth: auth
priv: priv
value.v3targets[].ip string SNMP target ip
value.v3targets[].port long SNMP target port
value.v3targets[].user string SNMP User
value.pid string Set up pid

Errors:

HTTP Status Code Type Description
500 error Generic error