discovery:status : Discovery Status object.

The discovery status of discovered data

Object Reference

This object does not support references.

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): address, name, network_view, status.

address

address

The IPv4 Address or IPv6 Address of the device.

Type

String.

Search

The field is available for search via

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

Notes

The address is part of the base object.

The address cannot be updated.

address cannot be written.

cli_collection_enabled

cli_collection_enabled

Indicates if CLI collection is enabled.

Type

Bool.

Search

The field is not available for search.

Notes

The cli_collection_enabled cannot be updated.

cli_collection_enabled cannot be written.

cli_credential_info

cli_credential_info

The CLI credential status information of the device.

Type

A/An Status information struct.

Search

The field is not available for search.

Notes

The cli_credential_info cannot be updated.

cli_credential_info cannot be written.

existence_info

existence_info

The existence status information of the device.

Type

A/An Status information struct.

Search

The field is not available for search.

Notes

The existence_info cannot be updated.

existence_info cannot be written.

fingerprint_enabled

fingerprint_enabled

Indicates if DHCP finterprinting is enabled.

Type

Bool.

Search

The field is not available for search.

Notes

The fingerprint_enabled cannot be updated.

fingerprint_enabled cannot be written.

fingerprint_info

fingerprint_info

This DHCP finterprinting status information of the device.

Type

A/An Status information struct.

Search

The field is not available for search.

Notes

The fingerprint_info cannot be updated.

fingerprint_info cannot be written.

first_seen

first_seen

The timestamp when the device was first discovered.

Type

Timestamp.

Search

The field is not available for search.

Notes

The first_seen cannot be updated.

first_seen cannot be written.

last_action

last_action

The timestamp of the last detected interface property change.

Type

String.

Search

The field is not available for search.

Notes

The last_action cannot be updated.

last_action cannot be written.

last_seen

last_seen

The timestamp when the device was last discovered.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_seen cannot be updated.

last_seen cannot be written.

last_timestamp

last_timestamp

The timestamp of the last executed action for the device.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_timestamp cannot be updated.

last_timestamp cannot be written.

name

name

The name of the device.

Type

String.

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

Search

The field is available for search via

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

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

network_view

network_view

The name of the network view in which this device resides.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view is part of the base object.

The network_view cannot be updated.

network_view cannot be written.

reachable_info

reachable_info

The reachable status information of the device.

Type

A/An Status information struct.

Search

The field is not available for search.

Notes

The reachable_info cannot be updated.

reachable_info cannot be written.

snmp_collection_enabled

snmp_collection_enabled

Indicates if SNMP collection is enabled.

Type

Bool.

Search

The field is not available for search.

Notes

The snmp_collection_enabled cannot be updated.

snmp_collection_enabled cannot be written.

snmp_collection_info

snmp_collection_info

The SNMP collection status information of the device.

Type

A/An Status information struct.

Search

The field is not available for search.

Notes

The snmp_collection_info cannot be updated.

snmp_collection_info cannot be written.

snmp_credential_info

snmp_credential_info

The SNMP credential status information of the device.

Type

A/An Status information struct.

Search

The field is not available for search.

Notes

The snmp_credential_info cannot be updated.

snmp_credential_info cannot be written.

status

status

The overall status of the device.

Type

String.

Valid values are:
  • ERROR
  • NOT_REACHABLE
  • OK

Search

The field is not available for search.

Notes

The status is part of the base object.

The status cannot be updated.

status cannot be written.

type

type

The type of device.

Type

String.

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

Search

The field is not available for search.

Notes

The type cannot be updated.

type cannot be written.

Fields List

Field Type Req R/O Base Search
address String N Y Y : =
cli_collection_enabled Bool N Y N N/A
cli_credential_info struct N Y N N/A
existence_info struct N Y N N/A
fingerprint_enabled Bool N Y N N/A
fingerprint_info struct N Y N N/A
first_seen Timestamp N Y N N/A
last_action String N Y N N/A
last_seen Timestamp N Y N N/A
last_timestamp Timestamp N Y N N/A
name String N Y Y : =
network_view String N Y Y =
reachable_info struct N Y N N/A
snmp_collection_enabled Bool N Y N N/A
snmp_collection_info struct N Y N N/A
snmp_credential_info struct N Y N N/A
status String N Y Y N/A
type String N Y N N/A