Skip to content

syslog_server

Configuration for Syslog Server resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
log_level_all<Boolean>Read-writeSend logs of all levels to this syslog server.
name<String>Read-writeSyslog server name.
Minimum length = 1
Maximum length = 128
log_level_warning<Boolean>Read-writeSend logs of level warning to this syslog server.
log_level_error<Boolean>Read-writeSend logs of level error to this syslog server.
port<Integer>Read-writeSyslog server port.
Maximum value =
log_level_info<Boolean>Read-writeSend logs of level info to this syslog server.
log_level_critical<Boolean>Read-writeSend logs of level critical to this syslog server.
ip_address<String>Read-writeSyslog server IP address.
Minimum length = 1
Maximum length = 64
log_level_none<Boolean>Read-writeSend no logs to this syslog server.
log_levels<String>Read-onlySet of all log levels at which messages are sent to this syslog server.
address_type<Integer>Read-onlyConfiguration Type. Values: 0: IPv4, 1: IPv6.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| MODIFY

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: https://<MGMT-IP>/nitro/v1/config/syslog_server?onerror=<String_value>

HTTP Method: null

Request Payload:

{syslog_server: {
<b>"name":<String_value></b>,
<b>"port":<Integer_value></b>,
<b>"ip_address":<String_value></b>,
"log_level_all":<Boolean_value>,
"log_level_info":<Boolean_value>,
"log_level_critical":<Boolean_value>,
"log_level_none":<Boolean_value>,
"log_level_error":<Boolean_value>,
"log_level_warning":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "syslog_server":[{
"log_level_all":<Boolean_value>,
"log_level_alert":<Boolean_value>,
"name":<String_value>,
"log_level_debug":<Boolean_value>,
"log_level_warning":<Boolean_value>,
"log_level_error":<Boolean_value>,
"port":<Integer_value>,
"log_levels":<String_value>,
"log_level_info":<Boolean_value>,
"log_level_notice":<Boolean_value>,
"log_level_critical":<Boolean_value>,
"ip_address":<String_value>,
"log_level_none":<Boolean_value>,
"address_type":<Integer_value>,
"log_level_emergency":<Boolean_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/syslog_server/name_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/syslog_server

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "syslog_server":[{
"log_level_all":<Boolean_value>,
"log_level_alert":<Boolean_value>,
"name":<String_value>,
"log_level_debug":<Boolean_value>,
"log_level_warning":<Boolean_value>,
"log_level_error":<Boolean_value>,
"port":<Integer_value>,
"log_levels":<String_value>,
"log_level_info":<Boolean_value>,
"log_level_notice":<Boolean_value>,
"log_level_critical":<Boolean_value>,
"ip_address":<String_value>,
"log_level_none":<Boolean_value>,
"address_type":<Integer_value>,
"log_level_emergency":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/syslog_server/name_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "syslog_server":[{
"log_level_all":<Boolean_value>,
"log_level_alert":<Boolean_value>,
"name":<String_value>,
"log_level_debug":<Boolean_value>,
"log_level_warning":<Boolean_value>,
"log_level_error":<Boolean_value>,
"port":<Integer_value>,
"log_levels":<String_value>,
"log_level_info":<Boolean_value>,
"log_level_notice":<Boolean_value>,
"log_level_critical":<Boolean_value>,
"ip_address":<String_value>,
"log_level_none":<Boolean_value>,
"address_type":<Integer_value>,
"log_level_emergency":<Boolean_value>}]}

modify

URL: https://<MGMT-IP>/nitro/v1/config/syslog_server/name_value<String>

HTTP Method: null

Request Payload:

{syslog_server:{
"log_level_all":<Boolean_value>,
"name":<String_value>,
"log_level_error":<Boolean_value>,
"log_level_warning":<Boolean_value>,
"port":<Integer_value>,
"log_level_info":<Boolean_value>,
"log_level_critical":<Boolean_value>,
"log_level_none":<Boolean_value>,
"ip_address":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "syslog_server":[{
"log_level_all":<Boolean_value>,
"log_level_alert":<Boolean_value>,
"name":<String_value>,
"log_level_debug":<Boolean_value>,
"log_level_warning":<Boolean_value>,
"log_level_error":<Boolean_value>,
"port":<Integer_value>,
"log_levels":<String_value>,
"log_level_info":<Boolean_value>,
"log_level_notice":<Boolean_value>,
"log_level_critical":<Boolean_value>,
"ip_address":<String_value>,
"log_level_none":<Boolean_value>,
"address_type":<Integer_value>,
"log_level_emergency":<Boolean_value>}]}