phpIPAM-for-vRA8/README.md

phpIPAM Integration for vRealize Automation 8.x
============

This integration allows vRealize Automation 8.x to use [phpIPAM](https://phpipam.net) 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

Prerequisite:
===============

phpIPAM 1.5 must be [installed, configured, and available over HTTPS](https://virtuallypotato.com/integrating-phpipam-with-vrealize-automation-8#step-0-phpipam-installation-and-base-configuration). Subnets [must be defined in phpIPAM](https://virtuallypotato.com/integrating-phpipam-with-vrealize-automation-8#step-2-configuring-phpipam-subnets), and those which should be available to vRA can be marked as an IP pool (marking as pool is optional as of [v1.0.6](https://github.com/jbowdre/phpIPAM-for-vRA8/releases/tag/v1.0.6)). 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](https://github.com/jbowdre/phpIPAM-for-vRA8/releases/latest)).

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. Click **Validate** to verify the information. It may take a minute or two for the validation to complete.

8. Once validated, click **Add**.

You can then learn how to utilize the new IPAM integration [here](https://docs.vmware.com/en/vRealize-Automation/8.2/Using-and-Managing-Cloud-Assembly/GUID-9AE32BD7-2D1B-4FEE-881F-A0EDE5907D10.html)

See [VMware's IPAM SDK README](README_VMware.md) for information on how to adapt the code if needed.
Update README 2021-01-15 22:15:14 +00:00			`phpIPAM Integration for vRealize Automation 8.x`
initial commit 2021-01-11 23:14:27 +00:00			`============`

Update README 2021-01-15 22:15:14 +00:00			`This integration allows vRealize Automation 8.x to use [phpIPAM](https://phpipam.net) for assigning static IP addresses to provisioned virtual machines. Built against vRA 8.2.0.12946 and phpIPAM 1.5.`
initial commit 2021-01-11 23:14:27 +00:00
Include blog post links for more config details. 2021-10-04 19:12:20 +00:00			`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`

Update README 2021-01-15 22:15:14 +00:00			`Prerequisite:`
initial commit 2021-01-11 23:14:27 +00:00			`===============`

Update README.md 2021-12-22 02:52:50 +00:00			phpIPAM 1.5 must be [installed, configured, and available over HTTPS](https://virtuallypotato.com/integrating-phpipam-with-vrealize-automation-8#step-0-phpipam-installation-and-base-configuration). Subnets [must be defined in phpIPAM](https://virtuallypotato.com/integrating-phpipam-with-vrealize-automation-8#step-2-configuring-phpipam-subnets), and those which should be available to vRA can be marked as an IP pool (marking as pool is optional as of [v1.0.6](https://github.com/jbowdre/phpIPAM-for-vRA8/releases/tag/v1.0.6)). A trusted SSL certificate is not required; vRA will prompt to confirm the certificate when the connection is initially validated.
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`Usage`
initial commit 2021-01-11 23:14:27 +00:00			`===============`

Update README 2021-01-15 22:15:14 +00:00			`From the phpIPAM web interface:`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`1. Administration > phpIPAM Settings > Feature Settings and enable the API option.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`2. Administration > phpIPAM Settings > Users and create a new user to be used by vRA.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`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).`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`In vRealize Automation:`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`1. Go to Cloud Assembly > Infrastructure > Integrations and Add Integration.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`2. Select the IPAM integration type.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`3. Give it a name, then click Manage IPAM Providers > Import Provider Package.`
initial commit 2021-01-11 23:14:27 +00:00
Update README.md 2021-01-15 22:18:17 +00:00			4. Upload `phpIPAM.zip` (get it [here](https://github.com/jbowdre/phpIPAM-for-vRA8/releases/latest)).
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`5. Back at the New Integration page, click the Provider dropdown and select phpIPAM.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`6. Enter the API App ID, Username, Password, and Hostname of the phpIPAM server (fully-qualified name or IP address).`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`7. Click Validate to verify the information. It may take a minute or two for the validation to complete.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`8. Once validated, click Add.`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`You can then learn how to utilize the new IPAM integration [here](https://docs.vmware.com/en/vRealize-Automation/8.2/Using-and-Managing-Cloud-Assembly/GUID-9AE32BD7-2D1B-4FEE-881F-A0EDE5907D10.html)`
initial commit 2021-01-11 23:14:27 +00:00
Update README 2021-01-15 22:15:14 +00:00			`See [VMware's IPAM SDK README](README_VMware.md) for information on how to adapt the code if needed.`