Citrix ADM NITRO API Reference

notify_service

Configuration for Notify Service resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
tenant_name <String> Read-write Tenant name for which notification to be sent..

Minimum length = 1

Maximum length = 128
template_name <String> Read-write Notification template name for different services..

Minimum length = 1

Maximum length = 128
notification_type <String> Read-write Notification type - email/slack/service-now/pager-duty.

Minimum length = 1

Maximum length = 128
servicenow_msg_body <String> Read-write Service now message body.
email_subject <String> Read-write Email Subject.
pagerduty_msg_body <String> Read-write Pager Duty Message Body.
slack_msg_body <String> Read-write Slack message body.
id <String> Read-write Id is system generated key..
severity <String> Read-write EVENT_SEV_CRITICAL_HEX = #cf3434,EVENT_SEV_MAJOR_HEX = #ff9e47,EVENT_SEV_MINOR_HEX = #b2af45,EVENT_SEV_WARNING_HEX = #ffd71c,EVENT_SEV_CLEAR_HEX = #49bf62,EVENT_SEV_INFORMATION_HEX = #21a9ef,EVENT_SEV_ALERT_HEX= #ffd71c,EVENT_SEV_NOTICE_HEX= #ffd71c,EVENT_SEV_EMERG_HEX = #cf3434,EVENT_SEV_UNKNOWN_HEX = #999999,EVENT_SEV_ERROR_HEX = #cf3434.
profile_name <String> Read-write Profile name through which notifications will be sent..

Minimum length = 1

Maximum length = 128
email_msg_body <String> Read-write Email notification body.

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

    notify_service