Overview

This topic describes how to configure SMTP, phone home email notification policy and event email functions.

 

Lattus has two mechanisms for automatically sending email:

 

• Phone home email policy – runs once a day and reports all errors above a user defined level since the last time the policy ran.
• Event email – sends out an email every time a critical event or failed job occurs.

Note: These values are typically set during the initialization of the Management Controller Node.

 

---

Procedures

The following procedures are required to configure SMTP and phone home email notifications:

 

• Configuring SMTP
• Configuring the Email Subject Line
• Setting the Admin User Email Address
• Configuring Phone Home
• Configuring Event Emails

---

Configuring SMTP

Viewing and Configuring SMTP Settings Via qshell:

 

1. Enter qshell:

# qshell

 

2. Create a connection to the database:

# In []: api=i.config.cloudApiConnection.find('main')
 

3. Get the cloud guid:

# In []: cloudguid=api.cloud.list()['result'][0]['cloudguid']
 

4. View the current SMTP IP address:

# In []: api.cloud.getObject(cloudguid).smtp.server
# Out[]: '10.60.4.162'

 

5. View the current SMTP login:

# In [] api.cloud.getObject(cloudguid).smtp.login

 

6. View the current SMTP password:

# In [] api.cloud.getObject(cloudguid).smtp.password

 

7. Set the new SMTP IP address (also login and password):

# In []: api.cloud.setSMTPConfiguration(cloudguid,'10.60.4.163','','')
# Out[]: {'jobguid': '753e527b-c977-43fb-9d2c-f0a95f57395b', 'result': None}
 

Notes: 

 

• The 3rd and 4th parameters are the credentials (login, password) for the SMTP server, if required.

• All quotes are single quotes.  Nothing in between if login and password are empty.

• A fully qualified name can be used in place of an IP address.

• Google SMTP servers require TLS port to be added.

In [1]: api.cloud.setSMTPConfiguration(cloudguid,'smtp.gmail.com:587','helpdesk@i3.com','Supp0rt1ng')

 

Viewing and Configuring SMTP Settings Via the eventcfg.cfg File:

 

1. View the current SMTP settings:

# cat /opt/qbase3/cfg/qconfig/eventcfg.cfg

 

2. Set the new SMTP setting:

# vi /opt/qbase3/cfg/qconfig/eventcfg.cfg
 

3. Add the SMTP information to “smtp = <fully qualified domain name or IP>”

    

4. Add the SMTP password to “smtppasswd = <password>”

    

5. Add the SMTP login to “smtplogin = <login>”

Notes:

 

• The changes to eventcfg.cfg are dynamic.
• The port used in the SMTP standard 25.
• There are no other SMTP security options at this time.
   

---

Configuring the Email Subject Line

The following procedure sets the email home subject line to contain the system serial number.

 

1. Enter qshell:

# qshell
 

2. Create a connection to the database:

# In []: api=i.config.cloudApiConnection.find('main')
 

3. Get the customer guid:

# In []: customerguid=api.customer.list()['result'][0]['guid']

 

4. View the current value for description:

# In []: api.customer.getObject(customerguid).description

 

5. View the current value for country:

# In []: api.customer.getObject(customerguid).country

 

6. Set the description to the system serial number:

# In [] api.customer.updateModelProperties(customerguid, description='<serial number>')

 

7. Set the country to reflect the customer name:

# In []: api.customer.updateModelProperties(customerguid, country='<free form text>')

 

---

Setting the Admin User Email Address

Configuring Admin User’s Email Value in the CMC:

 

1. Log into the CMC and select Dashboard > Administration > Lattus Management > Groups and Users > Users.

    

2. Select admin and Edit.

    

3. Enter the Email address on the Information tab.

    

4. Select Next and Yes.

Note: Requires a .com extension when entering value thru the CMC.
 

Configuring Admin User’s Email Value in eventcfg.cfg:

 

1. Edit the config file on the management controller:

# vi /opt/qbase3/cfg/qconfig/eventcfg.cfg
 

2. Add your desired email address to “admin_email = <email>”

Notes:

• Leaving the admin user’s email blank places “None” in the eventcfg.cfg file.

• When “None” is in the eventcfg.cfg file, the “From” value will display “None”.

   

 

---

Configuring Phone Home

1. To start phone home policy log into the CMC and select Dashboard > Administrator > Lattus Management > Policies.

    

2. Select amplistor.phoneHome.

    

3. Click Edit Policy.

    

4. Set E-mail to: techsup@quantum.com (Can use other address for testing)

    

5. Set maxErrorconditionLevel to CRITICAL.

    

6. Select Next and OK.

    

7. Click on Start Policy Now and OK to run policy.

Notes:

• By default the Policy will run every 24 hours from the time it is started.  If the policy gets restarted then the send time will change.

• When “None” is in the eventcfg.cfg file the “From” value will display “None”.

   

 

---

Configuring Event Emails

Event emails will start automatically. They are sent to the admin user’s email address.
 

---