Integrating BlueCat™ IP Address Management with vCommander

You can configure Embotics® vCommander® to use BlueCat™ IP address management (IPAM) capabilities. When you integrate vCommander with BlueCat IPAM as shown in this article, you can create host records or DHCP reservations from BlueCat™ IPAM during provisioning with vCommander.

To set this up, you need to:

Copy the BlueCat™ API bindings file to the vCommander installation directory.

Create a set of credentials that has access to the BlueCat™ server.

Connect vCommander to a BlueCat™ server.

Set up a completion workflow with a Configure OS Networking step, or add this step to an existing completion workflow.

NotePencil-small        The Configure OS Networking step is also supported in command workflows.

Set up a decommissioning workflow to release the addresses when decommissioning VMs managed by BlueCat™.

These tasks are explained in this topic. For an end-to-end example that includes BlueCat™ networking, see Automating VM Customization through Workflows: Examples.

Copy the BlueCatTM JAR file to the vCommander installation directory

1.Download the BlueCat™ API bindings file (likely called api.tgz) from the BlueCat™ website.

If you cannot locate this file, contact your BlueCat™ representative.

2.Create a subdirectory named "ext" in the following directory:

<vCommander_install_dir>\tomcat\lib

3.From the downloaded file, extract the api.jar file to the following directory:

<vCommander_install_dir>\tomcat\lib\ext

4.Restart the vCommander Windows service.

Create system credentials for the BlueCatTM server

Access through:

Configuration menu > Credentials

Available to:

vCommander Role of Superuser and Enterprise Admin

1.On the Credentials page, click Add.

2.Enter the user name and password for a BlueCat™ account.

The vCommander integration with BlueCat™ automatically uses sudo with non-root-user credentials, so the user must be able to run sudo in this case. vCommander supports interactive sudo prompts. Ensure that the sudoers file on the BlueCat™ server does not contain the following line: Defaults requiretty

3.For Description, enter "BlueCat", to serve as a memory aid to administrators when configuring tasks requiring credentials.

4.From the Category list, choose System Credentials.

5.Click OK.

Connect vCommander to a BlueCatTM server

Access through:

Configuration menu > System Configuration > Integration tab

Available to:

vCommander Role of Superuser

1.On the Integration page, click Add > BlueCat™ IPAM Server.

2.In the BlueCat™ IPAM Server dialog, enter the host name or IP address and port for the BlueCat™ server.

Both http and https protocols are supported. The default port is 80.

3.From Credentials, choose the BlueCat™ credentials.

4.In the Configuration field, enter the BlueCat™ configuration (the parent IPAM object).

5.In the Server field, enter the DNS/DHCP server to deploy the changes to. You can add multiple servers as a comma-separated list.

6.For Services, select DNS and/or DHCP as required.

7.Click Test to test the connection.

vCommander queries BlueCat™ to determine whether everything is set up correctly. If you see an error about a missing file, see Copy the BlueCatTM API Bindings to the vCommander Installation Directory above.

NotePencil-smallvCommander connects to BlueCat™ only as needed; there's no continuous connection.

4.Once you see a Success message, click OK to save the configuration.

Set up a completion workflow

Access through:

Configuration menu > Service Request Configuration > Completion Workflow tab

Available to:

vCommander Role of Superuser and Enterprise Administrator

1.Create a completion workflow.

2.On the Name page, provide a name, and in the Apply this workflow drop-down menu, select after a VM is deployed.

3.On the Steps page, add a Configure OS Networking step.

4.Give the step a descriptive name.

5.In the Credentials drop-down menu, select credentials or click Add Credentials. See Configuring OS Networking through a Workflow Step for guidance.

6.In the Assign IP drop-down menu, select From BlueCat™ IPAM.

7.Enter networking details as required. The Gateway, DNS View, Block, Network and Domain Name fields are mandatory.

8.In the Action drop-down list, select Apply Settings to configure the VM in this step, or select Reserve Only to have the IP information recorded in the approval comments. When you select Reserve Only, the output can be used as input to a subsequent Customize VM step in the workflow.

Workflow errors are written to the workflow step comment log. See Troubleshooting and Tracking Workflows for more information.

For full details on completion workflows, see Creating a Completion Workflow.

Set up a decommissioning workflow

Access through:

Configuration menu > Service Request Configuration > Completion Workflow tab

Available to:

vCommander Role of Superuser and Enterprise Administrator

When you use vCommander to create host records or DHCP reservations from BlueCat™ IPAM during provisioning, it makes sense to release the addresses when decommissioning VMs.

1.Create a new completion workflow.

2.On the Name page, provide a name, and in the Apply this workflow drop-down menu, select after a Change Request is fulfilled.

3.On the Steps page, add a Decommissioning Networking step (in the Guest OS category).

4.On the Assigned Forms page, select Apply this workflow to the selected forms and select the Decommissioning Request form.

For full details on completion workflows, see Creating a Completion Workflow.

Disabling or removing the BlueCatTM server

Access through:

Configuration menu > System Configuration > Integration tab

Available to:

vCommander Role of Superuser

Disabling an external server makes the server unavailable for connections but saves the settings, meaning that you can return to the configuration dialog later and simply re-enable it.

Removing an external server clears the settings, meaning that you must reconfigure all of the settings if you want to reintegrate later.

To disable an external server

1.On the Integration page, select the server you want to disable, and click Edit.

2.Clear the Enabled checkbox, and click OK.

To remove an external server

1.On the Integration page, select the server you want to remove, and click Remove.

2.Click Yes to confirm the change.