deploy-rancid/example-router.db at main · christopherpaquin/deploy-rancid · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
###############################################################################
# RANCID DEVICE INVENTORY FILE — router.db
#
# PURPOSE
# -------
# This file defines the list of network devices that RANCID will connect to
# for configuration collection within THIS GROUP ONLY.
#
# Each RANCID group (e.g. core-switches, tor-switches, firewalls) has its own
# router.db file.
#
# IMPORTANT RULES
# ---------------
# - One device per line
# - Do NOT store credentials in this file
# - Hostnames must be resolvable via DNS or /etc/hosts
# - This file SHOULD be version controlled (Git)
#
###############################################################################

###############################################################################
# FILE FORMAT
# -----------
# Each non-comment line uses the following format:
#
#   <device-name>;<device-type>;<state>
#
# FIELD DEFINITIONS
# -----------------
# <device-name>
#   - DNS hostname or resolvable alias
#   - SHOULD encode device role and function (preferred)
#   - IP addresses are supported but discouraged
#
# <device-type>
#   - Tells RANCID which vendor/collector to use
#   - Must match a supported RANCID device type
#
# <state> (REQUIRED)
#   - "up"   → device is collected (MUST be specified for active devices)
#   - "down" → device is skipped without error
#
# IMPORTANT: The state field is REQUIRED. Devices without "up" state will
#            NOT be collected by RANCID. Always specify "up" for
#            devices you want to monitor.
#
###############################################################################

###############################################################################
# SUPPORTED DEVICE TYPE EXAMPLES (non-exhaustive)
# -----------------------------------------------
# juniper   → Juniper Junos
# cisco     → Cisco IOS / IOS-XE
# asa       → Cisco ASA / ASAv
# dell      → Dell OS10
# arista    → Arista EOS
# paloalto  → Palo Alto PAN-OS (if supported in your build)
#
###############################################################################

###############################################################################
# EXAMPLES — ACTIVE DEVICES
# -------------------------
# These devices will be contacted during each rancid-run.
###############################################################################

# Core Juniper switches
# jun-core-01;juniper;up
# jun-core-02;juniper;up

# Core Arista switches
# arista-core-01;arista;up
# arista-core-02;arista;up

# Core Dell OS10 switch
# dell-core-01;dell;up

###############################################################################
# EXAMPLES — DIFFERENT VENDORS IN SAME GROUP
# ------------------------------------------
# Usage-based grouping allows multiple vendors in a single group.
###############################################################################

# mor-sw-01;dell;up
# mor-sw-02;cisco;up

###############################################################################
# TEMPORARILY DISABLED DEVICES
# ----------------------------
# Use ";down" instead of removing entries.
# This preserves history and avoids confusion.
###############################################################################

# Device is offline for maintenance
#tor-sw-17;dell;down

###############################################################################
# IP ADDRESS EXAMPLE (DISCOURAGED BUT SUPPORTED)
# ----------------------------------------------
# Prefer DNS names. Use IPs only when absolutely required.
###############################################################################

# 10.107.0.22;cisco;up

###############################################################################
# COMMENTING & ORGANIZATION
# -------------------------
# - Blank lines are ignored
# - Lines beginning with "#" are comments
# - Group related devices together
# - Use comments to explain intent or special cases
###############################################################################

###############################################################################
# WHAT NOT TO DO
# --------------
# ❌ Do NOT include usernames or passwords
# ❌ Do NOT include spaces around the semicolon separators
# ❌ Do NOT mix role naming conventions inconsistently
# ❌ Do NOT delete devices unless permanently decommissioned
###############################################################################

###############################################################################
# CHANGE MANAGEMENT NOTES
# -----------------------
# - Adding a device:
#     Add a new line with format: <hostname>;<device-type>;up
#     Example: switch-01;cisco;up
#
# - Removing a device:
#     Prefer ";down" first, then remove after decommission.
#
# - Moving a device between groups:
#     Remove from old group router.db
#     Add to new group router.db
#     (History remains in the original group repository.)
#
###############################################################################