Send Test trap To SNMP destination profile

Send Test trap to SNMP destination profile. Only admin users can perform this action.

Request

URI

POST

https://{api_host}/api/ni/settings/snmp/profiles/send-test-trap

COPY

Request Body

SNMP destination profile

SnmpProfileRequest of type(s) application/json

Required

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

string

nick_name

Optional

Descriptor or identifier for particular SNMP profile.

string

target_ip

Optional

IP address of SNMP target destination

integer

target_port

Optional

Receiving port number of SNMP target destination

string

snmp_version

Optional

snmp_version

Possible values are : v2c, v3,

SNMP2cConfig

snmp_v2c

Optional

snmp_v2c

SNMP3Config

snmp_v3

Optional

snmp_v3

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns TestSnmpProfileResponse of type(s) application/json

{
    "status": true,
    "message": "Failed sending SNMP trap"
}

boolean

status

Optional

Test trap sent successfully or not

string

message

Optional

Test SNMP trap status message

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

403

Forbidden

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

500

Internal Error

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details