Tutorial para la creación de Bots de NTRadmin

Transcripción

1 Tutorial para la creación de Bots de NTRadmin NTRglobal Torres Diagonal Litoral Josep Pla, 2 Edificio B3, 1ª Planta Barcelona (Spain) Tel Fax Offices in Barcelona - Boston - Dallas - Heidelberg - London - Madrid Milan - Paris - Poznan - Santiago de Chile - Stockholm - Tokyo

2 Índice de contenidos Introducción... 3 Creación de Bots... 3 Lanzar Bots... 5 Control de Resultados... 6 Uso de parámetros en Bots... 9 Consejos útiles...10 Control de Errores...11 Depurar Bots (debugging)...12 Ejecución de archivos wscript.exe y cscript.exe...13 Envío de mensajes...17 Marzo 2007 Pág 2 de 17

3 Introducción Este documento es una introducción a la programación de Bots que pueden ser lanzados en ordenadores remotos mediante la aplicación NTRadmin. El tutorial incluye también una introducción a las técnicas de control de resultado y control de errores que permiten el tratamiento de los resultados obtenidos en el Informe de Bots. El servicio NTRadmin dispone de un motor propio de creación de Bots que permite ejecutar código VBScript y Javascript. La lectura de este documento permite además adquirir los conocimientos necesarios para lanzar Bots en WSH (Windows Scripting Host) en máquinas remotas utilizando los motores de scripting wscript.exe o cscript.exe. Creación de Bots Para crear un nuevo Bot debe desplegar los elementos del árbol Avanzado dentro del menú Trabajos. Haciendo clic en la opción Mis Bots se despliega una lista de los Bots ya creados. Inicialmente esta lista se mostrará vacía hasta que Vd. empiece a crear sus propios Bots. Para crear un Bot haga clic en la opción Nuevo Bot que aparece en el menú de Herramientas, a la derecha de Listado de Bots. Aparecerá un formulario en el que debe introducir el nombre del Bot, la descripción, comentarios y el código del Bot. su funcionamiento. Los campos obligatorios son Nombre del Bot y Bot, sin embargo, a la hora de lanzar Bots será de gran ayuda encontrar la descripción de lo que hace cada uno, y comentarios sobre Bot Hola Mundo Empezaremos con un Bot muy básico que permite mostrar el mensaje Hola Mundo!!!. Utilizaremos la función MsgBox propia del lenguaje VBScript que permite lanzar mensajes de alerta sobre un ordenador. El código es el siguiente: MsgBox Hola Mundo!!! Código 1 Complete el formulario como se indica a continuación: Figura 3. Descripción del Bot Marzo 2007 Pág 3 de 17

4 Haga clic en Aceptar y el nuevo Bot aparecerá en el Listado de Bots. Figura 4. Listado de Bots Al seleccionar un Bot en el listado, el campo Detalles muestra la información referente al Bot y el código del Bot introducido. Una vez creado el Bot, veremos cómo lanzarlo. Marzo 2007 Pág 4 de 17

5 Lanzar Bots Desplegando el árbol de equipos que aparece en el menú de la izquierda, puede seleccionar el ordenador u ordenadores sobre los que desea lanzar el Bot. En este primer ejemplo, para observar mejor el funcionamiento del Bot, seleccionamos sólo un ordenador remoto. Posteriormente se mostrará el lanzamiento simultáneo sobre varios ordenadores. Una vez seleccionado el equipo o equipos deseados, haga clic en la opción Lanzar Bots, en el menú de Herramientas. Se mostrará el listado de los Bots disponibles para ser lanzados: Seleccione el Bot Hola Mundo!!! y haga clic en Aceptar. En la siguiente pantalla se muestran los parámetros necesarios para lanzar el Bot seleccionado. En este caso no hay ningún parámetro, por lo que basta con hacer clic sobre el botón Lanzar Bot. Más adelante se explica el uso de parámetros en los Bots. Tras lanzar el Bot, se mostrará el mensaje Hola mundo!!! en todos los ordenadores remotos sobre los que ha sido lanzado. Figura 9. El mensaje se muestra en todos los ordenadores en los que se ha lanzado el Bot. Marzo 2007 Pág 5 de 17

6 Control de Resultados Tras lanzar el Bot Hola Mundo!!!, la única forma posible de saber si ha funcionado correctamente en cada ordenador es acceder físicamente a cada una de las máquinas remotas (o bien efectuar un control remoto de cada una). Por ello, es interesante tener un control de los Bots lanzados en las máquinas remotas, y a continuación se muestra cómo hacerlo. NTRadmin proporciona dos variables globales pre-declaradas: RESULTID y RESULT. Es decir, pueden ser utilizadas en el código de sus Bots sin tener que declararlas mediante la instrucción Dim. El código del Bot sería el siguiente: MsgBox "Hola Mundo!!!" RESULTID = 10 RESULT = "Bot lanzado correctamente" Código 2 Copie el código anterior y sustitúyalo en su Bot de ejemplo, Hola Mundo!!!. Para ello seleccione el Bot en el Listado de Bots y haga clic en Editar Bot, en el menú de Herramientas. Cuando se abra la pestaña Editar Bot, remplace el contenido del campo Bot con el nuevo código y haga clic en Aceptar. Al igual que antes, seleccione los ordenadores y lance el Bot. Para que el Bot finalice debe hacer clic en OK, sobre el mensaje Hola mundo!!! en la máquina remota. Marzo 2007 Pág 6 de 17

7 Para ver el resultado del lanzamiento seleccione Informes de Bots. En esta pantalla se muestra un listado de los Bots lanzados y ordenados del más reciente al menos, por lo que el último Bot lanzado aparecerá al principio del listado. Haciendo clic sobre ambos listados podremos ver el resultado del lanzamiento en el Detalle del informe. En el primer Bot lanzado (Código 1), el resultado del Informe ha sido el siguiente: Por otra parte, el resultado del último Bot con las variables globales RESULT y RESULTID, ha sido el siguiente: Al comparar ambos informes se puede observar que en el último Bot lanzado el campo Código de salida ha tomado el valor de la variable RESULTID (10) y el campo Mensaje ha tomado el valor de RESULT ( Bot lanzado correctamente ). Marzo 2007 Pág 7 de 17

8 El valor por defecto de la variable global RESULTID es 0, y para RESULT es cadena vacía. Así, si no asignamos valor a estas variables en nuestros Bots, tomarán los valores por defecto. En este último ejemplo se asigna el valor 10 para la variable RESULTID. No obstante, RESULTID puede tomar cualquier valor. Como se verá más adelante en el apartado de Control de Errores, la variable RESULTID tomará el valor 0 cuando el Bot se haya lanzado correctamente. En caso contrario tomará el valor del código del error. Marzo 2007 Pág 8 de 17

9 Uso de parámetros en Bots En determinados casos resulta muy útil poder pasar parámetros a un Bot. La declaración de parámetros tiene el siguiente formato: #PARAM_<variable>#, donde <variable> es cualquier cadena de caracteres que deseemos. Para mostrar el uso de los parámetros, en el siguiente ejemplo crearemos un Bot con nombre Message, con el siguiente código: MsgBox "#PARAM_message#" RESULTID = 0 RESULT = "Successful Message" Al hacer clic en Aceptar la aplicación detecta que en el Bot introducido se ha insertado algún parámetro y abre la siguiente pantalla: Figura 16. Detecta que en el Bot se han incluido parámetros. En esta ventana se debe especificar el tipo de parámetro que será y si se trata de un Campo obligatorio para que el Bot funcione. Recomendamos introducir una Descripción del parámetro. No es un campo obligatorio, pero puede será muy útil a la hora de lanzar Bots. Haga clic en Aceptar y el Bot quedará añadido a su Listado de Bots Una vez creado el Bot, seleccione los equipos sobre los que desea lanzarlo. Haga clic en Lanzar Bot, en el menú Herramientas, y aparecerá el Listado de Bots: Al igual que en el ejemplo anterior, seleccione su Bot Hola Mundo!!! y haga clic en Aceptar. Marzo 2007 Pág 9 de 17

10 En esta ocasión la pantalla de introducción de parámetros le pedirá que introduzca un valor para el parámetro PARAM_message: Figura 18. Introducir valores en el parámetro del Bot Al hacer clic en Lanzar Bot el resultado será el siguiente: Figura 19. Resultado del Bot que permite mostrar mensajes en los ordenadores remotos. Con este Bot podrá visualizar cualquier mensaje por pantalla sobre los ordenadores remotos modificando tan sólo el parámetro PARAM_message. Consejos útiles Hasta ahora hemos mostrado cómo crear y lanzar Bots que muestran mensajes sobre los ordenadores remotos. No obstante, a la hora de crear sus propios Bots debe evitar ese tipo de acción, y reservar el uso de mensajes para comprobar el correcto funcionamiento de los Bots (modo DEBUG). Imagine un Bot que elimina archivos de una carpeta, y que cada vez que elimina un archivo muestra al usuario un mensaje del tipo Archivo borrado correctamente. Aparte de lo molesto que puede llegar a ser para el usuario tener que hacer clic en OK cada vez que sale el mensaje, el Bot no continuará hasta que el usuario haga clic en el botón. De esta forma no podrá recibir respuesta acerca del resultado del lanzamiento del Bot hasta que el usuario haga clic varias veces hasta el último OK. Por ese motivo, los bots deben lanzarse como si fueran servicios, es decir, sin interacción del usuario. Marzo 2007 Pág 10 de 17

11 Control de Errores Las variables globales RESULTID y RESULT son útiles también para controlar errores en el código. Para ello debe declarar la expresión On Error Resume Next al principio del código. Esto evita que se muestre un mensaje de error en el ordenador remoto sobre el que se ha lanzado el Bot y además permite tratarlo mediante el objeto Err. Cómo hacerlo: On Error Resume Next MsgBox "#PARAM_message#" If Err.Number <> 0 then RESULTID = Err.Number RESULT = Err.Description Else RESULT = "Successful Message" End If En caso de error en el código, el Err.Number nos indicará el número de error, y el Err.Description un mensaje del error. Para ver su funcionamiento provocaremos un error en el código: On Error Resume Next MsgBox #PARAM_message# error If Err.Number <> 0 then RESULTID = Err.Number RESULT = Err.Description Else RESULT = "Successful Message" End If Así es como aparecerá el resultado en el Informe de Bots: Figura. Control de errores. Marzo 2007 Pág 11 de 17

12 Depurar Bots (debugging) Las variables globales RESULTID y RESULT también pueden ser utilizadas para hacer un debug del código de los Bots. Podemos ver un ejemplo de uso en el siguiente código: On Error Resume Next RESULTID = 1 RESULT = "Primer Mensaje" SendResult RESULTID, RESULT MsgBox "Primer mensaje" RESULTID = 2 RESULT = "Segundo Mensaje" SendResult RESULTID, RESULT MsgBox "Segundo mensaje" If Err.Number <> 0 then RESULTID = Err.Number RESULT = Err.Description Else RESULTID = 0 RESULT = "Successful Debug" End If Tras lanzar el Bot, y después de que aparezca el mensaje Primer Mensaje por pantalla, si hace clic en Informes de Bots observará el siguiente resultado: Haga clic en OK y el lanzamiento proseguirá hasta el siguiente mensaje Segundo Mensaje. Anule la selección y seleccione de nuevo el Bot (para que se refresque el estado) dentro de Informes de Bots, y podrá observar cómo cambia el resultado: Finalmente, al hacer clic en OK, el resultado será el siguiente: Marzo 2007 Pág 12 de 17

13 Ejecución de archivos wscript.exe y cscript.exe En algunos casos puede ser interesante ejecutar archivos.vbs o.js para que puedan ser lanzados mediante los motores de scripting wscript.exe o cscript.exe. Para lanzar archivos utilizando WScript es necesario que en la máquina remota esté instalado el programa Windows Scripting Host (WSH). Para ver su funcionamiento, cree en su ordenador un archivo llamado holamundo.vbs con el siguiente código: Wscript.echo Hola Mundo!!! Los archivos que va a lanzar deben estar almacenados en el Área de archivos. Suba su archivo al servidor del Área de archivos de NTRadmin. Previamente debe haber creado una carpeta llamada Bots dentro del directorio Principal, de modo que le permita guardar los Bots.vbs. Una vez almacenados los archivos.vbs debe crear un Bot con el siguiente código: On Error Resume Next Dim istatus istatus = DownloadToFile("#PARAM_url#", "Bot.vbs") RunApp "wscript.exe", "Bot.vbs #PARAM_arguments#", 0 If Err.Number <> 0 then RESULTID = Err.Number RESULT = Err.Description Else RESULT = "Successful Execute WScript" End If Marzo 2007 Pág 13 de 17

14 La función DownloadToFile es una función interna de NTRadmin que permite descargar archivos en un ordenador remoto. El primer parámetro de DownloadToFile, #PARAM_url# será un archivo almacenado en el Area de archivos (Online Storage). El segundo parámetro será el nombre que tomará el archivo en la máquina remota. En este caso script.vbs. A continuación, mediante la función interna de NTRadmin, RunApp, lance la aplicación wscript.exe pasándole como parámetro el nombre de archivo a ejecutar, en este caso script.vbs. Si quisiera lanzar archivos.js bastaría con cambiar script.vbs por script.js en el código anterior. En #PARAM_arguments# puede escribir los parámetros a pasar a su programa.vbs. Al hacer clic en Aceptar podrá introducir el tipo y la descripción de los parámetros: Figura. Tipo y descripción de parámetros. Tras hacer clic en Aceptar, el Bot queda listo para lanzar archivos.vbs en máquinas remotas. Marzo 2007 Pág 14 de 17

15 Seleccione los ordenadores en los que debe lanzarse el Bot y haga clic sobre el Bot Execute Wscript que acaba de crear. Le pedirá una serie de parámetros. El Bot holamundo.vbs no necesita parámetros, por lo que la variable PARAM_arguments se deja vacía. Haga clic en Lanzar Bot y el Bot será lanzado en la máquina remota. Marzo 2007 Pág 15 de 17

16 En caso de que Vd. desee que el archivo.vbs desaparezca de la máquina del usuario tras ser lanzado, el código que debe utilizar es el siguiente: On Error Resume Next Dim istatus Dim oshell Dim ofso istatus = DownloadToFile("#PARAM_url#", "Bot.vbs") Set oshell = CreateObject("WScript.Shell") oshell.run "wscript.exe bot.vbs #PARAM_arguments#", 0, true Set ofso = CreateObject("Scripting.FileSystemObject") ofso.deletefile("bot.vbs") Set ofso = Nothing Set oshell = Nothing If Err.Number <> 0 then RESULTID = Err.Number RESULT = Err.Description Else RESULT = "Successful Execute WScript" End If Marzo 2007 Pág 16 de 17

17 Envío de mensajes Dentro del panel de herramientas hay un apartado denominado Mensajes : Con NTRadmin es posible enviar mensajes a la aplicación mediante un Bot. Para ello NTRadmin proporciona una variable pre-declarada llamada MESSAGE. Al igual que con las variables RESULTID y RESULT, la variable MESSAGE la podemos utilizar en el código de nuestros Bots sin tener que declararla con la instrucción Dim. El siguiente ejemplo de código muestra como utilizar esta variable: On Error Resume Next MESSAGE = "Bot lanzado correctamente en el ordenador del usuario" If Err.Number <> 0 then RESULTID = Err.Number RESULT = Err.Description Else RESULT = "Successful Send Message" End If Marzo 2007 Pág 17 de 17