WARNING.  This script is to be used for informational and learning purposes only.  Should you choose to modify and or include this script in your test or production environments, you do so at your own risk.  Custom scripts are only supported by Snow, when they are produced by a Snow Application Architect as part of a paid service engagement.

phpIPAM is a free opensource IP address Management tool. phpIPAM can be integrated into Commander to get and assign IP address on deployment for VM's in an VMware environment and remove the address on decomissioning. 

Requirements

• Commander scripts
  • Get the Next IP
  • Release the IP
• PowerShell v4 installed on the Commander application server
• Snow® Commander® 6.1.4 or later
• Snow Commander 2.8 REST API powershell libraries (Download here )
• phpIPAM Version 1.3.1 or higher can be downloaded from https://phpipam.net/ 

Prepare the Script Files

Download and extract the script to your Commander application server. Snow recommends storing all scripts called by Commander in a single location (c:\Scripts) for example. These scripts are executed by Commander. With the scripts extracted, the file system will look like this:

The scripts require minor editing before they will work with your systems. Refer to the comments in the individual script or the table below for guidance on editing the contents.

Note: Your Environment may require additional or different logic depending on how phpIPAM has been configured. This example assumes the virtual Portgroup Name matches the subnet Description in phpIPAM and DNS, Gateway are configured. 

The phpipam_NextIP.ps1 has sample logic to ensure that production goes to the production portgroup when deploying through Commander. You can edit this logic for any combination as long as there is a match in phpIPAM for the name of the portgroup in the description field for a subnet. 

Update Approval Workflow

Now that the scripts and credentials have been configured it's time to update the approval workflow to call out to phpIPAM and Assign IP addresses for each VM in the request based on a Service Form attribute. In this example we use a "Service Type" form attribute with Static drop downs for "Production, Development,and QA"

Sample Form:

Adding a step to call the script on a new request with the following command line syntax:

powershell.exe c:\Scripts\phpipam\phpipam_nextIP.ps1 -RequestID "#{request.id}" -ServiceType "#{request.services[1].settings.customAttribute['Service Type']}"

That's all there is to assigining an ip from phpIPAM. 

Update Decomissioning Workflow

Now to configure Commander to remove the assigned address when the service is decommissioned through Commander. 

Edit your completion workflow that's tied to your decommissioning change request form. 

Add an execute script step to remove the IP from phpIPAM before your delete vm step with the following commandline syntax: 

            powershell.exe c:\Scripts\phpipam\phpipam_releaseIP.ps1 -IPAddress "#{target.ipv4Addresses}"

Now Request a VM as a test if everything was configured properly you will see an entry in phpIPAM for the newly created VM and the Customized vm will have the correct network information assigned. 

New address assigned in phpIPAM: 

Verify the Deployed VM has the correct information: