Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleNote

Release 2.10 API replaced the previous .Networks. API with the generalized .VirtualNetwork. API. Avoid using the .Networks. API for any applications.

The current language-independent API Core provides bidirectional functionality, enabling clients to both retrieve data and send commands to NetMRI.

This enables clients to do the following:

  • Send HTTP requests using GET, or using POST with MIME types application/x-www-form-urlencoded, multipart/form-data, application/json, or application/xml.
  • Receive HTTP responses with MIME type application/json or application/xml.
  • Query and search over 70 different types of objects within the NetMRI data model.
  • Configure the NetMRI discovery ranges and other settings.
  • Schedule and run jobs on the NetMRI programmatically.
  • Associate job custom fields with jobs programmatically. For more information, see NetMRI API Core.
  • The Perl/Python API is a set of Perl/Python modules built on top of the API Core. These modules handle authentication, formatting of URL requests, and parsing of XML returned documents. This implementation of the API enables more focus on program logic. NetMRI includes a Perl and Python package providing adherence to Perl/Python conventions, and added functionality. For more information, see Migration to Current API Core.

The system maintains security by requiring authentication based on the same user names and passwords used by the NetMRI graphical user interface.

Effective use of the API requires programming skills. If you are not a programmer, you will need a programmer’s help to develop applications to query the NetMRI database through the API, process the resulting data, and send commands. While any language can be used with the API Core, Perl/Python is an appropriate choice. As its name implies, interactions with the Perl/Python API are implemented using Perl/Python scripts.

Note
titleNote

Infoblox may release future versions of the API that are not backward compatible with the current version.