This article provides information on how to use the out-of-the-box task library components within MSPComplete
Tasks
Copy Files To Remote Machines
Copies files onto remote machines.
The file can be located in:
- The automation server (this machine)
- A network file server
- A web URL
For this task to be able to copy the file to the remote machine, the Windows Remote Management (WinRM) service must be enabled on the remote machine, and access must be granted through the firewall by the remote machine to the automation server.
If the file is hosted on a file server, the automation server must have valid credentials to access that server.
Inputs
Usage option 1: Copy a file to a remote machine
-
RemoteMachineComputerName
Single string, required
This is the computer name of the remote machine.
This computer name is used to create a PowerShell session to connect to the machine.
-
FileLocation
Single string, required
This specifies the location of the file.
If the file is located on the automation server, it should be a full path starting with the drive (for example 'C:\TEMP\foobar.txt').
If the file is located on a network file server, it should be a full path starting with the name of the server (example '\\file-server\foobar.txt')
If the file is located on a web URL, it should be a full path starting with either http or https (for example 'https://mydomain.com/files/foobar.txt')
-
FileDestination
Single string, required
This specifies the destination on the remote machine for the file.
It should be a full path starting with the drive (example 'C:\Users\Administrator\Documents\foobar.txt')
Usage option 2: Copy files to remote machines
-
FilesCsv
Required columns:
-
RemoteMachineComputerName
-
FileLocation
-
FileDestination
-
Outputs
-
WindowsCopyFilesToRemoteMachinesProcessedFilesCsv
A CSV string containing the information about the files that were copied, as well as an additional column 'FileCopied' to indicate if the file copy was successful.
-
WindowsCopyFilesToRemoteMachinesErrorMessages
A string containing all the error messages that were generated over the course of this task.
Version: 1.0.2
Date: 14 March 2019
Run Executables On Remote Machines
Runs executable files on remote machines.
Additional parameters can be provided which will be passed to the file during execution, for example, parameters that specify an installation directory or that force the executable to run quietly.
For this task to be able to remotely run the executable on the remote machine, the Windows Remote Management (WinRM) service must be enabled on the remote machine, and access must be granted through the firewall by the remote machine to the automation server.
This task is unable to receive error messages from the executable running or to determine its overall success or failure. It is only able to check if the executable completed running, or if it timed out within the specified timeout period.
Inputs
Usage option 1: Run an executable on a remote machine
-
RemoteMachineComputerName
Single string, required
This is the computer name of the remote machine.
This computer name is used to create a PowerShell session to connect to the machine.
-
ExecutableFilePath
Single string, required
This specifies the path to the executable on the remote machine.
-
ExecutableParameters
Single string, optional
This specifies any additional parameters which are passed to the executable when invoking it.
-
TimeoutMinutes
Single string, optional
The default value is 10.
This specifies the maximum amount of time to wait for the executable to complete running.
If this maximum amount of time is reached before the executable has completed, it will be terminated and marked as failed.
Usage option 2: Run executables on remote machines
-
ExecutablesCsv
Required columns:
-
RemoteMachineComputerName
-
ExecutableFilePath
Optional columns:
-
ExecutableParameters
-
TimeoutMinutes
-
Outputs
-
WindowsRunExecutablesOnRemoteMachineProcessedExecutablesCsv
A CSV string containing the information about the executables that were run, as well as an additional column 'RunCompleted' to indicate if the executable had completed running.
-
WindowsRunExecutablesOnRemoteMachinesErrorMessages
A string containing all the error messages that were generated over the course of this task.