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. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the left menu, click Remote Support > Endpoint Automation.
   The Endpoint Automation page displays.

Jobs tab

📘

Note

While you can begin by creating a job directly, you may find it more efficient to start by adding resource files, then creating script templates.

The Jobs tab lets you create a job and shows a list of previously created jobs.

1. Search the list by job name.

2. Select one or more tags to filter the list.

   • If you have at least one tag selected, check Last created job for selected tags to show only the most recently created job for each applied tag.

3. To hide jobs from the initial view, click Hide Jobs.

   1. Select one or more jobs to hide, then click Hide Selected Job(s).
   2. Cancel Hide Jobs cancels the current operation but leaves any previously hidden jobs as hidden.
   3. Now, you can filter jobs by Active, Hidden, or All.
   4. From the Hidden view, click Unhide Jobs to select jobs to return to active status.
   5. You can also show or hide a job by clicking , then selecting either Hide or Unhide.

4. Click to refresh the view.

5. Click to choose which columns to view.

📘

Note

The length of time finished job data remains on the appliance can be configured on the Security page.

Create a job

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. Create a tag to help sort and filter jobs.

5. Enter any notes if you would like to record more information about this job.

6. Select an existing script template and modify the fields as needed, or complete the following:

   • Select the operating system. Scripts are usually specific to operating systems.
   • Complete the run script command.
   • Enter the script.
   • If needed, add a resource to the script. Click Add Resource and select a previously added resource, or click Add External Resource and provide a filename and URL.

7. Now enter the search criteria for your endpoints. For more information about each option, click the i icon beside it. You must click Search Jump Clients before any endpoints become available. Remember that you will see only endpoints with the same operating system as designated by the script above.

8. From the list of search results, choose which Jump Clients to add to the job.

   • Select specific Jump Clients and then click Add Selected Jump Clients to Job, or
   • Click Add All Jump Clients Search Results to Job.
     Modifying the search criteria updates the results without removing any Jump Clients you have already added.

9. The list of Jump Clients selected for the job appears at the bottom of the screen.

10. To remove Jump Clients from a job, select their check boxes in the Selected Endpoints list, then click Clear selected Jump Clients.

11. Once the list of Jump Clients for the job is complete, click Run job.

12. You can immediately view the job in the jobs list.

    • If a job fails to start, it retries for up to 7 days.
    • Only one job at a time can run on an endpoint.
    • Job statuses are:
      • Pending: The server is waiting to schedule the job until certain conditions are true.
      • Scheduled: The job has been sent to the endpoint.
      • Running: The endpoint has notified the server that the script has started.
      • Finished: The endpoint has notified the server that the job has finished, or the server has declared it finished after it exceeded a timeout.
    • There are also several finished types:
      • Success: The script completed.
      • Error: The script returned an error, or an internal error occurred at the endpoint.
      • Canceled: A user canceled a pending job.
      • Timed out: The job exceeded the timeout period.
      • Ping timed out: The job failed to ping the server within the ping timeout period.
      • Endpoint offline timed out: The endpoint was not online within the timeout period.
      • Endpoint removed: The Jump Client was removed after the job was created, meaning the script could not be completed.

13. To cancel a pending job, click , then select Cancel Pending Endpoint Jobs.

    • Canceling a job doesn’t stop the process; it just prevents it from starting.

View job details

1. For more information about a job, click , then select Details.
2. Details shows you all the information about the job in a static, non-editable form. In addition to the fields defined when the job was created, details include who created the script and when, when the script finished running, and if the script was cancelled.
3. A table at the bottom of this page lists all jobs, which can be filtered by Successful, Failed, or All. The All view includes pending and running jobs.
   1. Click to refresh the view.
   2. Click to choose which columns to view.
4. Click Download Report to download the output tail either as a CSV or a text file. This provides a high level overview of the results of completed scripts.
5. For more details about a finished job on a specific endpoint, click . This opens a modal window that shows the exit code, the log file path, any error codes, and the output tail, which may be useful for diagnosing errors.

Duplicate a job

1. To duplicate a job, click , then select either Duplicate With All Endpoints, Duplicate With Unsuccessful Endpoints, or Duplicate With Successful Endpoints.
2. This creates a new job with all fields identical to the previous job. You can modify these fields before running it.
   • If you select Duplicate With All Endpoints, the same endpoints will be automatically selected.
   • If you select Duplicate With Unsuccessful Endpoints, only endpoints that failed the previous job are selected.
   • If you select Duplicate With Successful Endpoints, only endpoints that succeeded with the previous job are selected.
   • You can modify the selected endpoints before running the job.
3. Once you have made any desired modifications, click Run job.
4. You can immediately view the job in the jobs list.
5. To cancel a pending job, click , then select Cancel Pending Endpoint Jobs.

Script templates tab

The Script Templates tab lets you create a script template and shows a list of previously created script templates.

1. You can search the list by script name.

2. Click a column header to sort by that field.

3. Click to choose which columns to view.

4. Click to edit a script template.

5. Click to delete a script template.

Create a script template

1. Click Create Script Template
2. Enter a name and description for the script.
3. Create a tag to help sort and filter jobs.
4. Select the operating system. Scripts are usually specific to operating systems.
5. Complete the run script command.
6. Enter the script.
7. If needed, add a resource to the script. Click Add Resource and select a previously added resource, or click Add External Resource and provide a filename and URL.
8. Save the script template.
9. You can immediately view the script template in the list of templates and can 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 lets you upload resource files for use in endpoint automation jobs and shows a list of previously uploaded resources.

1. You can search the list by resource name.
2. Click a column header to sort by that field.
3. Click to choose which columns to view.
4. Click to download a resource file.
5. Click to delete a resource file.

ℹ️

Note

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

Add a new resource

1. Click Choose and Upload Resource to select a new resource.
2. Navigate to the file, and then click Open.
3. You can immediately view the resource in the list of resources and can select it when creating a script template or a job.

📘

Note

The maximum resource storage size is 1 GB by default and can be configured on the Security page.