Configuring email alerts by using the CLI

Edit online

Starting with Copy Services Manager Version 6.1.2, you can use the command-line to configure email alerts.

About this task

The following commands are available for setting email alerts:
addemailserver
Configures the server to use for sending email alerts.
Note: The addemailserver command can overwrite the existing server configuration.
lsemailserver
Displays the configuration that is being used for email alerts, if any.
rmemailserver
Removes the SMTP server configuration that is used to send email alerts.
Note: After you submit the command, email alerts are no longer sent.
addemailalert
Adds email addresses to the list of email addresses that receive email alerts.
rmemailalert
Removes email addresses from the list of email addresses that receive email alerts.
lsemailalert
Displays the recipient list of email addresses to send email alerts to.
testalert
Uses the current alert configuration to send a test alert.
Note: Currently, this command only supports sending a test email alert.

For more information, see the IBM® Copy Services Manager online product documentation (http://www-01.ibm.com/support/knowledgecenter/SSESK4). Command syntax details are located under the "Reference" section of the navigation.

For more information, see csmcli command descriptions.

The flow of tasks for configuring email alerts from the CLI is as follows:

Procedure

  1. Define an email server, and an optional reply-to email address.
  2. Define the email recipients.
  3. (Optional) You can use the testalert command to verify that the email alert function is working and that recipients are receiving emails.
    Important: If you have problems sending outgoing email alerts, you might need to customize the setting that defines the outgoing email server name. The default server name for sending email alerts is csmServer@<server hostname>. However, some environments do not accept this server email address. You can change the default setting by using the csm.server.notification.sender.address:[email address] parameter in the rmserver.properties file.

    For more information, see rmserver.properties file.