Setup

Add SovLabs vCenter Endpoint

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

FieldValue
Configuration label

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

Unique label that does NOT contain {tenantName}_

Version

Choose the appropriate vCenter version

Platform Service Controller (FQDN)

Shown when 'Version' is 6+

Type in the PSC FQDN

Is the PSC embedded on the vCenter server?

Shown when 'Version' is 6+

Select if the PSC embedded on the vCenter server

vCenter hostname (FQDN)

Text input if 'Version' is less than 6. Auto-generated list in dropdown if 'Version' 6+

Type in or select the appropriate vCenter server FQDN

Credential Configuration for vCenter Endpoint
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


Add SovLabs vRA IaaS Endpoint

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

FieldValue
Configuration label

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

Unique label that does NOT contain {tenantName}_

Version

Auto-filled based on querying vRA IaaS from the vRA tenant

Read-only field

Hostname (FQDN)

Auto-generated based on querying vRA IaaS from the vRA tenant

Please verify vRA CAFE hostname

Domain

Auto-generated based on querying vRA IaaS from the vRA tenant

Please verify domain

Credential Configuration for vRA IaaS Endpoint

Credentials to the vRA IaaS is necessary to utilize vRA's IaaS API

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

(Username only, no domain)

Password

Shown when 'Create credential?' is checked

User's password


Add SovLabs vRA CAFE Endpoint

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

FieldValue
Configuration label

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

Unique label that does NOT contain {tenantName}_

Version

Auto-filled based on querying vRA CAFE from the vRA tenant

Read-only field

Hostname (FQDN)

Auto-generated based on querying vRA CAFE from the vRA tenant

Please verify vRA CAFE hostname

Credential Configuration for vRA CAFE Endpoint

Credentials to the vRA CAFE is necessary to utilize vRA's CAFE API

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

(user@example.com)

Password

Shown when 'Create credential?' is checked

User's password


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 SNAPSHOT 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 SNAPSHOT as the type of Notifications Configurations to group

Notifications

Auto-populated list based on selected 'Type'

Select all notification configurations for this notification group


Add Snapshot Configuration

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

A Snapshot Configuration represents configurations for vSphere Snapshot Management

FieldValue
vCenter Endpoints defined?

Read-only field

SovLabs vCenter Endpoints must be defined prior to completing/submitting this form

This field should read 'Yes'

Configuration label

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

Unique label that does NOT contain {tenantName}_

SovLabs vRA CAFE Endpoint

Select the desired SovLabs vRA CAFE endpoint

SovLabs vRA IaaS Endpoint

Select the desired SovLabs vRA IaaS endpoint

Notification Group

Auto-generated list of Notification Groups with type Snapshot

Select the desired Notification Group

VMs for all vRA Business Groups?

Select whether or not to manage snapshots for all vRA Business Groups defined for this vRA tenant

Filter VMs by vRA Business Group(s)

Shown when 'VMs for all vRA Business Groups?' is not checked

Select all desired vRA Business Group(s) to manage snapshots for

Snapshot lifespan (days)

Define a snapshot's lifespan in number of days

Expiration warning notification(s)

This field is required!

Define when to send warning notifications in number of days from expiration.

At minimum the field must have 1 value, which could be 0, in order to successfully run.

Exclusions by VM Name
Regular Expression Patterns

For the order of precedence for Snapshot management bypass, this is the first

Exclude VMs from Snapshot Management with Java Regex matches on VM names.

Example: ^*-test-*

Reference: Regular Expression

Simple String Patterns

For the order of precedence for Snapshot management bypass, this is the second

Exclude VMs from Snapshot Management with string patterns on VM names.

Example: test

Exclusions by Snapshot Name
Regular Expression Patterns

For the order of precedence for Snapshot management bypass, this is the third

Exclude VMs from Snapshot Management with Java Regex matches on snapshot names.

Example: ^*note-managed*

Reference: Regular Expression

Simple String Patterns

For the order of precedence for Snapshot management bypass, this is the fourth

Exclude VMs from Snapshot Management with string patterns on snapshot names.

Example: DONOTDELETE

Click for Snapshot Scheduler
FieldValue
All scheduling will be executed in the vRO instance timezone

Read-only field

Depicts vRealize Orchestrator's timezone.

When defining a schedule for snapshot management, please convert your desired scheduled time(s) to be aligned with vRO's timezone.

Schedule is active?

Defaulted to 'Yes'

At a later time, can specify a specific Snapshot Configuration to become inactive by unchecking the checkbox and the scheduler will not run for the specific Snapshot Configuration

Schedule type

Define when to run this Snapshot Configuration: Daily, Weekly, Monthly, or Run once

Daily

Shown when 'Schedule type' is Daily

hh:mm in military time

Weekly

Shown when 'Schedule type' is Weekly

EEE hh:mm

EEE: Mon, Tue, Wed, Thu, Fri, Sat, Sun

hh:mm in military time

Monthly

Shown when 'Schedule type' is Monthly

dd hh:mm

dd: Day of the month 01-31

hh:mm in military time

Run once

Shown when 'Schedule type' is Run once

Select a specific date and time to run. Will only run once.

Schedule end date

Optional

Select a date when to 'end' this Snapshot Configuration scheduled task