From 37b9a82de694872fa2efabc83c9e4015c0f86fc9 Mon Sep 17 00:00:00 2001 From: Oliver Gorwits Date: Fri, 3 Apr 2015 19:48:19 +0100 Subject: [PATCH] Update troubleshooting doc to mention four key actions --- Netdisco/Changes | 3 +- .../App/Netdisco/Manual/Troubleshooting.pod | 35 +++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/Netdisco/Changes b/Netdisco/Changes index 82a8b410..0e5c4026 100644 --- a/Netdisco/Changes +++ b/Netdisco/Changes @@ -2,7 +2,8 @@ [ENHANCEMENTS] - * Update development pod to mention cpanm installdeps + * Update development doc to mention cpanm installdeps + * Update troubleshooting doc to mention four key actions 2.032001 - 2015-03-24 diff --git a/Netdisco/lib/App/Netdisco/Manual/Troubleshooting.pod b/Netdisco/lib/App/Netdisco/Manual/Troubleshooting.pod index b1ecf960..b77b18f6 100644 --- a/Netdisco/lib/App/Netdisco/Manual/Troubleshooting.pod +++ b/Netdisco/lib/App/Netdisco/Manual/Troubleshooting.pod @@ -38,6 +38,41 @@ Netdisco. Use the C command to troubleshoot this: ~netdisco/bin/netdisco-do show -d 192.0.2.1 -e c_id +=head1 Understanding Netdisco Jobs + +Please read the section above, if you've not yet done so. + +Netdisco has four principal job types: + +=over 4 + +=item discover + +Gather information about a Device, including interfaces, vlans, PoE status, +and chassis components (modules). Also learns about potential new Devices via +neighbor protocols and adds jobs for their discovery to the queue. + +=item macsuck + +Gather MAC to port mappings from known Devices reporting Layer 2 capability. +Wireless client information is also gathered from Devices supporting the +802.11 MIBs. + +=item arpnip + +Gather MAC to IP mappings from known Devices reporting layer 3 capability. + +=item nbtstat + +Poll a Node to obtain its NetBIOS name. + +=back + +The actions as named above will operate on one device only. Complimentary job +types C, C, C, and C will enqueue one +corresponding single-device job for each known device. The Netdisco backend +daemon will then process the queue (in a random order). + =head1 Run a C Task with Debugging The C command has several debug flags which will show what's