Avi AlertSyslogConfig Object API
CLI ``` - configure alertsyslogconfig - show alertsyslogconfig - test alerttestsyslog ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /alertsyslogconfigpost /alertsyslogconfigdelete /alertsyslogconfig/{uuid}get /alertsyslogconfig/{uuid}patch /alertsyslogconfig/{uuid}put /alertsyslogconfig/{uuid}post /alertsyslogconfig/{uuid}/testsyslog
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.
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"syslog_servers" : [ {
"udp" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"tls_enable" : true,
"format" : "aeiou",
"syslog_server" : "aeiou",
"pkiprofile_ref" : "aeiou",
"syslog_server_port" : 123,
"anon_auth" : true
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "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.
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
Example data
Content-Type: application/json
{
"syslog_servers" : [ {
"udp" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"tls_enable" : true,
"format" : "aeiou",
"syslog_server" : "aeiou",
"pkiprofile_ref" : "aeiou",
"syslog_server_port" : 123,
"anon_auth" : true
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "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.
Responses
200
OK
AlertSyslogConfig
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 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.
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
Example data
Content-Type: application/json
{
"syslog_servers" : [ {
"udp" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"tls_enable" : true,
"format" : "aeiou",
"syslog_server" : "aeiou",
"pkiprofile_ref" : "aeiou",
"syslog_server_port" : 123,
"anon_auth" : true
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "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.
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
Example data
Content-Type: application/json
{
"syslog_servers" : [ {
"udp" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"tls_enable" : true,
"format" : "aeiou",
"syslog_server" : "aeiou",
"pkiprofile_ref" : "aeiou",
"syslog_server_port" : 123,
"anon_auth" : true
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "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.
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
Example data
Content-Type: application/json
{
"syslog_servers" : [ {
"udp" : true,
"ssl_key_and_certificate_ref" : "aeiou",
"tls_enable" : true,
"format" : "aeiou",
"syslog_server" : "aeiou",
"pkiprofile_ref" : "aeiou",
"syslog_server_port" : 123,
"anon_auth" : true
} ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"description" : "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.
Responses
200
OK
AlertSyslogConfig
401
log in failed
Up
post /alertsyslogconfig/{uuid}/testsyslog
(alertsyslogconfigUuidTestsyslogPost)
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
AlertSyslogConfigAlertSyslogConfigApiResponseAlertSyslogServerAlertTestSyslogSnmpParamsConfigPbAttributes
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
description (optional)
String User defined description for alert syslog config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String A user-friendly name of the syslog notification. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
syslog_servers (optional)
array[AlertSyslogServer] The list of syslog servers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
anon_auth (optional)
Boolean Enable anonymous authentication of Syslog Serverwhich will disable server certificate authentication. Field introduced in 17.2.17, 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
format (optional)
String Syslog output format - legacy, RFC 5424, JSON. Enum options - SYSLOG_LEGACY, SYSLOG_RFC5424, SYSLOG_JSON, SYSLOG_RFC5425_ENHANCED. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pkiprofile_ref (optional)
String Select the PKIProfile containing a CA or list of CA chainswhich will validate the certificate of the syslog server. It is a reference to an object of type PKIProfile. Field introduced in 17.2.17, 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_key_and_certificate_ref (optional)
String Select a certificate and key which will be used to authenticate to the syslog server. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 17.2.17, 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
syslog_server
String The destination Syslog server IP address or hostname. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
syslog_server_port (optional)
Integer The destination Syslog server's service port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
tls_enable (optional)
Boolean Enable TLS to the syslog server. Field introduced in 17.2.16, 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
udp
Boolean Network protocol to establish syslog session. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
text
String The contents of the Syslog message/SNMP Trap contents. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32