Citrix ADM NITRO API Reference

sms_server

Configuration for SMS server properties resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
optional1_val <String> Read-write Optional1 Val for the sms server.

Maximum length = 128
to_seperater <String> Read-write To list seperater for the sms server.

Maximum length = 128
username_val <String> Read-write Username val for the sms server.

Maximum length = 128
to_key <String> Read-write To key for the sms server.

Maximum length = 128
id <String> Read-write Id is system generated key for all the sms server.
is_ssl <Boolean> Read-write Is SSL support configured..
base_url <String> Read-write Base URL for the sms server, without payload.

Maximum length = 2000
username_key <String> Read-write Username key for the sms server.

Maximum length = 128
optional1_key <String> Read-write Optional1 key for the sms server.

Maximum length = 128
message_key <String> Read-write Message key for the sms server.

Maximum length = 128
message_word_sperater <String> Read-write Message Word Seperater for the sms server.

Maximum length = 128
type <String> Read-write HTTP type supported for the sms server.

Maximum length = 128
password_val <String> Read-write Password Val for the sms server.

Maximum length = 128
password_key <String> Read-write Password key for the sms server.

Maximum length = 128
server_name <String> Read-write SMS server name.

Minimum length = 1

Maximum length = 128
tenant_id <String> Read-only Tenant Id of the Config Jobs.

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • UPDATE

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/sms_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:

{"sms_server": {
<b>"username_val":<String_value></b>,
<b>"to_key":<String_value></b>,
<b>"base_url":<String_value></b>,
<b>"username_key":<String_value></b>,
<b>"message_key":<String_value></b>,
<b>"type":<String_value></b>,
<b>"password_val":<String_value></b>,
<b>"password_key":<String_value></b>,
<b>"server_name":<String_value></b>,
"optional1_val":<String_value>,
"to_seperater":<String_value>,
"message_word_sperater":<String_value>,
"is_ssl":<Boolean_value>,
"optional1_key":<String_value>,
"id":<String_value>}}

<!--NeedCopy-->

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, "sms_server":[{
"optional2_val1":<String_value>,
"optional1_val":<String_value>,
"to_seperater":<String_value>,
"username_val":<String_value>,
"to_key":<String_value>,
"tenant_id":<String_value>,
"optional3_key":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"optional3_val":<String_value>,
"base_url":<String_value>,
"username_key":<String_value>,
"optional2_key":<String_value>,
"optional1_key":<String_value>,
"message_key":<String_value>,
"message_word_sperater":<String_value>,
"type":<String_value>,
"password_val":<String_value>,
"password_key":<String_value>,
"server_name":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/sms_server/id_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 }

<!--NeedCopy-->

get (all)

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

filter https://<MGMT-IP>/nitro/v2/config/sms_server ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of sms_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/sms_server ?pagesize=#no;pageno=#no Use this query-parameter to get the sms_server resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/sms_server ?count=yes Use this query-parameter to get the count of sms_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, "sms_server":[{
"optional2_val1":<String_value>,
"optional1_val":<String_value>,
"to_seperater":<String_value>,
"username_val":<String_value>,
"to_key":<String_value>,
"tenant_id":<String_value>,
"optional3_key":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"optional3_val":<String_value>,
"base_url":<String_value>,
"username_key":<String_value>,
"optional2_key":<String_value>,
"optional1_key":<String_value>,
"message_key":<String_value>,
"message_word_sperater":<String_value>,
"type":<String_value>,
"password_val":<String_value>,
"password_key":<String_value>,
"server_name":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/sms_server/id_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, "sms_server":[{
"optional2_val1":<String_value>,
"optional1_val":<String_value>,
"to_seperater":<String_value>,
"username_val":<String_value>,
"to_key":<String_value>,
"tenant_id":<String_value>,
"optional3_key":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"optional3_val":<String_value>,
"base_url":<String_value>,
"username_key":<String_value>,
"optional2_key":<String_value>,
"optional1_key":<String_value>,
"message_key":<String_value>,
"message_word_sperater":<String_value>,
"type":<String_value>,
"password_val":<String_value>,
"password_key":<String_value>,
"server_name":<String_value>}]}

<!--NeedCopy-->

update

URL: https://<MGMT-IP>/nitro/v2/config/sms_server/id_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:

{"sms_server":{
<b>"id":<String_value></b>,
"optional1_val":<String_value>,
"to_seperater":<String_value>,
"username_val":<String_value>,
"message_word_sperater":<String_value>,
"server_name":<String_value>,
"to_key":<String_value>,
"is_ssl":<Boolean_value>,
"message_key":<String_value>,
"optional1_key":<String_value>,
"password_key":<String_value>,
"type":<String_value>,
"password_val":<String_value>,
"base_url":<String_value>,
"username_key":<String_value>}}

<!--NeedCopy-->

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, "sms_server":[{
"optional2_val1":<String_value>,
"optional1_val":<String_value>,
"to_seperater":<String_value>,
"username_val":<String_value>,
"to_key":<String_value>,
"tenant_id":<String_value>,
"optional3_key":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"optional3_val":<String_value>,
"base_url":<String_value>,
"username_key":<String_value>,
"optional2_key":<String_value>,
"optional1_key":<String_value>,
"message_key":<String_value>,
"message_word_sperater":<String_value>,
"type":<String_value>,
"password_val":<String_value>,
"password_key":<String_value>,
"server_name":<String_value>}]}

<!--NeedCopy-->
sms_server