The neighbor associated with the device discovered by Network Automation.
Only reference searches are supported for retrieving a single discovery:deviceneighbor object. If no search parameters and references are passed, the appliance returns an empty list.
NOTE: Currently, reference searches DO NOT return all the values for the object’s fields. For example, ‘mac’ and ‘vlan_infos’ will not be returned. These values can be retrieved by fetching the discovery:device object and using nested return fields for the ‘neighbors’ field.
References to discovery:deviceneighbor are object references. The name part of a Discovery Device Neighbor object reference has the following components:
- Name of the device neighbor
- Name of the network view
Example: discovery:deviceneighbor/ZG5zLmJpbmRfY25h:deviceneighbor/myview
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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, address_ref, mac, name.
The IPv4 Address or IPv6 Address of the device neighbor.
Type
String.
Search
The field is not available for search.
Notes
The address is part of the base object.
The address cannot be updated.
address cannot be written.
The ref to the management IP address of the device neighbor.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The address_ref is part of the base object.
The address_ref cannot be updated.
address_ref cannot be written.
The ref to the device to which the device neighbor belongs.
Type
String.
This field supports nested return fields as described here.
Search
The field is available for search via
Notes
The device cannot be updated.
device cannot be written.
The ref to the interface to which the device neighbor belongs.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The interface cannot be updated.
interface cannot be written.
The MAC address of the device neighbor.
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 mac is part of the base object.
The mac cannot be updated.
mac cannot be written.
The name of the device neighbor.
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 name is part of the base object.
The name cannot be updated.
name cannot be written.
The list of VLAN information associated with the device neighbor.
Type
A/An VLAN information struct array.
Search
The field is not available for search.
Notes
The vlan_infos cannot be updated.
vlan_infos cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address | String | N | Y | Y | N/A |
| address_ref | String | N | Y | Y | N/A |
| device | String | N | Y | N | = |
| interface | String | N | Y | N | N/A |
| mac | String | N | Y | Y | N/A |
| name | String | N | Y | Y | N/A |
| vlan_infos | [struct] | N | Y | N | N/A |
