Manual Pages
Table of Contents
na_autosupport - Notification daemon
Data ONTAP is capable of sending automated notifications
to support personnel and/or to other designated addressees
in certain situations. The notifications contains useful
information to help them solve or recognize problems
quickly and proactively. The system can also be configured
to send a short alert notification containing only the
reason for the alert to a separate list of recipients.
This notification is sent only for critical events that
might require some corrective action and can be useful for
Administrators with alphanumeric pagers that can accept
short email messages.
The AutoSupport mechanism will use SMTP if there are any
(user configured) destination email addresses set in the
autosupport.to option. If autosupport.support.enable is
on, AutoSupport will also be sent to support personnel.
AutoSupport messages sent to support personnel may be
transmitted by SMTP, HTTP or HTTPS as specified in the
autosupport.support.transport option.
If SMTP is used, then the AutoSupport mechanism contacts a
mail host that is listening on the SMTP port (25) to send
email. A list of up to 5 mailhosts can be specified by
using the autosupport.mailhosts option, and they will be
accessed in the order specified until one of them answers
as a mailhost. It will then send email through the successful
mailhost connection to the destination email
address specified in the autosupport.to option. Note that
the autosupport.to option allows only 5 email addresses.
To send to more than 5 recipients, create a local alias,
or distribution list, and add that as the recipient.
If autosupport.support.enable is on then a copy of the
AutoSupport message is also sent to support personnel as
follows:
If autosupport.support.transport is smtp then the
copy of the AutoSupport is emailed to the destination
specified in autosupport.support.to and the
same mailhost picking algorithm is used as above.
If autosupport.support.transport is http or https
then a direct connection to the location specified
in autosupport.support.put_url or autosupport.support.url
is made and the AutoSupport message is
transmitted to support personnel via HTTP PUT/POST.
The AutoSupport mechanism is triggered automatically periodically
by the kernel to send information. It can also be
invoked on-demand by the System Administrator. AutoSupport
messages will also be sent on events that require
corrective action from the System Administrator or support
personnel.
To accommodate multiple delivery methods and destinations
and to preserve time dependent values, the outgoing AutoSupport
messages are spooled in /etc/log/autosupport.
AutoSupport processing will attempt to deliver all (currently
undelivered) messages until the autosupport.retry.count
has been reached or until subsequent
AutoSupport messages "fill the spool" such that the oldest
(undelivered) messages are forced to be dropped. The spool
size is currently 50 messages.
The subject line of the mail sent by the AutoSupport mechanism
contains a text string to identify the reason for
the notification. The subject also contains a relative
prioritization of the message, using syslog severity levels
from DEBUG to EMERGENCY (see na_syslog.conf(5)). The
messages and other information in the notification should
be used to check on the problem being reported.
The setup command tries to configure AutoSupport as follows:
If a mailhost is specified, it adds an entry for
mailhost to the /etc/hosts file.
Setup also queries for autosupport.from information.
autosupport destinations show [ -fields ]
This command displays a list of all message destinations
used by AutoSupport. The command provides
you with a quick summary of all addresses and URLs
that receive AutoSupport messages.
- -fields
-
If you specify the -fields <fieldname>, ... parameter,
the command only displays the fields that you
specify.
autosupport history retransmit [ -seq-num ] [ -size-limit
] [ -uri ]
This command retransmits a locally stored AutoSupport
message.
Support personnel might ask you to run this command
to retransmit an AutoSupport message. You might
also retransmit an AutoSupport message if you run
the autosupport history show command and notice
that a message was not delivered.
If you retransmit an AutoSupport message, and if
support already received that message, the support
system will not create a duplicate case. If, on
the other hand, support did not receive that message,
then the AutoSupport system will analyze the
message and create a case, if necessary.
Use the autosupport history show command to display
the 50 most recent AutoSupport messages, which are
available for retransmission.
- -seq-num
-
Use this parameter to specify the sequence number
of the AutoSupport message to retransmit.
- -size-limit
-
Use this parameter to specify a size limit for the
retransmitted AutoSupport message. If the message
information exceeds this limit, it will be trimmed
to fit the limit you specify. Omit the size limit
or set it to 0 to disable it, which is useful to
retransmit an AutoSupport message that was truncated
by a mail or Web server due to the default
size limits.
- -uri
-
Use this parameter to specify the HTTP, HTTPS,
FILE, or MAILTO uniform resource indicator (URI) to
which the AutoSupport message is sent.
autosupport history show [ -fields ] [ -delivery ] [
-detail ] [ -instance ] [ -seq-num ] [ -destination ] [
-trigger ] [ -last-update ] [ -status ] [ -attempt-count ]
[ -subject ] [ -uri ] [ -error ]
This command displays information about the 50 most
recent AutoSupport messages sent by nodes in the
cluster.
- -fields
-
If you specify the -fields <fieldname>, ... parameter,
the command only displays the fields that you
specify.
- -delivery
-
Use this parameter to display destination information
about each AutoSupport message.
- -detail
-
Use this parameter to display trigger and subject
information about each AutoSupport message.
- -instance
-
If you specify the -instance parameter, the command
displays detailed information about all entries.
- -seq-num
-
Use this parameter to display only AutoSupport messages
with the sequence number you specify.
Sequence numbers are unique to a node.
- -destination
-
Use this parameter to display only AutoSupport messages
that were sent to the destination type you
specify.
- -trigger
-
Use this parameter to display only AutoSupport messages
that match the trigger event you specify.
- -last-update
-
Use this parameter to display only AutoSupport messages
that were updated most recently at the time
you specify. Specify time in "MM/DD/YYYY HH:MM:SS"
format.
- -status
-
Use this parameter to display only AutoSupport messages
with the status you specify. Possible statuses
are:
- initializing - The AutoSupport message request
-
is being processed.
- collection-failed - The AutoSupport collection
-
failed. View the `Last Error' field of this
message for more information.
- collection-in-progress - The AutoSupport collection
-
is in progress.
- queued - The AutoSupport message is queued for
-
delivery.
- transmitting - The AutoSupport message transmission
-
is in progress.
- sent-successful - The AutoSupport message was
-
sent successfully.
- ignore - The AutoSupport message was processed
-
successfully, but the trigger event is not configured
for delivery to the current destination
type.
- re-queued - The AutoSupport message transmission
-
failed, has been re-queued, and will be
retried.
- transmission-failed - The AutoSupport message
-
transmission failed, and the retry limit was
exceeded.
- -attempt-count
-
Use this parameter to display only AutoSupport messages
that the system has attempted to send the
number of times you specify. This parameter is most
useful when given a range, such as ">5".
- -subject
-
Use this parameter to display only AutoSupport messages
of the type you specify.
- -uri
-
Use this parameter to display only AutoSupport messages
sent to the destination URI you specify.
- -error
-
Use this parameter to display only AutoSupport
messages that failed with the "Last Error" description
you specify.
autosupport manifest show [ -fields ] [ -content ] [
-instance ] [ -seq-num ] [ -prio-num ] [ -subsys ] [
-cmd-tgt ] [ -body-file ] [ -cmd ] [ -query ] [ -size-collected
] [ -time-collected ] [ -status ] [ -error ] [
-content-type ]
This command reports what information is contained
in AutoSupport messages. The name and size of each
file collected for the message is reported, along
with any errors.
- -fields
-
If you specify the -fields <fieldname>, ... parameter,
the command only displays the fields that you
specify.
- -content
-
Use this parameter to display detailed information
about the content of the files contained in the
report.
- -instance
-
If you specify the -instance parameter, the command
displays detailed information about all entries.
- -seq-num
-
Use this parameter to display information about
only AutoSupport message content with the sequence
number you specify. Sequence numbers are unique to
a node.
- -prio-num
-
Use this parameter to display information about
only AutoSupport message content with the collection
priority you specify. Content is collected in
order, by priority number.
- -subsys
-
Use this parameter to display information about
only AutoSupport message content collected by the
AutoSupport subsystem you specify.
- -cmd-tgt
-
Use this parameter to display information about
only AutoSupport message content produced in the
execution domain you specify.
- -body-file
-
Use this parameter to display information about
only AutoSupport message content stored in the body
file with the file name you specify.
- -cmd
-
Use this parameter to display information about
only AutoSupport message content produced by the DBlade
command, BSD command, file, or XML table you
specify.
- -query
-
Use this parameter to display information about
only AutoSupport message content produced by the
table query you specify.
- -size-collected
-
Use this parameter to display information about
only AutoSupport message content collected in files
with the file size you specify.
- -time-collected
-
Use this parameter to display information about
only AutoSupport message content collected in the
amount of time you specify, in milliseconds.
- -status
-
Use this parameter to display information about
only AutoSupport message content with the collection
status you specify. Possible statuses are:
- requested - The AutoSupport request has been
-
added to the queue and is waiting processing by
the collector.
- working - The AutoSupport collector is actively
-
gathering the needed data.
- file-not-found - AutoSupport data collection
-
failed because a necessary file is missing.
- no-such-table - The AutoSupport collector was
-
unable to find the requested SMF table.
- collection-truncated-size-limit - AutoSupport
-
data was truncated due to size limits, but partial
data is available.
- collection-skipped-size-limit - AutoSupport
-
data was skipped due to size limits, and no
data is available.
- collection-truncated-time-limit - AutoSupport
-
data was truncated due to time limits, but partial
data is available.
- collection-skipped-time-limit - AutoSupport
-
data was skipped due to time limits, and no
data is available.
- delivery-skipped-size-limit - AutoSupport data
-
was skipped at delivery time due to size limits.
- general-error - AutoSupport data collection
-
failed. Additional information (if any) is in
the Error String field.
- completed - AutoSupport data collection is
-
complete, and the AutoSupport message is ready
for delivery.
- content-not-collected-mode - AutoSupport content
-
was not collected due to an incompatible
operational mode.
- content-not-collected-precheck - AutoSupport
-
content was not collected due to pre-check
function violation.
- content-not-collected-privacy - AutoSupport
-
content was not collected because the operation
is disabled in privacy mode.
- content-empty - AutoSupport content was collected
-
successfully, but the output was empty.
- collection-aborted - AutoSupport data collection
-
was aborted.
- -error
-
Use this parameter to display information about
only AutoSupport message content with the error
text you specify. If data collection has failed,
the error text contains a description of the failure.
If data collection completes successfully,
this field is empty.
- -content-type
-
Use this parameter to display information about
only AutoSupport message content of the type you
specify. Types supported are:
- basic - Configuration data about this subsystem
-
- troubleshooting - Detailed diagnostic data
-
about this subsystem
autosupport trigger modify [ -autosupport-message ] [ -to
] [ -noteto ] [ -basic-additional ] [ -troubleshootingadditional
]
This command enables and disables AutoSupport messages
for individual triggers, and specifies additional
subsystem reports to include if an individual
trigger sends an AutoSupport message.
- -autosupport-message
-
Use this parameter to specify the AutoSupport trigger
to modify. AutoSupport triggers are EMS messages
whose names begin with "callhome.". However,
for the purposes of this command, "callhome." is
implied, does not need to be entered, and will not
be displayed in command output.
- -to
-
Use this parameter with the value "enabled" to
enable sending AutoSupport messages to the configured
"to" address.
- -noteto
-
Use this parameter with the value "enabled" to
enable sending short notes to the configured
"noteto" address.
- -basic-additional
-
Use this parameter to include basic configuration
content from the additional subsystems you specify.
Content is collected from these subsystems in addition
to the default list of subsystems.
- -troubleshooting-additional
-
Use this parameter to include detailed diagnostic
content from the additional subsystems you specify.
Content is collected from these subsystems in addition
to the default list of subsystems.
autosupport trigger show [ -fields ] [ -basic ] [ -troubleshooting
] [ -instance ] [ -autosupport-message ] [ -to
] [ -noteto ] [ -basic-default ] [ -troubleshootingdefault
] [ -additional-content ] [ -basic-additional ] [
-troubleshooting-additional ]
This command displays what system events trigger
AutoSupport messages. When a trigger event occurs,
the node may send an AutoSupport message to a predefined
destination, and a short note to another
destination. The full AutoSupport message contains
detail for troubleshooting. The short message is
meant for short pager or SMS text messages.
- -fields
-
If you specify the -fields <fieldname>, ... parameter,
the command only displays the fields that you
specify.
- -basic
-
Use this parameter to display which subsystem
information is included as basic information when
the AutoSupport message is triggered.
- -troubleshooting
-
Use this parameter to display which subsystem
information is included as troubleshooting information
when the AutoSupport message is triggered.
- -instance
-
If you specify the -instance parameter, the command
displays detailed information about all entries.
- -autosupport-message
-
Use this parameter to display only AutoSupport
triggers with the name you specify. AutoSupport
triggers are EMS messages whose names begin with
"callhome.". However, for the purposes of this command,
"callhome." is implied, does not need to be
entered, and will not be displayed in command output.
- -to
-
Use this parameter with the value "enabled" to display
only AutoSupport messages that send full messages
to the "to" address when triggered. Use this
parameter with the value "disabled" to display only
AutoSupport messages that do not send full messages.
- -noteto
-
Use this parameter with the value "enabled" to display
only AutoSupport messages that send short
notes to the "noteto" address when triggered. Use
this parameter with the value "disabled" to display
only AutoSupport messages that do not send short
notes.
- -basic-default
-
Use this parameter to display only AutoSupport
triggers that include in their messages, by
default, basic configuration content from the subsystems
you specify.
- -troubleshooting-default
-
Use this parameter to display only AutoSupport
triggers that include in their messages, by
default, detailed diagnostic content from the subsystems
you specify.
- -additional-content
-
Use this parameter to display only AutoSupport
triggers that have been configured to include additional
basic or troubleshooting content.
- -basic-additional
-
Use this parameter to display only AutoSupport
triggers that have been configured to include additional
basic configuration content from the subsystems
you specify.
- -troubleshooting-additional
-
Use this parameter to display only AutoSupport
triggers that have been configured to include additional
detailed diagnostic content from the subsystems
you specify. Partner Hostname (if HA) CFO
Node Status (if HA) cf monitor all output (if HA)
ic stats performance output (if HA with VIA) ic
stats error -v output (if HA with VIA) snet stats
-v output (if HA with SNET) REBOOT (CF TAKEOVER)
The AutoSupport messages from a node in an HA pair are
different from the AutoSupport messages from a standalone
node in the following ways:
The AutoSupport messages from a node in an HA pair
contains information about its partner, such as the
partner system ID and the partner host name.
In takeover mode, if you reboot the live node, two
AutoSupport messages notify the email recipients of the
reboot: one is from the live node and one is from the
failed node.
The live node sends an AutoSupport message after it finishes
the takeover process.
The following examples show how to modify AutoSupport URLs
when using IPv6 address literals:
node-1> options autosupport.mailhost
[2620:10a:4002:6004::bbbb]:25
node-1> options autosupport.support.proxy username:password@[2620:10a:4002:6004::bbbb]:8080
na_options(1), na_partner(1), na_setup(1), na_hosts(5),
RFC821
Table of Contents