Add User Accounts
Bulk Registry Write
Console Execute
Console Logoff User
Console Open Browser
Console Registry Read
Console Screen Capture
Console Shell
Console Show Message
Disk Check
Disk Cleanup
Disk Defrag
Email
Email Alerts
Email Load Attachment
Execute Script
ExtraData Set Value
File BITS Download
File Copy
File Copy as Admin
File Copy as User
File Delete
File Delete as Admin
File Delete as User
File Download
File Download (Forced)
File Download URL
File Download URL (Forced)
File Rename
File Rename as Admin
File Rename as User
File Upload
File Write Text
File Zip
Folder Create
Folder Create as Admin
Folder Create as User
Folder Delete
Folder Delete as Admin
Folder Delete as User
Folder Move
Folder Move as Admin
Folder Move as User
Generate Random Password
Hibernate
IF AutoStartup Check
IF Console Logged On
IF Drive Status
IF File Check
IF File Compare
IF Group Member
IF New Unassigned Ticket
IF Patch Installed
IF Plugin Agent Command Available
IF Plugin Enabled
IF Plugin Server Function Available
IF Process Exists
IF Registry Check
IF Role Detected
IF Service is Running
IF Smart Attributes
IF Software Installed
IF SQL Data Check
IF Ticket Status
IF Tool Installed
IF User Response
LabTech Agent Uninstall
LabTech Agent Update
LabTech Command
LabTech FasTalk
LabTech License Deactivate
LabTech License Retrieve
LabTech Plugin Alert
LabTech Probe Control
LabTech Send Message to Computer
LTServer Alert Delete
LTServer Call Alert Template
LTServer Create Alert
LTServer Execute
LTServer Net Send
LTServer Pager Message
LTServer Record Stat
LTServer Send Fax
LTServer Shell Execute
LTServer Voice Message
LTServer Write to File
Maintenance Mode Clear
Maintenance Mode Start
MatchGoto
Net DNS Lookup
Net Get IP Port
Net Get SNMP
Net IPConfig
Net Ping
Net Renew IP
Net Set SNMP
Net TFTP Send
Net Wake on Lan
Offline Backup
Patch Approve
Patch Install
Patch Install All
Performance Counter Get
Play Sound
Plugin Agent Command
Plugin Server Function
Powershell Command
Powershell Command as Admin
Printer Clear Queue
Printer Set Default
Process Execute
Process Execute as Admin
Process Execute as User
Process Kill
Reboot forced
Reboot to Cmd Prompt
Reboot to Safemode
Registry Delete Key
Registry Set Value
Report Email
Report Print
Resend Autostartup List
Resend Config
Resend Drive Info
Resend Error Logs
Resend EventLogs
Resend Everything
Resend Hardware
Resend Network information
Resend Patch information
Resend Printers
Resend Process List
Resend Service List
Resend Software
Resend System Information
Script Call
Script Exit with Error
Script For Each
Script For Each SQL
Script Goto
Script Log Message
Script Math
Script Note
Script RegEx
Script Return
Script Run
Script Sleep
Script State Clear
Script State Get
Script State Set
Script Stats Clear
Script Stats Get
Script Stats Save
Script String Functions
Service Start
Service Startup Control
Service Stop
Share Create
Share Delete
Shell
Shell as Admin
Shell as User
Shell Enhanced
SQL Execute
SQL Fetch DataSet Row
SQL Get DataSet
SQL Get Value
SSH Close Connection
SSH Open Connection
SSH Send Raw
SSH Send Secure
Suspend
Telnet Close Connection
Telnet Open Connection
Telnet Send Raw
Telnet Send Secure
Template Property Get Value
Ticket Add Time
Ticket Assign
Ticket Attach File
Ticket Combine
Ticket Comment
Ticket Create
Ticket Elevate
Ticket Finish
Ticket Open
Ticket Reading View
Ticket Stall
Ticket Update
Tool Install
Variable Check
Variable Check
Variable Set
Virus Definition Update
Virus Scan
Windows Update Settings
Adds a new user account to the local computer unless this is a domain controller then it creates a domain account.
Parameters
| Param | Values | Note |
|---|---|---|
| Username | User Provided | Do not include the domain name or quotes. |
| Password | User Provided | Password to use for new user account. |
Example Function Text
Add User @USERNAME@ with password @PASSWORD@ storing the result in %userresult%
Does a Bulk Import of Registry Keys, Starts at the Registry key and then Splits the Name value pairs By a Pipe and sets those names to values.
Parameters
| Param | Values | Note |
|---|---|---|
| Registry Key | User Provided | The Base registry key to start writing values at. |
| Name Value Pairs | User Provided | The name value pairs that are split and written. |
Example Function Text
Bulk Registry Write to key: @REGISTRYKEY@
Run a program on user's desktop, User must be logged on, Use IF Logged On to Test and activate the %ConsoleNumber% variable. Returns data to "%executeresult% variable. This command has FULL Access to the User's Desktop, Network and Environment but will not return results of commands.
Parameters
| Param | Values | Note |
|---|---|---|
| Executable | User Provided | Full path to the program to run with quotes. |
| Arguments | User Provided | The arguments passed to the executable. |
| Console Number | User Provided | Console number to run program on, use %consolenumber% when IF logged on. |
Example Function Text
Run: @EXECUTABLE@ @ARGUMENTS@ on Console #%consolenumber%
Log the console and user off, User must be logged on, Use IF Logged On to Test.
Parameters
| Param | Values | Note |
|---|---|---|
| Console Number | User Provided | Console number to log off, use %consolenumber% when IF logged on. |
Example Function Text
LOGOFF console: #%consolenumber%
Open the users Internet Explorer to the specified address, User must be logged on, Use IF Logged On to Test.
Parameters
| Param | Values | Note |
|---|---|---|
| URL | User Provided | The address the browser should display. |
| Console Number | User Provided | The console number we should display this on, use %consolenumber% when IF logged on. |
Example Function Text
Open Browser to @URL@ on Console #%consolenumber%
Reads a registry key or value and sets the %regresult% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Registry Key | User Provided | The Key or value to be read. |
| Console Number | User Provided | Console number to read key or value from, use %consolenumber% when IF logged on. |
Example Function Text
Console Registry Read: @REGISTRYKEY@ on %consolenumber%
Perform a Screen Capture on the users console, User must be logged on, Use IF Logged On to Test.
Parameters
| Param | Values | Note |
|---|---|---|
| Console Number | User Provided | Console number to capture on, use %consolenumber% when IF logged on. |
Example Function Text
Capture Screen on Console: #%consolenumber%
Execute shell commands in the background on the user's console, using CMD.exe to execute them. Returns output to %shellresult%. This command has limited user environment access.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
| Console Number | User Provided | Console Number |
Example Function Text
Console Shell: @COMMAND@ on %consolenumber%
Popup message on user's desktop, User must be logged on, Use IF Logged On to Test.
Parameters
| Param | Values | Note |
|---|---|---|
| Message | User Provided | The message to display on the desktop. |
| Console Number | User Provided | The console number to display on, use %consolenumber% obtained from IF User Logged on. |
Example Function Text
Popup Message: @MESSAGE@ on Console #%consolenumber%
Run chkdisk on a drive, uses @computerid@ for the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Drive Letter | User Provided | The Drive Letter to scan, leave blank for all drives. |
| Result Variable | User Provided | Put the results in this variable, without the @ signs. |
Example Function Text
Scan Drive: @DRIVELETTER@ and save result to @RESULTSVAR@
Run the internal LabTech disk cleanup according to the settings in the config, uses @computerid@ for the target computer.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Perform a Disk Cleanup
Defragment Drive, uses @computerid@ for the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Drive Letter | User Provided | The drive letter to defragment |
| Result Variable | User Provided | Put the results in this variable, without the @ signs. |
Example Function Text
Defragment Drive: @DRIVELETTER@ and save result to @RESULTSVAR@
Send an email message from the LabTech Server.
Parameters
| Param | Values | Note |
|---|---|---|
| To | User Provided | Address to send email to, separate multiple addresses with a semi-colon(;) |
| Subject | User Provided | Subject of email. |
| Body | User Provided | Body of message. |
| File Path | User Provided | Path to File to attach to email or List of Attachment IDs, Leave Empty for no Attachment |
Example Function Text
Send Email To: @EMAIL@ Subject: @SUBJECT@
Send all alerts for target computer to email address, uses @computerid@ for the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| User Provided | Address to send the alerts to. | |
| Clear | [Yes, No] | Clear this computers alerts after sending. |
Example Function Text
Email Alerts to: @EMAIL@ and Clear.
Email Alerts to: @EMAIL@
Loads an attachment into the database for sending with email, returns %AttachmentID%.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Path to File to load as an attachment |
| Variable | User Provided | Variable to save the ID of the Attachment to. |
Example Function Text
SET: @VARIABLE@ = AttachmentID(@FILEPATH@)
Executes a script and stores the script in %invokedscript%, stores script result in the named variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Script Type | [PowerShell, VBScript, Batch, PowerShell Bypass] | Select Script Type. |
| Script to Execute | User Provided | Enter Script (Use Button to Expand Text Editor). |
| Script Parameters | User Provided | Enter Script Parameters to Send. |
| Script Credentials | [Run as Local Agent, Run as Admin] | Select Credentials to Use |
| Variable | User Provided | Enter Variable to Store Result of Output. |
Example Function Text
Execute: PowerShell Script as Local and store result in: @VARIABLE@
Execute: PowerShell Script as Admin and store result in: @VARIABLE@
Execute: VBScript as Local and store result in: @VARIABLE@
Execute: VBScript as Admin and store result in: @VARIABLE@
Execute: Batch as Local and store result in: @VARIABLE@
Execute: Batch as Admin and store result in: @VARIABLE@
Execute: PowerShell Bypass as Local and store result in: @VARIABLE@
Execute: PowerShell Bypass as Admin and store result in: @VARIABLE@
Save an Extra Data Field from a variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Extra Field | Values loaded from database | The field ends with the type of ID. 1=computer 2=locationid 3=client 4=probe 5=device 6=ticket 7=group 13=contact |
| ID | User Provided | Use the correct ID type, like @computerid@. |
| Value | User Provided | If specifying a variable, include @ signs. |
Example Function Text
SET: [EXTRAFIELD 34cd0cf3-2f61-11e1-ac0f-3d76979114ae - @computerid@] = @VALUE@
Download a File using the BITS Service or Check the Status of a Download. This returns the JOBID or the Status of the download.
Parameters
| Param | Values | Note |
|---|---|---|
| Operation | [Download, Status Check] | The operation to preform. |
| Source | User Provided | Source URL or JobID |
| Destination | User Provided | Destination to Save File |
| ScriptID | User Provided | Script ID to run when completed downloading. |
Example Function Text
BITS Download: @SOURCE@ saved to @DESTINATION@
BITS Status Check: @SOURCE@
Copy a file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Source Path | User Provided | The full path of the source file, without quotes. |
| Destination Path | User Provided | The full path of the destination file, without quotes. |
Example Function Text
Copy: @SOURCEPATH@ to @DESTINATION@
Copy: @SOURCE@ to @DESTINATION@
Copy a file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Source Path | User Provided | The full path of the source file, without quotes. |
| Destination Path | User Provided | The full path of the destination file, without quotes. |
Example Function Text
Copy File as Admin: @SOURCE@ to @DESTINATION@
Copy a file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Source Path | User Provided | The full path of the source file, without quotes. |
| Destination Path | User Provided | The full path of the destination file, without quotes. |
| Username | User Provided | Enter full username in Domain\User format. |
| Password | User Provided | The password to use. |
Example Function Text
Copy File as @USERNAME@: @SOURCE@ to @DESTINATION@
Delete file on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path of file to delete. |
Example Function Text
Delete: @FILEPATH@
Delete: @FILE@
Delete file on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path of file to delete. |
Example Function Text
Delete File as Admin: @FILE@
Delete file on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path of file to delete. |
| Username | User Provided | Enter full username in Domain\User format. |
| Password | User Provided | The password to use. |
Example Function Text
Delete File as @USERNAME@: @FILE@
Transfers a file from the LabTech server and saves it to the local computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Local File | Values loaded from database | Local file to send, must exist in the LTShare\Transfer directory. (IIS blocks some transfer of some files like *.config, *.vb, *.licx... by default) |
| Destination Path | User Provided | The full path to file destination including file name, without quotes. |
Example Function Text
Download: /Labtech/Transfer/@LOCALFILE@ saved to @DESTINATION@
Transfers a file from the LabTech server and saves it to the local computer. Forces agent to perform download.
Parameters
| Param | Values | Note |
|---|---|---|
| Local File | Values loaded from database | Local file to send, must exist in the LTShare\Transfer directory. (IIS blocks some transfer of some files like *.config, *.vb, *.licx... by default) |
| Destination Path | User Provided | The full path to file destination including file name, without quotes. |
Example Function Text
Download Force: /Labtech/Transfer/@LOCALFILE@ saved to @DESTINATION@
Download file from external site and save it to a local file.
Parameters
| Param | Values | Note |
|---|---|---|
| URL | User Provided | URL to the file that is downloaded, urlencode any strange characters. |
| Local File | User Provided | Full path to the file to save the URL as including file name. |
| [Wait Until Finished, Return Now] | Wait for the download if you need the file in the next steps. |
Example Function Text
Download: @URL@ saved to @LOCALFILE@ and wait until finish.
Download: @URL@ saved to @LOCALFILE@ and return immediately.
Download file from external site and save it to a local file. Agent will be forced to perform download.
Parameters
| Param | Values | Note |
|---|---|---|
| URL | User Provided | URL to the file that is downloaded, urlencode any strange characters. |
| Local File | User Provided | Full path to the file to save the URL as including file name. |
| [Wait Until Finished, Return Now] | Wait for the download if you need the file in the next steps. |
Example Function Text
Download Force: @URL@ saved to @LOCALFILE@ and wait until finish.
Download Force: @URL@ saved to @LOCALFILE@ and return immediately.
Rename or move file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path of file to move\rename. |
| New Path | User Provided | Full path to the new file. |
Example Function Text
Rename: @FILEPATH@ to @NEWPATH@
Rename: @FILE@ to @NEWPATH@
Rename or move file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path of file to move\rename. |
| New Path | User Provided | Full path to the new file. |
Example Function Text
Rename File as Admin: @FILE@ to @NEWPATH@
Rename or move file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path of file to move\rename. |
| New Path | User Provided | Full path to the new file. |
| Username | User Provided | Enter full username in Domain\User format. |
| Password | User Provided | The password to use. |
Example Function Text
Rename File as @USERNAME@: @FILE@ to @NEWPATH@
Send file from the remote computer to your LabTech server and save it in LTShare\Uploads. Returns %uploadedfile% with the local path to the file.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path to the file to send. |
Example Function Text
Upload: @FILEPATH@ to LTSHARE\Uploads\, store the result in %uploadedfile%
Save text to a file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Text File | User Provided | The full path to the file, will replace existing file. |
| Data | User Provided | The text to write to the file. |
Example Function Text
Write @DATA@ to @TEXTFILE@
Add List of files to compressed zip archive.
Parameters
| Param | Values | Note |
|---|---|---|
| Path List | User Provided | A comma separated list of full paths. |
| Archive | User Provided | The full path to the save the zip archive. |
Example Function Text
Zip Files @PATHLIST@ to @ARCHIVE@ storing the size in %zipsize%
Create a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Folder | User Provided | Full Path to the new folder. |
Example Function Text
Create Folder: @FOLDER@
Create a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Folder | User Provided | Full Path to the new folder. |
Example Function Text
Create Folder as Admin: @FOLDER@
Create a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Folder | User Provided | Full Path to the new folder. |
| Username | User Provided | Enter full username in Domain\User format. |
| Password | User Provided | The password to use. |
Example Function Text
Create Folder as @USERNAME@: @FOLDER@
Delete a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Folder | User Provided | Full Path to the folder. |
Example Function Text
Delete Folder: @FOLDER@
Delete a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Folder | User Provided | Full Path to the folder. |
Example Function Text
Delete Folder as Admin: @FOLDER@
Delete a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Folder | User Provided | Full Path to the folder. |
| Username | User Provided | Enter full username in Domain\User format. |
| Password | User Provided | The password to use. |
Example Function Text
Delete Folder as @USERNAME@: @FOLDER@
Move a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Source Folder | User Provided | Full Path to the target folder. |
| Dest Folder | User Provided | Full path to the destination Folder. |
Example Function Text
Move Folder: @SOURCE@ to @DEST@
Create a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Source Folder | User Provided | Full Path to the target folder. |
| Dest Folder | User Provided | Full path to the destination Folder. |
Example Function Text
Move Folder as Admin: @SOURCE@ to @DEST@
Create a folder on the target computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Source Folder | User Provided | Full Path to the target folder. |
| Dest Folder | User Provided | Full path to the destination Folder. |
| Username | User Provided | Enter full username in Domain\User format. |
| Password | User Provided | The password to use. |
Example Function Text
Move Folder as @USERNAME@: @SOURCE@ to @DEST@
Generates a Random password based on the given parameters (All parameters must be numeric or blank) and sets the %randompassword% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Minimum Length | User Provided | Minimum password length (Required, Must be > 0) |
| Maximum Length | User Provided | Maximum password length (Required, Must be Greater than Minimum Length) |
| Minimum Special Characters | User Provided | undefined |
| Minimum Numerical Characters | User Provided | undefined |
| Minimum Upper Case Characters | User Provided | undefined |
Example Function Text
Generate Random Password INTO %randompassword%
Hibernates the computer if it supports this function. This command returns immediately.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Hibernate
Checks Startup Value for result and sets the %autostartupvalue% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| AutoStart Def | Values loaded from database | Pick the Location to check. |
| Compare | [Exists, Not Exists, =, Not =, <, <=, >, >=, Contains, Not Contains] | Logical Operator. |
| To | User Provided | Value to compare. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF AUTOSTARTUP AutoDefId 1 < @COMPARETO@ THEN Jump to :Label
IF AUTOSTARTUP AutoDefId 2 < @COMPAREVAR@ THEN Jump to :Label
IF AUTOSTARTUP AutoDefId 1 Exists THEN Jump to :Label
Return True if user is logged on and sets the %consolenumber% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Username | User Provided | Check if the specific user is logged on, leave blank for anyone. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF USER LOGGED IN @USERNAME@ THEN Jump to :Label
IF NOT USER LOGGED IN THEN Jump to :NoConsoleUser
IF USER LOGGED IN @INPUTPARAMETER@ THEN Jump to :Label
Returns True if any of the Conditions are met and sets the %driveletter% variable with the drive.
Parameters
| Param | Values | Note |
|---|---|---|
| FreeSpace | User Provided | Minimum Percentage of free space |
| Fragmentation | User Provided | Maximum Fragmentation that is acceptable for this drive |
| MFT Frag | User Provided | Maximum MFT Fragmentation that is acceptable. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF DRIVE STATUS BAD THEN Jump to :Label
IF DRIVE STATUS BAD THEN Jump to :Label
Check if the file Exists or does Not Exist.
Parameters
| Param | Values | Note |
|---|---|---|
| File Path | User Provided | Full path to the file to test. |
| Compare | [Exists, Not Exists] | Returns true if the condition is met. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF FILE Exists @FILEPATH@ THEN Jump to :Label
IF FILE Exists @INPUTPARAMETER@ THEN Jump to :Label
IF FILE Not Exists @INPUTPARAMETER@ THEN Jump to :Label
Compares 2 files on the agent and returns true if they are identical.
Parameters
| Param | Values | Note |
|---|---|---|
| Check Type | [Created, Modified, Accessed, Version, Contents, Size, MD5] | The type of file compare to perform. |
| File #1 | User Provided | Full path to filename without quotes. |
| File #2 | User Provided | Full path to filename without quotes. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF @FILE1@ = @FILE2@ THEN Jump to :Label
IF @FILE1@ = @FILE2@ THEN Jump to :Label
IF @FILE1@ = @FILE2@ THEN Jump to :Label
IF @FILE1@ = @FILE2@ THEN Jump to :Label
IF @FILE1@ = @FILE2@ THEN Jump to :Label
IF @FILE1@ = @FILE2@ THEN Jump to :Label
IF @FILE1@ = @FILE2@ THEN Jump to :Label
Tests if the computer is a member of the selected group or any of its children.
Parameters
| Param | Values | Note |
|---|---|---|
| Group Name | Values loaded from database | Name of the group to check. |
| Computer ID | User Provided | Use @ComputerID@ for the current computer. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF Member of GroupId 1045 THEN Jump to :Label
Runs the True part when a new ticket exists and sets the %ticketid% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Client ID | User Provided | The Client to search, leave blank for all clients. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF NEW UNASSIGNED TICKET FOR CLIENT @CLIENTID@ THEN Jump to :Label
Check if Patch is installed.
Parameters
| Param | Values | Note |
|---|---|---|
| Patch ID | Values loaded from database | Select Patch or type Variable Name. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF PATCH INSTALLED HotFixId 5c9e30a9-9015-44a4-9be9-94d6b8fac949 THEN Jump to :Label
Checks if a Plugin is loaded and enabled for use.
Parameters
| Param | Values | Note |
|---|---|---|
| Command ID | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
| Label to Jump to or Steps to Skip | User Provided | undefined |
Example Function Text
IF SvcCommandId 1049 Agent Command Available THEN Jump to line :Label1315
Checks to see if PlPlugin Name to Check.
Parameters
| Param | Values | Note |
|---|---|---|
| GUID | Values loaded from database | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
| Label to Jump to or Steps to Skip | User Provided | undefined |
Example Function Text
IF PluginId 24b84eb4-2104-11e1-b223-6e3ff20334fb Plugin Enabled THEN Exit Script
Checks if a Plugin Function Exists and is ready for use.
Parameters
| Param | Values | Note |
|---|---|---|
| Function Guid | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
| Label to Jump to or Steps to Skip | User Provided | undefined |
Example Function Text
IF FunctionId ec90525e-9d73-11e4-bf92-005056844d96 Server Function Available THEN Jump to line :Label1316
Check if the process is running and sets the %processid% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Process Name | User Provided | Name or ID of Process to Check. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF PROCESS EXISTS @PROCESSNAME@ THEN Exit Script
IF PROCESS EXISTS INPUTPARAMETER THEN Jump to line 136
IF NOT PROCESS EXISTS @PROCESSNAME@ THEN Jump to line 137
IF PROCESS EXISTS @PROCESSNAME@ THEN Jump to :Label
IF NOT PROCESS EXISTS @PROCESSNAME@ THEN Jump to :Label
IF PROCESS EXISTS @INPUTPARAMETER@ THEN Jump to :Label
Test the Registry Value and sets the %registryresult% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Registry Key | User Provided | End the Value name with a \ to indicate a Key rather than a value. |
| Compare | [Exists, Not Exists, =, Not =, <, <=, >, >=, Contains, Not Contains] | For Keys Exists and Not Exists are the only applicable choices. |
| To | User Provided | Leave blank for Exists and Not Exists. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF [REGISTRY @REGISTRYKEY@] = @COMPAREVALUE@ THEN Exit Script
IF [REGISTRY @REGISTRYKEY@] <= @COMPAREVALUE@ THEN Jump to line 141
IF [REGISTRY @INPUTPARAMETER@] Exists THEN Jump to :Label
Checks to see if Role has been detected
Parameters
| Param | Values | Note |
|---|---|---|
| Role Definition | Values loaded from database | Role Definition to check. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF Role detected - AD Domain Controller:c79927ec-2b6f-11e3-9392-08002788414b - Then Jump to :Label
Check if the Service is Running and sets the %servicename% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Service Name | User Provided | Name of service to check. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF SERVICE RUNNING @SERVICENAME@ THEN Jump to :Label
IF SERVICE RUNNING @INPUTPARAMETER@ THEN Jump to :Label
Tests if an Attribute is under its threshold for the current computer and sets the %smartresult% variable with the drive.
Parameters
| Param | Values | Note |
|---|---|---|
| Smart Attribute | Values loaded from database | The attribute to test. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF SMART ATTRIBUTE 11 FAILED THEN Jump to :Label
IF SMART ATTRIBUTE 99 FAILED THEN Jump to :Label
Check if software package is installed and set the %softwarelocation% variable with the path.
Parameters
| Param | Values | Note |
|---|---|---|
| App Name | User Provided | The name of the application to check for. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF SOFTWARE INSTALLED @APPNAME@ THEN Jump to :Label
IF SOFTWARE INSTALLED @APPNAME@ THEN Jump to :Label
Test a Value from the Database and set %sqlresult% variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Sql Statement | User Provided | Statement must return 1 value. |
| Compare | [Exists, Not Exists, =, Not =, <, <=, >, >=, Contains, Not Contains] | Logical Operator. |
| To | User Provided | Value to compare. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
| ODBC Connection | User Provided | Leave blank to use the LabTech database. |
Example Function Text
IF [SQL @SQLSTATEMENT@] <= @COMPAREVAR@ THEN Jump to :Label
IF [SQL @SQLSTATEMENT@] Exists THEN Jump to :Label
Tests if a Ticket is set to the selected status.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket ID to test. |
| Status | Values loaded from database | Status to Equal if true |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF Ticket @TICKETID@ Exists THEN Jump to :Label
Check if Tool\Tweak is installed.
Parameters
| Param | Values | Note |
|---|---|---|
| Tool ID | Values loaded from database | Name of Tool to check. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF TOOL INSTALLED 0 THEN Jump to :Label
IF TOOL INSTALLED 0 THEN Jump to :Label
Ask the User a Yes or No Question and jumps to the Label to Jump to or Steps to Skip if Yes.
Parameters
| Param | Values | Note |
|---|---|---|
| Question | User Provided | The question to ask. |
| Console Number | User Provided | Console Number to ask the question on, get this from a previous script. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. Prefix with '!' to invert check. |
Example Function Text
IF USER RESPONSE YES TO @QUESTION@ ON CONSOLE #%consolenumber% THEN Exit Script
IF USER RESPONSE YES TO @QUESTION@ ON CONSOLE #%consolenumber% THEN Exit Script
Uninstalls the LabTech Agent from the target computer. This command returns immediately and no further commands can be sent to the computer.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function LabTech Agent Uninstall
Tells the LabTech Agent to update itself to the latest version, the agent will update EVEN if it has the same version to refresh its files and correct any errors. This command returns immediately and no further commands can be sent to the computer.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function LabTech Agent Update
Runs an internal LabTech command.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Numerical command to execute. |
| Parameters | User Provided | Parameters needed for the command. |
| Group List | User Provided | Comma separated list of Group IDs, must be blank if specifying a value in the ID field below. |
| ID | User Provided | ID of object to run against. |
| ID Type | [Computer, Location, Client] | Type of object of the above ID. |
Example Function Text
LTCommand: Update Agent
LTCommand: Execute Command INPUTPARAMETER
LTCommand: Install Tool INPUTPARAMETER
LTCommand: Upload File INPUTPARAMETER
LTCommand: Download File INPUTPARAMETER
LTCommand: DownLoad URL INPUTPARAMETER
LTCommand: Identify OS INPUTPARAMETER
LTCommand: Scan Hosts INPUTPARAMETER
LTCommand: iSendScreenshot INPUTPARAMETER
LTCommand: Agent Tracing INPUTPARAMETER
Toggle FasTalk Off\On or send FasTalk packet across network.
Parameters
| Param | Values | Note |
|---|---|---|
| Control | User Provided | Use 1 for On, 00 for Off or an IP address to send a network packet. |
Example Function Text
Toggle FasTalk
Toggle FasTalk ON
Toggle FasTalk OFF
Reset a Retrieved License.
Parameters
| Param | Values | Note |
|---|---|---|
| License Identifier | User Provided | The identifier of the Retrieved License, typically %obtainedlicenseid%. |
Example Function Text
Deactivate License ID: %obtainedlicenseid%
Retrieve a License and save it to %obtainedlicense%. %licensesuccess% indicates whether property found (1) or not (0).
Parameters
| Param | Values | Note |
|---|---|---|
| License Type | Values loaded from database | The type of license to retrieve. |
| Target Type | [System, Client, Location, Computer] | The target of license. |
| Target Id | User Provided | The target Id of the license, if known, otherwise 0. |
Example Function Text
Retrieve License into %obtainedlicense% with an ID of %obtainedlicenseid%
Runs a Plugin Alert from a script, returns the results to %pluginalertresult%. This command is used to run plugins from scripts, this is very advanced and parameters are determined by the plugin.
Parameters
| Param | Values | Note |
|---|---|---|
| Plugin Alert ID | User Provided | undefined |
| ClientID | User Provided | undefined |
| ComputerID | User Provided | undefined |
| Message | User Provided | undefined |
| Agent Name | User Provided | undefined |
Example Function Text
Raise Plugin alert for: @PLUGINALERTID@
Control the probe by sending commands to the current computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Control Command | [Reattempt Push, Reinventory Devices, Rescan Network] | The Command to send to the Probe. |
Example Function Text
Probe Control - Reattempt Push
Probe Control - Reinventory Devices
Probe Control - Rescan Network
Send a Preformatted message to the User.
Parameters
| Param | Values | Note |
|---|---|---|
| Message | Values loaded from database | The Message to use. |
| Computer ID | User Provided | ID of computer to send message to. |
| Parameters to Pass to the Script | User Provided | Extra Parameters to REPLACE with this script |
Example Function Text
Send Message MessageId 1 To ComputerId @computerid@
Deletes the Alert with the specific ID.
Parameters
| Param | Values | Note |
|---|---|---|
| AlertID | User Provided | The ID of the Alert to delete. |
Example Function Text
LTServer delete alert: @ALERTID@
Call an alert template and perform the actions defined.
Parameters
| Param | Values | Note |
|---|---|---|
| Alert Message | User Provided | The Alert Message, can be blank. |
| Failed | [False, True] | Is this a Failure? |
| Agent ID | User Provided | A Number used to track this alert from others. |
| Agent Name | User Provided | A Name used to track this from others |
| Alert Template | User Provided | The Enter TemplateID to use. |
Example Function Text
LabTech Server Call Alert Template: @ALERTTEMPLATE@
Create an alert, to create a system alert set Computer ID to 0. Returns %AlertID% with the ID of the alert created.
Parameters
| Param | Values | Note |
|---|---|---|
| Computer ID | User Provided | The computer ID to link the alert to, for computer scripts use @computerid@. |
| Severity | [Informational, Warning, Error, Critical] | The severity of the alert. |
| Body | User Provided | Body of the message. |
| Subject | User Provided | Subject or Source of the Alert. |
Example Function Text
Create Informational Alert: @SUBJECT@
Create Warning Alert: @SUBJECT@
Create Error Alert: @SUBJECT@
Create Critical Alert: @SUBJECT@
Runs a program on the LabTech Server. Must not show windows or require any user action.
Parameters
| Param | Values | Note |
|---|---|---|
| Program Path | User Provided | Path to program to run. |
| Arguments | User Provided | Parameters to pass to the program. |
Example Function Text
Run on the Labtech Server: @PROGRAMPATH@ @ARGUMENTS@
Send a NetBIOS message from the LabTech Server.
Parameters
| Param | Values | Note |
|---|---|---|
| NetBios Name | User Provided | The computer or user to send the message to. |
| Message | User Provided | The message to send. |
Example Function Text
Send NetBios Message from the Labtech Server to @NETBIOSNAME@
Send Pager message from the LabTech Server.
Parameters
| Param | Values | Note |
|---|---|---|
| Phone Number | User Provided | The exact number to dial. |
| Message | User Provided | Numeric message to send. |
Example Function Text
Make Page Call to @PHONENUMBER@
Record Stat to the Extra stats to be used with reporting.
Parameters
| Param | Values | Note |
|---|---|---|
| Stat Number | [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20] | Over 10 can be Strings |
| Value | User Provided | The Value to Save as a stat |
| Computer ID | User Provided | The Computer ID |
Example Function Text
Record Stat #1 AS @VALUE@ For @computerid@
Send a fax from the LabTech Server.
Parameters
| Param | Values | Note |
|---|---|---|
| Phone Number | User Provided | The Exact number to dial. |
| Message | User Provided | Message to fax. |
Example Function Text
Make Fax Call to @PHONENUMBER@
Executes a shell command on the LabTech server and returns the results to %shellresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Command interpreter to use (e.g. cmd.exe) without parameters |
| Arguments | User Provided | Parameters to pass to the executable. |
Example Function Text
LabTech Server Shell Execute: @COMMAND@ @ARGUMENTS@
Place Voice call from the LabTech Server.
Parameters
| Param | Values | Note |
|---|---|---|
| Phone Number | User Provided | The exact number to dial. |
| Message | User Provided | The message to read over the phone. |
Example Function Text
Make Voice Call to @PHONENUMBER@
Write to a file on the LabTech Server.
Parameters
| Param | Values | Note |
|---|---|---|
| File Name | User Provided | Full path to the file. |
| Message | User Provided | The text data to write to the file. |
Example Function Text
LTServer Write @MESSAGE@ to @FILENAME@
Clears Maintenance mode for the selected computer.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | undefined |
Example Function Text
Clear Maintenance Mode for @computerid@
Sets Maintenance mode for the selected computer.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | The Computer to Set |
| Duration | User Provided | Time in Minutes. |
Example Function Text
Set Maintenance Mode for @DURATION@ Minutes on @computerid@
Go to different labels depending on the given value.
Parameters
| Param | Values | Note |
|---|---|---|
| Value | User Provided | Variable name or value to match. |
| Match Definition | User Provided | Comma separated list of value/label pairs. Example: (1,:StartProc),(2,:EndProc),(:DefaultLabel) |
Example Function Text
MatchGoto: @MATCH@
Performs a DNS Lookup on the remote computer and saves the result to %dnsresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Host Name | User Provided | The hostname or IP Address. |
Example Function Text
Nslookup @HOSTNAME@ storing the result in %dnsresult%
Connects to Internet Protocol port and reads characters into %portresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Type | [TCP, UDP] | Select the protocol to use. |
| Host name | User Provided | The hostname or IP Address. |
| Port | User Provided | The port number to connect to. |
| Data | User Provided | Data to send after connect, leave blank for none. |
| Receive Bytes | User Provided | Number of bytes to receive, enter 0 for listen test. |
Example Function Text
Connect to @HOSTNAME@ TCP storing the result in %portresult%
Connect to @HOSTNAME@ UDP storing the result in %portresult%
Gets a SNMP Object Identifier and saves it to %snmpresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Host Name | User Provided | The hostname or IP Address. |
| Community | User Provided | The community string to use. |
| OID | User Provided | Numeric Object Identifier. |
Example Function Text
Get SNMP @OID@ from @HOSTNAME@ storing it in %snmpresult%
Returns the IPConfig information and saves it to %ipconfigresult%.
Parameters
| Param | Values | Note |
|---|
Example Function Text
IPConfig and store the result in %ipconfigresult%
Ping a hostname and save the result in %pingresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Host name | User Provided | The hostname or IP Address. |
Example Function Text
Pinging @HOSTNAME@ storing the result in %pingresult%
Renews the remote computers IP address.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Renew IP Address
Set a SNMP OID to a value.
Parameters
| Param | Values | Note |
|---|---|---|
| Host Name | User Provided | The IP or DNS name. |
| Community | User Provided | The Community of the device. |
| OID | User Provided | The numeric OID to set. |
| Value | User Provided | The value to set the OID to. |
Example Function Text
Set SNMP OID @OID@ to @VALUE@ for @HOSTNAME@ using community @COMMUNITY@
Send a local TFTP File to a machine.
Parameters
| Param | Values | Note |
|---|---|---|
| File name | User Provided | The file must exist in the %Windir%\ltsvc\TFTP directory, without quotes. |
| Server Address | User Provided | The hostname or IP Address. |
Example Function Text
TFTP Send file @FILENAME@ to @SERVERADDRESS@ storing the result in %tftpresult%
Send wake on Lan packet from the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| MAC | User Provided | MAC address of target computer, use : to separate VALUES . |
Example Function Text
Wake on LAN sent to @ComputerID@
Wake on LAN sent to @MACADDRESS@
Performs LabTech offline backup, using template or global settings.
Parameters
| Param | Values | Note |
|---|---|---|
| FTP Directory | User Provided | Initial Directory on FTP Server. |
| File Password | User Provided | Password for the zip archive. |
| File Size | User Provided | Maximum file size. |
| File Path | User Provided | Full path to backup, disables my doc backup. |
| File Filter | User Provided | File filter for my documents backup. |
Example Function Text
Perform Offline Backup and store the result in %backupsize%
Approve all Security Patches for the group selected.
Parameters
| Param | Values | Note |
|---|---|---|
| Group Name | Values loaded from database | Name of group to approve patches to. |
Example Function Text
Approve All Hotfixes for GroupId: 1045
Install a Patch on the current computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Patch ID | Values loaded from database | The Patch to install. |
Example Function Text
HotFix Install: HotFixId 5c9e30a9-9015-44a4-9be9-94d6b8fac949
Deploy Windows Updates to the current computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Action | [All Missing Patches, Missing Security Patches, Missing Approved Patches] | Action to perform. |
| Script ID | User Provided | Script to run on completion of patch install. |
Example Function Text
HotFix Install: All Missing Patches
HotFix Install: All Missing Security Patches
HotFix Install: All Missing Approved Patches
Read Performance Counter and save result to variable. Use performance monitor to obtain category and counter names.
Parameters
| Param | Values | Note |
|---|---|---|
| Category | User Provided | Performance Counter Category |
| Counter | User Provided | Performance Counter |
| Instance | User Provided | Performance Counter Instance, if there are multiple instances one must be specified. |
| Result Variable | User Provided | Save results to this variable, without @ signs. |
Example Function Text
Read Performance Counter: @CATEGORY@\@COUNTER@\@INSTANCE@ and save result to @RESULTSVAR@
Play a sound file on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Wave File | User Provided | The full path to the wave file. |
Example Function Text
Play Wave @WAVEFILE@
Executes an Agent Plugin Command and returns the results to %PluginCommandResults%.
Parameters
| Param | Values | Note |
|---|---|---|
| Command ID | User Provided | The Command to Execute |
| Parameters | User Provided | undefined |
Example Function Text
Plugin Command PluginId: 1049 Params: @PARAMETERS@
Plugin Command PluginId: 1049 Params:
Executes a Plugin Function and returns the results to %PluginResults%.
Parameters
| Param | Values | Note |
|---|---|---|
| Function Guid | User Provided | The Function to Execute |
| Parameter1 | User Provided | undefined |
| Parameter2 | User Provided | undefined |
| Parameters3 | User Provided | undefined |
| Parameters4 | User Provided | undefined |
Example Function Text
Plugin Function PluginId: ec90525e-9d73-11e4-bf92-005056844d96
Execute powershell command using PS.exe to run them and store the result in %powershellresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
Example Function Text
PowerShell: @COMMAND@ and store the result in %powershellresult%
Execute powershell command using PS.exe to run them and store the result in %powershellresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
Example Function Text
PowerShell as Admin: @COMMAND@
Clear the printer queue.
Parameters
| Param | Values | Note |
|---|---|---|
| Printer Name | User Provided | Lookup the exact name of the printer in LabTech. |
Example Function Text
Clear Printer Queue: @PRINTERNAME@
Set the default printer on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Printer Name | User Provided | Lookup the exact name of the printer in LabTech. |
Example Function Text
Set Default Printer: @PRINTERNAME@
Run program in the background on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File | User Provided | Full path to executable. |
| Arguments | User Provided | Parameters to pass to the executable. |
| [Wait for Process, Return Immediately] | Wait for process to end before returning. |
Example Function Text
Execute: @FILEPATH@ @ARGUMENTS@ and wait until finish, store the result in %executeresult%
Execute: @FILEPATH@ @ARGUMENTS@ and return immediately.
Run program in the background as the administrator account defined for this location on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| File | User Provided | Full path to executable. |
| Arguments | User Provided | Parameters to pass to the executable. |
| [Wait for Process, Return Immediatly] | Wait for process to end before returning. |
Example Function Text
Execute as Admin: @FILE@ @ARGUMENTS@ and wait until finish, store the result in %executeresult%
Execute as Admin: @FILE@ @ARGUMENTS@ and return immediately.
Run program in the background as the username specified below.
Parameters
| Param | Values | Note |
|---|---|---|
| File | User Provided | Full path to executable. |
| Arguments | User Provided | Parameters to pass to the executable. |
| [Wait for Process, Return Immediatly] | Wait for process to end before returning. | |
| Username | User Provided | The username to run this process as. |
| Password | User Provided | The password used with this username. |
Example Function Text
Execute as @USERNAME@: @FILE@ @ARGUMENTS@ and wait until finish, store the result in %executeresult%
Execute as @USERNAME@: @FILE@ @ARGUMENTS@ and return immediately.
End process on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Process Name | User Provided | The process name or number to end. |
Example Function Text
Terminate Process: @PROCESSNAME@
Issues a reboot command to the computer that bypasses all user prompting and template settings. The command gives the user 30 seconds to abort and then restarts the computer forcing any hung applications to close.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Reboot forced
Reboots the computer to Safemode with only a command prompt as the shell. This command returns immediately.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Reboot to Cmd Prompt
Reboots the computer to Safemode. This command returns immediately.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Reboot to Safemode
Deletes a registry key or value.
Parameters
| Param | Values | Note |
|---|---|---|
| Registry Key | User Provided | The Key or value to be deleted |
Example Function Text
Delete: [REGISTRY @REGISTRYKEY@]
Write a Registry Value
Parameters
| Param | Values | Note |
|---|---|---|
| Registry Value | User Provided | The Registry Key to write to |
| Data | User Provided | The data to write. |
| Data Type | [Reg_String, Reg_Binary, Reg_DWORD, Reg_Multi_String, Reg_QWORD, Reg_Ex_String] | The type of data to write. |
Example Function Text
SET: @REGISTRYKEY@ = @DATA@
Email Report as PDF attachment.
Parameters
| Param | Values | Note |
|---|---|---|
| Report | Values loaded from database | The report to run. |
| User Provided | Email address to send report to. | |
| Selection | User Provided | The Crystal Reports selection string to limit the results. |
| Subject | User Provided | The Subject of the Email |
| Message | User Provided | The Body of the message as the report will be a PDF attachment. |
Example Function Text
Email: Agent_Status Report TO: @EMAIL@
Print Report to printer.
Parameters
| Param | Values | Note |
|---|---|---|
| Report | Values loaded from database | The report to run. |
| Printer | User Provided | The name of the printer to print to, leave blank for default printer. |
| Selection | User Provided | The Crystal Reports selection string to limit the results. |
Example Function Text
Print: Agent_Status Report on the Labtech Servers Default Printer
Print: Agent_Status Report on the Labtech Servers Default Printer
Send Autostartup Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Autostartup List
Update the Templates and Config now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Config
Send Disk Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Drive Info
Send the Remote Monitors Error logs from LTErrors.txt.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Error Logs
Send Event Log Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend EventLogs
Send all information now. Script will wait until last command is completed.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Everything
Send Hardware Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Hardware
Send Network Inventory Information now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Network information
Send Patch Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Patch information
Send Printer Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Printers
Send Process Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Process List
Send Service Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Service List
Send Software Inventory now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend Software
Send Virus Scanner, Shadowprotect and Other Inventory Information now.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Resend System Information
Jumps to a label and returns
Parameters
| Param | Values | Note |
|---|---|---|
| Label | User Provided | Label to jump to, you can return to this position with a script return function. |
Example Function Text
Call: :Label
Exits the script and sets the failure status in the logs, All normal script exits and ends exit with success status.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Script Exit with Error
Function Script Exit with Error
Run a script with each variable in comma separated list.
Parameters
| Param | Values | Note |
|---|---|---|
| Script To Run | Values loaded from database | Execute this script on each variable in the list. |
| List | User Provided | The comma separated list |
| Variable | User Provided | The variable to set with the value obtained from the list. |
Example Function Text
FOR each @VARNAME@ in @LIST@ run script c7a65c93-eadc-11e1-bca6-7ec667b1402e
Performs a SQL Query and runs a script for each row returned setting all returned columns to internal variables like this %sqlCOLUMNNAME%.
Parameters
| Param | Values | Note |
|---|---|---|
| SQL | User Provided | The SQL Query to execute. |
| Script To Run | Values loaded from database | Choose the script to run on each row. |
| ODBC Connection | User Provided | Leave blank to use the LabTech database. |
Example Function Text
FOR each row in @SQL@ run script c7a65c93-eadc-11e1-bca6-7ec667b1402e
Jumps to label or skips steps either forward or back.
Parameters
| Param | Values | Note |
|---|---|---|
| Label to Jump to or Steps to Skip | User Provided | Enter Zero to Exit the Script. |
Example Function Text
Exit Script
GOTO: line 307
GOTO: :Label
Writes an informational entry to the script log.
Parameters
| Param | Values | Note |
|---|---|---|
| Message | User Provided | Message to write to the script log. |
Example Function Text
LOG: @MESSAGE@
Performs specified math function on the values and stores the result in %MathResult% as well as the specified script variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Value | User Provided | First numeric value to use. |
| Operator | [+, -, *, , div, mod, pow, abs, max, min] | Operation to perform. |
| Value | User Provided | ABS does not need a second value. |
| Variable | User Provided | Enter the variable name without the @ symbols around it. |
Example Function Text
SET: @RESULTSVAR@ = @VALUE@ + @VALUE@
SET: @RESULTSVAR@ = @VALUE@ - @VALUE@
SET: @RESULTSVAR@ = @VALUE@ * @VALUE@
SET: @RESULTSVAR@ = @VALUE@ \ @VALUE@
SET: @RESULTSVAR@ = @VALUE@ DIV @VALUE@
SET: @RESULTSVAR@ = @VALUE@ MOD @VALUE@
SET: @RESULTSVAR@ = @VALUE@ POWER OF @VALUE@
SET: @RESULTSVAR@ = @VALUE@ ABS(@VALUE@)
SET: @RESULTSVAR@ = @VALUE@ MAX(@VALUE@, @VALUE@)
SET: @RESULTSVAR@ = @VALUE@ MIN(@VALUE@, @VALUE@)
Adds a remark to the script and will not be executed.
Parameters
| Param | Values | Note |
|---|---|---|
| Remark | User Provided | Remark to be added to script, use : at start to specify a label. |
Example Function Text
Note: NOTE TEXT @NOTETEXT@
:CustomLabel - Label
Performs regular expression parsing for the given value and stores the result in %RegEXResult% and the named variable, use VBScript/VB.net syntax.
Parameters
| Param | Values | Note |
|---|---|---|
| Value | User Provided | The value to test. |
| Pattern | User Provided | The expression to use, if groups are defined the first group is returned. |
| Variable | User Provided | Enter the variable name without the @ symbols around it. |
Example Function Text
SET: @RESULTSVAR@ = MATCH(@VALUE@ PATTERN @PATTERN@)
Returns to the last script call function executed.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Return from Call
Start a new script, all variables are passed to new script. If script fails then step will fail.
Parameters
| Param | Values | Note |
|---|---|---|
| Script ID | Values loaded from database | Choose script to run. |
| Delay | User Provided | Leave blank or enter zero to run script as procedure, otherwise script will be scheduled to run the number of minutes entered. |
Example Function Text
Run Script: c7a65c93-eadc-11e1-bca6-7ec667b1402e in Minutes: @DELAY@
Run Script: c7a65c93-eadc-11e1-bca6-7ec667b1402e
Pause the script and wait a number of seconds.
Parameters
| Param | Values | Note |
|---|---|---|
| Seconds | User Provided | Number of seconds to wait. |
Example Function Text
Sleep: 123 seconds
Clear the script state variable for this script.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | Computer to clear the state on, use @computerid@ on computer scripts. |
Example Function Text
Clear Script State for: @computerid@
Load a variable from the script state.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | Computer to load state for, use @computerid@ on computer scripts. |
| Name | User Provided | Name of the variable to load or leave empty to load all script variables. |
| Variable | User Provided | Save results to this variable, without @ signs. Ignored when loading all variables. |
Example Function Text
GET: VARIABLE = ALL State Variables for computer @computerid@
Save a variable to the script state to use later. Script state is unique for every script and computer.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | Computer to save state for, use @computerid@ on computer scripts. |
| Name | User Provided | Name of the variable to save or leave empty to save all script variables. |
| Value | User Provided | Value to save to the variable. |
Example Function Text
SET: [ALL STATE Variables] = @VALUE@ for computer @computerid@
Clear the script stats for this computer. Stats can be used to track counts of actions performed.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | Computer to load stat for, use @computerid@ on computer scripts. |
| Name | User Provided | Name of the stat to clear, leave blank to clear all stats. |
Example Function Text
Clear Script Stat: @NAME@ for: @computerid@
Get the scripts stat counter for this computer.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | Computer to load state for, use @computerid@ on computer scripts. |
| Name | User Provided | Name of the variable to load. |
| Variable | User Provided | Save results to this variable, without @ signs. |
Example Function Text
SET: @VALUE@ = Script Stat (@NAME@)
Adds 1 to the script stat counter for the computer specified.
Parameters
| Param | Values | Note |
|---|---|---|
| ComputerID | User Provided | Computer to save stat for, use @computerid@ on computer scripts. |
| Name | User Provided | Name of the stat to save. |
Example Function Text
SET: [STAT @NAME@] = [STAT @NAME@]+1 for computer @computerid@
Perform operations on a String and return the results to %stringresult% and the variable named.
Parameters
| Param | Values | Note |
|---|---|---|
| Operation | [Left, Right, Middle, Upper Case, Lower Case, Reverse, Trim Spaces, Find String, Last Find String, Replace, Insert, URL Encode, URL Decode, HTML Encode, HTML Decode, MYSQL Encode, Encrypt, Decrypt, LabTech Pipe Encode, LabTech Pipe Decode, Encrypt Version Two, Decrypt Version Two, Split] | Operation to perform. |
| Original String | User Provided | The string to perform the operation on. |
| Length | User Provided | Length of operation or string to use for replace,insert,find and last find,Delimiter for the split. |
| Start Position | User Provided | Where to start operation from, or string to find for replace, or Position to return for split. |
| Variable | User Provided | Enter the variable name without the @. |
Example Function Text
SET: @RESULTSVAR@ = LEFT(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = RIGHT(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = MID(@ORIGINALSTRING@,@START@,@LENGTH@)
SET: @RESULTSVAR@ = UPPER(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = LOWER(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = REVERSE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = TRIMSPACE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = INDEXOF(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = LASTINDEXOF(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = REPLACE(@ORIGINALSTRING@,@START@,@LENGTH@)
SET: @RESULTSVAR@ = INSERT(@ORIGINALSTRING@,@LENGTH@,@START@)
SET: @RESULTSVAR@ = URLENCODE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = URLDECODE(@ORIGINALSTRING@,)
SET: @RESULTSVAR@ = HTMLENCODE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = HTMLDECODE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = MYSQLENCODE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = ENCRYPT(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = DECRYPT(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = LTPIPEENCODE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = LTPIPEDECODE(@ORIGINALSTRING@)
SET: @RESULTSVAR@ = ENCRYPTv2(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = DECRYPTv2(@ORIGINALSTRING@,@LENGTH@)
SET: @RESULTSVAR@ = SPLIT(@ORIGINALSTRING@,@LENGTH@,@START@)
Start a windows service.
Parameters
| Param | Values | Note |
|---|---|---|
| Service Name | User Provided | The name of the service. |
Example Function Text
Start Service: @SERVICENAME@
Set the Service startup mode.
Parameters
| Param | Values | Note |
|---|---|---|
| Service Name | User Provided | The service name. |
| Mode | [AutoStart, Manual, Disabled] | The startup mode to set. |
Example Function Text
Set Service: @SERVICENAME@ to AutoStart
Set Service: @SERVICENAME@ to Manual
Set Service: @SERVICENAME@ to Disabled
Stop a windows service.
Parameters
| Param | Values | Note |
|---|---|---|
| Service Name | User Provided | The name of the service. |
Example Function Text
Stop Service: @SERVICENAME@
Share a Folder on the remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Directory Path | User Provided | Full path to the directory to share. |
| Share Name | User Provided | Name of Share. |
Example Function Text
Share Folder: @DIRECTORYPATH@ as @SHARENAME@
Delete Share on remote computer.
Parameters
| Param | Values | Note |
|---|---|---|
| Share Name | User Provided | Name of Share. |
Example Function Text
Stop Sharing Folder: @SHARENAME@
Execute shell commands in the background, using CMD.exe to run them.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
Example Function Text
Shell: @SHELLCOMMAND@ and store the result in %shellresult%
Execute shell commands as the administrator account defined for this location, using CMD.exe to run them.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
Example Function Text
Shell as Admin: @COMMAND@ and store the result in %shellresult%
Execute shell commands as the username specified below, using CMD.exe to run them.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
| Username | User Provided | The username to run this process as. |
| Password | User Provided | The password used with this username. |
Example Function Text
Shell as @USERNAME@: @COMMAND@ and store the result in %shellresult%
Execute shell commands in the background, using CMD.exe to run them.
Parameters
| Param | Values | Note |
|---|---|---|
| Command | User Provided | Commands to execute |
| Delimiter | User Provided | Used to split the variable list and the results returned by the shell command |
| Variable List | User Provided | List of Variable to be set from the resulting shell command |
Example Function Text
Shell: @INPUTPARAMETER@ split result by @DELIMITER@ and save results to @VARIABLELIST@
Run a SQL statement.
Parameters
| Param | Values | Note |
|---|---|---|
| SQL Statement | User Provided | The SQL statement to run. |
| ODBC Connection | User Provided | Leave blank to use the LabTech Database. |
Example Function Text
SQL EXECUTE: @SQLSTATEMENT@
Gets the row of the DataSet (starting at row 1), and stores the value of each column in a variable referenced by the column name like @sqlCOLUMNNAME@.
Parameters
| Param | Values | Note |
|---|---|---|
| SQL DataSet | User Provided | The DataSet to pull information from, use sqldataset without % signs. |
| Row To Fetch | User Provided | Which row of the dataset to use. |
Example Function Text
Fetch row: @ROWS@ from dataset: @SQLDATASET@
Gets the results of the query, and stores in %sqldataset% variable to be used by the Fetch Dataset Row function. Number of rows is stored in %sqldatasetrowcount%.
Parameters
| Param | Values | Note |
|---|---|---|
| SQL Query | User Provided | The SQL Statement to execute. |
| ODBC Connection | User Provided | Leave blank to use the LabTech database. |
Example Function Text
SET: %sqldataset% = SQL Get DataSet: @SQLQUERY@
Gets the first Column of the first Row returned by the query and saves it in %sqlresult%.
Parameters
| Param | Values | Note |
|---|---|---|
| SQL Query | User Provided | The SQL Statement to execute. |
| ODBC Connection | User Provided | Leave blank to use the LabTech database. |
Example Function Text
SET: %sqlresult% = [@SQLQUERY@]
Close an existing SSH session. The response is stored in %sshresult% and the success state in %sshsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| SSH Session ID | User Provided | Session ID of the open SSH connection. |
Example Function Text
Close SSH Session ID: %sshsessionid%
Establishes a connection to a device using the SSH protocol and stores the session ID in %sshsessionid%. The response is stored in %sshresult% and the success state in %sshsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| Hostname | User Provided | Hostname or IP address of the device. |
| Port | User Provided | Port to use. |
| Timeout | User Provided | Timeout period (minutes). |
| Username | User Provided | SSH Username. |
| Password | User Provided | SSH Password. |
Example Function Text
Open SSH To: "@HOSTNAME@", Port: 22, Timeout: 15
Send unencrypted data to a device that has an open SSH connection. The response is stored in %sshresult% and the success state in %sshsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| SSH Session ID | User Provided | Session ID of the open SSH connection. |
| Text To Send | User Provided | Text to send to the device. |
Example Function Text
SSH Send: @TEXT@ unencrypted to SSH session ID: %sshsessionid%
Send encrypted data to a device that has an open SSH connection. The response is stored in %sshresult% and the success state in %sshsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| SSH Session ID | User Provided | Session ID of the open SSH connection. |
| Text To Send | User Provided | Text to send to the device. |
Example Function Text
SSH Send: @TEXT@ encrypted to SSH session ID: %sshsessionid%
Suspends the computer if it supports this function. This command returns immediately.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Suspend
Close an existing Telnet session. The response is stored in %telnetresult% and the success state in %telnetsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| Telnet Session ID | User Provided | Session ID of the open Telnet connection. |
Example Function Text
Close Telnet session ID: %telnetsessionid%
Establishes a connection to a device using the Telnet protocol and stores the session ID in %telnetsessionid%. The response is stored in %telnetresult% and the success state in %telnetsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| Hostname | User Provided | Hostname or IP address of the device. |
| Port | User Provided | Port to use. |
| Timeout | User Provided | Timeout period (minutes). |
Example Function Text
Open Telnet To: "@HOSTNAME@", Port: 23, Timeout: 15
Send unencrypted data to a device that has an open Telnet connection. The response is stored in %telnetresult% and the success state in %telnetsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| Telnet Session ID | User Provided | Session ID of the open Telnet connection. |
| Text To Send | User Provided | Text to send to the device. |
Example Function Text
Telnet Send To: @TEXT@ unencrypted to Telnet session ID: %telnetsessionid%
Send encrypted data to a device that has an open Telnet connection. The response is stored in %telnetresult% and the success state in %telnetsuccess%.
Parameters
| Param | Values | Note |
|---|---|---|
| Telnet Session ID | User Provided | Session ID of the open Telnet connection. |
| Text To Send | User Provided | Text to send to the device. |
Example Function Text
Telnet Send To: @TEXT@ encrypted to Telnet session ID: %telnetsessionid%
Read a Template Property and save it to a variable. %templatepropertyfound% indicates whether property found (1) or not (0).
Parameters
| Param | Values | Note |
|---|---|---|
| Property Name | Values loaded from database | The name of property to retrieve. |
| Variable | User Provided | Put the results in this variable, without the @ signs. |
| Default Value | User Provided | Default value to use if variable not found. |
Example Function Text
SET: @VARIABLE@ = TemplateProperty(@PROPERTYNAME@)
Add Time to Ticket as User.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket to add time to. |
| User ID | Values loaded from database | ID Number of the user to perform the Comment or type a Variable name |
| Body | User Provided | The Message to include as the Body. |
| Time | User Provided | Number of Minutes to Add. |
| Time Category ID | User Provided | ID Number of the Time Category to add. |
Example Function Text
Add @TIME@ Minutes to Ticket #@TICKETID@
Assign Ticket to specified user.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | ID of Ticket to Assign. |
| User | Values loaded from database | User to Assign the ticket to or type a Variable name. |
Example Function Text
Assign Ticket @TICKETID@ to user 1
Attach File to an Existing Ticket.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket To Attach to |
| User ID | Values loaded from database | The user to perform the Attach or type a Variable name |
| Body | User Provided | The Message to include as the Body. |
| File Path | User Provided | Local path on Server to file to attach. |
Example Function Text
Attach File: @FILEPATH@ to ticket #@TICKETID@
Combine Ticket into master ticket.
Parameters
| Param | Values | Note |
|---|---|---|
| Master Ticket | User Provided | The Ticket to keep |
| Combined Ticket | User Provided | The Ticket to get rid of |
Example Function Text
Combine Ticket: @COMBINEDVAR@ into @MASTERTICKET@
Comment on Ticket as User.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket To Comment on |
| User ID | Values loaded from database | ID Number of the user to perform the Comment or type a Variable name |
| Body | User Provided | The Message to include as the Body. |
| Respond | [Yes, No] | Send an Email to the Requestor |
Example Function Text
Comment Ticket: @TICKETID@ to user 1
Create a new support ticket and saves the ticket ID to %ticketid%.
Parameters
| Param | Values | Note |
|---|---|---|
| Client ID | User Provided | Client Id to link ticket to. |
| Computer ID | User Provided | Computer ID to link the ticket to. |
| User Provided | Email address of ticket requestor. | |
| Subject | User Provided | Subject of the ticket. |
| Body | User Provided | The Message to include as the Body. |
Example Function Text
Create New Ticket for %clientid%\%computerid% Email: @EMAIL@ Subject: @SUBJECT@
Elevate the selected ticket to the next level.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | The Ticket ID to Elevate. |
Example Function Text
Elevate Ticket #@TICKETID@
Finish Ticket as User.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket To Finish |
| User ID | Values loaded from database | ID Number of the user to perform the Finish or type a Variable name |
| Body | User Provided | The Message to include as the Body. |
Example Function Text
Finish Ticket: @TICKETID@ to 1
Open Ticket as User.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket To Open |
| User ID | Values loaded from database | ID Number of the user to perform the Open or type a Variable name |
| Comment | User Provided | The comment to include in the summary. |
Example Function Text
Open Ticket: @TICKETID@ to user 1
Create a Ticket Reading View and Save it to %ticketreadingview%.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | The ID of the Ticket to use |
| Newest on Top | [Yes, No] | List Items starting with the newest. |
| HTML | [Yes, No] | Use HTML for message. |
| For Customer | [Yes, No] | Hide internal Ticketing information. |
Example Function Text
SET: %ticketreadingview% = TicketReadingView(#@TICKETID@)
Stall or Unstall Ticket.
Parameters
| Param | Values | Note |
|---|---|---|
| Ticket ID | User Provided | Ticket ID To Stall |
| Action | [Stall, Unstall] | Stall Or Unstall Ticket |
| Date To Unstall | User Provided | If Stalling Ticket, unstall on this date (YYYY-MM-DD HH:MM:SS) |
Example Function Text
Stall Ticket: @TICKETID@
Unstall Ticket: @TICKETID@
Update Ticket information.
Parameters
| Param | Values | Note |
|---|---|---|
| Requestor Email | User Provided | Leave blank to keep existing. |
| Priority | User Provided | Leave blank to keep existing. |
| Subject | User Provided | Leave blank to keep existing. |
| Category ID | User Provided | Leave blank to keep existing. |
| Ticket ID | User Provided | ID of ticket to Update. |
Example Function Text
Update Ticket #@TICKETID@ set Email=@REQUESTOREMAIL@ Priority=@PRIORITY@ Subject=@SUBJECT@ Category=@CATEGORYID@
Install or remove a Tool\Tweak.
Parameters
| Param | Values | Note |
|---|---|---|
| Action | [Install, Remove] | Install or Remove. |
| Tool ID | Values loaded from database | Name of Tool to perform action to. |
Example Function Text
Tool Install: AppID=
Tool Remove: AppID=@INPUTPARAMETER@
Compares a variable to the specified data and skips if the result is TRUE.
Parameters
| Param | Values | Note |
|---|---|---|
| Variable Name | User Provided | Enter variable name without % or @. Script will attempt to use %variablename%, if no match is found it will attempt to use @variablename@. |
| Compare | [Exists, Not Exists, =, Not =, <, <=, >, >=, Contains, Not Contains, In, Not In] | Logical Operator. |
| To | User Provided | Value to compare to. |
| Label to Jump to or Steps to Skip | User Provided | Label to jump to or the number of steps to skip when the result is true, zero to exit script. |
Example Function Text
IF VARIABLENAME@ < @COMPAREVALUE@ THEN Jump to line 142
IF @VARIABLENAME@ = @COMPAREVAR@ THEN Jump to :Label
IF @VARIABLENAME@ Contains @COMPAREVAR@ THEN Jump to :Label
IF @VARIABLENAME@ Not Contains @COMPAREVAR@ THEN Jump to :Label
IF @VARIABLENAME@ In @COMPAREVAR@ THEN Jump to :Label
IF @VARIABLENAME@ Not In @COMPAREVAR@ THEN Jump to :Label
Runs the THEN if the condition is true.
Parameters
| Param | Values | Note |
|---|---|---|
| Test the Variable's value | User Provided | Enter Variable Name with the @ symbols around it. |
| Compare | [Exists, Not Exists, =, Not =, <, <=, >, >=, Contains, Not Contains, In, Not In] | Exists is true if anything is returned. |
| To | User Provided | Value to compare to. |
Example Function Text
If Variable Check
Set a script variable.
Parameters
| Param | Values | Note |
|---|---|---|
| Set Type | [Registry, Constant, Current ComputerID, Current ClientID, Current LocationID, Current Console Number, Temp Directory, File Contents, File Date, File Version, File Size, SQL Query, All Local Variables, Properties, Reload Computer Variables, Split NameValue Parameter, Get Virus Scanner Variables, Expand on Agent, File MD5 Hash] | What type of value to use, some require parameters |
| Parameter | User Provided | Enter required parameters |
| Variable Name | User Provided | Name of variable to set, use @variablename@ in future parameters. |
Example Function Text
SET: @VARNAME@ = REGISTRY[@INPUTPARAMETER@]
SET: @VARNAME@ = @INPUTPARAMETER@
SET: @VARNAME@ = %computerid%
SET: @VARNAME@ = %clientid%
SET: @VARNAME@ = %locationid%
SET: @VARNAME@ = %consolenumber%
SET: @VARNAME@ = [Temporary Directory]
SET: @VARNAME@ = FILECONTENTS[@INPUTPARAMETER@]
SET: @VARNAME@ = FILEWRITEDATE[@INPUTPARAMETER@]
SET: @VARNAME@ = FILEVERSION[@INPUTPARAMETER@]
SET: @VARNAME@ = FILESIZE[@INPUTPARAMETER@]
SET: @VARNAME@ = SQLRESULT[@INPUTPARAMETER@]
SET: @VARNAME@ = [ALL LOCAL VARIABLES]
SET: @VARNAME@ = PROPERTY[@INPUTPARAMETER@]
SET: [RELOAD INTERNAL VARIABLES]
SET: Variables from Splitting @INPUTPARAMETER@
SET: Virus Scanner Variables for scanner #@INPUTPARAMETER@
SET: @VARNAME@ = AgentExpand[@INPUTPARAMETER@]
SET: @VARNAME@ = MD5[@INPUTPARAMETER@]
Run a Virus Scanner Update on the target computer if the computer has a scanner installed with this ability. The command will fail if no scanner is detected.
Parameters
| Param | Values | Note |
|---|
Example Function Text
Function Virus Definition Update
Run a Virus scan on the target computer if the computer has a scanner installed with this ability. The command will fail if no scanner is detected.
Parameters
| Param | Values | Note |
|---|---|---|
| Path | User Provided | The full path to scan. |
Example Function Text
Virus Scan: @PATH@
Set the Windows Update Agents settings.
Parameters
| Param | Values | Note |
|---|---|---|
| Action | [Restore Defaults, Set WSUS Server, Force Windows Update, Windows Update Download Only, Enable Windows Update at Time, Disable Windows Update, Disable Access to Windows Update, Set LabTech Mode, Install WUA Agent] | Action to perform. |
| WSUS or Time: | User Provided | Enter Time as Day:Time |
Example Function Text
Windows Update Setting Restore Defaults to: @WSUS@
Windows Update Setting Set WSUS Server to: @WSUS@
Windows Update Setting Force Windows Update to: @WSUS@
Windows Update Setting Windows Update Download Only to: @WSUS@
Windows Update Setting Enable Windows Update at Time to: @WSUS@
Windows Update Setting Disable Windows Update to: @WSUS@
Windows Update Setting Disable Access to Windows Update to: @WSUS@
Windows Update Setting Set LabTech Mode to: @WSUS@
Windows Update Setting Install WUA Agent to: @WSUS@