Submit a ticketCall us

Get a crash course on Network Monitoring delivered right to your inbox
This free 7-day email course provides a primer to the philosophy, theory, and fundamental concepts involved in IT monitoring. Lessons will explain not only how to perform various monitoring tasks, but why and when you should use them. Sign up now.

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

SWIS API to perform IPAM operations

Table of contents
No headers

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.

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' record 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:
  • Learn the basics of using the Orion SDK in 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.

Last modified
07:10, 1 Jun 2017

Tags

This page has no custom tags.

Classifications

Public