Skip to content

ns_syslog_task

Configuration for Citrix ADC Syslog Configure Task resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
scheduleTimesEpoch <String> Read-write Schedule time epoch (string representation of 11 digit numbers)..
device_family <String> Read-write Family of Devices for which config template is defined..

Minimum length = 1

Maximum length = 64
device_groups <String[]> Read-write Device Group Array on which for which template is applied.
scheduleTimes <String> Read-write Comma separated times of the day(HH:MM) on which Configuration Template is scheduled.
variables <variable_values[]> Read-write Values of Variables used in commands of the configuration template.
on_error <String> Read-write Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT.

Minimum length = 1

Maximum length = 16
port <Integer> Read-write Syslog server port.

Maximum value =
execute_sequentially <Boolean> Read-write True if configuration template is to be applied to devices sequentially.
tz_offset <Integer> Read-write Time zone offset..
scheduleOptions <String> Read-write Comma separated Options for scheduling Configuration Template.
devices <String[]> Read-write Device IP Address Array on which template is applied.
scheduleType <String> Read-write Schedule Type of Configuration Template that is scheduled.
ip_address <String> Read-write Syslog server IP address.

Minimum length = 1

Maximum length = 64

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)

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/ns_syslog_task?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:

{"ns_syslog_task": {
<b>      "port":<Integer_value></b>,
<b>      "ip_address":<String_value></b>,
      "scheduleTimes":<String_value>,
      "variables":[{
<b>      "name":<String_value></b>,
      "parent_id":<String_value>,
      "default_value":<String_value>,
      "id":<String_value>,
      "values_enum_db":<String_value>,
      "parent_name":<String_value>,
      "value":<String_value>,
      "description":<String_value>,
      "type":<String_value>,
      "valuex":<String_value>,
      "device_values":[{
      "value":<String_value>,
      "id":<String_value>,
      "device":<String_value>,
      "device_group":<String_value>,
      "valuex":<String_value>}],
      "display_name":<String_value>}],
      "execute_sequentially":<Boolean_value>,
      "scheduleTimesEpoch":<String_value>,
      "device_groups":<String_value[]>,
      "device_family":<String_value>,
      "on_error":<String_value>,
      "devices":<String_value[]>,
      "scheduleOptions":<String_value>,
      "tz_offset":<Integer_value>,
      "scheduleType":<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, "ns_syslog_task":[{
      "scheduleTimesEpoch":<String_value>,
      "device_family":<String_value>,
      "device_groups":<String_value>,
      "scheduleTimes":<String_value>,
      "variables":[{
      "device_values_mapping":<String_value>,
      "parent_name":<String_value>,
      "value":<String_value>,
      "name":<String_value>,
      "valuex":<String_value>,
      "display_name":<String_value>,
      "description":<String_value>,
      "device_values":[{
      "parent_name":<String_value>,
      "value":<String_value>,
      "id":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>,
      "device":<String_value>,
      "parent_id":<String_value>}],
      "parent_id":<String_value>,
      "default_value":<String_value>,
      "id":<String_value>,
      "type":<String_value>,
      "values_enum_db":<String_value>}],
      "on_error":<String_value>,
      "port":<Integer_value>,
      "execute_sequentially":<Boolean_value>,
      "tz_offset":<Integer_value>,
      "scheduleOptions":<String_value>,
      "devices":<String_value>,
      "scheduleType":<String_value>,
      "ip_address":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns_syslog_task/

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/ns_syslog_task

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_syslog_task ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_syslog_task 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/ns_syslog_task ?pagesize=#no;pageno=#no

Use this query-parameter to get the ns_syslog_task resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_syslog_task ?count=yes

Use this query-parameter to get the count of ns_syslog_task 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, "ns_syslog_task":[{
      "scheduleTimesEpoch":<String_value>,
      "device_family":<String_value>,
      "device_groups":<String_value>,
      "scheduleTimes":<String_value>,
      "variables":[{
      "device_values_mapping":<String_value>,
      "parent_name":<String_value>,
      "value":<String_value>,
      "name":<String_value>,
      "valuex":<String_value>,
      "display_name":<String_value>,
      "description":<String_value>,
      "device_values":[{
      "parent_name":<String_value>,
      "value":<String_value>,
      "id":<String_value>,
      "valuex":<String_value>,
      "device_group":<String_value>,
      "device":<String_value>,
      "parent_id":<String_value>}],
      "parent_id":<String_value>,
      "default_value":<String_value>,
      "id":<String_value>,
      "type":<String_value>,
      "values_enum_db":<String_value>}],
      "on_error":<String_value>,
      "port":<Integer_value>,
      "execute_sequentially":<Boolean_value>,
      "tz_offset":<Integer_value>,
      "scheduleOptions":<String_value>,
      "devices":<String_value>,
      "scheduleType":<String_value>,
      "ip_address":<String_value>}]}
Was this article helpful?