Setup

Add Notification Configuration

  1. Login to vRA tenant
  2. Click on the Catalog tab
  3. Request the Add Notification Configuration vRA Catalog Item
  4. Fill out the form accordingly (see below) and Submit
Add Notification Configuration
Add Notification Configuration

FieldValue
Type

Select VMLIFECYCLE as the desired notification type

Configuration label

No spaces, periods, nor special characters except underscore (_) and dash (-)

Unique label that does NOT contain {tenantName}_

State

Select when to send out a notification

Message type

Select the notification message type

Format

Select the desired format

From address

The email address that will be sending this notification

This field is templatable. Click the link below to view documentation on the SovLabs Template Engine

SovLabs Template Engine page
Title

Notification title

This field is templatable. Click the link below to view documentation on the SovLabs Template Engine

SovLabs Template Engine page
Body

Please update standard provided template accordingly

Notification body

For a WebService, the only payload accepted is JSON

This field is templatable. Click the link below to view documentation on the SovLabs Template Engine

SovLabs Template Engine page
Click for Message Server Configuration
FieldValue
Message Server Configuration
New Message Server?

Message Server

Shown when 'New Message Server?' is not checked

Select the appropriate message server from the drop-down

Configuration label

Shown when 'New Message Server?' is checked

No spaces, periods, nor special characters except underscore (_) and dash (-)

Unique label that does NOT contain {tenantName}_

Message Server Address

Shown when 'New Message Server?' is checked

Message Server address

Enable SSL?

Shown when 'New Message Server?' is checked

Check only if SSL is enabled on the message server

Message Server port

Shown when 'New Message Server?' is checked

Message Server port

Message Server HTTP verb

Shown when 'New Message Server?' is checked and 'Message type' is WebService

Select the HTTP Verb

The HTTP verb used must be in the message body content to properly direct the server's behavior.

The Notifications module does not modify URL with parameters.

Enable credential?

Shown when 'New Message Server?' is checked

Check only if credentials are enabled on the message server

Create credential?

Check the checkbox to create a new credential.

Uncheck the checkbox to use an existing credential.

Credential

Shown when 'Create credential?' is not checked

Select the appropriate credential from an existing list of credentials

Credential Configuration label

Shown when 'Create credential?' is checked

No spaces, periods, nor special characters except underscore (_) and dash (-)

Unique label that does NOT contain {tenantName}_

Username

Shown when 'Create credential?' is checked

Username that has necessary permissions

Password

Shown when 'Create credential?' is checked

User's password

Enable STARTTLS?

Shown when 'New Message Server?' is checked and 'Message type' is Email

Check to enable STARTTLS

Network timeout

Shown when 'New Message Server?' is checked

Defaulted to 6000. Update accordingly

Email Group Configuration

Shown when the 'Message Server Type' is Email

New Email Group?

Email Group

Shown when 'New Email Group?' is not checked

Configuration label

No spaces, periods, nor special characters except underscore (_) and dash (-)

Unique label that does NOT contain {tenantName}_

To addresses

Shown when 'New Email Group?' is checked

Enter all the email addresses to send the notifications TO

This field is templatable. Click the link below to view documentation on the SovLabs Template Engine

SovLabs Template Engine page
CC addresses

Shown when 'New Email Group?' is checked

Enter all the CC email addresses to send the notifications to

This field is templatable. Click the link below to view documentation on the SovLabs Template Engine

SovLabs Template Engine page
BCC addresses

Shown when 'New Email Group?' is checked

Enter all the BCC email addresses to send the notifications to

This field is templatable. Click the link below to view documentation on the SovLabs Template Engine

SovLabs Template Engine page

Add Notification Group

  1. Login to vRA tenant
  2. Click on the Catalog tab
  3. Request the Add Notification Group Configuration vRA Catalog Item
  4. Fill out the form accordingly (see below) and Submit
Add Notification Group Configuration
Add Notification Group Configuration

A Notification Group configuration holds multiple Notification Configurations

FieldValue
Configuration label

No spaces, periods, nor special characters except underscore (_) and dash (-)

Unique label that does NOT contain {tenantName}_

Type

"A Notification Group does not need to be added for Notification types: SovLabs IPAM or Backup as a Service because it will be auto-generated when adding a Notification Configuration."

Select VMLIFECYCLE as the type of Notifications Configurations to group

Notifications

Auto-populated list based on selected 'Type'

Select all notification configurations for this notification group