Updated October 30, 2017
Overview
Starting with IPAM 4.5, you can use Windows PowerShell and the Orion SDK to manage IP addresses in IPAM. The IPAM-specific API fields are documented on the IPAM API wiki page in the Orion SDK.
Note: You can also use Python OrionSDK to call to the API. This article provides instructions on how to use Windows PowerShell.
Supported operations:
- Get the first available IP address for a specified subnet
- Change IP node status
- Start, finish, and cancel an IP address reservation
- Create a new subnet
- Add a DNS 'A' record for an IP address
- Change a DNS 'A' record for an IP address
- Remove a DNS 'A' record for an IP address
- Add an 'A' record with an associated PTR for a zone
- Add PTR to a DNS 'A' record
- Create an IP address reservation on a DHCP server
- Remove an IP address reservation from a DHCP server
- Get an 'A' recorde and PTR records for a DNS zone
- Create a custom property
- Update a custom property
- Reorder a custom property
- Delete a custom property
- CRUD operations for subnets
- CRUD operations for IP addresses
- Pre-requisites
- Verify that at least PowerShell 4.0 is installed:
Open PowerShell and enter $PSVersionTable.PSVersion to determine the PowerShell engine version. The major version should be 4 or higher. - Install the Orion SDK if you have not yet installed it:
Download the OrionSDK.msi installer from GitHub here:
https://github.com/solarwinds/OrionSDK/releases/
Run the installer and complete the setup wizard. - Learn the basics of using the Orion SDK in PowerShell:
Review the Orion SDK PowerShell page posted here:
https://github.com/solarwinds/OrionSDK/wiki/PowerShell - In PowerShell, add the SwisSnapin if you have not yet added it:
Add the SwisSnapin by running the Add-PSSnapin cmdlet:
Add-PSSnapin -Name SwisSnapin
For more information open the Orion SDK PowerShell page and follow the steps in the "Using SwisSnapin" section:
https://github.com/solarwinds/OrionSDK/wiki/PowerShell
- Getting started with the API
- Open Windows PowerShell ISE to test the example(s)
- Enter Windows-key+R to open the Run dialog.
- Type powershell ise and press OK
- In PowerShell ISE, create a SWIS connection object using the Connect-Swis cmdlet.
For details, open the Orion SDK PowerShell page and follow the steps in the "Cmdlets Provided by SwisSnapin" section:
https://github.com/solarwinds/OrionSDK/wiki/PowerShell
- In PowerShell ISE, enter the IPAM API cmdlets and run them. Refer to the IPAM API reference for documentation.