CLI: Email

You can use the email command to configure email settings.

email {auth|autosupport|dead-letter|diag-max-size|domain|mailhub|mailhub-port|notify|return-addr|return-host|send-test}

To configure authentication options for sending email:

email auth {enable|password|username}

  • enable - Enable authentication for sending email
  • password <password> - Set password to use in SMTPSimple Mail Transfer Protocol authentication
  • username <username> - Set username to use in SMTP authentication
  • ssl enable - Set use of Secure Sockets Layer (SSL) for SMTP authentication
  • starttls enable - Set the use of the advanced SSL option of using STARTTLS

To set handling of automatic support email:

email autosupport {enable|event}

  • enable - Send automatic support notifications via email
  • event <event-type> - Specify which events will trigger sending autosupport notification emails, e.g. cpu-util-high

To configure settings for saving undeliverable emails:

email dead-letter {enable|cleanup}

  • enable - Enable saving undeliverable emails
  • cleanup max-age <duration> - Delete any dead.letter files older than the specified age. The age format is: #d#h#m#s. For example, 1d2h3m4s or 3d.

To set the maximum attachment size for diagnostic emails:

email diag-max-size <size-in-MB>

To override the domain from which emails appear to come:

email domain <hostname-or-IPInternet protocol-address>

To set the mail relay to be used to send emails:

email mailhub <hostname-or-IP-address>

To set mail port to be used to send emails:

email mailhub-port <port-number>

To set handling of events and failures via email:

email notify {event|recipient}

  • event <event-type> - Specify which events will trigger sending notification emails, e.g. APM
  • recipient <email-address> class {failure|info} - Specify which email addresses will receive email notifications upon a failure event or an informational event
  • recipient <email-address> detail - Specify that the email notifications sent to the email addresses will be in the detailed format

To set the username in the return address of the email notifications:

email return-addr <username>

To include a hostname in the return address of the email notifications:

email return-host

To send a test email to all configured event and failure recipients:

email send-test