Avi AlertSyslogConfig Object API

##CLI## ``` - configure alertsyslogconfig - show alertsyslogconfig - test alerttestsyslog ```
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 /alertsyslogconfig
  2. post /alertsyslogconfig
  3. post /alertsyslogconfig/{uuid}/alerttestsyslog
  4. delete /alertsyslogconfig/{uuid}
  5. get /alertsyslogconfig/{uuid}
  6. patch /alertsyslogconfig/{uuid}
  7. put /alertsyslogconfig/{uuid}
Up
get /alertsyslogconfig
( alertsyslogconfigGet)

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

AlertSyslogConfigApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "syslog_servers" : [ {
      "udp" : true,
      "syslog_server" : "aeiou",
      "syslog_server_port" : 123
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "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 AlertSyslogConfigApiResponse

401

log in failed

Up
post /alertsyslogconfig
( alertsyslogconfigPost)

Consumes

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

Request body

body (required)
Body Parameter — AlertSyslogConfig object creation

Return type

AlertSyslogConfig

Example data

Content-Type: application/json
{
  "syslog_servers" : [ {
    "udp" : true,
    "syslog_server" : "aeiou",
    "syslog_server_port" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "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 AlertSyslogConfig

401

log in failed

Up
post /alertsyslogconfig/{uuid}/alerttestsyslog
( alertsyslogconfigUuidAlerttestsyslogPost)

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 /alertsyslogconfig/{uuid}
( alertsyslogconfigUuidDelete)

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 /alertsyslogconfig/{uuid}
( alertsyslogconfigUuidGet)

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

AlertSyslogConfig

Example data

Content-Type: application/json
{
  "syslog_servers" : [ {
    "udp" : true,
    "syslog_server" : "aeiou",
    "syslog_server_port" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "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 AlertSyslogConfig

401

log in failed

Up
patch /alertsyslogconfig/{uuid}
( alertsyslogconfigUuidPatch)

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 — AlertSyslogConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AlertSyslogConfig

Example data

Content-Type: application/json
{
  "syslog_servers" : [ {
    "udp" : true,
    "syslog_server" : "aeiou",
    "syslog_server_port" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "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 AlertSyslogConfig

401

log in failed

Up
put /alertsyslogconfig/{uuid}
( alertsyslogconfigUuidPut)

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 — AlertSyslogConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AlertSyslogConfig

Example data

Content-Type: application/json
{
  "syslog_servers" : [ {
    "udp" : true,
    "syslog_server" : "aeiou",
    "syslog_server_port" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "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 AlertSyslogConfig

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AlertSyslogConfig
  2. AlertSyslogConfigApiResponse
  3. AlertSyslogServer
  4. AlertTestSyslogSnmpParams

AlertSyslogConfig Up

description (optional)
String User defined description for alert syslog config.
name
String A user-friendly name of the syslog notification.
syslog_servers (optional)
array[AlertSyslogServer] The list of syslog servers.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

AlertSyslogConfigApiResponse Up

count
Integer format: int32
results

AlertSyslogServer Up

syslog_server
String The destination Syslog server IP address or hostname.
syslog_server_port (optional)
Integer The destination Syslog server's service port. format: int32
udp
Boolean Network protocol to establish syslog session.

AlertTestSyslogSnmpParams Up

text
String The contents of the Syslog message/SNMP Trap contents.
uuid (optional)
String Unique object identifier of the object.