Setup

Add Microsoft Endpoint

Login to vRA tenant
Click on the Catalog tab
Request the Add Microsoft Endpoint vRA Catalog Item
Fill out the form accordingly (see below) and Submit

For Microsoft Endpoints using OpenSSH (winsshd) Connection Method, only use the username (not UPN format)

Add Microsoft Endpoint

A Windows 2012 R2 jump server or domain controller that is utilized by the SovLabs plugin for a target AD, DNS, and/or IPAM server

Field	Value
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_
Connection type	Connection method to connect to the target or proxy Microsoft server. Click here to use VMware Tools
vCenter Endpoint	Shown when 'Connection type' is `vmware-tools` Select an existing SovLabs vCenter Endpoint where the Microsoft server VM resides in
VM name as it appears in vCenter	Shown when 'Connection type' is `vmware-tools` Type in the VM name of the Microsoft IPAM server as it appears in vCenter *VM name is case sensitive!
Is a jump server?	Jump servers are limited to `SSH` daemon connection methods only or VMware Tools Choose whether or not to utilize a jump server to make remote commands to the target IPAM server
Hostname	Shown when 'Connection type' is not `vmware-tools` and 'Is a jump server?' is not checked Microsoft IPAM server (FQDN or IP Address)
Jump server	Shown when 'Connection type' is not `vmware-tools` and 'Is a jump server?' is checked Jump server FQDN or IP Address for the target Microsoft IPAM server
Remote server	Shown when 'Is a jump server?' is checked Type in the target Microsoft IPAM server
Uses non-standard port?	Shown when 'Is a jump server?' is checked Was the `WinRM` or `SSH` daemon was configured to listen on a non-standard port?
Port	Shown when 'Uses non-standard port?' is checked Port number
Credential Configuration for Microsoft 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_
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
Advanced
Temporary directory where scripts will be placed	Optional If not provided, will default to `C:\Windows\temp`. *The Service Account must have permission to write files to and remove files from this directory.
Share path for temporary directory to access	Define if administrative shares are not available Type in `path\share` instead of `\\share-server\path\share`

Add IPAM Profile

Login to vRA tenant
Click on the Catalog tab
Request the Add IPAM Profile vRA Catalog Item
Fill out the form accordingly (see below) and Submit

Add IPAM Profile

Field	Value
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_
Description	Optional Description of IPAM profile
IPAM type	Select 'Microsoft' as the IPAM type
Provider host	Auto-generated list after an IPAM type is selected. If nothing is available, please make sure to have added an IPAM endpoint Select the desired Microsoft Endpoint
Subnets, Gateways and Network names	Type in a subnet and its gateway and network name (all comma separated) into the input field (e.g. `10.0.0.0/24, 10.0.0.1, networkName`) Subnet: `X.X.X.X/CIDR` Gateway: `X.X.X.X` (optional) Network Name: Corresponds to the VMware port group name in vCenter to be configured on the VM for this nic. Please refer to your vCenter configuration to identify what this value should be (vSphere Client > Networking > Portgroups) Network Mask: Optional / Can be templated This field is templatable. Click the link below to view documentation on the SovLabs Template Engine SovLabs Template Engine page
Excluded IPs	Enter all IPs to be excluded (e.g. `10.0.0.1`)
NIC number	Enter in a NIC number (`0-9`) for this IPAM profile
Primary DNS	Input Primary DNS
Secondary DNS	Input Secondary DNS
DNS suffix	Input DNS suffix
DNS search suffix	Comma separate values Input DNS search suffix(es)
Primary WINS	Input Primary WINS
Secondary WINS	Input Secondary WINS

Using VMware Tools

Notice

The Service Account being used for the vCenter endpoint needs to be a member of the SystemConfiguration.Administrators group in vCenter (Administration > Single Sign-On > Users and Groups).

Perform this step only if using VMware Tools to connect to a jump server or target Microsoft IPAM server

VMware Cloud on AWS

Enable connectivity for VM tools for VMware Cloud on AWS and VM tools support

Establish a VPN between the MGW (Management Network) and CGW (Customer Network)
Open port 443 from the firewall

This allows Guest Operations API

Add SovLabs vCenter Endpoint

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

Add SovLabs vCenter Endpoint

Field	Value
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	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 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