---
# optional. If set, entries which have not been seen for this period of time
# are removed. Modifiers are h, d, w, m, y (hours, days, weeks, months, years)
ttl: '1d'
# instead of doing all of the snmp walks, if refresh is set, it will only check the
# switch ports to see if they have changed MAC addresses. Once every 'refresh' time
# a full rescan of port names, switch names, and rdns look ups will occur
# using this cuts the time to run by about 1/3
refresh: '12h'
# You must include at least one router.
# this will be queried to resolve IP's to MAC 
# using its arp table
# put IP and community name into the hash
routers:
  'DNS or IP':
    community: 'snmp community name'
# one or more switches and their corresponding
# community name. Use v1 snmp only
switches:
  'DNS or IP':
    community: 'snmp community name'
# the following list can be used to ignore ports on this switch. Note that these are the port numbers
# returned by OID iso.3.6.1.2.1.2.2.1.8
    portsToIgnore:
      - port
      - numbers
      - to
      - ignore
# this is entire optional, but if it exists, it will be used to supplement or override MAC to IP to DNS lookup.
# Each entry is optional
# MAC is the hexidecimal mac address, with no delimiters and all lower case. Example is: 
#    402cf4e9ae9b      CORRECT
#    40:2c:f4:e9:ae:9b CORRECT, colons will be removed
#    402CF4E9AE9B      CORRECT, alphas will be lc'd
#    402-cf4-e9a-e9b   CORRECT, dashes will be removed
# ip:       if this is entered, will be used as IP for the mac address, otherwise it is looked up in the routers arp table.
#           default is to get IP from router's arp table
# hostname: If this is entered, will be used for hostname, otherwise done via reverse DNS entry from router. Default is
#           to look up via rdns
# override: If false, ip/hostname only be used if no value returned from arp/rdns. If true, ip/hostname are not even
#           attempted, ie this will override anything in those services. Default is false, only use if you can not find
#           it.
staticmaps:
  MAC1:
    hostname: some.host.name
    ip: 1.1.1.1
    override: 0
  MAC2:
    hostname: 'some other host name'
    ip: 1.1.1.2
    override: 1

# Optional files to be processed for items which were not in the router
# these are assumed to be tab delimited files which contain the column
# headers hostname, mac and ip, with values below
# this can be done via staticmaps (above), but is set up as an alternative
# here for very large files, say from database dumps
nonrouter:
  - filename
  - filename