IP Range Management API

In the Data Flow Management Java API, a new method importIPRanges() is introduced into the DDMConfigurationService class in UCMDB version 10.22. This method allows you to perform the following tasks by using a customized script to manage the IP ranges of specified Probes:

  • Overwrite the IP ranges of specified Probes. The IPv4/6, Range, and Type settings of an IP range are manageable through this method.
  • Assign certain probes in the same domain into a probe list, and then distribute the IP addresses in the specified ranges evenly to each probe in the group.

    Note Group is a temporary parameter used in this API method to group a set of probes assigned to the same domain, and to balance the IPs evenly among these probes.

You can perform this task on any computer that can access the UCMDB server. One or both of the following files are mandatory to set up the work environment on different computers:

  • ucmdb-api.jar: On the UCMDB server or on a probe, you only need this file. This file is available for download from the UCMDB server through the following URL: https://<IP_or_FQDN>:8443/ucmdb-api/download
  • api-client.jar: On a computer other than the UCMDB server or a probe, you need this file in addition to the ucmdb-api.jar file. This file is available in the following directory on the UCMDB server: <UCMDB_server>\lib\

For more information about how to use the UCMDB API, refer to the following documentation:

  • The Universal CMDB API chapter in the Developer Reference section of the UCMDB Help
  • API Reference

For a sample script to perform the IP range management task, see Sample Script for IP Range Management API .

Note  

  • This method does not support Data Flow Probe clusters.
  • You can specify the excluded IP ranges in the script. The API will calculate the whole IP ranges and the excluded IP ranges, and only assign the resulting IP ranges to a probe.
  • For both IPv4 and IPv6, you must specify an IP range with a starting IP address and an ending IP address in the format of x.x.x.x-x.x.x.x. If you want to specify a single IP address, the starting IP address and the ending IP address are the same.
  • An IP range should not overlap with another IP range in the script or with an IP range in another existing probe. Otherwise, the IP range will not be imported.

  • When you add probe list in the Java API importIPRanges() method, make sure you only add the discovery probe list. Do not add integration probes (for example, Linux probes or integration services).

    Linux Probes and integration services do not need IP ranges. If you add Linux probes or integration services, although the IPs in Linux probe or integration services do not display in the UI, they will be assigned to Linux Probes or integration services.