Manual de Usuario de PNMDiag
Manual de usuario de PNMDiag
Va a acceder a Información Confidencial propiedad de Panda Software. La citada información es para uso exclusivo de empresas pertenecientes al Grupo Panda Software. No puede distribuir, ceder, reproducir o en cualquier modo transferir la citada información salvo que medie previa autorización escrita de Panda Software. Los nombres de productos que aparecen en este manual / documento pueden ser marcas registradas de sus respectivas compañías. © Panda Software, 2007 Cualquier reproducción total o parcial del presente documento está expresamente prohibida, salvo que medie previa autorización escrita de Panda Software.
Confidencial
© Panda Software 2006
Página 1 de 11
Manual de Usuario de PNMDiag
Tabla de contenidos 1.
INTRODUCCIÓN....................................................................................................................... 3
2.
INSTALACIÓN........................................................................................................................... 3
3.
FUNCIONAMIENTO................................................................................................................. 4 3.1 REQUISITOS ........................................................................................................................... 4 3.2 DESCRIPCIÓN GENERAL ......................................................................................................... 5 3.3 PARÁMETROS ......................................................................................................................... 7 3.3.1 Help ............................................................................................................................... 7 3.3.2 Session ........................................................................................................................... 7 3.3.3 Start ............................................................................................................................... 9 3.3.4 Stop................................................................................................................................ 9 3.3.5 Reports......................................................................................................................... 10 3.3.6 Snap ............................................................................................................................. 11
Tabla de figuras Figura 1.- Carpetas de resultados ........................................................................................................... 6 Figura 2.- Comienzo de una sesión de capturas..................................................................................... 8 Figura 3.- Sesión de capturas completa.................................................................................................. 8 Figura 4.- Ejecución de PNMDiag con opción ‘/start’ .............................................................................. 9 Figura 5.- Ejecución de PNMDiag con opción ‘/stop’ .............................................................................. 9 Figura 6.- Arranque de captura de reportes .......................................................................................... 10 Figura 7.- Ejecución completa con opción ‘/reports’.............................................................................. 10 Figura 8.- Ejecución de PNMDiag con opción ‘/snap’ ........................................................................... 11
Confidencial
© Panda Software 2006
Página 2 de 11
Manual de Usuario de PNMDiag
1.
Introducción
El presente documento es un manual de usuario de la herramienta de diagnóstico de Panda Network Manager llamada PNMDiag. Esta herramienta tiene como funcionalidad principal la recogida de datos de diagnóstico de incidencias (capturas, logs, snapshot, etc…) en el cliente. Se trata de una herramienta en línea de comandos que activa las funcionalidades de traceo y log incluidas en la versión 3 de la tecnología PNM. Asimismo, admite una serie de parámetros para ajustar la recogida de datos a las necesidades de diagnóstico, pudiendo activar todas las funciones de diagnóstico o sólo un grupo concreto de ellas.
2.
Instalación
La herramienta consta de un ejecutable llamado PNMDiag.exe que no requiere ningún tipo de instalación y que funciona en línea de comandos. Debido a que la herramienta crea subdirectorios donde reúne la información generada durante su ejecución, no es imprescindible, pero es recomendable, crear un directorio propio para la herramienta y ejecutarla dentro de ese directorio; de este modo, toda la información podrá ser fácilmente localizada.
Confidencial
© Panda Software 2006
Página 3 de 11
Manual de Usuario de PNMDiag
3.
Funcionamiento
3.1 Requisitos
PNMDiag funciona en sistemas operativos Windows Vista 32 bits/XP/2000 Professional y sus requisitos hardware son mínimos. De todos modos es importante señalar que, debido a que la herramienta crea claves de registro en HKEY_LOCAL_MACHINE para activar las capturas PCAP, debe ejecutarse con permisos de administrador en la máquina. De no ser así, las capturas PCAP no podrán ser activadas correctamente. En el caso particular de Windows Vista (32 bits), además de iniciar sesión como administrador, es necesario asignar permisos de administración antes de acceder a la pantalla de Sólo símbolo del sistema (CMD) para poder activar las capturas PCAP. Para ello, se accede a Inicio, Todos los programas, Accesorios, pulsar con el botón derecho sobre la opción Sólo símbolo del sistema y seleccionar Ejecutar como administrador.
Confidencial
© Panda Software 2006
Página 4 de 11
Manual de Usuario de PNMDiag
3.2 Descripción general
La herramienta se debe ejecutar en línea de comandos y según los parámetros que se ejecuten se realizarán unas acciones u otras. El idioma de utilización de la herramienta es inglés. PNMDiag.exe carga el API de PNM (PNMApi.dll) para activar las funciones necesarias. La librería PNMApi.dll se localiza mediante la entrada de registro que instala la tecnología y que contiene el path de instalación de PNM. Una vez cargado el API de PNM, se interpretan las opciones ejecutadas. Si se encuentran errores, la herramienta indicará el error y mostrará un mensaje de ayuda con los parámetros de uso. La idea principal de uso de PNMDiag, es la de activar las funciones de diagnóstico, reproducir la incidencia y posteriormente desactivarlos. Así, sólo se capturará la información imprescindible y se evitará “ruido” en las capturas. Si la opción es correcta, se procederá a activar las funcionalidades de traceo, capturas, logs, etc… indicadas. Los mecanismos de diagnóstico que se pueden activar son los siguientes: 9 Capturas PCAP: PNM es capaz de capturar paquetes como si de un sniffer se tratase. PNMDiag activa esta funcionalidad de PNM indicándole que vuelque todos los paquetes a un fichero de manera que ese tráfico se pueda utilizar en el análisis de la incidencia. Puede ser útil ante incidencias relacionadas con los drivers de la capa NDIS. 9 Capturas ATDI: Es la funcionalidad de PNM por la cual es posible capturar eventos en la capa TDI. Los datos podrán ser de utilidad ante incidencias que impliquen a los driver TDI. 9 Logs: Poco a poco todos los módulos de PNM incorporan trazas que pueden ayudar a encontrar problemas y fallas en su funcionamiento. PNMDiag hace uso de esta capacidad activando las trazas de todos los módulos que las tienen. 9 Reportes: Otra característica que puede ser de utilidad en el diagnóstico de incidencias es la capacidad de generar reportes. PNMDiag puede registrar un callback de reportes contra PNM e ir volcando a disco todos los que reciba. Esta característica requiere que PNMDiag se mantenga ejecutándose durante todo el tiempo que se desee capturar reportes. 9 Snapshot de configuración: Esta característica de PNM consiste en la creación de un fichero donde se vuelca la configuración más importante que tiene PNM en el momento actual. Dicho fichero se puede utilizar como una fotografía de PNM en un momento dado y es útil para diagnosticar incidencias provocadas por configuraciones incorrectas: reglas, adaptadores, etc...
Para facilitar el uso de la herramienta se han agrupado las funcionalidades mencionadas anteriormente, de manera que es posible capturar toda la información necesaria especificando un sólo parámetro. También es posible activar ciertas
Confidencial
© Panda Software 2006
Página 5 de 11
Manual de Usuario de PNMDiag funcionalidades de manera independiente mediante opciones concretas; esto puede ser útil para una recogida de datos más selectiva. En general, cuando una sesión de recogida de información ha concluido, PNMDiag recolecta todos los ficheros de información generados y los guarda en una subcarpeta del directorio de la herramienta. La carpeta donde se guarda todos los ficheros, se nombra según el patrón: PNMDiagSession_. En la siguiente figura se puede ver un ejemplo:
Figura 1.- Carpetas de resultados La herramienta PNMDiag también genera un fichero de log con las operaciones que ha realizado, este log (llamado pnmdiag.log) se podrá utilizar para diagnosticar fallos de funcionamiento en el propio PNMDiag.
Confidencial
© Panda Software 2006
Página 6 de 11
Manual de Usuario de PNMDiag
3.3 Parámetros
A continuación se explica cada una de las opciones que admite la herramienta.
3.3.1 Help Uso: C:\PNMDIAG> PNMDiag /help Descripción: Muestra el siguiente texto de ayuda.
3.3.2 Session Uso: C:\PNMDIAG> PNMDiag /session Descripción: Mediante esta opción, se ejecuta una sesión completa de captura de datos. Esta opción está pensada para que la herramienta se encuentre activa durante el intervalo de tiempo en el que se reproduce la incidencia, una vez reproducida se podrá, pulsando una tecla, finalizar todas las capturas y reunir todos los ficheros de log generados en la subcarpeta correspondiente.
Confidencial
© Panda Software 2006
Página 7 de 11
Manual de Usuario de PNMDiag Con esta opción, la herramienta inicializa la comunicación con PNMAPI, captura un snapshot de configuración y activa todos los mecanismos de diagnóstico disponibles: PCAP, logs, ATDI y reportes.
Figura 2.- Comienzo de una sesión de capturas
La herramienta se queda residente esperando a que la incidencia sea reproducida. En ese intervalo de tiempo se está capturando toda la información posible. Una vez que la incidencia se reproduce, el usuario podrá detener (mediante la pulsación de la tecla “Enter”) todos los mecanismos de diagnóstico con el fin de generar únicamente la información imprescindible para el análisis del problema.
Figura 3.- Sesión de capturas completa
Confidencial
© Panda Software 2006
Página 8 de 11
Manual de Usuario de PNMDiag Para facilitar la localización de la información generada, al terminar la sesión, PNMDiag recopilará todos los ficheros generados en un subdirectorio llamado PNMDiagSession_.
3.3.3 Start Uso: C:\PNMDIAG> PNMDiag /start Descripción: Arranca las capturas PCAP, ATDI y logs. Mediante esta opción lo que se busca es arrancar los mecanismos de diagnóstico de funcionamiento autónomo que no requieren que PNMDiag se quede en ejecución. Así, PNMDiag activará de manera persistente estas funcionalidades y terminará su ejecución.
Figura 4.- Ejecución de PNMDiag con opción ‘/start’
La máquina podrá ser reiniciada si así se necesita. Para desactivar estos mecanismos (PCAP, ATDI y logs) bastará realizar otra llamada a PNMDiag con la opción “/stop”.
3.3.4 Stop Uso: C:\PNMDIAG> PNMDiag /stop Descripción: Detiene los mecanismos de captura PCAP, ATDI y logs. Realiza la acción opuesta a la opción “/start”. Adicionalmente a la parada de estas capturas, se intentan reunir los ficheros generados en la correspondiente subcarpeta PNMDiagSession_ para facilitar su localización.
Figura 5.- Ejecución de PNMDiag con opción ‘/stop’
Confidencial
© Panda Software 2006
Página 9 de 11
Manual de Usuario de PNMDiag
3.3.5 Reports Uso: C:\PNMDIAG> PNMDiag /reports Descripción: Activa el dispositivo de captura de reportes de PNM, de este modo, cada reporte generado por PNM será capturado por PNMDiag y volcado a un fichero nombrado según el patrón: PNMDiagReports_. Al utilizar esta opción, PNMDiag registrará un callback contra PNM y se quedará esperando por reportes.
Figura 6.- Arranque de captura de reportes La idea es que se intente reproducir la incidencia durante este intervalo de tiempo, y que una vez reproducida se pulse la tecla de finalización para detener la captura de reportes. El fichero generado con los reportes será movido a una subcarpeta PNMDiagSession_ para facilitar su localización.
Figura 7.- Ejecución completa con opción ‘/reports’
Confidencial
© Panda Software 2006
Página 10 de 11
Manual de Usuario de PNMDiag
3.3.6 Snap Uso: C:\PNMDIAG> PNMDiag /snap Descripción: Con esta opción se provoca la captura de un snapshot de configuración de PNM. El snapshot será generado en un fichero nombrado según el patrón PNMDiagShot_ que, una vez generado, será movido a la correspondiente carpeta PNMDiagSession_ para facilitar su localización.
Figura 8.- Ejecución de PNMDiag con opción ‘/snap’
Confidencial
© Panda Software 2006
Página 11 de 11
