Skip to main content

Create Syslog Server (v2.1)

POST 

/v2.1/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/syslogservers

Create a syslog server.

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    ID of the site.

    element_id stringrequired

    ID of the element.

Body

Details of the Syslog Server

    description

    The description of the syslog server. Max characters = 1024.

    enable_flow_logging boolean

    Enables export flow logs to the Syslog server.

    enabled boolean

    The Syslog server field is enabled to enable the syslog server.

    id string

    The ID of the Syslog server.

    name string

    The Syslog server name. Max characters = 128.

    protocol string

    The protocol type (TCP, or UDP, or TLS). The default protocol is UDP.

    server_ip string

    The Syslog server IP address.

    server_port int32

    The Syslog server port number. The default port is 514 for TCP or UDP and 6514 for TLS.

    severity_level string

    The Severity Level from a severity level of critical, major, or minor.

    source_interface string

    The source interface for the Syslog server. If no value is entered for this field, then the controller port is considered as the default source interface.

    tags string[]

    A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.

Responses

Successful Operation

Schema
    description

    The description of the syslog server. Max characters = 1024.

    enable_flow_logging boolean

    Enables export flow logs to the Syslog server.

    enabled boolean

    The Syslog server field is enabled to enable the syslog server.

    id string

    The ID of the Syslog server.

    name string

    The Syslog server name. Max characters = 128.

    protocol string

    The protocol type (TCP, or UDP, or TLS). The default protocol is UDP.

    server_ip string

    The Syslog server IP address.

    server_port int32

    The Syslog server port number. The default port is 514 for TCP or UDP and 6514 for TLS.

    severity_level string

    The Severity Level from a severity level of critical, major, or minor.

    source_interface string

    The source interface for the Syslog server. If no value is entered for this field, then the controller port is considered as the default source interface.

    tags string[]

    A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.

Loading...