Searchable Fields by Model

When you use a list view's search bar (the q= search), Nautobot matches your query against a specific set of fields for that model. This page documents which fields are searchable for each model.

This page is generated automatically from each model's SearchFilter definition, so it always reflects the current behavior of the code. It is not maintained by hand.

A few notes on reading the tables below:

• Matches are case-insensitive partial matches unless otherwise defined by the model's filter.
• A field name containing __ (for example, circuit_terminations__description) searches a field on a related object.
• The id field matches an object's primary-key UUID exactly.

Tip

To scope a global search to a single model, prefix your query with in:$model (for example, in:Devices). See Search for details.

Circuits

Model	Searchable Fields
Circuit	cid, circuit_terminations__description, circuit_terminations__pp_info, circuit_terminations__xconnect_id, comments, description, id
Circuit Termination	circuit__cid, description, id, pp_info, xconnect_id
Circuit Type	id, name
Provider	account, admin_contact, comments, id, name, noc_contact
Provider Network	comments, description, id, name

Cloud

Model	Searchable Fields
Cloud Account	account_number, description, id, name, provider__name
Cloud Network	cloud_account__description, cloud_account__name, cloud_resource_type__description, cloud_resource_type__name, description, id, name, parent__description, parent__name
Cloud Network Prefix Assignment	cloud_network__description, cloud_network__name, id
Cloud Resource Type	description, id, name, provider__name
Cloud Service	cloud_account__description, cloud_account__name, cloud_networks__description, cloud_networks__name, cloud_resource_type__description, cloud_resource_type__name, description, id, name
Cloud Service Network Assignment	cloud_network__cloud_account__description, cloud_network__cloud_account__name, cloud_network__cloud_resource_type__description, cloud_network__cloud_resource_type__name, cloud_network__description, cloud_network__name, cloud_service__cloud_account__description, cloud_service__cloud_account__name, cloud_service__cloud_resource_type__description, cloud_service__cloud_resource_type__name, cloud_service__description, cloud_service__name, id

Data Validation Engine

Model	Searchable Fields
Data Compliance	compliance_class_name, content_type__app_label, content_type__model, id, message, object_id
Min Max Validation Rule	content_type__app_label, content_type__model, error_message, field, id, name
Regular Expression Validation Rule	content_type__app_label, content_type__model, error_message, field, id, name, regular_expression
Required Validation Rule	content_type__app_label, content_type__model, error_message, field, id, name
Unique Validation Rule	content_type__app_label, content_type__model, error_message, field, id, name

DCIM

Model	Searchable Fields
Cable	id, label
Cable Type	description, id, manufacturer__name, name, part_number
Console Port	description, id, label, name
Console Port Template	id, name
Console Server Port	description, id, label, name
Console Server Port Template	id, name
Controller	description, id, name
Controller Managed Device Group	id, name
Device	asset_tag, comments, device_type__device_family__name, device_type__manufacturer__name, id, inventory_items__serial, name, serial
Device Bay	description, id, label, name
Device Bay Template	id, name
Device Cluster Assignment	cluster__name, device__asset_tag, device__name, device__serial, id
Device Family	id, name
Device Redundancy Group	comments, id, name
Device Type	comments, device_family__name, id, manufacturer__name, model, part_number
Device Type To Software Image File Mapping	device_type__model, id, software_image_file__image_file_name
Front Port	description, id, label, name
Front Port Template	id, name
Interface	description, id, label, name
Interface Redundancy Group	id, name
Interface Redundancy Group Association	id, interface__name, interface_redundancy_group__name
Interface Template	id, name
Interface Vdc Assignment	id, interface__name, virtual_device_context__name
Inventory Item	asset_tag, description, id, name, part_id, serial
Location	asn, comments, contact_email, contact_name, contact_phone, description, facility, id, name, physical_address, shipping_address
Location Type	id, name
Manufacturer	id, name
Module	asset_tag, id, module_type__manufacturer__name, module_type__model, parent_module_bay__name, parent_module_bay__parent_device__name, parent_module_bay__parent_module__module_type__manufacturer__name, parent_module_bay__position, serial
Module Bay	id, name, parent_device__name, parent_module__module_type__manufacturer__name, parent_module__module_type__model, position
Module Bay Template	device_type__manufacturer__name, device_type__model, id, module_type__manufacturer__name, module_type__model, name, position
Module Family	description, id, module_types__manufacturer__name, module_types__model, name
Module Type	comments, id, manufacturer__name, model, part_number
Platform	id, name
Power Feed	comments, id, name
Power Outlet	description, id, label, name
Power Outlet Template	id, name
Power Panel	id, name
Power Port	description, id, label, name
Power Port Template	id, name
Rack	asset_tag, comments, facility_id, id, name, serial
Rack Group	id, name
Rack Reservation	description, id, rack__facility_id, rack__name, user__username
Rear Port	description, id, label, name
Rear Port Template	id, name
Software Image File	id, image_file_name, software_version__alias, software_version__platform__name, software_version__version
Software Version	alias, id, platform__name, version
Virtual Chassis	domain, id, members__name, name
Virtual Device Context	device__name, id, name, tenant__name

Extras

Model	Searchable Fields
Approval Workflow	id, object_under_review_content_type__app_label, object_under_review_content_type__model
Approval Workflow Definition	id, model_content_type__app_label, model_content_type__model, name
Approval Workflow Stage	approval_workflow__approval_workflow_definition__name, approval_workflow_stage_definition__name, id
Approval Workflow Stage Definition	denial_message, id, min_approvers, name, sequence
Approval Workflow Stage Response	comments, id, state
Computed Field	content_type__app_label, content_type__model, description, fallback_value, grouping, id, label, template
Config Context	data, description, id, name
Config Context Schema	data_schema, description, id, name
Contact	email, id, name, phone
Contact Association	contact__name, id, team__name
Custom Field	description, grouping, id, label
Custom Field Choice	id, value
Custom Link	content_type__app_label, content_type__model, id, name, target_url, text
Dynamic Group	content_type__app_label, content_type__model, description, id, name
Dynamic Group Membership	group__name, id, operator, parent_group__name
Export Template	content_type__app_label, content_type__model, description, id, name, owner_content_type__app_label, owner_content_type__model
External Integration	id, name, remote_url
File Proxy	id, job_result__job_model__name, name
Git Repository	branch, id, name, remote_url
GraphQL Query	id, name, query
Image Attachment	id, name
Job	description, grouping, id, name
Job Button	id, job__name, name, text
Job Hook	id, name
Job Log Entry	grouping, id, log_level, message
Job Queue	description, id, name, queue_type, tenant__name
Job Queue Assignment	id, job__description, job__grouping, job__name, job_queue__description, job_queue__name, job_queue__queue_type
Job Result	id, job_model__name, name, scheduled_job__name, user__username
Metadata Choice	id, value
Metadata Type	description, id, name
Note	assigned_object_id, id, note, user_name
Object Change	id, object_repr, user_name
Object Metadata	_value, contact__name, id, metadata_type__name, team__name
Relationship	description, id, label
Relationship Association	id, relationship__key, relationship__label
Role	content_types__model, id, name
Saved View	id, name, owner__username
Scheduled Job	description, id, name, task
Secret	id, name
Secrets Group	id, name
Secrets Group Association	id, secret__name, secrets_group__name
Static Group Association	associated_object_type__app_label, associated_object_type__model, dynamic_group__description, dynamic_group__name, id
Status	content_types__model, id, name
Tag	content_types__model, id, name
Team	email, id, name, phone
Webhook	additional_headers, body_template, id, name, payload_url

IPAM

Model	Searchable Fields
IP Address Assignment	id, interface__name, vm_interface__name
IP Address Range	description, id, name
Namespace	id, name
Prefix Location Assignment	id, location__name
RIR	id, name
Route Target	description, id, name
Service	description, id, name
VLAN	description, id, name, vid
VLAN Group	id, name
Vlan Location Assignment	id, location__name, vlan__vid
VRF	description, id, name, rd
VRF-device Assignment	device__name, id, name, rd, virtual_device_context__name, virtual_machine__name, vrf__name
VRF-prefix Assignment	id, vrf__name

Load Balancers

Model	Searchable Fields
Certificate Profile	certificate_file_path, certificate_type, chain_file_path, cipher, id, key_file_path, name
Health Check Monitor	health_check_type, id, interval, name, port, retry, timeout
Load Balancer Pool	id, name
Load Balancer Pool Member	id, ip_address__host, label, load_balancer_pool__name, port
Virtual Server	device__name, id, load_balancer_pool__name, name, port

Tenancy

Model	Searchable Fields
Tenant	comments, description, id, name
Tenant Group	id, name

Users

Model	Searchable Fields
Permission	id, name
Token	description, id
User	email, first_name, id, last_name, username

Virtualization

Model	Searchable Fields
Cluster	comments, id, name
Cluster Group	id, name
Cluster Type	id, name
Virtual Machine	comments, id, name
VM Interface	id, name

VPNs

Model	Searchable Fields
VPN	description, id, name, vpn_id
VPN Phase 1 Policy	description, id, name
VPN Phase 2 Policy	description, id, name
VPN Profile	description, id, name
Vpn Profile Phase1 Policy Assignment	id, vpn_phase1_policy__name, vpn_profile__name
Vpn Profile Phase2 Policy Assignment	id, vpn_phase2_policy__name, vpn_profile__name
VPN Termination	id, interface__name, vlan__name, vm_interface__name, vpn__name
VPN Tunnel	description, id, tunnel_id, vpn__name, vpn_profile__name
VPN Tunnel Endpoint	device__name, id, source_fqdn, source_interface__name

Wireless

Model	Searchable Fields
Controller Managed Device Group Radio Profile Assignment	controller_managed_device_group__name, id, radio_profile__name
Controller Managed Device Group Wireless Network Assignment	controller_managed_device_group__name, id, wireless_network__name
Radio Profile	frequency, id, name, regulatory_domain
Supported Data Rate	id, mcs_index, rate, standard
Wireless Network	description, id, name, ssid