NetScaler SDX 14.1 NITRO API Reference

syslog_server

Configuration for Syslog Server resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
log_level_all Read-write Send logs of all levels to this syslog server.
name Read-write Syslog server name.

Minimum length = 1

Maximum length = 128
log_level_warning Read-write Send logs of level warning to this syslog server.
log_level_error Read-write Send logs of level error to this syslog server.
port Read-write Syslog server port.

Maximum value =
log_level_info Read-write Send logs of level info to this syslog server.
log_level_critical Read-write Send logs of level critical to this syslog server.
ip_address Read-write Syslog server IP address.

Minimum length = 1

Maximum length = 64
log_level_none Read-write Send no logs to this syslog server.
log_levels Read-only Set of all log levels at which messages are sent to this syslog server.
address_type Read-only Configuration 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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/syslog_server?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/syslog_server/name_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/syslog_server Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/syslog_server ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of syslog_server resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/syslog_server ?pagesize=#no;pageno=#no Use this query-parameter to get the syslog_server resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/syslog_server ?count=yes Use this query-parameter to get the count of syslog_server resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/syslog_server/name_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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/v2/config/syslog_server/name_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}
syslog_server