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

appliance techpreview monitoring snmp: set

Set SNMP configuration.

Request:

HTTP request

PUT https://{server}/rest/appliance/techpreview/monitoring/snmp

Request Body Structure:

{
    "config": {
        "authentication": "none",
        "communities": [
            "string",
            "string"
        ],
        "engineid": "string",
        "loglevel": "string",
        "notraps": [
            "string",
            "string"
        ],
        "port": 1,
        "privacy": "AES128",
        "remoteusers": [
            "string",
            "string"
        ],
        "syscontact": "string",
        "syslocation": "string",
        "targets": [
            "string",
            "string"
        ],
        "users": [
            "string",
            "string"
        ],
        "v3targets": [
            "string",
            "string"
        ]
    }
}
<?xml version="1.0" ?>
<ns0:Set-Input xmlns:ns0="http://vmware.com/appliance/techpreview/monitoring/snmp" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <config>
    <port>1</port>
    <v3targets-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </v3targets-array>
    <loglevel>string</loglevel>
    <users-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </users-array>
    <communities-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </communities-array>
    <privacy>AES128</privacy>
    <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>string</array-item>
      <array-item>string</array-item>
    </remoteusers-array>
    <syslocation>string</syslocation>
    <targets-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </targets-array>
  </config>
</ns0:Set-Input>

Request Body Parameters:

Name Type Description
bold = required
config SNMP_config SNMP configuration.
config.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
config.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.
config.engineid string Set SNMPv3 engine ID. The engine ID must contain 5 to 32 hexadecimal characters. "0x" and colon (:) are removed from the ID.
config.loglevel string System Agent syslog logging level: debug|info|warning|error.
config.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.
config.port long Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.
config.privacy string Set the default privacy protocol. Values: none or AES128.

Defines SNMP privacy protocols Value is one of:
AES128: AES128
none: NONE
config.remoteusers string[] Set up to five inform user IDs. The format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id[,...]. Here, user must be maximum 32 characters long; auth-proto is none, MD5 or SHA1; priv-proto is none or AES; '-' indicates no hash; engine-id is a hexadecimal string '0x0-9a-f' and must be up to 32 characters long.
config.syscontact string System contact string as presented in sysContact.0. Up to 255 characters long.
config.syslocation string System location string as presented in sysLocation.0. Up to 255 characters long.
config.targets string[] Set up to three targets to which to send SNMPv1 traps. The format is: ip-or-hostname[@port]/community[,...]. The default port is UDP 162. This setting overwrites any previous settings.
config.users string[] Set up to five local users. The format is: user/-|auth-hash/-|priv-hash/model[,...]. Here user is maximum 32 characters long; '-' indicates no hash; model is one of none, auth or priv.
config.v3targets string[] Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,...].

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error