AlertSyslogConfig

Description

API


    POST /api/alertsyslogconfig
    PUT /api/alertsyslogconfig/<key>
    DELETE /api/alertsyslogconfig/<key>
    GET /api/alertsyslogconfig
    GET /api/alertsyslogconfig/<key>

CLI


    configure alertsyslogconfig <key>
    show alertsyslogconfig <key>

Data

AlertSyslogConfig

uuid

Type
string
Category
required
Description

name

Type
string
Category
required
Description
A user-friendly name of the syslog notification

syslog_servers

Type
AlertSyslogServer
Category
repeated
Description
The list of syslog servers

description

Type
string
Category
optional
Description
User defined description for alert syslog config

tenant_ref

Type
Reference to Tenant
Category
optional
Description

AlertSyslogServer

syslog_server

Type
string
Category
required
Description
The destination Syslog server IP address or hostname.

syslog_server_port

Type
uint32
Category
optional
Description
The destination Syslog server's service port.
Default
514

udp

Type
bool
Category
required
Description
Network protocol to establish syslog session
Default
True

Actions

API


    POST /api/alertsyslogconfig/<key>/testsyslog

CLI


    test alerttestsyslog <key>

Data

AlertTestSyslogSnmpParams

text

Type
string
Category
required
Description
The contents of the Syslog message/SNMP Trap contents

References

Tenant

Sub Objects