|
23 | 23 | # ----------- |
24 | 24 | # Each non-comment line uses the following format: |
25 | 25 | # |
26 | | -# <device-name>:<device-type>[:<state>] |
| 26 | +# <device-name>;<device-type>;<state> |
27 | 27 | # |
28 | 28 | # FIELD DEFINITIONS |
29 | 29 | # ----------------- |
|
36 | 36 | # - Tells RANCID which vendor/collector to use |
37 | 37 | # - Must match a supported RANCID device type |
38 | 38 | # |
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. |
42 | 46 | # |
43 | 47 | ############################################################################### |
44 | 48 |
|
|
61 | 65 | ############################################################################### |
62 | 66 |
|
63 | 67 | # 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 |
66 | 70 |
|
67 | 71 | # 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 |
70 | 74 |
|
71 | 75 | # Core Dell OS10 switch |
72 | | -# dell-core-01:dell |
| 76 | +# dell-core-01;dell;up |
73 | 77 |
|
74 | 78 | ############################################################################### |
75 | 79 | # EXAMPLES — DIFFERENT VENDORS IN SAME GROUP |
76 | 80 | # ------------------------------------------ |
77 | 81 | # Usage-based grouping allows multiple vendors in a single group. |
78 | 82 | ############################################################################### |
79 | 83 |
|
80 | | -# mor-sw-01:dell |
81 | | -# mor-sw-02:cisco |
| 84 | +# mor-sw-01;dell;up |
| 85 | +# mor-sw-02;cisco;up |
82 | 86 |
|
83 | 87 | ############################################################################### |
84 | 88 | # TEMPORARILY DISABLED DEVICES |
85 | 89 | # ---------------------------- |
86 | | -# Use ":down" instead of removing entries. |
| 90 | +# Use ";down" instead of removing entries. |
87 | 91 | # This preserves history and avoids confusion. |
88 | 92 | ############################################################################### |
89 | 93 |
|
90 | 94 | # Device is offline for maintenance |
91 | | -#tor-sw-17:dell:down |
| 95 | +#tor-sw-17;dell;down |
92 | 96 |
|
93 | 97 | ############################################################################### |
94 | 98 | # IP ADDRESS EXAMPLE (DISCOURAGED BUT SUPPORTED) |
95 | 99 | # ---------------------------------------------- |
96 | 100 | # Prefer DNS names. Use IPs only when absolutely required. |
97 | 101 | ############################################################################### |
98 | 102 |
|
99 | | -# 10.107.0.22:cisco |
| 103 | +# 10.107.0.22;cisco;up |
100 | 104 |
|
101 | 105 | ############################################################################### |
102 | 106 | # COMMENTING & ORGANIZATION |
|
111 | 115 | # WHAT NOT TO DO |
112 | 116 | # -------------- |
113 | 117 | # ❌ Do NOT include usernames or passwords |
114 | | -# ❌ Do NOT include spaces around the colon separators |
| 118 | +# ❌ Do NOT include spaces around the semicolon separators |
115 | 119 | # ❌ Do NOT mix role naming conventions inconsistently |
116 | 120 | # ❌ Do NOT delete devices unless permanently decommissioned |
117 | 121 | ############################################################################### |
|
120 | 124 | # CHANGE MANAGEMENT NOTES |
121 | 125 | # ----------------------- |
122 | 126 | # - 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 |
124 | 129 | # |
125 | 130 | # - Removing a device: |
126 | | -# Prefer ":down" first, then remove after decommission. |
| 131 | +# Prefer ";down" first, then remove after decommission. |
127 | 132 | # |
128 | 133 | # - Moving a device between groups: |
129 | 134 | # Remove from old group router.db |
|
0 commit comments