discovery:diagnostictask : The discovery diagnostic task object.

The object provides information about the discovery diagnostic task.

Object Reference

References to discovery:diagnostictask are object references.

The name part of a discovery diagnostic task object reference has the following components:

  • IP address of the discovery diagnostic task
  • Name of the network view

Example: discovery:diagnostictask/ZG5zLmJpbmRfY25h:12.0.30.4/default

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): ip_address, network_view, task_id.

community_string

community_string

The SNMP community string of the discovery diagnostic task.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is not available for search.

debug_snmp

debug_snmp

The SNMP debug flag of the discovery diagnostic task.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

force_test

force_test

The force test flag of the discovery diagnostic task.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

ip_address

ip_address

The IP address of the discovery diagnostic task.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The ip_address is part of the base object.

network_view

network_view

The network view name of the discovery diagnostic task.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view is part of the base object.

start_time

start_time

The time when the discovery diagnostic task was started.

Type

Timestamp.

Create

The default value is undefined.

Search

The field is not available for search.

task_id

task_id

The ID of the discovery diagnostic task.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The task_id is part of the base object.

Fields List

Field Type Req R/O Base Search
community_string String N N N N/A
debug_snmp Bool N N N N/A
force_test Bool N N N N/A
ip_address String N N Y : = ~
network_view String N N Y =
start_time Timestamp N N N N/A
task_id String N N Y =