Setup

Add Ansible Tower Endpoint

  1. Login to vRA tenant
  2. Click on the Catalog tab
  3. Request the Add Ansible Tower Endpoint vRA Catalog Item
  4. Fill out the form accordingly (see below) and Submit
Add Ansible Tower Endpoint
Add Ansible Tower 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_

Hostname

Ansible Tower hostname

Credential Configuration for Ansible Tower 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 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

Password

Shown when 'Create credential?' is checked

User's password

Organization

Auto-generated list based on Ansible Tower hostname and credentials

Select the appropriate Ansible Tower organization from an existing list of organizations


Add Ansible Tower Inventory Profile

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

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_

Ansible Tower Endpoint

Select the desired Ansible Tower Endpoint

Inventory Type

New field
Select Static to enable operations relating to Ansible Tower via API rather than having to provide root access for SSH.

Select Dynamic to enable operations relating to Ansible Tower via root access for SSH (method for SovLabs Plug-in 2018.2.7 and older)

Filters
vRA Business Group(s)

Auto-generated list of vRA Business Groups, if any exist

Select desired vRA Business Groups. Leave blank to select all

Property Filters

Specify the properties (key, value) to filter on. May have zero or more property filters

Dynamic Groups
Group separator

Define how VMs will be grouped via one or more string characters.

Used in the groups definitions below to separate group names.

Groups

Shown when 'Use Import Set?' is checked

List groups, separated by the character defined in Group separator above.

The group will be omitted if the template does not resolve

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

SovLabs Template Engine page
Paging
Result page size

Leave blank to get all VMs in a page result

Specify the maximum number of VMs to return at one time, will make multiple calls to get the entire inventory

vRA Property Translation

Enter a value of one or more characters that will replace dots (periods) that may occur in certain vRA custom properties, allowing Ansible to properly utilize them. For example, an underscore in this field (_) would translate a vRA custom property named my.dc as my_dc when referenced within an Ansible playbook.

Click for Ansible Tower Host Access
FieldValue

Only shown for "Dynamic" Inventory Type

Configure Custom Inventory?

Select to create the cache directory and dynamic inventory configuration YAML file on the indicated Ansible Tower endpoint

Ansible Tower Host Access
Ansible Tower Endpoint

Read-only field provided as a reference

References the Ansible Tower Endpoint selected in the previous tab

Ansible Tower Hostname

Read-only field provided as a reference

Displays the full Ansible Tower Endpoint's URL.

The cache directory and dynamic inventory configuration YAML file will be placed in the /sovlabs directory

Command for privilege escalation (e.g. sudo)

The command for the type of Linux the Ansible Tower server is using.

If the Host Username defined below has root privilege, this field can be left blank

Host Username

A username who is in the sudoer file or otherwise root privilege

Host Password

Host username's password

Dynamic Inventory Configuration
vRO Host

Auto-generated and may be overwritten by the user

The URL of the vRO Host

vRO Port

Auto-generated and may be overwritten by the user

The Port of the vRO Host

vRO Username

The vRO Username of the vRO Host

vRO Password

The Password for the vRO Username

Click for Inventory Setup
FieldValue
Organization Setup
Create Organization?

Shown when 'Inventory Type' is Dynamic

Select to create a new Organization or use an existing one

Organization Name

Create Organization? is not checked

Auto-generated list based on Ansible Tower Endpoint selected

Select a desired Organization


Create Organization? is checked

Type in the new Organization name to create

Description

Shown when 'Create Organization?' is checked

New Organization description

Inventory Setup
Create Inventory?

Select to create a new Inventory or use an existing one

Inventory Name

Create Inventory? is not checked

Auto-generated list based on Ansible Tower Endpoint selected

Select a desired Inventory


Create Inventory? is checked

Type in the new Inventory name to create

Description

Shown when 'Create Inventory?' is checked

New Inventory description

Group Setup
Create Group?

Select to create a new Group or use an existing one

Group Name

Create Group? is not checked

Auto-generated list based on Ansible Tower Endpoint selected

Select a desired Group


Create Group? is checked

Type in the new Group name to create

Description

Shown when 'Create Group?' is checked

New Group description

Inventory Source Setup
Create Inventory Source?

Option only available to Ansible Tower 3.2+

Select to create a new Inventory Source or use an existing one

Inventory Source Name

Create Inventory Source? is not checked

Auto-generated list based on Ansible Tower Endpoint selected

Select a desired Inventory Source


Create Inventory Source? is checked

Type in the new Inventory Source name to create

Description

Shown when 'Create Inventory Source?' is checked

New Inventory Source description

Inventory Script Setup
Inventory Script Options

Select from the provided options

Inventory Script Name

Inventory Script Options is either of the 'Assign to Group' option is selected

Auto-generated list based on Ansible Tower Endpoint and Organization selected. If Organization is blank, gets all

Select a desired Inventory Source


Inventory Script Options is Create new with Latest Custom Inventory

Type in the new Inventory Script name to create

Description

New Inventory Script description

Click for VM Deprovisioning
FieldValue

Shown when 'Inventory Type' is Dynamic

Immediate VM Deletion?

Select to immediately delete the VM from Ansible Tower Inventory (Group) list and cache when the VM is deprovisioned. Not checking this checkbox, the VM may still appear to be in inventory until the Inventory is synced or a new VM is added into the Inventory


Add Ansible Tower Profile

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

FieldValue
Ansible Tower Profile Configuration
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_

Ansible Tower Endpoint

Select the desired Ansible Tower Endpoint

Specify Job Templates
Filter Projects by Team

Filter Job Templates by Project

Get Job Templates from list?

Check the checkbox to get an auto-generated list based on Ansible Tower Endpoint selected.

Uncheck the checkbox to manually define Job Template name(s).

Job Templates

Get Job Templates from list? is checked

Auto-generated list based on Ansible Tower Endpoint selected

Select a Job Template from the left column and click on the right arrow to move it to the right column.

Repeat for all desired Job Templates


Get Job Templates from List? is not checked

Manually type in any additional Job Templates

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

SovLabs Template Engine page
Get Deprovision Job Templates from list?

Check the checkbox to get an auto-generated list based on Ansible Tower Endpoint selected.

Uncheck the checkbox to manually define Deprovision Job Template name(s).

Deprovision Job Templates

Get Deprovision Job Templates from list? is checked

Auto-generated list based on Ansible Tower Endpoint selected

Select a Deprovision Job Template from the left column and click on the right arrow to move it to the right column.

Repeat for all desired Deprovision Job Templates


Get Deprovision Job Templates from List? is not checked

Manually type in any additional Deprovision Job Templates

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

SovLabs Template Engine page
Ignore Job Run Errors?

Prompt on Launch Overrides
Machine credential

Get Machine credential from list? is checked

Auto-generated list based on Ansible Tower Endpoint selected

Select the desired machine credential, if any


Get Machine credential from List? is not checked

Manually type in the machine credential.

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

SovLabs Template Engine page
Inventory

The Inventory field is required if this profile is to be used with a Static inventory.

Field required for Static Inventory

Get Inventory from list? is checked

Auto-generated list based on Ansible Tower Endpoint selected

Select the desired Inventory, if any


Get Inventory from List? is not checked

Manually type in the desired Inventory

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

SovLabs Template Engine page
Extra vars

Define a string that represents a JSON or YAML formatted dictionary (with escaped parentheses) which includes variables given by the user, including answers to survey questions