discovery:devicecomponent : Device Component object.¶
The device components discovered by Network Automation.
Object Reference¶
References to discovery:devicecomponent are object references. The name part of a Discovery Device Component object reference has the following components:
Name of the device component
Example: discovery:devicecomponent/ZG5zLmJpbmRfY25h:somedevice/mynview
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): component_name, description, model, serial, type.
component_name¶
- component_name¶
The component name.
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 component_name is part of the base object.
The component_name cannot be updated.
component_name cannot be written.
description¶
- description¶
The description of the device component.
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 is part of the base object.
The description cannot be updated.
description cannot be written.
device¶
- device¶
A reference to a device, to which this component belongs to.
Type
String.
This field supports nested return fields as described here.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The device cannot be updated.
device cannot be written.
model¶
- model¶
The model of the device component.
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 model is part of the base object.
The model cannot be updated.
model cannot be written.
serial¶
- serial¶
The serial number of the device component.
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 serial is part of the base object.
The serial cannot be updated.
serial cannot be written.
type¶
- type¶
The type of device component.
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 is part of the base object.
The type cannot be updated.
type cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
component_name |
String |
N |
Y |
Y |
N/A |
description |
String |
N |
Y |
Y |
N/A |
device |
String |
N |
Y |
N |
= |
model |
String |
N |
Y |
Y |
N/A |
serial |
String |
N |
Y |
Y |
N/A |
type |
String |
N |
Y |
Y |
N/A |
