The scripting feature allows users to add, edit, and schedule custom scripts using any generic script language, including bash, VBscript, Jscript, Perl, and PowerShell. You can register custom interpreters so that any scripting language can be used. In addition, you can package scripts into functional IF-THEN-ELSE logic groups to complete more advanced maintenance and reme- diation tasks. Scripting is controlled by five functional sections which you can view by clicking the scripting dashboard in the tree view. The five functional sections are as follows:
1. Script Status
This section shows the status of scripts that are currently running only. Double-clicking on a status line item will show the target machines that the scripts are running on, the cur- rent status for each target, and the current status for each script running on that target. 2. Script Library
This section lists all the custom scripts that are currently in the database. These scripts include read-only scripts provided with the software, sample scripts, and custom scripts created by the users. The application supports any scripting language, and individual scripts can be customized to use custom parameter syntax.
3. Script Packages
This section lists all the script packages in the database. A script packages organizes mul- tiple scripts into functional blocks, either simple ordered lists of scripts, or IF-THEN-ELSE logical blocks that can check conditions and run different scripts based on the success or failure of the IF conditions.
4. Script Schedules
This section lists all the script schedules in the database. A script schedule is a list of script packages than are to be run on a system, along with a schedule for the scripts and a list of target devices on which the lists can be run. Both Windows and Linux script pack- ages can be added to the same schedule, and the packages will only run on the devices for which the packages were designed.
5. Logs
This section includes the log output from all scripts that run on the system. Double-click- ing on the log output will bring up more details and the full output from the script. Here
you can see the results of the script, as well as IP address of the machine, Date, Severity, Schedule Name and Hostname.
Topics in this section
l Understanding Script Types
l Importing Scripts to PacketTrap MSP l Exporting Scripts from PacketTrap MSP
Understanding Script Types
There are 3 types of scripts in PacketTrap MSP:
l Standard: By default, the script type is set to standard when you add a new script. You
can update and delete standard scripts from PacketTrap MSP.If you import a script and select to overwrite the existing standard script in the system, then the script is updated.
l Read-only: You cannot update read-only scripts in PacketTrap MSP, but you can view it
and/or create a copy of it. The copy that you create is a standard script. If you import a script and select to overwrite the existing script is the system, PacketTrap MSP creates a copy of the script named "Copy of <original script name>".
l System: You cannot view, copy, or export system scripts. If you import a script and select
to overwrite the existing script in the system, you will receive an error message.
NOTE: If you choose not to overwrite a script, you can update the existing script without receiv- ing any error messages.
Importing Scripts to PacketTrap MSP
You can simultaneously import a large number of scripts to PacketTrap MSP. Scripts that you select to import must be formatted in XML.
Before you can import a script, PacketTrap MSP will validate the XML file to make sure that it is free of errors. To see a list of the fields that are validated, click here. If any errors are dis- covered, the scripts will fail to import into the script and the errors will appear in a pop-up win- dow.
If the scripts are successfully parsed, PacketTrap MSP will continue to process the scripts and do the following:
l Read-only scripts will be imported as ‘standard’ scripts. This action occurs because you
cannot add read-only scripts to PacketTrap MSP.
l If you try to import a script that already exists in PacketTrap MSP, you will receive a con-
firmation message informing you that those scripts will be overwritten. You have the option to overwrite the existing scripts or to ignore the scripts and continue importing the remaining scripts.
l When you choose to overwrite existing scripts, the file name will remain the same except
if the script is read-only. The new standard script is renamed using the following format: "Copy of <original script name>".
To import a script
1. In the Studio main menu, click Configuration -> Scripting. 2. Click the Import button.
3. Navigate to the scripts that you want to import.
4. Type a file name and click Save.NOTE: All scripts are imported as XML files and it must have valid XML-formatted content. If the format of the XML file is not valid format you can not import it into PacketTrap MSP.
Exporting Scripts from PacketTrap MSP
You can simultaneously export a large number of scripts from PacketTrap MSP. Scripts that you select to export must be formatted in XML.
PacketTrap MSP provides 2 ways in which you can export a script:
l Click the Export button in top right corner of the Scripts view. This option will open a
pop-up window that allows you to select the path where you want to export the script and type a file name for the newly exported script. All scripts are exported in XML.
l Select an individual script from the Script Library and the click the Export option in
where you want to export the script and type a file name for the newly exported script. This script will be exported in XML.
NOTE: You cannot export a system script. If you try to export a script using the Export option in the context menu, you will receive and error message.
To export a script using option 1
1. In the Studio main menu, click Configuration -> Scripting. 2. Click the Export button.
3. Navigate to the location where you want to export the script. 4. Type a file name and click Save.
To export a script using option 2
1. In the Studio main menu, click Configuration -> Scripting
2. In the tree view, select a script from the Script Library or Script Packages tab. NOTE: You cannot export system scripts.
3. Right-click the selected script and click Export.
4. In the Export Script Package window, navigate to the location where you want to export the script.
5. Type a file name. 6. Click Save.