Skip to main content

Create and send an AutoSupport message

Contributors
PDFs

POST /support/autosupport/messages

Introduced In: 9.6

Creates and sends an AutoSupport message with the provided input parameters.

Important note:

  • By default, the response is an empty object. If return_records=true is passed in the request, the response includes information about the node and the index of the invoked AutoSupport message.

  • message - Message included in the AutoSupport subject. Use this to identify the generated AutoSupport message.

Default property values

If not specified in POST, the following are the default property values:

  • type - all

  • node.name or node.uuid - Not specifying these properties invokes AutoSupport on all nodes in the cluster.

  • system node autosupport invoke

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

destination

string

Destination for the AutoSupport

error

error

Last error during delivery attempt. Empty if "status=sent-successful".

generated_on

string

Date and Time of AutoSupport generation in ISO-8601 format

index

integer

Sequence number of the AutoSupport

message

string

Message included in the AutoSupport subject

node

node

state

string

State of AutoSupport delivery

subject

string

Subject line for the AutoSupport

type

string

Type of AutoSupport collection to issue

uri

string

Alternate destination for the AutoSupport
Example request 
{
  "destination": "http",
  "error": {
    "code": "53149746",
    "message": "Could not resolve host: test.com"
  },
  "generated_on": "2019-03-25 17:30:04 -0400",
  "index": 9,
  "message": "invoked_test_autosupport_rest",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "state": "sent_successful",
  "subject": "WEEKLY_LOG",
  "type": "test",
  "uri": "https://1.2.3.4/delivery_uri"
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[autosupport_message]

List of messages invoked on the node
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "destination": "http",
      "error": {
        "code": "53149746",
        "message": "Could not resolve host: test.com"
      },
      "generated_on": "2019-03-25 17:30:04 -0400",
      "index": 9,
      "message": "invoked_test_autosupport_rest",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "state": "sent_successful",
      "subject": "WEEKLY_LOG",
      "type": "test",
      "uri": "https://1.2.3.4/delivery_uri"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

8650851

AutoSupport invocation failed because AutoSupport collection is disabled

8650852

AutoSupport invocation failed because the trigger is disabled

8650853

AutoSupport invocation failed because the trigger rate is higher than the maximum supported value

8650866

The message parameter is not supported with performance AutoSupports

8650884

The specified field is not allowed for the current operation

8650885

The specified field cannot be empty

53149748

The destination URI provided for the invoked AutoSupport is invalid

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

Name Type Description

error

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

Definitions

See Definitions

error

Last error during delivery attempt. Empty if "status=sent-successful".

Name Type Description

code

integer

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_message

Name Type Description

destination

string

Destination for the AutoSupport

error

error

Last error during delivery attempt. Empty if "status=sent-successful".

generated_on

string

Date and Time of AutoSupport generation in ISO-8601 format

index

integer

Sequence number of the AutoSupport

message

string

Message included in the AutoSupport subject

node

node

state

string

State of AutoSupport delivery

subject

string

Subject line for the AutoSupport

type

string

Type of AutoSupport collection to issue

uri

string

Alternate destination for the AutoSupport

_links

Name Type Description

next

href

self

href

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.