change device_identity to be list of mappings

lib/App/Netdisco/Core/Discover.pm

@@ -58,20 +58,25 @@ sub set_canonical_ip {
       $new_ip = $revofname;
   }
 
-  if (ref {} eq ref setting('device_identity')
+  if (ref [] eq ref setting('device_identity')
-        and scalar keys %{ setting('device_identity') }) {
+        and scalar @{ setting('device_identity') }) {
-      my $idmap  = setting('device_identity');
+
+      my @idmaps = @{ setting('device_identity') };
       my $devips = $device->device_ips->order_by('alias');
 
       ALIAS: while (my $alias = $devips->next) {
           next if $alias->alias eq $old_ip;
 
-          foreach my $key (keys %$idmap) {
+          foreach my $map (@idmaps) {
-              # lhs of device_identity matches device, rhs matches device_ip
+              next unless ref {} eq ref $map;
-              if (check_acl($device, $key)
+
-                    and check_acl($alias, $idmap->{$key})) {
+              foreach my $key (keys %$map) {
-                  $new_ip = $alias->alias;
+                  # lhs matches device, rhs matches device_ip
-                  last ALIAS;
+                  if (check_acl($device, $key)
+                        and check_acl($alias, $map->{$key})) {
+                      $new_ip = $alias->alias;
+                      last ALIAS;
+                  }
               }
           }
       }

lib/App/Netdisco/Manual/Configuration.pod

@@ -38,7 +38,7 @@ e.g.:
  community: ['public', 'another']
  
  discover_no:
-   - '192.0.2.0/24'
+   - 192.0.2.0/24
    - '2001:db8::/32'
 
 =item *
@@ -88,11 +88,11 @@ device DNS name (using a fresh DNS lookup, so works on new discovery), e.g.:
 
 =item *
 
-"C<property:regexp>" - matched against a device property, such as C<model> or
+"C<property:regexp>" to match against a device property, such as C<model> or
 C<vendor> (with enforced begin/end regexp anchors). When matching a device's
-interface (see C<device_identity>), "C<port:regexp>" is also an option.
+interface, "C<port:regexp>" is also an option (see C<device_identity>).
 
- - vendor:cisco
+ - 'vendor:cisco'
 
 =item *
 
@@ -111,7 +111,7 @@ To negate any item in an ACL (except YAML regexp), prefix with "C<!>", for
 example "C<!192.0.2.0/29>". In that case the test will be that the ACL entry
 does I<not> match the device or IP being assessed. Note, however, that the
 first match in an ACL wins (because the default mode is "OR"), so take care
-over the order of items, or include "C<op:and>" in the ACL if appropriate.
+with the order of items or include "C<op:and>" in the ACL if appropriate.
 
 To match any device, use "C<any>". To match no devices use "C<!any>".
 
@@ -607,17 +607,17 @@ for L</"ACCESS CONTROL LISTS">.
 
 =head3 C<device_identity>
 
-Value: Dictionary of Access Control Lists. Default: None.
+Value: List of Access Control List mappings. Default: None.
 
 This setting allows you to control the canonical name or identity of devices
 in Netdisco. For example if Netdisco discovers devices and uses the "wrong"
 interface to identfy them (thereby confusing users) you can correct that here.
 
-The C<device_identity> setting is a dictionary where the key should match a
+The C<device_identity> setting is a list of dictionaries. For each dictionary,
-device as Netdisco knows it, and the value should match one of the device's
+the key is an Access Control List matching a device and the value is another
-interfaces to use as its new canonical identity. Both keys and values are
+Access Control List matching one of the device's interfaces to use as the
-Access Control Lists as described in L</"ACCESS CONTROL LISTS"> (but with
+device canonical identity. The format of Access Control Lists is described in
-additional features, see below).
+L</"ACCESS CONTROL LISTS">.
 
 In general, because the key of a dictionary must be a simple text string, you
 can use hostname, IP prefix, device properties, and group references to match
@@ -631,25 +631,25 @@ placed in a C<host_groups> entry and referenced by name. For example:
      - 'model:.*(?i:DCS7508).*'
  
  device_identity:
-   'group:backbone_devices':
+   - 'group:backbone_devices':
-     - !!perl/regexp ^.*\.backbone\.example\.com$
+       - !!perl/regexp ^.*\.backbone\.example\.com$
-     - '172.16.20.0/24'
+       - '172.16.20.0/24'
-   'vendor:cisco': '192.0.2.0/24'
+   - 'vendor:cisco': '192.0.2.0/24'
 
 During "discover" jobs, Netdisco will find all entries in C<device_identity>
-where the I<key> matches the device. For those entries, the device's interface
+where the I<key> matches the device in some way. For those entries, the
-IPs are put in ascending order, and then tested against the C<device_identity>
+device's interface IPs are put in ascending order, and then tested in turn
-I<value> in turn. If any interface matches, then the device is renumbered to
+against the entry's I<value>. If any interface matches, then the device is
-use that interface as its new identity and the process stops.
+renumbered to use that interface as its new identity and the process stops.
 
 When using an Access Control List for the value (interface selection), as well
 as the options described in L</"ACCESS CONTROL LISTS"> you can use
 "C<port:regexp>" to match an interface's port name. For example to renumber
-all Arista devices to the IP and host name of their Vlan1 interface (if they
+all Arista devices to the IP and host name of their Mgmt1 interface (if they
 have one), you could use:
 
  device_identity:
-   'vendor:arista': 'port:(?i)vlan1'
+   - 'vendor:arista': 'port:(?i)mgmt1'
 
 Once a device is renumbered, its new identity is "sticky". That is, you could
 remove the C<device_identity> configuration and the next "discover" job will

lib/App/Netdisco/Manual/Troubleshooting.pod

@@ -86,6 +86,13 @@ the "SNMP Connect Failures" report under the Admin menu. Any devices listed
 have had multiple SNMP connect failures, indicating a possible configuration
 error on the device or in Netdisco's configuration.
 
+=head1 Devices have the wrong names
+
+Netdisco uses neighbor protocols to discover devices and will use as the
+default identity for a device the interface IP advertised over those neighbor
+protocols. You can use the C<device_identity> configuration setting to steer
+Netdisco towards using a different interface for the canonical device name.
+
 =head1 After OS update or upgrade, Netdisco fails
 
 If you upgrade the operating system then your system libraries will change and

share/config.yml

@@ -118,7 +118,7 @@ login_logo: ""
 # mibhome is discovered from environment
 # mibdirs defaults to contents of mibhome
 host_groups: {}
-device_identity: {}
+device_identity: []
 community: ['public']
 community_rw: ['private']
 snmp_auth: []