Network Management

SWIS API to perform IPAM operations

Use extended API support to make changes in IPAM from a 3rd party platform.

First published date

11/29/2018 10:39 PM

Last published date

5/26/2022 11:21 AM

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 (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018) 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.  

Product section

IP Address Manager

Resolution

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  (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018)
  • 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/  (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018).
      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  (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018).
    • 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  (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018).

  • Getting started with the API
    1. Open Windows PowerShell ISE to test the example(s)
      1. Enter Windows-key+R to open the Run dialog.
      2. Type powershell ise and press OK
         
    2. 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  (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018). 
    3. In PowerShell ISE, enter the IPAM API cmdlets and run them. Refer to the IPAM API  (© 2018 GitHub, available at https://github.com, obtained on Dec 14, 2018) reference for documentation.


GitHub Terms and Conditions