Skip to main content
REST API reference

Update the AutoSupport configuration for an entire cluster

PDFs

PATCH /support/autosupport

Introduced In: 9.6

Updates the AutoSupport configuration for the entire cluster.

  • system node autosupport modify

Learn more

Parameters

Name Type In Required Description

force

boolean

query

False

Set the force flag to true to modify some of the AutoSupport configurations that are otherwise blocked when the automatic update feature is enabled. Without this flag set to true, an attempt to disable AutoSupport, modify the transport to SMTP, or disable the AutoSupport OnDemand feature fails if the automatic update feature is enabled.

  • Introduced in: 9.16

  • Default value:

Request Body

Name Type Description

contact_support

boolean

Specifies whether to send the AutoSupport messages to vendor support.

enabled

boolean

Specifies whether the AutoSupport daemon is enabled. When this setting is disabled, delivery of all AutoSupport messages is turned off.

from

string

The e-mail address from which the AutoSupport messages are sent. To generate node-specific 'from' addresses, enable '-node-specific-from' parameter via ONTAP CLI.

is_minimal

boolean

Specifies whether the system information is collected in compliant form, to remove private data or in complete form, to enhance diagnostics.

issues

array[autosupport_issues]

A list of connectivity issues to the HTTPS/SMTP/AOD AutoSupport destinations on the nodes in the cluster along with the corrective actions.

mail_hosts

array[string]

The names of the mail servers used to deliver AutoSupport messages via SMTP.

ondemand_enabled

boolean

Specifies whether the AutoSupport OnDemand feature is enabled. When AutoSupport OnDemand is enabled, support personnel can remotely trigger new AutoSupport messages, resend existing AutoSupport messages, and decline the delivery of unwanted AutoSupport messages. When this option is disabled, the cluster does not respond to any AutoSupport OnDemand requests from support personnel.

partner_addresses

array[string]

The list of partner addresses.

proxy_url

string

Proxy server for AutoSupport message delivery via HTTPS. Optionally specify a username/password for authentication with the proxy server.

smtp_encryption

string

The encryption protocol used to deliver AutoSupport messages via SMTP to the configured mail_hosts.

to

array[string]

The e-mail addresses to which the AutoSupport messages are sent.

transport

string

The name of the transport protocol used to deliver AutoSupport messages.

Note 'http' transport is no longer supported by AutoSupport servers.
Example request 
{
  "contact_support": 1,
  "enabled": 1,
  "from": "postmaster@example.com",
  "is_minimal": 1,
  "issues": [
    {
      "component": "mail_server",
      "corrective_action": {
        "code": "53149746",
        "message": "Check the hostname of the SMTP server"
      },
      "destination": "mailhost1.example.com",
      "issue": {
        "code": "53149746",
        "message": "SMTP connectivity check failed for destination: mailhost. Error: Could not resolve host - 'mailhost'"
      },
      "node": {
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ],
  "mail_hosts": [
    "mailhost1.example.com",
    "mailhost2.example.com"
  ],
  "ondemand_enabled": 1,
  "partner_addresses": [
    "user1@partner.com",
    "user2@partner.com"
  ],
  "proxy_url": "proxy.company.com",
  "smtp_encryption": "none",
  "to": [
    "user1@example.com",
    "user2@example.com"
  ],
  "transport": "smtp"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

8650862

The SMTP mail host provided cannot be empty

8650863

A maximum of 5 SMTP mail hosts can be provided

8650864

A maximum of 5 email addresses can be provided

8650865

A maximum of 5 partner email addresses can be provided

8650880

Automatic update requires AutoSupport to be enabled

8650881

Automatic update requires AutoSupport to use the HTTPS transport

8650882

Automatic update requires AutoSupport OnDemand to be enabled

8650886

The provided parameter requires an effective cluster version of ONTAP 9.15.1 or later

8650887

Username or password is not allowed in the AutoSupport url and put-url fields

8650889

The provided parameter requires an effective cluster version of ONTAP 9.16.1 or later

53149727

The proxy URI provided is invalid

53149728

The SMTP mail host URI provided is invalid

53149732

The proxy URI provided is invalid. IPv6 addresses must be enclosed within square brackets

53149737

The proxy URI provided specifies an unsupported scheme

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

autosupport_connectivity_corrective_action

Name Type Description

code

string

Corrective action code

message

string

Corrective action message. The corrective action might contain commands which needs to be executed on the ONTAP CLI.

  • example: Check the hostname of the SMTP server

  • readOnly: 1

  • Introduced in: 9.6

  • x-nullable: true

autosupport_connectivity_issue

Name Type Description

code

string

Error code

message

string

Error message

href

Name Type Description

href

string

_links

node

Name Type Description

name

string

uuid

string

autosupport_issues

Name Type Description

component

string

The name of the component where the issue occurred.

corrective_action

autosupport_connectivity_corrective_action

destination

string

The HTTPS/SMTP/AOD AutoSupport Destination.

issue

autosupport_connectivity_issue

node

node

autosupport

Name Type Description

contact_support

boolean

Specifies whether to send the AutoSupport messages to vendor support.

enabled

boolean

Specifies whether the AutoSupport daemon is enabled. When this setting is disabled, delivery of all AutoSupport messages is turned off.

from

string

The e-mail address from which the AutoSupport messages are sent. To generate node-specific 'from' addresses, enable '-node-specific-from' parameter via ONTAP CLI.

is_minimal

boolean

Specifies whether the system information is collected in compliant form, to remove private data or in complete form, to enhance diagnostics.

issues

array[autosupport_issues]

A list of connectivity issues to the HTTPS/SMTP/AOD AutoSupport destinations on the nodes in the cluster along with the corrective actions.

mail_hosts

array[string]

The names of the mail servers used to deliver AutoSupport messages via SMTP.

ondemand_enabled

boolean

Specifies whether the AutoSupport OnDemand feature is enabled. When AutoSupport OnDemand is enabled, support personnel can remotely trigger new AutoSupport messages, resend existing AutoSupport messages, and decline the delivery of unwanted AutoSupport messages. When this option is disabled, the cluster does not respond to any AutoSupport OnDemand requests from support personnel.

partner_addresses

array[string]

The list of partner addresses.

proxy_url

string

Proxy server for AutoSupport message delivery via HTTPS. Optionally specify a username/password for authentication with the proxy server.

smtp_encryption

string

The encryption protocol used to deliver AutoSupport messages via SMTP to the configured mail_hosts.

to

array[string]

The e-mail addresses to which the AutoSupport messages are sent.

transport

string

The name of the transport protocol used to deliver AutoSupport messages.

Note 'http' transport is no longer supported by AutoSupport servers.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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