Create Syslog Server (v2.2)

POST 
/sdwan/v2.2/api/sites/:site_id/elements/:element_id/syslogservers

Create the syslog server.

Request

Path Parameters

site_id stringrequired

ID of the site.

element_id stringrequired

ID of the element.

application/json

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 stringrequired

The Syslog server name. Max characters = 128.

protocol string

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

remote_ca_certificate string

The standard VPN endpoint CA certificate uploaded for certificate authentication.

server_fqdn string

The Syslog server FQDN domain name.

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.

syslog_profile_id string

The syslog profile ID.

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

200

Successful Operation

application/json

Schema

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 stringrequired

The Syslog server name. Max characters = 128.

protocol string

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

remote_ca_certificate string

The standard VPN endpoint CA certificate uploaded for certificate authentication.

server_fqdn string

The Syslog server FQDN domain name.

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.

syslog_profile_id string

The syslog profile ID.

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.

Example (from schema)

{
  "enable_flow_logging": true,
  "enabled": true,
  "id": "string",
  "name": "string",
  "protocol": "string",
  "remote_ca_certificate": "string",
  "server_fqdn": "string",
  "server_ip": "string",
  "server_port": 0,
  "severity_level": "string",
  "source_interface": "string",
  "syslog_profile_id": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "ELEMENT_NOT_FOUND"
      },
      {
        "code": "ELEMENT_NOT_BOUND"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_EXCEEDS_LIMIT"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_INVALID_PROTOCOL"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_IP_OR_FQDN_REQUIRED"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_INVALID_RANGE"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_NOT_SUPPORTED"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED"
      },
      {
        "code": "SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE"
      }
    ]
  }
}

Loading...