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 main menu, click Privileged Remote Access > Jump.
   The Jump page opens and the Jump Clients tab displays by default.
3. Click the Endpoint Automation.
   The Endpoint Automation page displays.

The Endpoint automation page

1. Left menu: Easy access to all pages in Privilege Remote Access, including Status, Consoles & Downloads, My Account, Configuration, Jump, Vault, Console Settings, Users & Security, Reports, Management, and Appliance pages.
2. Status: Opens the Status page.
3. Header: Change your tenant site, manage your profile, and access documentation.

4. Create Job: Creates a new automation job.
5. Search: Search a job by name.
6. Filter: Filters three tabs: Active, Hidden, or All.
7. Endpoint Automation columns- The list of endpoint automation columns. Not all of the columns are displayed.

   Endpoint Automation columns

   • Name: The unique name of the job.
   • Operating System: The name of the operating system the run is to run on.
   • Start By: Determines the date/time when the job runs. This is set in the Start By field.
   • Percent Complete: Displays the number of endpoints the job has successfully run.
   • Finished Timestamp: Displays detailed information of the job. For example, date/time.
   • Created By: The owner's name that created the job.
   • Created At: Displays date/time of creation.

8. Endpoint automation options: You can get details, duplicate endpoints, hide or cancel endpoint jobs.
9. List options: Click Hide Jobs to hide a job, click to refresh the jobs list, and click to hide or display columns.

Jobs tab

Create a job

1. Click Create job.

2. In the Name field, enter a name for the job.

3. In the Start by field, select the starting date and time. To run a job immediately, select the current date and time.

4. In the Notes field, enter any notes if you would like to record more information about this job.

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

   1. In the Operating System field, select the operating system. Scripts are usually specific to operating systems.

      ℹ️

      Note

      A default command compatible with all operating systems is provided, along with a specific command for Windows PowerShell. In the Powershell cmdlet, Set-ExecutionPolicy, the Unrestricted parameter is set by default. This temporarily changes the execution policy to Unrestricted for the duration of the script.

   2. In the Run Script Command field, enter the complete script command. For an example of a Windows command, use cmd.exe /C %script%.
   3. In the Script field, enter a script. For example, type ping.com.
   4. 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.

6. From the Endpoint Search section, enter the search criteria for your endpoints.

   👍

   Tip

   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.

7. From the list of search results, select specific Jump Clients and then click Add Selected Jump Clients to Job, or click Add All Jump Clients Search Results to Job.

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

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

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

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

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

    📘

    Note

    • When you cancel a job, it doesn’t stop the process; it just prevents it from starting.
    • If a job fails to start, it retries for up to 7 days.
    • Only one job at a time can run on an endpoint.
    • The length of time finished job data remains on the appliance can be configured on the Security page.

👍

Tip

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.

Job Status

The Job statuses are the following:

Job status types

The job status has the following types:

View job details

1. For more information about a job, click , then select Details.

2. From the submenu, 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.

   This is an example of a Details report.

   

3. A table at the bottom of this page lists all jobs, which can be filtered by the Successful, Failed, or All tabs. The All view includes pending and running jobs.

   1. Click to refresh the view.
   2. Click to choose which columns to view.

4. From the Output Tail Report section, 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 displays 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.
   1. If you select Duplicate With All Endpoints, the same endpoints are automatically selected.
   2. If you select Duplicate With Unsuccessful Endpoints, only endpoints that failed the previous job are selected.
   3. If you select Duplicate With Successful Endpoints, only endpoints that succeeded with the previous job are selected.

      📘

      Note

      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.

Hide a job

1. 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 the Active, Hidden, or All tabs.
   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.

2. Click to refresh the view.

3. Click to choose which columns to view.

Script templates tab

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

1. Create Script Template: Creates a new script.
2. Search: Search a job by name.
3. Script Template columns- The list of Script Template columns. Not all of the columns are displayed.

   Script Template columns

   • Name: The unique name of the job.
   • Description: The name of the operating system the run is to run on.
   • Operating System: Displays the operating system..

4. Script template options: The option to edit or delete a script.

Create a script template

1. Click Create Script Template
   The Create Endpoint Automation Script Template page displays.
2. In the Name and Description fields, enter a name and description for the script respectively.
3. In the Operating System field, select the operating system. Scripts are usually specific to operating systems.
4. In the Run Script Command field, enter the run script command. For example, on a Windows operating system, use cmd.exe /C %script%.
5. In the Script field, enter the script. For example, ping .
6. 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. Click Save.
8. You can immediately view the script template in the list of templates and can select it when you create a job.

Search scripts

1. In the Search Scripts field, enter the script name to search.

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

3. Click to choose which columns to view.

Edit a script

1. Select a script from a list.

2. Click the pencil to edit a script template.

3. Make the necessary changes, and then click Save.

Delete a script

1. Select a script from a list.

2. Click the trash can to delete a script template.

3. A confirmation dialog box displays. Click Yes.

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. Choose and Upload Resource: Opens a dialog box to select a resource to upload.
2. Search: Search a resource by filename.
3. Resource columns- The list of Resource columns. Not all of the columns are displayed.

   Resource columns

   • File Name: The unique name of the resource.
   • Jobs using the Resource: Displays the jobs that are defined from the Jobs tab.
   • Scripts using the Resource: Displays the scripts that are defined from the Scripts Templates tab.

4. Resource options: The option to download or delete a resource.

Add a resource

1. Click Choose and Upload Resource.

2. An Open dialog box displays.

3. Select the appropriate resource file.

4. Click Open.

This adds the resource (that is, batch.bat file) to the resource list where you can either download or delete the resource file.

📘

Note

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

Download a resource

1. From the resource list, locate your resource.

2. Click to download a resource file.

👍

Tip

By default, it downloads the resource file to the Downloads folder.

Delete a resource

1. From the resource list, locate the file you wish to delete.

2. Click the trash can to delete a resource file.

3. A confirmation dialog box displays. Click Yes.

ℹ️

Note

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