[{"label":"Latest (6.4.0)","version":"latest"}]

vrealize-network-insight-api

Update An Existing SNMP Destination Profile

Description

Update an existing SNMP Trap destination profile. Only admin users can perform this action.

Request

URL

put

https://vrni.example.com/api/ni/settings/snmp/profiles/{id}

Copy

Path Parameters

string

id Required

The Entity ID of object requestion information on

Request Body

SnmpProfileRequest of type(s) application/json Required

SNMP destination profile

{
    "nick_name": "AWS SNMP collector profile",
    "target_ip": "10.11.11.102",
    "target_port": 161
}

string

nick_name Optional

Descriptor or identifier for particular SNMP profile.

SNMP2CConfig

snmp_v2c Optional

SNMP3Config

snmp_v3 Optional

string

snmp_version Optional

Possible values are: v2c , v3

string

target_ip Optional

IP address of SNMP target destination

integer

target_port Optional

Receiving port number of SNMP target destination

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns SnmpProfileResponse of type(s) application/json

{
    "entity_id": "snmp-er67ght8kn67",
    "nick_name": "AWS SNMP collector profile",
    "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.

SNMP2CConfig

snmp_v2c Optional

SNMP3Config

snmp_v3 Optional

string

snmp_version Optional

Possible values are: v2c , v3

string

target_ip Optional

IP address of SNMP target destination

integer

target_port Optional

Receiving port number of SNMP target destination

Errors

ApiError

400

Bad Request

ApiError

401

Unauthorized

ApiError

403

Forbidden

ApiError

404

Not Found

ApiError

500

Internal Error

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"nick_name":"AWS SNMP collector profile","target_ip":"10.11.11.102","target_port":161}' https://vrni.example.com/api/ni/settings/snmp/profiles/{id}

[{"label":"Latest (6.4.0)","version":"latest"}]

vrealize-network-insight-api

Settings Operations

post

Activate Serial Number

post

Add Backup Config

post

Add IP Tag

post

Add New SNMP Trap Destination Profile

post

Add Restore Config

post

Add Search Based Alert Config

post

Add VIdm User

post

Add VIdm User Group

post

Add Web Proxy

post

Create Subnet Mapping

post

Create Subscriber

post

Create User Defined Event

delete

Deactivate Serial Number

delete

Delete An Existing SNMP Trap Destination Profile

delete

Delete Backup Config

delete

Delete Restore Config

delete

Delete Search Based Alert Config

delete

Delete Subnet Mapping

delete

Delete Subscriber

delete

Delete User

delete

Delete User Defined Event

delete

Delete User Group

delete

Delete VIdm Configuration

delete

Delete Web Proxy

post

Disable Search Based Alert Config

post

Disable User Defined Event

post

Disable VIdm

post

Enable Search Based Alert Config

post

Enable User Defined Event

post

Enable VIdm

get

Get All Search Based Alert Configs

get

Get All Subscriber

get

Get All User Defined Events

get

Get Backup Config

get

Get Backup Status Report

get

Get Certificate

get

Get Connected Clients To Web Proxy

get

Get Details Of An Existing SNMP Destination Profile

get

Get IP Tag

get

Get IP Tag Ids

get

Get Infra Nodes Web Proxy

get

Get Licenses

get

Get Restore Config

get

Get Restore Status Report

get

Get Search Based Alert Config

get

Get Subnet Mappings

get

Get Subscriber

get

Get User

get

Get User Defined Event

get

Get User Group

get

Get User Groups

get

Get Users

get

Get VIdm Configuration

get

Get Web Proxies

get

Get Web Proxy

get

List The Configured SNMP Trap Destination Profiles

post

Migrate Event Subscriptions To Other SNMP Trap Destination Profiles

post

Remove IP Tag

post

Save VIdm Configuration

post

Send Test Trap To SNMP Destination Profile

put

Update An Existing SNMP Destination Profile

put

Update Backup Config

put

Update Search Based Alert Config

put

Update Subnet Mapping

put

Update Subscriber

put

Update User Defined Event

put

Update User Password

put

Update VIdm Configuration

put

Update VIdm User Group Role

put

Update VIdm User Role

put

Update Web Proxy

post

Validate Connections via Web Proxy

post

Validate Serial Number

post

Validate Web Proxy Migration

Update An Existing SNMP Destination Profile

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Settings Operations

Was this page helpful?