Endpoint automation

What is endpoint automation?

Endpoint automation allows you to remotely execute scripts across multiple endpoints simultaneously without needing to start a support session, streamlining administrative tasks and improving efficiency.

How is endpoint automation useful to my organization?

Endpoint automation simplifies the management of multiple systems by enabling the automated execution of scripts, reducing the need for manual intervention and ensuring consistent updates and configurations across all endpoints.

ℹ️

Note

The endpoint automation feature is only available to service mode Jump Clients with an active connection on Mac, Windows, or Desktop Linux.

How do I access the Endpoint Automation page?

1. Use a Chromium-based browser to sign in to your Remote Support URL.
   This URL is provided in the BeyondTrust welcome email and includes your site URL followed by /login.
2. From the left menu, click Jump.
   The Jump Clients page opens and displays by default.
3. At the top of the page, click Endpoint Automation.
   The Endpoint Automation page displays.

Jobs tab

The jobs tab lets your create a job, and shows a list of previously created jobs. The list can be searched and refreshed, and the list can be modified by selecting visible columns, using the icon at the right edge above the top row.

For more information about a job, click the vertical ellipsis at the right end of the row for that job, then click Details. This view also shows the results of a job. For more details about the results, click the eye icon at the right end of the results row. The results includes any exit codes or error messages, and the last lines of the output log file, which may be useful for diagnosing errors. There is a link to the full output log file. These files are stored for no more than 90 days.

The vertical ellipsis at the right end of the row for a job also has options to duplicate or rerun the job, and cancel the job if is it pending.

Create a job

You can create job with a script, or you can create a script template first and then use it to create jobs.

1. Click Create job.
2. Enter a name for the job.
3. Select the starting date and time. To run a job immediately, select the current date and time.
4. Enter any notes if you would like to record more information about this job.
5. Select an existing script template, or complete the following:
   • Select the operating system. Scripts are usually specific to operating systems.
   • Complete the run script command.
   • Enter the script.
6. Now select your endpoint or endpoints, using the search and filter options. For more information about each option, click the i icon beside it.
7. From the list of search results, you can select specific Jump Clients to add to the job, or select all search results. You can modify the search criteria to find and add additional Jump Clients. You can also select and clear Jump Clients from the job.
8. The list of Jump Clients selected for the job appears at the bottom of the screen.
9. Once the list of Jump Clients for the job is complete, click Run job.
10. You can immediately view the job in the list of jobs.

Run the Output Tail Report

The Output Tail Report can be downloaded as a text file for a high level overview of the results of completed scripts, or as a CSV file to run queries on.

1. Select Details from the Actions menu next to a job.
2. Under Output Tail Report, select CSV or Text from the Download Report dropdown.
3. Go to your downloads to select and view the report.

Script templates tab

The script templates tab lets you create a script, and shows a list of previously created script templates. The list can be searched and the list can be modified by selecting visible columns, using the icon at the right edge above the top row. Scripts can also be edited or deleted. Scripts are selected for jobs when creating a job.

Create script template

1. Click Create Script Template
2. Enter a name and description for the script.
3. Select the operating system. Scripts are usually specific to operating systems.
4. Complete the run script command.
5. Enter the script.
6. Save the script template.
7. You can immediately view the script template in the list of templates, and select it when creating a job.

ℹ️

Note

We provide a default command compatible with all operating systems, along with a specific command for PowerShell. In the PowerShell command, the -ExecutionPolicy Unrestricted option is set by default. This temporarily changes the execution policy to Unrestricted for the duration of the script.

Resources tab

The resources tab allows you to upload resource files and include external resource files in Endpoint Automation jobs. You can also delete resource files.

ℹ️

Note

If a resource is in use, it cannot be deleted.

Add a new resource

1. Click Resources.
2. Click Choose and Upload Resource to select a new resource. Navigate to the file, and then click Open. The file is now visible in the resources pane.
3. To add the resource to a job, click Jobs.
4. Click Create Job. Under Resources, click Add Resource. Choose a resource from the Select a Resource dropdown.
5. To add an external resource file, select Add External Resource. Add a File Name and URL, and then click the plus sign.
6. To run the job, click Run Job.
7. Return to Resources to verify that the job you just ran is listed under the Jobs Using the Resource column. While the job is running and the resource is in use, the delete option is unavailable for that resource.