lldpd: note about capabilities
[openwrt/openwrt.git] / package / network / services / lldpd / files / lldpd.init
1 #!/bin/sh /etc/rc.common
2 # Copyright (C) 2008-2015 OpenWrt.org
3 # shellcheck disable=1091,2034,3037,3043,3045
4
5 START=90
6 STOP=01
7
8 CONFIG_LLDPD_WITH_CDP=y
9 CONFIG_LLDPD_WITH_EDP=y
10 CONFIG_LLDPD_WITH_FDP=y
11 CONFIG_LLDPD_WITH_LLDPMED=y
12 CONFIG_LLDPD_WITH_SNMP=y
13 CONFIG_LLDPD_WITH_SONMP=y
14
15 USE_PROCD=1
16 LLDPDBIN=/usr/sbin/lldpd
17 LLDPCLI=/usr/sbin/lldpcli
18 LLDPSOCKET=/var/run/lldpd.socket
19 LLDPD_CONF=/tmp/lldpd.conf
20 LLDPD_CONFS_DIR=/tmp/lldpd.d
21
22 LLDPD_RUN=/var/run/lldpd
23 LLDPD_RESTART_HASH=${LLDPD_RUN}/lldpd.restart_hash
24
25 . "$IPKG_INSTROOT/lib/functions/network.sh"
26
27 find_release_info()
28 {
29 [ -s /etc/os-release ] && . /etc/os-release
30 [ -z "$PRETTY_NAME" ] && [ -s /etc/openwrt_version ] && \
31 PRETTY_NAME="$(cat /etc/openwrt_version)"
32
33 echo "${PRETTY_NAME:-Unknown OpenWrt release} @ $(cat /proc/sys/kernel/hostname)"
34 }
35
36 get_config_restart_hash() {
37 local var="$1"
38 local _string _hash v
39
40 config_load 'lldpd'
41
42 config_get v 'config' 'lldp_class'; append _string "$v" ","
43 if [ "$CONFIG_LLDPD_WITH_SNMP" = "y" ]; then
44 config_get v 'config' 'agentxsocket'; append _string "$v" ","
45 fi
46 config_get v 'config' 'cid_interface'; append _string "$v" ","
47 config_get v 'config' 'filter'; append _string "$v" ","
48 config_get_bool v 'config' 'readonly_mode'; append _string "$v" ","
49 config_get_bool v 'config' 'lldp_no_version'; append _string "$v" ","
50 if [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ]; then
51 config_get_bool v 'config' 'lldpmed_no_inventory'; append _string "$v" ","
52 fi
53 config_get_bool v 'config' 'enable_lldp' 1; append _string "$v" ","
54 config_get_bool v 'config' 'force_lldp'; append _string "$v" ","
55 if [ "$CONFIG_LLDPD_WITH_CDP" = "y" ]; then
56 config_get_bool v 'config' 'enable_cdp'; append _string "$v" ","
57 config_get v 'config' 'cdp_version'; append _string "$v" ","
58 config_get_bool v 'config' 'force_cdp'; append _string "$v" ","
59 config_get_bool v 'config' 'force_cdpv2'; append _string "$v" ","
60 fi
61 if [ "$CONFIG_LLDPD_WITH_EDP" = "y" ]; then
62 config_get_bool v 'config' 'enable_edp'; append _string "$v" ","
63 config_get_bool v 'config' 'force_edp'; append _string "$v" ","
64 fi
65 if [ "$CONFIG_LLDPD_WITH_FDP" = "y" ]; then
66 config_get_bool v 'config' 'enable_fdp'; append _string "$v" ","
67 config_get_bool v 'config' 'force_fdp'; append _string "$v" ","
68 fi
69 if [ "$CONFIG_LLDPD_WITH_SONMP" = "y" ]; then
70 config_get_bool v 'config' 'enable_sonmp'; append _string "$v" ","
71 config_get_bool v 'config' 'force_sonmp'; append _string "$v" ","
72 fi
73
74 _hash=$(echo -n "${_string}" | md5sum | awk '{ print $1 }')
75 export -n "$var=$_hash"
76 }
77
78 get_config_cid_ifaces() {
79 local _ifaces
80 config_get _ifaces 'config' "$2"
81
82 local _iface _ifnames=""
83 for _iface in $_ifaces; do
84 local _ifname=""
85 if network_get_device _ifname "$_iface" || [ -e "/sys/class/net/$_iface" ]; then
86 append _ifnames "${_ifname:-$_iface}" ","
87 fi
88 done
89
90 export -n "${1}=$_ifnames"
91 }
92
93 write_lldpd_conf()
94 {
95 local lldp_description
96
97 config_load 'lldpd'
98 config_get lldp_description 'config' 'lldp_description' "$(find_release_info)"
99
100 local lldp_hostname
101 config_get lldp_hostname 'config' 'lldp_hostname' "$(cat /proc/sys/kernel/hostname)"
102
103 local ifnames
104 get_config_cid_ifaces ifnames "interface"
105
106 local lldp_mgmt_ip
107 config_get lldp_mgmt_ip 'config' 'lldp_mgmt_ip'
108
109 # Configurable capabilities in lldpd >= v1.0.15
110 local lldp_syscapabilities
111 config_get lldp_syscapabilities 'config' 'lldp_syscapabilities'
112
113 if [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ]; then
114 local lldpmed_fast_start
115 config_get_bool lldpmed_fast_start 'config' 'lldpmed_fast_start' 0
116
117 local lldpmed_fast_start_tx_interval
118 config_get lldpmed_fast_start_tx_interval 'config' 'lldpmed_fast_start_tx_interval' 0
119
120 local lldp_location
121 config_get lldp_location 'config' 'lldp_location'
122
123 local lldp_class
124 config_get lldp_class 'config' 'lldp_class'
125
126 local lldp_policy
127 config_get lldp_policy 'config' 'lldp_policy'
128
129 fi
130
131 local lldp_agenttype
132 config_get lldp_agenttype 'config' 'lldp_agenttype' 'nearest-bridge'
133
134 local lldp_portidsubtype
135 config_get lldp_portidsubtype 'config' 'lldp_portidsubtype' 'macaddress'
136
137 local lldp_platform
138 config_get lldp_platform 'config' 'lldp_platform' ""
139
140 local lldp_tx_interval
141 config_get lldp_tx_interval 'config' 'lldp_tx_interval' 0
142
143 local lldp_tx_hold
144 config_get lldp_tx_hold 'config' 'lldp_tx_hold' 0
145
146 # Clear out the config file first
147 echo -n > "$LLDPD_CONF"
148 [ -n "$ifnames" ] && echo "configure system interface pattern $ifnames" >> "$LLDPD_CONF"
149 [ -n "$lldp_description" ] && echo "configure system description" "\"$lldp_description\"" >> "$LLDPD_CONF"
150 [ -n "$lldp_hostname" ] && echo "configure system hostname" "\"$lldp_hostname\"" >> "$LLDPD_CONF"
151 [ -n "$lldp_mgmt_ip" ] && echo "configure system ip management pattern" "\"$lldp_mgmt_ip\"" >> "$LLDPD_CONF"
152 [ -n "$lldp_syscapabilities" ] && echo "configure system capabilities enabled $lldp_syscapabilities" >> "$LLDPD_CONF"
153 if [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ] && [ "$lldpmed_fast_start" -gt 0 ]; then
154 if [ "$lldpmed_fast_start_tx_interval" -gt 0 ]; then
155 echo "configure med fast-start tx-interval $lldpmed_fast_start_tx_interval" >> "$LLDPD_CONF"
156 else
157 echo "configure med fast-start enable" >> "$LLDPD_CONF"
158 fi
159 fi
160 if [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ]; then
161 # other 'configure med xxx' statements go here
162
163 [ -n "$lldp_location" ] && echo "configure med location" "$lldp_location" >> "$LLDPD_CONF"
164
165 # Manual states that if Class (-M) is 2 or 3, at least one network policy must be defined
166 case "$lldp_class" in
167 2 | 3 ) [ -n "$lldp_policy" ] && echo "configure med policy $lldp_policy" >> "$LLDPD_CONF"
168 ;;
169 esac
170
171 fi
172
173 [ -n "$lldp_agenttype" ] && echo "configure lldp agent-type" "\"$lldp_agenttype\"" >> "$LLDPD_CONF"
174 [ -n "$lldp_portidsubtype" ] && echo "configure lldp portidsubtype" "\"$lldp_portidsubtype\"" >> "$LLDPD_CONF"
175 [ -n "$lldp_platform" ] && echo "configure system platform" "\"$lldp_platform\"" >> "$LLDPD_CONF"
176 [ -n "$lldp_tx_interval" ] && echo "configure lldp tx-interval $lldp_tx_interval" >> "$LLDPD_CONF"
177 [ "$lldp_tx_hold" -gt 0 ] && echo "configure lldp tx-hold $lldp_tx_hold" >> "$LLDPD_CONF"
178
179 # Since lldpd's sysconfdir is /tmp, we'll symlink /etc/lldpd.d to /tmp/$LLDPD_CONFS_DIR
180 [ -e "$LLDPD_CONFS_DIR" ] || ln -s /etc/lldpd.d "$LLDPD_CONFS_DIR"
181 }
182
183 start_service() {
184
185 local enable_lldp
186 local force_lldp
187 local enable_cdp
188 local cdp_version
189 local force_cdp
190 local force_cdpv2
191 local enable_fdp
192 local force_fdp
193 local enable_sonmp
194 local force_sonmp
195 local enable_edp
196 local force_edp
197 local lldp_class
198 local lldp_no_version
199 local lldpmed_no_inventory
200 local readonly_mode
201 local agentxsocket
202 local filter
203
204 config_load 'lldpd'
205 config_get_bool enable_lldp 'config' 'enable_lldp' 1
206 config_get_bool force_lldp 'config' 'force_lldp' 0
207 if [ "$CONFIG_LLDPD_WITH_CDP" = "y" ]; then
208 config_get_bool enable_cdp 'config' 'enable_cdp' 0
209 config_get cdp_version 'config' 'cdp_version' 'cdpv1v2'
210 config_get_bool force_cdp 'config' 'force_cdp' 0
211 config_get_bool force_cdpv2 'config' 'force_cdpv2' 0
212 fi
213 if [ "$CONFIG_LLDPD_WITH_FDP" = "y" ]; then
214 config_get_bool enable_fdp 'config' 'enable_fdp' 0
215 config_get_bool force_fdp 'config' 'force_fdp' 0
216 fi
217 if [ "$CONFIG_LLDPD_WITH_SONMP" = "y" ]; then
218 config_get_bool enable_sonmp 'config' 'enable_sonmp' 0
219 config_get_bool force_sonmp 'config' 'force_sonmp' 0
220 fi
221 if [ "$CONFIG_LLDPD_WITH_EDP" = "y" ]; then
222 config_get_bool enable_edp 'config' 'enable_edp' 0
223 config_get_bool force_edp 'config' 'force_edp' 0
224 fi
225 config_get lldp_class 'config' 'lldp_class'
226 config_get_bool lldp_no_version 'config' 'lldp_no_version' 0
227 if [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ]; then
228 config_get_bool lldpmed_no_inventory 'config' 'lldpmed_no_inventory' 0
229 fi
230 config_get_bool readonly_mode 'config' 'readonly_mode' 0
231 if [ "$CONFIG_LLDPD_WITH_SNMP" = "y" ]; then
232 config_get agentxsocket 'config' 'agentxsocket'
233 fi
234 config_get filter 'config' 'filter' 15
235
236 mkdir -p ${LLDPD_RUN}
237 chown lldp:lldp ${LLDPD_RUN}
238
239 # When lldpd starts, it also loads up what we write in this config file
240 write_lldpd_conf
241
242 procd_open_instance
243 procd_set_param command ${LLDPDBIN}
244 procd_append_param command -d
245
246 if [ "$enable_lldp" -gt 0 ]; then
247 if [ "$force_lldp" -gt 0 ]; then
248 procd_append_param command '-l'
249 fi
250 else
251 # Disable LLDP
252 procd_append_param command '-ll'
253 fi
254
255 if [ "$CONFIG_LLDPD_WITH_CDP" = "y" ] && [ "$enable_cdp" -gt 0 ]; then
256 if [ "$cdp_version" = "cdpv2" ]; then
257 if [ "$force_cdp" -gt 0 ]; then
258 # CDPv1 disabled, CDPv2 forced
259 procd_append_param command '-ccccc'
260 else
261 # CDPv1 disabled, CDPv2 enabled
262 procd_append_param command '-cccc'
263 fi
264 elif [ "$cdp_version" = "cdpv1v2" ]; then
265 if [ "$force_cdp" -gt 0 ] && [ "$force_cdpv2" -gt 0 ]; then
266 # CDPv1 enabled, CDPv2 forced
267 procd_append_param command '-ccc'
268 elif [ "$force_cdp" -gt 0 ]; then
269 # CDPv1 forced, CDPv2 enabled
270 procd_append_param command '-cc'
271 else
272 # CDPv1 and CDPv2 enabled
273 procd_append_param command '-c'
274 fi
275 fi
276 fi
277
278 if [ "$CONFIG_LLDPD_WITH_FDP" = "y" ] && [ "$enable_fdp" -gt 0 ]; then
279 if [ "$force_fdp" -gt 0 ]; then
280 # FDP enabled and forced
281 procd_append_param command '-ff'
282 else
283 # FDP enabled
284 procd_append_param command '-f'
285 fi
286 fi
287
288 if [ "$CONFIG_LLDPD_WITH_SONMP" = "y" ] && [ "$enable_sonmp" -gt 0 ]; then
289 if [ "$force_sonmp" -gt 0 ]; then
290 # SONMP enabled and forced
291 procd_append_param command '-ss'
292 else
293 # SONMP enabled
294 procd_append_param command '-s'
295 fi
296 fi
297
298 if [ "$CONFIG_LLDPD_WITH_EDP" = "y" ] && [ "$enable_edp" -gt 0 ]; then
299 if [ "$force_edp" -gt 0 ]; then
300 # EDP enabled and forced
301 procd_append_param command '-ee'
302 else
303 # EDP enabled
304 procd_append_param command '-e'
305 fi
306 fi
307
308 [ "$readonly_mode" -gt 0 ] && procd_append_param command '-r'
309 [ "$lldp_no_version" -gt 0 ] && procd_append_param command '-k'
310 [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ] && [ "$lldpmed_no_inventory" -gt 0 ] && procd_append_param command '-i'
311 [ -n "$lldp_class" ] && procd_append_param command -M "$lldp_class"
312 [ "$CONFIG_LLDPD_WITH_SNMP" = "y" ] && [ -n "$agentxsocket" ] && procd_append_param command -x -X "$agentxsocket"
313 [ -n "$filter" ] && procd_append_param command -H "$filter"
314
315 # ChassisID interfaces
316 local ifnames
317 get_config_cid_ifaces ifnames "cid_interface"
318
319 [ -n "$ifnames" ] && procd_append_param command -C "$ifnames"
320
321 # Overwrite default configuration locations processed by lldpcli at start
322 procd_append_param command -O "$LLDPD_CONF"
323
324 local restart_hash
325 get_config_restart_hash restart_hash
326 echo -n "$restart_hash" > "$LLDPD_RESTART_HASH"
327
328 # set auto respawn behavior
329 procd_set_param respawn
330 procd_close_instance
331 }
332
333 service_triggers() {
334 procd_add_config_trigger "config.change" "lldpd" /etc/init.d/lldpd reload
335 }
336
337 reload_service() {
338 running || return 1
339
340 local running_hash=""
341 local config_hash=""
342
343 get_config_restart_hash config_hash
344 [ -f ${LLDPD_RESTART_HASH} ] && running_hash=$(cat "$LLDPD_RESTART_HASH")
345
346 if [ "x$running_hash" != "x$config_hash" ]; then
347 # Restart LLDPd
348 # Some parameters can't be configured at runtime
349 restart
350 return 0
351 fi
352
353 $LLDPCLI -u "$LLDPSOCKET" >/dev/null 2>&1 <<-EOF
354 pause
355 unconfigure lldp custom-tlv
356 unconfigure system interface pattern
357 unconfigure system description
358 unconfigure system hostname
359 unconfigure system ip management pattern
360 unconfigure system platform
361 EOF
362 if [ "$CONFIG_LLDPD_WITH_LLDPMED" = "y" ]; then
363 $LLDPCLI -u "$LLDPSOCKET" >/dev/null 2>&1 <<-EOF
364 unconfigure med fast-start
365 EOF
366
367 fi
368 # Rewrite lldpd.conf
369 # If something changed it should be included by the lldpcli call
370 write_lldpd_conf
371 $LLDPCLI -u "$LLDPSOCKET" -c "$LLDPD_CONF" -c "$LLDPD_CONFS_DIR" >/dev/null 2>&1
372 # Broadcast update over the wire
373 $LLDPCLI -u "$LLDPSOCKET" >/dev/null 2>&1 <<-EOF
374 resume
375 update
376 EOF
377 return 0
378 }
379
380 stop_service() {
381 rm -rf ${LLDPD_RUN} "$LLDPSOCKET" >/dev/null 2>&1
382 }
383