Discovery Run node

A Discovery Run is a scan of one or more Discovery endpoints, specified as an IP address or addresses or ranges which are scanned as an entity. These ranges might be being scanned locally on from the appliance, or be the result of appliance consolidation.

For each Discovery Run, a Discovery Run node is created which records information such as the user who started the run, the start and end time, and so on. A Discovery Run contains a number of Discovery Access nodes. In turn, Discovery Access nodes contain all other non-integration DDD nodes.

Additionally a Discovery Run node can also contain Provider Access nodes. A Provider Access node is created for a particular IP address as a result of a SQL Discovery access. In turn, Provider Access nodes contain all other Integration related DDD nodes.

Discovery Run lifecycle

The following section describes the scenarios in which a Discovery Run is created or destroyed. DDD nodes are never updated.

Creation

A Discovery Run node is created when a Discovery Run starts; when a range that has been configured to be scanned starts actually scanning or, if the appliance is a Consolidation Appliance, when a Scanning Appliance's scan starts to be consolidated. The Discovery Run remains open until all of the endpoints (IP addresses) in the range have been scanned or consolidated.

Removal

Discovery Runs are removed when all of their contained Discovery Access have been destroyed through the Aging process. When the Discovery Run node is destroyed any linked Integration Access nodes and their associated DDD nodes are also destroyed.

Attributes and relationships of the DiscoveryRun node

The attributes of the DiscoveryRun node are described in the following table:

UI Name Attribute Name and Type	Description
Key `key : string`	Unique identity string for DiscoveryRun
Label `label : string`	Label
Range Summary `range_summary : string`	Summarizes content of DiscoveryRun
User `user : string`	User who created the run
Scope `scope : string`	Distinguish overlapping address spaces
Restricted Organization Id `restricted_org_id : string`	Restricted organization id
Restricted Organization `restricted_org_name : string`	Restricted organization name
Restricted Organization Path `restricted_org_path : string`	Restricted organization path
Explicit Ranges `valid_ranges : string`	Valid IP address ranges in the run
Number of Explicit IPs `explicit_ip_count : int`	Number of user provided addresses in run
Number of Implicit IPs `implicit_ip_count : int`	Number of system provided addresses in run
Total Number of Endpoints `total : int`	Number of addresses in run
Failure Reason `failure_reason : string`	Reason for failure, if any
Number of Endpoints Scanned `done : int`	Number of completed addresses
Number of IPs being Pre-scanned `pre_scanning : int`	Number of addresses being pre-scanned
Number of Endpoints being Scanned `scanning : int`	Number of addresses being scanned
Number of IPs waiting on Exclude Ranges `waiting : int`	Number of addresses waiting for end of exclude range
Blocked Waiting on Exclude Ranges `blocked : boolean`	Blocked waiting for end of exclude range
Cancelled `cancelled : string`	Reason why run was cancelled
Consolidation Cancelled `consolidation_cancelled : string`	Reason why consolidation run was cancelled
Scan Type `scan_type : string`	Type of scan, e.g. Snapshot, Scheduled
Scan Kind `scan_kind : string`	Kind of scan, e.g. Cloud, IP
Scan Level `scan_level : string`	Scan level
Outpost `outpost_id : string`	Outpost that performed scan
Scan Options `scan_options : dictionary`	Scan options
Start Time `starttime : date`	Date and time the run started
End Time `endtime : date`	Date and time the run ended
Discovery Start Time `discovery_starttime : date`	Date and time the discovery started
Discovery End Time `discovery_endtime : date`	Date and time the discovery ended
ECA Error `has_eca_error : boolean`	True if there have been any ECA Errors for this Discovery Run
Hard Failure `hard_failure : boolean`	True if there have been hard failures for this Discovery Run
Not shown in UI `__inprogress : boolean`	True if Discovery Run still executing
Not shown in UI `__remote_inprogress : boolean`	True if Discovery Run still executing on the discovery appliance
Number of Endpoints Consolidated `consolidation_done_count : int`	Number of completed consolidation endpoints
Not shown in UI `_consolidation_source : string`	Identifier for the discovery appliance which provided the info for this run
Consolidated From Appliance `_consolidation_source_name : string`	Name of the discovery appliance which provided the info for this run
Consolidated From System `_consolidation_source_system : string`	Name of the system, cluster name or appliance name if not a cluster, which provided the info for this run
Consolidation Data Last Received `_consolidation_last_received : date`	Date and time last received consolidation data
Not shown in UI `_consolidation : list:string`	List of the consolidation appliance identifiers this run needs to be sent to
Not shown in UI `_consolidation_done : list:string`	List of the consolidation appliance identifiers this run has been sent to
Multi-tenant company `cdm_company : string`	Multi-tenant company name

The relationships of the DiscoveryRun node are described in the following table:

UI Name	Relationship	Description
Scan Range	`DiscoveryRun: EndpointRange: EndpointRange: ScanRange`	Scan Range used by this Discovery Run
Dropped Endpoints	`DiscoveryRun: EndpointRange: EndpointRange: DroppedEndpoints`	Endpoints that were not scanned
Endpoints	`List: List: Member: DiscoveryAccess`	Discovery Accesses made with this run
Data Source Accesses	`List: List: Member: DataSourceAccess`	Data Source Accesses made with this run
Provider Accesses	`List: List: Member: ProviderAccess`	Provider Accesses made with this run (deprecated)

Discovery Run node

Discovery Run lifecycle

Creation

Removal

Attributes and relationships of the DiscoveryRun node

Comments