Citrix ADM NITRO API Reference

trigger_detail

Configuration for Trigger Detail resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
expiry <String> Read-write Time at which the trigger should end.Format:YY:MM:DD:HH:MM.Applicable for trigger of type fixed.
parent_name <String> Read-write .
daily_time <String> Read-write Time of the day.Format is HH:MM where HH is hours and MM is minutes.Applicable for trigger of type daily.
trigger_type <String> Read-write Trigger type.Possible values: fixed,daily,weekly,monthly.

Minimum length = 1

Maximum length = 128
recur_hr <String> Read-write Recur interval in hours. Applicable for trigger of type fixed.
duration <String> Read-write Duration in days for which the trigger should last. Applicable for trigger of type fixed.
description <String> Read-write Trigger description.
parent_id <String> Read-write .
monthday_time <String> Read-write Days of the month.Format is DD:HH:MM where DD is either 1-31 or last for days of the month,HH is hours and MM is minutes.Applicable for trigger of type monthly..
id <String> Read-write .
weekday_time <String> Read-write Days of the week.Format is Day:HH:MM where Day is 0-6 for sunday-saturday,HH is hours and MM is minutes.Applicable for trigger of type weekly.
recur_min <String> Read-write Recur interval in minutes. Applicable for trigger of type fixed.
start <String> Read-write Time at which the trigger should start.Format:YY:MM:DD:HH:MM.

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

    trigger_detail