[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Add New SNMP Trap Destination Profile

Description

Add a new SNMP destination profile. By Default, maximum of 4 SNMP Trap profiles can be configured. Only admin users can perform this action.

Request

Request

URL

URL


post
https://vrni.example.com/api/ni/settings/snmp/profiles
Copy

Request Body

Request Body

SnmpProfileRequest of type(s) application/json Required

SNMP Trap destination profile

{
	"nick_name": "AWS SNMP collector profile",
	"snmp_v2c": {
		"community_string": "public"
	},
	"snmp_v3": {
		"authentication_password": "VMware1!",
		"authentication_type": "MD5",
		"context_name": "default",
		"privacy_password": "VMware1!",
		"privacy_type": "AES256",
		"username": "readonly"
	},
	"snmp_version": "v2c",
	"target_ip": "10.11.11.102",
	"target_port": 161
}
string
nick_name Optional

Descriptor or identifier for particular SNMP profile.


snmp_v2c Optional

snmp_v3 Optional

string
snmp_version Optional

Possible values are: v2cv3


string
target_ip Optional

IP address of SNMP target destination


integer
target_port Optional

Receiving port number of SNMP target destination

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns SnmpProfileResponse of type(s) application/json
{
	"entity_id": "snmp-er67ght8kn67",
	"nick_name": "AWS SNMP collector profile",
	"snmp_v2c": {
		"community_string": "public"
	},
	"snmp_v3": {
		"authentication_password": "VMware1!",
		"authentication_type": "MD5",
		"context_name": "default",
		"privacy_password": "VMware1!",
		"privacy_type": "AES256",
		"username": "readonly"
	},
	"snmp_version": "v2c",
	"target_ip": "10.11.11.102",
	"target_port": 161
}
string
entity_id Optional

Entity Identifier for SNMP profile.


string
nick_name Optional

User defined descriptor or identifier for particular SNMP profile.


snmp_v2c Optional

snmp_v3 Optional

string
snmp_version Optional

Possible values are: v2cv3


string
target_ip Optional

IP address of SNMP target destination


integer
target_port Optional

Receiving port number of SNMP target destination

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"nick_name":"AWS SNMP collector profile","snmp_v2c":{"community_string":"public"},"snmp_v3":{"authentication_password":"VMware1!","authentication_type":"MD5","context_name":"default","privacy_password":"VMware1!","privacy_type":"AES256","username":"readonly"},"snmp_version":"v2c","target_ip":"10.11.11.102","target_port":161}' https://vrni.example.com/api/ni/settings/snmp/profiles


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?