Required Command-Line Mode = Configure
Use the email command to configure automatic email notifications for events on the GigaVUE H Series node. Separate arguments let you add the mail server/port to use, the account from which emails will be sent, email recipients, and so on. Refer to the Hardware Installation Guide for a description of how to configure email notification essentials
The email command has the following syntax:
email
auth
enable
password [password]
username <username>
autosupport
enable
event <event name>
ssl
ca-list <none | default-ca-list>
cert-verify
mode <none | tls | tls-none>
dead-letter
cleanup max-age cleanup <duration>
enable
domain <hostname or IP address>
mailhub <hostname, IPv4, or IPv6 address>
mailhub-port <port number>
notify
event <<event name> | all>
recipient <email address>
class <failure | info>
detail
return-addr <username>
return-host
send-test
ssl
ca-list <none | default-ca-list>
cert-verify
mode <none | tls | tls-none>
The following table describes the arguments for the email command:
Command |
Description |
||||||||||||||||||
auth |
Enables the sending of notification emails and specifies the account to be used for authentication with the SMTP server specified by the email mailhub command as follows:
|
||||||||||||||||||
autosupport enable |
Configures auto support, as follows:
|
||||||||||||||||||
dead-letter |
Configures the handling of email notifications that could not be sent (for example, because the mail hub was not configured correctly), as follows:
|
||||||||||||||||||
domain <hostname or IP address> |
Specifies the domain from which notification emails will appear to come from. This name is used together with the hostname setting to form the name of the domain included in notification emails. The name is formed using the following rules:
|
||||||||||||||||||
mailhub <hostname, IPv4, or IPv6 address> |
Specifies the address or hostname of the server to use for sending notification emails. |
||||||||||||||||||
email mailhub-port <port number> |
Specifies the TCP port used by the server added using email mailhub. |
||||||||||||||||||
notify |
Specifies the events that will trigger notification emails and where they will be sent as follows:
For example, the following command sends emails to bposey@argus.com for all failures: (config) # email notify recipient bposey@argus.com class failure Note: No email is sent when failure is configured and an info event is generated. Use the recipient detail argument to specify whether summarized or detailed output should be included in the email. Note that not all events have both summary and detail formats. |
||||||||||||||||||
return-addr <username> |
Specifies the address from with notification emails are sent. If you include the @ character, the address is used as-is (for example, email return-addr support@mycompany.com). If the @ character is not included, the system adds the <return-host>.<domain>. The default settings is do-not-reply. |
||||||||||||||||||
return-host |
Specifies whether or not to include the hostname in the return address for emails. This only takes effect if the return addr entry does not contain an @ character. |
||||||||||||||||||
send-test |
Sends a test mail to all recipients configured for event and failure notifications with the email notify command. This command is useful once you have finished configured email settings and want to make sure they are functioning properly. |
||||||||||||||||||
ssl ca-list <none | default-ca-list> |
Configures the use of SSL for notification emails sent by the GigaVUE H Series node as follows:
|
Related Commands
The following table summarizes other commands related to the email command:
Task |
Command |
Displays email and notification settings. |
show email |
Displays the events that will trigger notification emails. |
show email events |
Disables authentication for sending email. |
(config) # no email auth enable |
Clears password for SMTP authentication. |
(config) # no email auth password |
Clears username for SMTP authentication (effectively disables authentication until the username set again). |
(config) # no email auth username |
Does not send automatic support notifications through email. |
(config) # no email autosupport enable |
Negates certain email event notification settings. |
(config) # no email autosupport event processcrash (config) # no email autosupport event livenessfailure |
Delete supplemental CA certificate list. |
(config) # no email autosupport ssl ca-list |
Does not verify server certificates. |
(config) # no email autosupport ssl cert-verify |
Resets autosupport email security mode to the default. |
(config) # no email autosupport ssl mode |
Does not clean up old dead letters based on age. |
(config) # no email dead-letter cleanup max-age |
Does not save dead letter for undeliverable emails. |
(config) # no email dead-letter enable |
Clears email domain override. |
(config) # no email domain |
Clears the configured mail hub. |
(config) # no email mailhub |
Clears the configured mail hub port. |
(config) # no email mailhub-port |
Negates certain email event notification settings. |
(config) # no email notify event all (config) # no email notify event firmwarechange (config) # no email notify event rxtxerror |
Does not send any notifications to this recipient. |
(config) # no email notify recipient friend@gmail.com |
Does not send certain types of events to this recipient. |
(config) # no email notify recipient friend@gmail.com class failure (config) # no email notify recipient friend@gmail.com class info |
Sends summarized event emails to this recipient. |
(config) # no email notify recipient friend@gmail.com detail |
Resets the return address to the default. |
(config) # no email return-addr |
Does not include hostname in return address for email notifications. |
(config) # no email return-host |
Deletes supplemental CA certificate list. |
(config) # no email ssl ca-list |
Does not verify server certificates. |
(config) # no email ssl cert-verify |
Resets email security mode to the default. |
(config) # no email ssl mode |