Update Syslog Server (v2.2)
Update the syslog server.
Path Parameters
- tenant_id string required
ID of the tenant.
- site_id string required
ID of the site.
- element_id string required
ID of the element.
- syslogserver_id string required
The syslog server configuration ID.
- application/json
Request 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 required
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.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from 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 string required
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.
{
"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"
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
},
{
"code": "SYSLOGSERVER_CONFIG_IP_OR_FQDN_REQUIRED"
},
{
"code": "SYSLOGSERVER_CONFIG_INVALID_PROTOCOL"
},
{
"code": "SYSLOGSERVER_CONFIG_INVALID_RANGE"
},
{
"code": "SYSLOGSERVER_CONFIG_INVALID_SEVERITY_LEVEL"
},
{
"code": "SYSLOGSERVER_CONFIG_FLOW_LOGGING_NOT_SUPPORTED"
},
{
"code": "SYSLOGSERVER_CONFIG_REQD_SOURCE_INTERFACE"
}
]
}
}