Skip to main content
A newer release of this product is available.

Retrieve the AutoSupport configuration

Contributors
PDFs

GET /support/autosupport

Introduced In: 9.6

Retrieves the AutoSupport configuration of the cluster and if requested, returns connectivity issues with the AutoSupport configuration.

Important note:

  • The issues field consists of a list of objects containing details of the node that has a connectivity issue, the issue description, and corrective action you can take to address the issue. When not empty, this indicates a connection issue to the HTTP/S, SMTP, or AutoSupport On Demand server.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • issues

  • system node autosupport show -instance

  • system node autosupport check show-details

Learn more

Parameters

Name Type In Required Description

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Response

Status: 200, Ok
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 nodes in the cluster with connectivity issues to HTTP/SMTP/AOD AutoSupport destinations along with the corresponding error descriptions and corrective actions.

mail_hosts

array[string]

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

partner_addresses

array[string]

The list of partner addresses.

proxy_url

string

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

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.
Example response 
{
  "contact_support": 1,
  "enabled": 1,
  "from": "postmaster@example.com",
  "is_minimal": 1,
  "issues": [
    {
      "corrective_action": {
        "code": "53149746",
        "message": "Check the hostname of the SMTP server"
      },
      "issue": {
        "code": "53149746",
        "message": "SMTP connectivity check failed for destination: mailhost. Error: Could not resolve host - 'mailhost'"
      },
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ],
  "mail_hosts": [
    "mailhost1.example.com",
    "mailhost2.example.com"
  ],
  "partner_addresses": [
    "user1@partner.com",
    "user2@partner.com"
  ],
  "proxy_url": "https://proxy.company.com",
  "to": [
    "user1@example.com",
    "user2@example.com"
  ],
  "transport": "smtp"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

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

autosupport_connectivity_issue

Name Type Description

code

string

Error code

message

string

Error message

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

autosupport_issues

Name Type Description

corrective_action

autosupport_connectivity_corrective_action

issue

autosupport_connectivity_issue

node

node

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.