The devices discovered by Network Automation
References to discovery:device are object references. The name part of a Discovery Device object reference has the following components:
- Name of the device
- Name of the network view
Example: discovery:device/ZG5zLmJpbmRfY25h:somedevice/mynview
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, name, network_view.
The IPv4 Address or IPv6 Address of the device.
Type
String.
Search
The field is available for search via
Notes
The address is part of the base object.
The address cannot be updated.
address cannot be written.
The ref to management IP address of the device.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The address_ref cannot be updated.
address_ref cannot be written.
The list of available management IPs for the device.
Type
String array.
Search
The field is not available for search.
Notes
The available_mgmt_ips cannot be updated.
available_mgmt_ips cannot be written.
Determines whether to modify the admin status of an interface of the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_admin_status_ind cannot be updated.
cap_admin_status_ind cannot be written.
The reason that the edit admin status action is not available.
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 cap_admin_status_na_reason cannot be updated.
cap_admin_status_na_reason cannot be written.
Determines whether to modify the description of an interface on the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_description_ind cannot be updated.
cap_description_ind cannot be written.
The reason that the edit description action is not available.
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 cap_description_na_reason cannot be updated.
cap_description_na_reason cannot be written.
Determines whether to deprovision a network from interfaces of the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_net_deprovisioning_ind cannot be updated.
cap_net_deprovisioning_ind cannot be written.
The reason that the deprovision a network from interfaces of this device is not available.
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 cap_net_deprovisioning_na_reason cannot be updated.
cap_net_deprovisioning_na_reason cannot be written.
Determines whether to modify the network associated to an interface of the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_net_provisioning_ind cannot be updated.
cap_net_provisioning_ind cannot be written.
The reason that network provisioning is not available.
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 cap_net_provisioning_na_reason cannot be updated.
cap_net_provisioning_na_reason cannot be written.
Determines whether to create a VLAN and then provision a network to the interface of the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_net_vlan_provisioning_ind cannot be updated.
cap_net_vlan_provisioning_ind cannot be written.
The reason that network provisioning on VLAN is not available.
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 cap_net_vlan_provisioning_na_reason cannot be updated.
cap_net_vlan_provisioning_na_reason cannot be written.
Determines whether to modify the VLAN assignement of an interface of the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_vlan_assignment_ind cannot be updated.
cap_vlan_assignment_ind cannot be written.
The reason that VLAN assignment action is not available.
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 cap_vlan_assignment_na_reason cannot be updated.
cap_vlan_assignment_na_reason cannot be written.
Determines whether to modify the voice VLAN assignment of an interface of the device.
Type
Bool.
Search
The field is not available for search.
Notes
The cap_voice_vlan_ind cannot be updated.
cap_voice_vlan_ind cannot be written.
The reason that voice VLAN assignment action is not available.
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 cap_voice_vlan_na_reason cannot be updated.
cap_voice_vlan_na_reason cannot be written.
The device chassis serial number.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The chassis_serial_number cannot be updated.
chassis_serial_number cannot be written.
The description of the 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 description cannot be updated.
description cannot be written.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
List of the device interfaces.
Type
A/An discovery:deviceinterface object array.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The interfaces cannot be updated.
interfaces cannot be written.
The location 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
Notes
The location cannot be updated.
location cannot be written.
The model 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
Notes
The model cannot be updated.
model cannot be written.
The Microsoft Active Directory user related information.
Type
A/An Active Directory User Data struct.
Search
The field is not available for search.
Notes
The ms_ad_user_data cannot be updated.
ms_ad_user_data cannot be written.
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
Notes
The name is part of the base object.
The name cannot be updated.
name cannot be written.
List of the device neighbors.
Type
A/An discovery:deviceneighbor object array.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The neighbors cannot be updated.
neighbors cannot be written.
The ref to the network to which belongs the management IP address belongs.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The network cannot be updated.
network cannot be written.
The list of networks to which the device interfaces belong.
Type
A/An Network info struct array.
Search
The field is not available for search.
Notes
The network_infos cannot be updated.
network_infos cannot be written.
The name of the network view in which this device resides.
Type
String.
Search
The field is available for search via
Notes
The network_view is part of the base object.
The network_view cannot be updated.
network_view cannot be written.
The list of networks to which the device interfaces belong.
Type
An array of the following objects: network, ipv6network.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The networks cannot be updated.
networks cannot be written.
The Operating System version running on 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
Notes
The os_version cannot be updated.
os_version cannot be written.
The port statistics of the device.
Type
A/An Port statistics struct.
Search
The field is not available for search.
Notes
The port_stats cannot be updated.
port_stats cannot be written.
A flag indicated that NI should send enable command when interacting with device.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
The type 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
Notes
The type cannot be updated.
type cannot be written.
User-defined management IP address of the device.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
The vendor 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
Notes
The vendor cannot be updated.
vendor cannot be written.
The list of VLAN information associated with the device.
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.
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| address | String | N | Y | Y | : = ~ |
| address_ref | String | N | Y | N | N/A |
| available_mgmt_ips | [String] | N | Y | N | N/A |
| cap_admin_status_ind | Bool | N | Y | N | N/A |
| cap_admin_status_na_reason | String | N | Y | N | N/A |
| cap_description_ind | Bool | N | Y | N | N/A |
| cap_description_na_reason | String | N | Y | N | N/A |
| cap_net_deprovisioning_ind | Bool | N | Y | N | N/A |
| cap_net_deprovisioning_na_reason | String | N | Y | N | N/A |
| cap_net_provisioning_ind | Bool | N | Y | N | N/A |
| cap_net_provisioning_na_reason | String | N | Y | N | N/A |
| cap_net_vlan_provisioning_ind | Bool | N | Y | N | N/A |
| cap_net_vlan_provisioning_na_reason | String | N | Y | N | N/A |
| cap_vlan_assignment_ind | Bool | N | Y | N | N/A |
| cap_vlan_assignment_na_reason | String | N | Y | N | N/A |
| cap_voice_vlan_ind | Bool | N | Y | N | N/A |
| cap_voice_vlan_na_reason | String | N | Y | N | N/A |
| chassis_serial_number | String | N | Y | N | = |
| description | String | N | Y | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| interfaces | [obj] | N | Y | N | N/A |
| location | String | N | Y | N | : = ~ |
| model | String | N | Y | N | : = ~ |
| ms_ad_user_data | struct | N | Y | N | N/A |
| name | String | N | Y | Y | : = ~ |
| neighbors | [obj] | N | Y | N | N/A |
| network | String | N | Y | N | N/A |
| network_infos | [struct] | N | Y | N | N/A |
| network_view | String | N | Y | Y | = |
| networks | obj | N | Y | N | N/A |
| os_version | String | N | Y | N | : = ~ |
| port_stats | struct | N | Y | N | N/A |
| privileged_polling | Bool | N | N | N | N/A |
| type | String | N | Y | N | : = ~ |
| user_defined_mgmt_ip | String | N | N | N | N/A |
| vendor | String | N | Y | N | : = ~ |
| vlan_infos | [struct] | N | Y | N | N/A |
| Field | Type | Search |
|---|---|---|
| discovery_member | String | = |
discovery:credentialgroup : The Credential group object.
