Configure SMTP to Email Outbound Notifications

To receive notifications by email, you must configure SMTP server settings. You can configure SMTP server settings using the Settings Controller API.
  • Verify that you have satisfied all general prerequisites. See the prerequisites for Performing Day 2 operations usingVMware Aria Suite Lifecycle APIs.
  • Verify that you have the email address from which you want notifications to be sent.
  • Verify that you have the following information for your SMTP server:
    • Host name or IP address. For example,
      smtp.office365.com
      .
    • Port number.
    • If the server requires authentication, you must provide a username and password. For example, your Office 365 email address and password.
The following procedure shows how to configure SMTP server settings with authentication and send a test email to verify the settings.
  1. Configure SMTP settings.
    curl -X POST \ '$url/lcm/lcops/api/v2/settings/smtp' \ -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \ -H 'Content-Type: application/json' \ -d '{ "authenticationRequired": true, "encryptionType": "NONE", "fromEmail": "<
    your_from_email
    >", "password": "<
    user_account_password
    >", "smtpEncryptionPort":"<
    port_number
    >", "smtpHostName": "<
    your_smtp_hostname
    >", "userName": "<user_account_email_address>" }' | jq "."
    The response shows an example of an Office 365 account configured with SMTP server settings.
    { "smtpHostName": "smtp.office365.com", "smtpEncryptionPort": "25", "authenticationRequired": true, "userName": "emailaccount@mycompany.com", "password": "locker:password:21c6bd20-fc92-4a09-b09b-bf4c3fdcf671:smtp-cbceb2b2-fb0c-41fb-9025-d69c1047c73a", "encryptionType": "NONE", "fromEmail": "mycompany@noreply.com" }
  2. Send a test email to
    test@mycompany.com
    .
    curl -X GET \ '$url/lcm/lcops/api/v2/testEmail/test@mycompany.com' \ -H 'Authorization: Basic YWRtaW5AbG9jYWw6VGhpc0lzUGFzc3dvcmQ=' \ -H 'Content-Type: application/json' | jq "."
    If the response shows
    "type": "SUCCESS"
    , the SMTP server settings are correct and
    test@mycompany.com
    is a valid email recipient.
    { "vmid": "5bdab51a-07a1-4b97-875b-5d4ffed31ffe", "transactionId": null, "message": "Email sent successfully", "identifier": null, "type": "SUCCESS" }
Configure an outbound notification with an email recipient. See Configure Outbound Notification Settings.