Avi SnmpTrapProfile Object API

##CLI## ``` - configure snmptrapprofile - show snmptrapprofile - test alerttestsnmptrap ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /snmptrapprofile
  2. post /snmptrapprofile
  3. post /snmptrapprofile/{uuid}/alerttestsnmptrap
  4. delete /snmptrapprofile/{uuid}
  5. get /snmptrapprofile/{uuid}
  6. patch /snmptrapprofile/{uuid}
  7. put /snmptrapprofile/{uuid}
Up
get /snmptrapprofile
(snmptrapprofileGet)

Consumes

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

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.
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
{
  "count" : 123,
  "results" : [ {
    "trap_servers" : [ {
      "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"
  } ]
}

Produces

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

Responses

200

OK SnmpTrapProfileApiResponse

401

log in failed

Up
post /snmptrapprofile
(snmptrapprofilePost)

Consumes

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

Request body

body (required)
Body Parameter — SnmpTrapProfile object creation

Return type

SnmpTrapProfile

Example data

Content-Type: application/json
{
  "trap_servers" : [ {
    "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"
}

Produces

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

Responses

200

OK SnmpTrapProfile

401

log in failed

Up
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:

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

401

log in failed

Up
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:

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
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:

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.
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" : [ {
    "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"
}

Produces

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

Responses

200

OK SnmpTrapProfile

401

log in failed

Up
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:

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" : [ {
    "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"
}

Produces

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

Responses

200

OK SnmpTrapProfile

401

log in failed

Up
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:

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" : [ {
    "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"
}

Produces

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

Responses

200

OK SnmpTrapProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AlertTestSyslogSnmpParams
  2. IpAddr
  3. SnmpTrapProfile
  4. SnmpTrapProfileApiResponse
  5. SnmpTrapServer
  6. 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.

SnmpTrapProfile Up

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

SnmpTrapServer Up

community (optional)
String The community string to communicate with the trap server.
ip_addr
IpAddr IP Address of the SNMP trap destination.
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. 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.