Discovery service

The discovery service resource starts a discovery with or without a profile.

Description

Use this type of request to start a discovery using any currently defined profile, or without a profile.

URL

scheme//hostname:port/rest/discovery/start/run_name
where:
scheme
The scheme of the URL (either HTTP: or HTTPS:).
hostname
The TCP/IP hostname or numeric IP address of the TADDM server.
port
The TCP/IP port on the TADDM server for the type of connection you are using (9430 for HTTP, or 9431 for HTTPS).
run_name
The name for the discovery run.

HTTP methods

POST
Starts a discovery. A discovery must not already be in progress. You must submit the url request by using the HTTP POST operator.

Parameters

feed={json|xml}

The format to use for the returned data. Specify json or xml. This parameter is optional.

If you do not specify the feed parameter, the server uses the format specified by the HTTP Accept header (application/json or application/xml). If this header is not specified, the results are returned in JSON format.

guids=values
One or more globally unique identifiers (GUIDs) of objects that have previously been discovered. Use this parameter to run a rediscovery on existing objects, if you have enabled rediscovery.
profile=profile_name
The name of the profile to use. The specified profile must exist.
scope=values
One or more scopes, separated by commas. Each value can be any of the following:
  • A defined scope name
  • A specific IP address or host name (for example, 192.168.1.71 or server.example.com)
  • A specific IP address to exclude, enclosed in parentheses (for example, (192.168.1.71))
  • An IP address range (for example, 10.10.10.1-10.10.10.20)
  • A subnet (for example, 10.10.20.0/255.255.255.0

An IP address, address range, or subnet can be enclosed in parentheses to indicate that it should be excluded from the scope. For example, 192.168.1.1-192.168.1.72,(192.168.1.71) would include all IP addresses in the specified range except 192.168.1.71.

locationTag=value
The value of location tag to set for objects that are created during a discovery.
Fix Pack 3 addressSpace=value
The address space name that is set for all IpAddress or IpNetwork objects that are created during a discovery.

Input example

This example starts a discovery by using the Level 3 Discovery profile, with the scope including the hosts 192.168.100.101 and 102.168.100.102. You can use any tool or utility that can make an HTTP request and submit the request by using the POST operator.
http://example.com:9430/rest/discovery/start/TestRun2?profile=Level%203
%20Discovery&scope=192.168.100.101,192.168.100.102

Returns

If the request is successful, the HTTP response code 200 is returned, along with the message Discovery start submitted. If a discovery is already in progress, the request fails and an error message is returned. You can then use the discovery status resource to monitor discovery progress.