smtp_server
Configuration for SMTP server properties resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| sender_mail_id | <String> | Read-write | Email Address from which email is to be sent. |
| is_auth | <Boolean> | Read-write | Is authentication enabled for this smtp server. |
| port | <Integer> | Read-write | SMTP Server port address.. Minimum value = 1 Maximum value = |
| username | <String> | Read-write | Username for the smtp server. Maximum length = 128 |
| password | <String> | Read-write | Password for the smtp server. Maximum length = 128 |
| id | <String> | Read-write | Id is system generated key for all the smtp server. |
| is_ssl | <Boolean> | Read-write | Is this smtp server is SSL support configured.. |
| server_name | <String> | Read-write | SMTP 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>.
add
URL: https://<MGMT-IP>/nitro/v1/config/smtp_server?onerror=<String_value>
HTTP Method: null
Request Payload:
{smtp_server: {
<b>"server_name":<String_value></b>,
"sender_mail_id":<String_value>,
"password":<String_value>,
"id":<String_value>,
"port":<Integer_value>,
"username":<String_value>,
"is_ssl":<Boolean_value>,
"is_auth":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "smtp_server":[{
"sender_mail_id":<String_value>,
"is_auth":<Boolean_value>,
"port":<Integer_value>,
"username":<String_value>,
"password":<String_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"server_name":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/smtp_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/smtp_server
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "smtp_server":[{
"sender_mail_id":<String_value>,
"is_auth":<Boolean_value>,
"port":<Integer_value>,
"username":<String_value>,
"password":<String_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"server_name":<String_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/smtp_server/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "smtp_server":[{
"sender_mail_id":<String_value>,
"is_auth":<Boolean_value>,
"port":<Integer_value>,
"username":<String_value>,
"password":<String_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"server_name":<String_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/smtp_server/id_value<String>
HTTP Method: null
Request Payload:
{smtp_server:{
<b>"id":<String_value></b>,
"sender_mail_id":<String_value>,
"password":<String_value>,
"port":<Integer_value>,
"username":<String_value>,
"server_name":<String_value>,
"is_ssl":<Boolean_value>,
"is_auth":<Boolean_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "smtp_server":[{
"sender_mail_id":<String_value>,
"is_auth":<Boolean_value>,
"port":<Integer_value>,
"username":<String_value>,
"password":<String_value>,
"tenant_id":<String_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"server_name":<String_value>}]}