Update an EMS configuration
Suggest changes
PDFs
PATCH /support/ems
Introduced In: 9.6
Updates the EMS configuration.
Related ONTAP commands
-
event config modify
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
| Name | Type | Description |
|---|---|---|
mail_from |
string |
Mail from |
mail_server |
string |
Mail server (SMTP) |
proxy_password |
string |
Password for HTTP/HTTPS proxy |
proxy_url |
string |
HTTP/HTTPS proxy URL |
proxy_user |
string |
User name for HTTP/HTTPS proxy |
pubsub_enabled |
boolean |
Is Publish/Subscribe Messaging Enabled? |
Example request
{
"mail_from": "administrator@mycompany.com",
"mail_server": "mail@mycompany.com",
"proxy_password": "password",
"proxy_url": "https://proxyserver.mycompany.com",
"proxy_user": "proxy_user",
"pubsub_enabled": 1
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
983123 |
The validation of the mail server provided failed |
983136 |
The proxy URL cannot contain a username or password |
983137 |
The proxy URLprovided is invalid |
983139 |
The IPv6 proxy URL provided is invalid |
983140 |
The proxy URL provided contains an invalid scheme. Supported schemes are 'http' or 'https' |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
ems_config
| Name | Type | Description |
|---|---|---|
mail_from |
string |
Mail from |
mail_server |
string |
Mail server (SMTP) |
proxy_password |
string |
Password for HTTP/HTTPS proxy |
proxy_url |
string |
HTTP/HTTPS proxy URL |
proxy_user |
string |
User name for HTTP/HTTPS proxy |
pubsub_enabled |
boolean |
Is Publish/Subscribe Messaging Enabled? |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |