Submit a ticketCall us

Webinar: Web Help Desk for HR, Facilities and Accounting Departments
This webinar will focus on use cases for HR, Facilities and Accounting.

Having a unified ticketing and asset management system for all the departments in your company can provide end-users with a seamless experience and make things easier for your IT team. Yet, with different business tasks and objectives, many departments don’t fully understand the capabilities of Web Help Desk and how the software can be customized for effective use in their departments.
Register Now.

Home > Success Center > IP Address Manager (IPAM) > SWIS API to perform IPAM operations

SWIS API to perform IPAM operations

Table of contents
No headers

Updated June 1st, 2017



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:
      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:
    • 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:

  • 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:
    3. In PowerShell ISE, enter the IPAM API cmdlets and run them. Refer to the IPAM API reference for documentation.





Last modified
14:24, 3 Oct 2017