discovery:vrf : The VRF object.¶
This object provides information about the virtual network membership (VRF).
Object Reference¶
References to discovery:vrf are object references.
The name part of the discovery:vrf object reference has the following components:
Name of the VRF
Name of the device
Example: discovery:vrf/ZG5zLmJpbmRfY25h:myvrf/mydevice
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): device, name, network_view, route_distinguisher.
description¶
- description¶
Additional information about the VRF.
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.
device¶
- device¶
The device to which the VRF belongs.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The device is part of the base object.
The device cannot be updated.
device cannot be written.
name¶
- name¶
The name of the VRF.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
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 VRF 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.
route_distinguisher¶
- route_distinguisher¶
The route distinguisher associated with the VRF.
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 route_distinguisher is part of the base object.
The route_distinguisher cannot be updated.
route_distinguisher cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
description |
String |
N |
Y |
N |
N/A |
device |
String |
N |
Y |
Y |
N/A |
name |
String |
N |
Y |
Y |
: = ~ |
network_view |
String |
N |
Y |
Y |
= |
route_distinguisher |
String |
N |
Y |
Y |
N/A |
