Setup

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 or special characters except underscore (_) and dash (-)

Unique label

DO NOT prepend with your tenant name and an underscore, e.g. mytenant_

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 or special characters except underscore (_) and dash (-)

Unique label

DO NOT prepend with your tenant name and an underscore, e.g. mytenant_

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 Lifecycle EBS

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

FieldValue
Action

Choose Create to add a new SovLabs Lifecycle Components Toolkit module vRA Event Broker Subscription

Lifecycle

Shown when 'Action' is Create

Select the Lifecycle State in which to create the SovLabs Lifecycle vRA EBS

Priority

Shown when 'Action' is Create

Type in the Priority (order) in which to run this EBS

Timeout (mins)

Defaults to 180

Define how many minutes before this EBS should timeout


Add Lifecycle Script Definition

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

FieldValue
General
Configuration label

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

Unique label

DO NOT prepend with your tenant name and an underscore, e.g. mytenant_

Lifecycle State

Select at which vRA Lifecycle State this script should run

Type

Select whether this script should run on a Specific Host or if it should run on the Provisioned Node

OS Family

Select what the server/node OS family is

Connection Type

Select the connection method to connect to the server/node

Hostname (FQDN)

Shown when 'Type' is Specific Host and 'Connection Type' is ssh

Hostname in FQDN format

vCenter Endpoint

Shown when 'Connection Type' is vmware-tools

Select an existing SovLabs vCenter Endpoint where the server/node resides in

VM name as it appears in vCenter

Shown when 'Type' is Specific Host and Connection Type' is vmware-tools

Type in the VM name of the Specific Host as it appears in vCenter

Credential Configuration
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 or special characters except underscore (_) and dash (-)

Unique label

DO NOT prepend with your tenant name and an underscore, e.g. mytenant_

SSH Key used?

Shown when Create credential?' is checked and 'Connection method' is SSH based

Check the checkbox to use an SSH Key

Username

Shown when 'Create credential?' is checked

Username that has necessary permissions

Password

Shown when 'Create credential?' is checked and SSH Key used? is not checked

User's password

SSH Key

Shown when 'Create credential?' is checked and SSH Key used? is checked

SSH Key

SSH Key Password

Shown when 'Create credential?' is checked and SSH Key used? is checked

SSH Key password, if any

Script Definition
Default EBS

Auto-generated list based on Lifecycle State selected

Select the EBS' at which to run this script

Blocking?

Select the checkbox to make this script blocking. If the script fails, it will throw an error and roll back the provision.

Default Order

Type in the scripts' default order in which to run (in the event there are multiple scripts in the same EBS)

Interpreter (Script type)

For Windows, only PowerShell and Windows Batch are valid interpreters

Script Temporary Directory

Directory to put temporary scripts on the specified host or provisioned node

Script

Type in the script to run

Specify success criteria (optional)

Optional

Select to specify success criteria(s)

Success Exit Code (optional)

Comma separate list, if multiple

Success is determined by the match of one of the exit code(s) against the script's exit code

Script output matches Regular Expression (optional)

The output used for matching is from the stdOut portion of the remote response returned by the target node


Add Lifecycle Profile

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

FieldValue
General
Configuration label

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

Unique label

DO NOT prepend with your tenant name and an underscore, e.g. mytenant_

SovLabs vRA CAFE Endpoint

Select the appropriate SovLabs vRA CAFE Endpoint this vRA tenant uses for appropriate address and security information

Ignore SovLabs Default Event Broker Subscriptions?

Indicate whether the SovLabs built-in Event Broker Subscriptions (EBS) should be ignored. Selecting this checkbox will cause any SovLabs module vRA property group attached to the vRA Blueprint other than the LCT property group to be ignored. Conversely, if this box is left unchecked, any SovLabs module property groups in the vRA Blueprint will override what is defined in this SovLabs Lifecycle Profile.

Click for Modules and Scripts
FieldValue
SovLabs Modules
AD

Select default SovLabs AD module to run.

*Note: If a blueprint has the module property group attached, the blueprint setting wins

vSphere DRS

Select default SovLabs vSphere DRS module to run.

*Note: If a blueprint has the module property group attached, the blueprint setting wins

IPAM

Select default SovLabs IPAM module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Naming

Select default SovLabs Naming module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Notification Group

Select default SovLabs Notifications module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Ansible Tower

Select default SovLabs Ansible Tower module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Puppet Enterprise Master

Select default SovLabs Puppet Enterprise module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Puppet Enterprise Agent

Select default SovLabs Puppet Enterprise module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Puppet Open Source with Foreman Master

Select default SovLabs Puppet Open Source with Foreman module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Puppet Open Source with Foreman Agent

Select default SovLabs Puppet Open Source with Foreman module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Red Hat Satellite

Select default SovLabs Red Hat Satellite module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

ServiceNow CMDB

Select default SovLabs ServiceNow CMDB module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Backup as a Service for Cohesity

Select default SovLabs Backup as a Service for Cohesity module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Backup as a Service for Rubrik

Select default SovLabs Backup as a Service for Rubrik module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Backup as a Service for Veeam

Select default SovLabs Backup as a Service for Veeam module to run

*Note: If a blueprint has the module property group attached, the blueprint setting wins

Machine Building PRE Scripts
Scripts

Select desired scripts to run. *The order of the scripts in this lifecycle is configured on the script definition itself.

Machine Provisioned PRE Scripts
Scripts

Select desired scripts to run. *The order of the scripts in this lifecycle is configured on the script definition itself.

Machine Disposing PRE Scripts
Scripts

Select desired scripts to run. *The order of the scripts in this lifecycle is configured on the script definition itself.

Machine Disposing POST Scripts
Scripts

Select desired scripts to run. *The order of the scripts in this lifecycle is configured on the script definition itself.

Click for Machine Building PRE
FieldValue
Machine Building PRE
SovLabs Property Toolkit

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Naming

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

IPAM

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

DNS

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

AD

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Click for Machine Provisioned PRE
FieldValue
Machine Provisioned PRE
SovLabs Property Toolkit

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

SovLabs VM Tagging

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

vSphere DRS

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Puppet Enterprise

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Puppet Open Source with Foreman

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Red Hat Satellite

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

AD

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

ServiceNow CMDB

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Backup as a Service for Cohesity

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Backup as a Service for Rubrik

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Backup as a Service for Veeam

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Ansible Tower

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Click for Machine Disposing PRE
FieldValue
Machine Disposing PRE
Puppet Open Source with Foreman

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Puppet Enterprise

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Red Hat Satellite

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Ansible Tower

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

AD

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

DNS

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

vSphere DRS

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Backup as a Service for Cohesity

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Backup as a Service for Veeam

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Click for Machine Disposing POST
FieldValue
Machine Disposing POST
IPAM

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

ServiceNow CMDB

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

vSphere DRS

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Notifications

Switch between default SovLabs EBS assignments and custom EBS that might have been created using Manage Lifecycle EBS.

Care should be taken when overriding the EBS used by a module as there may be interdependencies that cause the provisioning process to fail if order of precedence is not adhered to.

Click for Advanced
FieldValue
Generate JSON?

Check the checkbox to generate a contextual JSON data store for review in the 'Lifecycle Component JSON' field below

Lifecycle Component JSON

JSON format

Provides very granular control of ordering between execution of SovLabs Modules and Script Definitions.

Within the JSON structure each vRA Lifecycle state has its contents divided into SovLabs Custom EBS.

Default SovLabs Module EBS run levels and configurations cannot be modified and are not controlled by the Lifecycle Components Toolkit so they are not included.

SovLabs modules are represented by negative numbers intended to ensure their place of precedence before any scripts run.
These numbers only consider built-in precedence relationships and do not attempt to automatically reconcile with Script Definition order numbers.

It is recommended that all Script Definitions by design be kept in positive number realms, but this is not enforced by SovLabs.
If a Script Definition is configured with the same order number as an automatically generated SovLabs module order number then precedence between the two will be arbitrary until corrected.

Do not recalculate JSON?

Check the checkbox to ensure any custom changes do not get overridden.