Configuration settings for the address and protocol of the SNMP server.

URL

GET https://<IP-address-of-SPS>/api/configuration/management/snmp/trap

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API. Note that this session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Sample request

The following command lists the configuration of the SNMP server.

curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/snmp/trap

Response

The following is a sample response received when listing the address and protocol settings of the SNMP server.

For details of the meta object, see Message format.

{
  "body": {
    "enabled": true,
    "version": {
      "selection": "2c",
      "value": {
        "community": "public",
        "server": {
          "selection": "ip",
          "value": "10.20.30.40"
        }
      }
    }
  },
  "key": "trap",
  "meta": {
    "first": "/api/configuration/management/snmp/trap",
    "href": "/api/configuration/management/snmp/trap",
    "last": "/api/configuration/management/snmp/trap",
    "next": null,
    "parent": "/api/configuration/management/snmp",
    "previous": null,
    "transaction": "/api/transaction"
  }
}

Element		Type	Description
key		string	Top level element, contains the ID of the endpoint.
body		Top level element (string)	Contains the address and protocol settings of the SNMP server.
	enabled	boolean	Set to true to send alerts to an SNMP server.
	version	Top level item	Contains the configuration settings for the server address, and the SNMP protocol.

Elements of version			Type	Description
selection			string	Defines the SNMP protocol to use. Possible values are: 2c Configures version 2c of the SNMP protocol. 3 Configures version 3 of the SNMP protocol.
value			Top level item	Contains the SNMP server address, and the protocol-specific settings.
	auth_method		string	Required parameter when using SNMP version 3. Configures encrypted communication with the SNMP server. Possible values are: md5: Use MD5 encryption. The auth_password element must reference a valid password. sha1: Use SHA1 encryption. The auth_password element must reference a valid password.
	auth_password		string	Required parameter when using SNMP version 3. References the password used for authenticating to the SNMP server. You can create passwords at the /api/configuration/passwords/ endpoint. To modify or add a password, use the value of the returned key as the value of the password element, and remove any child elements (including the key). The referenced password must be at least 8 characters long, and can contain letters (a-z, A-Z), numbers (0-9) the special characters (!"#$%&'()*+,;<=&@[\]^`{|}_./:?-) and the space character.
	community		string	Must be used if version 2c of the SNMP protocol is configured. The name of the SNMP community.
	encryption_method		string	Must be used if version 3 of the SNMP protocol is configured. Configures encrypted communication with the SNMP server. Possible values are: none: No encryption. The value of the encryption_password element must also be set to null. aes: AES encryption. The encryption_password element must reference a valid password. des: DES encryption. The encryption_password element must reference a valid password.
	encryption_password		string	Must be used if version 3 of the SNMP protocol is configured. Set to null if the value of the encryption_method is set to none. References the password used for encrypting the communication with the SNMP server. You can create passwords at the /api/configuration/passwords/ endpoint. To modify or add a password, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). The referenced password must be at least 8 characters long, and can contain letters (a-z, A-Z), numbers (0-9) the special characters (!"#$%&'()*+,;<=&@[\]^`{|}_./:?-) and the space character.
	engine_id		string	Must be used if version 3 of the SNMP protocol is configured. The Engine ID. Must be a a hexadecimal number at least 10 digits long (for example, 0x0123456789ABCDEF).
	server		top level item	Contains the IP address of FQDN of the SNMP server.
		selection	string	Defines the address type (IP or domain name). Possible values are: fqdn The SNMP server address is provided as a fully qualified domain name. ip The SNMP server address is provided as an IP address.
		value	string	The address of the SNMP server.
	username		string	Must be used if version 3 of the SNMP protocol is configured. The username for sending SNMP traps.

Examples:

Configure a server with the SNMP v2c protcol.

{
  "enabled": true,
  "version": {
    "selection": "2c",
    "value": {
      "community": "public",
      "server": {
        "selection": "ip",
        "value": "<server-ip>"
      }
    }
  }
}

Configure a server with the SNMP v3 protocol, and MD5 authentication.

{
  "enabled": true,
  "version": {
    "selection": "3",
    "value": {
      "auth_method": "md5",
      "auth_password": {
        "key": "d21f3675-8dff-43c5-a982-17839390a6b3",
        "meta": {
          "href": "/api/configuration/passwords/d21f3675-8dff-43c5-a982-17839390a6b3"
        }
      },
      "encryption_method": "none",
      "encryption_password": null,
      "engine_id": "<0x0123456789ABCDEF>",
      "server": {
        "selection": "ip",
        "value": "<server-ip>"
      },
      "username": "<username>"
    }
  }
}

Configure a server with the SNMP v3 protocol, SHA1 authentication, and AES-encrypted communication.

{
  "enabled": true,
  "version": {
    "selection": "3",
    "value": {
      "auth_method": "sha",
      "auth_password": {
        "key": "0f5f646d-d6e7-4a4a-bc66-ead670faff3f",
        "meta": {
          "href": "/api/configuration/passwords/0f5f646d-d6e7-4a4a-bc66-ead670faff3f"
        }
      },
      "encryption_method": "aes",
      "encryption_password": {
        "key": "6237d67a-b6b4-49e0-b0f6-6d68d0f08cc3",
        "meta": {
          "href": "/api/configuration/passwords/6237d67a-b6b4-49e0-b0f6-6d68d0f08cc3"
        }
      },
      "engine_id": "<0x0123456789ABCDEF>",
      "server": {
        "selection": "ip",
        "value": "<server-ip>"
      },
      "username": "<username>"
    }
  }
}

Modify SNMP trap settings

To modify the address and protocol settings for the SNMP server, you have to:

1. Open a transaction.

   For details, see Open a transaction.

2. Modify the JSON object of the SNMP trap endpoint.

   PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/snmp/trap endpoint. You can find a detailed description of the available parameters listed in Element .

3. Commit your changes.

   For details, see Commit a transaction.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
201	Created	The new resource was successfully created.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
401	AuthenticationFailure	Authenticating the user with the given credentials has failed.
404	NotFound	The requested object does not exist.