john/phpIPAM-for-vRA8
1
0
Fork 0
mirror of https://github.com/jbowdre/phpIPAM-for-vRA8.git synced 2024-12-22 03:22:18 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
39 commits 1 branch 11 tags 9.9 MiB
Python 97.9%
Dockerfile 2.1%
Find a file
John Bowdre a57d20d7b4 improve documentation for subnet filter usage
2022-07-25 15:45:43 -05:00
docs improve documentation for subnet filter usage 2022-07-25 15:45:43 -05:00
src improve documentation for subnet filter usage 2022-07-25 15:45:43 -05:00
.gitignore fixing .gitignore 2021-01-15 12:41:56 -06:00
Dockerfile initial commit 2021-01-11 17:14:27 -06:00
open_source_licenses.txt initial commit 2021-01-11 17:14:27 -06:00
pom.xml improve documentation for subnet filter usage 2022-07-25 15:45:43 -05:00
README.md improve documentation for subnet filter usage 2022-07-25 15:45:43 -05:00
README_VMware.md Update README 2021-01-15 16:15:14 -06:00

README.md

phpIPAM Integration for vRealize Automation 8.x

This integration allows vRealize Automation 8.x to use phpIPAM for assigning static IP addresses to provisioned virtual machines. Built against vRA 8.2.0.12946 and phpIPAM 1.5.

Details on how I built this (as well as notes on how I configured phpIPAM to work correctly with this plugin) can be found here: https://virtuallypotato.com/integrating-phpipam-with-vrealize-automation-8

Prerequisites

  • phpIPAM 1.5 must be installed, configured, and available over HTTPS
  • Subnets must be defined in phpIPAM.
  • (Optional) A Custom Field defined to identify subnets which should be available to vRA.
    • Note: I previously used the built-in isPool field, but this is not ideal with versions of phpIPAM 1.5 since a change on April 4, 2022 which made the subnet and broadcast addresses (x.x.x.0 and x.x.x.255) assignable on networks with this field set. Use a Custom Field instead.
  • A trusted SSL certificate is not required; vRA will prompt to confirm the certificate when the connection is initially validated.

Usage

From the phpIPAM web interface:

  1. Administration > phpIPAM Settings > Feature Settings and enable the API option.
  2. Administration > phpIPAM Settings > Users and create a new user to be used by vRA.
  3. Administration > phpIPAM Settings > API and create a new API key with Read/Write permissions and SSL with User Token security. Make a note of the selected App ID field (not the auto-generated App Code).

In vRealize Automation:

  1. Go to Cloud Assembly > Infrastructure > Integrations and Add Integration.
  2. Select the IPAM integration type.
  3. Give it a name, then click Manage IPAM Providers > Import Provider Package.
  4. Upload phpIPAM.zip (get it here).
  5. Back at the New Integration page, click the Provider dropdown and select phpIPAM.
  6. Enter the API App ID, Username, Password, and Hostname of the phpIPAM server (fully-qualified name or IP address).
  7. (Optional) Configure the subnet filter.
  8. Click Validate to verify the information. It may take a minute or two for the validation to complete.
  9. Once validated, click Add.

You can then learn how to utilize the new IPAM integration here

See VMware's IPAM SDK README for information on how to adapt the code if needed.