Citrix ADM NITRO API Reference

syslog_purge_setting_details

Configuration for Syslog Purge Setting Details resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
syslog_detail_type_desc <String> Read-write syslog groups.

Maximum length = 255
parent_name <String> Read-write .
syslog_type <String> Read-write syslog groups.

Maximum length = 255
syslog_module <String> Read-write syslog modulename.

Maximum length = 255
id <String> Read-write Id is system generated key for all the events.
syslog_detail_purge_interval <Integer> Read-write Purge interval for syslog groups..
parent_id <String> Read-write ID of syslog_purge_setting_details.

Operations

(click to see Properties )

    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

    syslog_purge_setting_details