Skip to content

Discovery Profile

A Discovery Profile defines the parameters and configuration for device discovery operations within the Nautobot Device Discovery application.

Fields

  • name (string): Unique identifier for the discovery profile.
  • description (string): Description of the discovery profile.
  • included_ip_prefixes (array): List of IP prefixes to include in the discovery scope.
  • excluded_ip_prefixes (array): List of IP prefixes to exclude from the discovery scope.
  • maximum_ip_addresses (integer): Maximum number of IP addresses this profile is allowed to scan.
  • protocols (array): List of protocols to use for device discovery (SSH, SNMP, etc.).
  • ssh_port (integer): SSH port to use for discovery (default: 22).
  • snmp_port (integer): SNMP port to use for discovery (default: 161).
  • snmpv3_auth_protocol (string): SNMPv3 authentication protocol selection.
  • snmpv3_priv_protocol (string): SNMPv3 privacy protocol selection.
  • snmp_timeout (integer): SNMP operation timeout in seconds (default: 5).
  • snmp_retries (integer): Number of SNMP retries (default: 0).
  • fast_path (boolean): Enables Fast Path collection (default: false).
  • strip_domain_suffixes (array): Domain suffixes to strip from hostnames returned by devices (e.g., example.com, corp.local). Matching is case-insensitive and the longest matching suffix wins; the original case of the remaining hostname is preserved. Leave empty to keep hostnames as-is.
  • secrets_groups (many-to-many): Associated Secrets Groups for credential management (via through model with weight ordering).

Strip Domain Suffixes

Devices often report their hostnames as fully qualified domain names (e.g., R01-WAW-RTR.Ntc.com). When importing into Nautobot, the short hostname is usually preferred. Configure Strip Domain Suffixes on the Discovery Profile to remove one or more trailing domain suffixes from hostnames returned by SNMP and SSH collection.

Input format

Comma-separated list of domain suffixes. Spaces around commas are tolerated, and leading/trailing dots in each entry are ignored.

example.com, corp.local, lab.internal

Matching rules

  • Matching is case-insensitive — Ntc.com and NTC.COM both match a configured suffix of ntc.com.
  • The longest matching suffix wins — given suffixes example.com and dc1.example.com, the hostname r1.dc1.example.com is stripped to r1 (not r1.dc1).
  • A leading dot before the suffix is required — mycorp.local will not be stripped by corp.local because there is no dot boundary; r1.corp.local will be stripped to r1.
  • The original case of the remaining hostname is preserved — R01-WAW-RTR.Ntc.com becomes R01-WAW-RTR.
  • A single trailing root dot on the hostname is tolerated — r1.example.com. is treated the same as r1.example.com.

Examples

Suffixes configured: example.com, corp.local

Hostname returned by device Stored hostname
R01-WAW-RTR.Ntc.com R01-WAW-RTR.Ntc.com (no match)
r1.example.com r1
R1.EXAMPLE.COM R1
core1.dc1.example.com core1.dc1
sw1.corp.local. sw1
mycorp.local mycorp.local (no dot boundary, unchanged)
fw1.other.net fw1.other.net (no match, unchanged)