Skip to content

Commit 2cae309

Browse files
added new symlinks for binaries, and changed example-router to use
1 parent c44014c commit 2cae309

2 files changed

Lines changed: 23 additions & 18 deletions

File tree

deploy-rancid.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ install_rancid_from_source() {
545545

546546
# Create symlinks in /usr/bin for PATH compatibility
547547
log "Creating symlinks in /usr/bin..."
548-
local binaries=("rancid" "rancid-run" "clogin")
548+
local binaries=("rancid" "rancid-run" "clogin" "control_rancid" "rancid-fe" "par")
549549
for binary in "${binaries[@]}"; do
550550
if [[ -f "/usr/local/bin/${binary}" ]]; then
551551
if [[ -L "/usr/bin/${binary}" ]] || [[ -f "/usr/bin/${binary}" ]]; then

example-router.db

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
# -----------
2424
# Each non-comment line uses the following format:
2525
#
26-
# <device-name>:<device-type>[:<state>]
26+
# <device-name>;<device-type>;<state>
2727
#
2828
# FIELD DEFINITIONS
2929
# -----------------
@@ -36,9 +36,13 @@
3636
# - Tells RANCID which vendor/collector to use
3737
# - Must match a supported RANCID device type
3838
#
39-
# <state> (optional)
40-
# - "up" (default) → device is collected
41-
# - "down" → device is skipped without error
39+
# <state> (REQUIRED)
40+
# - "up" → device is collected (MUST be specified for active devices)
41+
# - "down" → device is skipped without error
42+
#
43+
# IMPORTANT: The state field is REQUIRED. Devices without "up" state will
44+
# NOT be collected by RANCID. Always specify "up" for
45+
# devices you want to monitor.
4246
#
4347
###############################################################################
4448

@@ -61,42 +65,42 @@
6165
###############################################################################
6266

6367
# Core Juniper switches
64-
# jun-core-01:juniper
65-
# jun-core-02:juniper
68+
# jun-core-01;juniper;up
69+
# jun-core-02;juniper;up
6670

6771
# Core Arista switches
68-
# arista-core-01:arista
69-
# arista-core-02:arista
72+
# arista-core-01;arista;up
73+
# arista-core-02;arista;up
7074

7175
# Core Dell OS10 switch
72-
# dell-core-01:dell
76+
# dell-core-01;dell;up
7377

7478
###############################################################################
7579
# EXAMPLES — DIFFERENT VENDORS IN SAME GROUP
7680
# ------------------------------------------
7781
# Usage-based grouping allows multiple vendors in a single group.
7882
###############################################################################
7983

80-
# mor-sw-01:dell
81-
# mor-sw-02:cisco
84+
# mor-sw-01;dell;up
85+
# mor-sw-02;cisco;up
8286

8387
###############################################################################
8488
# TEMPORARILY DISABLED DEVICES
8589
# ----------------------------
86-
# Use ":down" instead of removing entries.
90+
# Use ";down" instead of removing entries.
8791
# This preserves history and avoids confusion.
8892
###############################################################################
8993

9094
# Device is offline for maintenance
91-
#tor-sw-17:dell:down
95+
#tor-sw-17;dell;down
9296

9397
###############################################################################
9498
# IP ADDRESS EXAMPLE (DISCOURAGED BUT SUPPORTED)
9599
# ----------------------------------------------
96100
# Prefer DNS names. Use IPs only when absolutely required.
97101
###############################################################################
98102

99-
# 10.107.0.22:cisco
103+
# 10.107.0.22;cisco;up
100104

101105
###############################################################################
102106
# COMMENTING & ORGANIZATION
@@ -111,7 +115,7 @@
111115
# WHAT NOT TO DO
112116
# --------------
113117
# ❌ Do NOT include usernames or passwords
114-
# ❌ Do NOT include spaces around the colon separators
118+
# ❌ Do NOT include spaces around the semicolon separators
115119
# ❌ Do NOT mix role naming conventions inconsistently
116120
# ❌ Do NOT delete devices unless permanently decommissioned
117121
###############################################################################
@@ -120,10 +124,11 @@
120124
# CHANGE MANAGEMENT NOTES
121125
# -----------------------
122126
# - Adding a device:
123-
# Add a new line with hostname and device type.
127+
# Add a new line with format: <hostname>;<device-type>;up
128+
# Example: switch-01;cisco;up
124129
#
125130
# - Removing a device:
126-
# Prefer ":down" first, then remove after decommission.
131+
# Prefer ";down" first, then remove after decommission.
127132
#
128133
# - Moving a device between groups:
129134
# Remove from old group router.db

0 commit comments

Comments
 (0)