Avi SnmpTrapProfile Object API

CLI ``` - configure snmptrapprofile - show snmptrapprofile - test alerttestsnmptrap ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /snmptrapprofile
post /snmptrapprofile
post /snmptrapprofile/{uuid}/alerttestsnmptrap
delete /snmptrapprofile/{uuid}
get /snmptrapprofile/{uuid}
patch /snmptrapprofile/{uuid}
put /snmptrapprofile/{uuid}

get /snmptrapprofile

(snmptrapprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SnmpTrapProfileApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "trap_servers" : [ {
      "port" : 123,
      "community" : "aeiou",
      "ip_addr" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "user" : {
        "auth_type" : "aeiou",
        "auth_passphrase" : "aeiou",
        "priv_passphrase" : "aeiou",
        "priv_type" : "aeiou",
        "username" : "aeiou"
      },
      "version" : "aeiou"
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SnmpTrapProfileApiResponse

401

post /snmptrapprofile

(snmptrapprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SnmpTrapProfile object creation

Return type

SnmpTrapProfile

Example data

Content-Type: application/json

{
  "trap_servers" : [ {
    "port" : 123,
    "community" : "aeiou",
    "ip_addr" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "user" : {
      "auth_type" : "aeiou",
      "auth_passphrase" : "aeiou",
      "priv_passphrase" : "aeiou",
      "priv_type" : "aeiou",
      "username" : "aeiou"
    },
    "version" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SnmpTrapProfile

401

post /snmptrapprofile/{uuid}/alerttestsnmptrap

(snmptrapprofileUuidAlerttestsnmptrapPost)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — AlertTestSyslogSnmpParams

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK String

401

delete /snmptrapprofile/{uuid}

(snmptrapprofileUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /snmptrapprofile/{uuid}

(snmptrapprofileUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SnmpTrapProfile

Example data

Content-Type: application/json

{
  "trap_servers" : [ {
    "port" : 123,
    "community" : "aeiou",
    "ip_addr" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "user" : {
      "auth_type" : "aeiou",
      "auth_passphrase" : "aeiou",
      "priv_passphrase" : "aeiou",
      "priv_type" : "aeiou",
      "username" : "aeiou"
    },
    "version" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SnmpTrapProfile

401

patch /snmptrapprofile/{uuid}

(snmptrapprofileUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SnmpTrapProfile object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SnmpTrapProfile

Example data

Content-Type: application/json

{
  "trap_servers" : [ {
    "port" : 123,
    "community" : "aeiou",
    "ip_addr" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "user" : {
      "auth_type" : "aeiou",
      "auth_passphrase" : "aeiou",
      "priv_passphrase" : "aeiou",
      "priv_type" : "aeiou",
      "username" : "aeiou"
    },
    "version" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SnmpTrapProfile

401

put /snmptrapprofile/{uuid}

(snmptrapprofileUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SnmpTrapProfile object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SnmpTrapProfile

Example data

Content-Type: application/json

{
  "trap_servers" : [ {
    "port" : 123,
    "community" : "aeiou",
    "ip_addr" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "user" : {
      "auth_type" : "aeiou",
      "auth_passphrase" : "aeiou",
      "priv_passphrase" : "aeiou",
      "priv_type" : "aeiou",
      "username" : "aeiou"
    },
    "version" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SnmpTrapProfile

401

Models

[ Jump to Methods ]

AlertTestSyslogSnmpParams
IpAddr
SnmpTrapProfile
SnmpTrapProfileApiResponse
SnmpTrapServer
SnmpV3UserParams

AlertTestSyslogSnmpParams Up

text

String The contents of the Syslog message/SNMP Trap contents.

uuid (optional)

String Unique object identifier of the object.

IpAddr Up

addr

String IP address.

type

String Enum options - V4, DNS, V6.

SnmpTrapProfile Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

name

String A user-friendly name of the SNMP trap configuration.

tenant_ref (optional)

String It is a reference to an object of type Tenant.

trap_servers (optional)

array[SnmpTrapServer] The IP address or hostname of the SNMP trap destination server.

url (optional)

String url

uuid (optional)

String UUID of the SNMP trap profile object.

SnmpTrapProfileApiResponse Up

count

Integer format: int32

results

array[SnmpTrapProfile]

next (optional)

String

SnmpTrapServer Up

community (optional)

String The community string to communicate with the trap server.

ip_addr

IpAddr IP Address of the SNMP trap destination.

port (optional)

Integer The UDP port of the trap server. Field introduced in 16.5.4,17.2.5. format: int32

user (optional)

SnmpV3UserParams SNMP version 3 configuration. Field introduced in 17.2.3.

version (optional)

String SNMP version support. V2 or V3. Enum options - SNMP_VER2, SNMP_VER3. Field introduced in 17.2.3.

SnmpV3UserParams Up

auth_passphrase (optional)

String SNMP V3 authentication passphrase. Field introduced in 17.2.3.

auth_type (optional)

String SNMP V3 user authentication type. Enum options - SNMP_V3_AUTH_MD5, SNMP_V3_AUTH_SHA, SNMP_V3_AUTH_SHA_224, SNMP_V3_AUTH_SHA_256, SNMP_V3_AUTH_SHA_384, SNMP_V3_AUTH_SHA_512. Field introduced in 17.2.3.

priv_passphrase (optional)

String SNMP V3 privacy passphrase. Field introduced in 17.2.3.

priv_type (optional)

String SNMP V3 privacy setting. Enum options - SNMP_V3_PRIV_DES, SNMP_V3_PRIV_AES. Field introduced in 17.2.3.

username (optional)

String SNMP username to be used by SNMP clients for performing SNMP walk. Field introduced in 17.2.3.

Avi SnmpTrapProfile Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents