Skip to content

sms_server

Configuration for SMS server properties resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
optional1_val<String>Read-writeOptional1 Val for the sms server.
Maximum length = 128
to_seperater<String>Read-writeTo list seperater for the sms server.
Maximum length = 128
username_val<String>Read-writeUsername val for the sms server.
Maximum length = 128
to_key<String>Read-writeTo key for the sms server.
Maximum length = 128
id<String>Read-writeId is system generated key for all the sms server.
is_ssl<Boolean>Read-writeIs SSL support configured..
base_url<String>Read-writeBase URL for the sms server, without payload.
Maximum length = 2000
username_key<String>Read-writeUsername key for the sms server.
Maximum length = 128
optional1_key<String>Read-writeOptional1 key for the sms server.
Maximum length = 128
message_key<String>Read-writeMessage key for the sms server.
Maximum length = 128
message_word_sperater<String>Read-writeMessage Word Seperater for the sms server.
Maximum length = 128
type<String>Read-writeHTTP type supported for the sms server.
Maximum length = 128
password_val<String>Read-writePassword Val for the sms server.
Maximum length = 128
password_key<String>Read-writePassword key for the sms server.
Maximum length = 128
server_name<String>Read-writeSMS server name.
Minimum length = 1
Maximum length = 128
optional2_val1<String>Read-onlyOptional2 Val for the sms server.
tenant_id<String>Read-onlyTenant Id of the Config Jobs.
optional3_key<String>Read-onlyOptional3 key for the sms server.
optional3_val<String>Read-onlyOptional3 Val for the sms server.
optional2_key<String>Read-onlyOptional2 key for the sms server.

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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/sms_server?onerror=<String_value>

HTTP Method: null

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>,
"id":<String_value>,
"message_word_sperater":<String_value>,
"is_ssl":<Boolean_value>,
"optional1_key":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/sms_server/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/sms_server

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/sms_server/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/sms_server/id_value<String>

HTTP Method: null

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>,
"type":<String_value>,
"password_val":<String_value>,
"server_name":<String_value>,
"to_key":<String_value>,
"is_ssl":<Boolean_value>,
"base_url":<String_value>,
"username_key":<String_value>,
"message_key":<String_value>,
"optional1_key":<String_value>,
"password_key":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}