Canned scripts

What are canned scripts?

Canned scripts are custom scripts created to be used in screen sharing and command shell sessions. These scripts are displayed in the interface as they are executed, running in the context of the logged-in user or the local system, depending on session elevation.

How are canned scripts useful?

Canned scripts allow representatives to automate tasks during remote sessions, enhancing efficiency and consistency. When you run a predefined scripts during screen sharing or command shell sessions, users can streamline troubleshooting or configuration tasks, while the scripts maintain proper context based on session elevation.

How do I access the Canned Scripts page?

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts tab displays.

The Canned Scripts page

1. Left menu: Easy access to all pages in Privilege Remote Access, including Home, Status, Consoles & Downloads, My Account, Configuration, Jump, Vault, Console Settings, Users & Security, Reports, Management, and Appliance pages.

2. Status: Takes you to the Status page.

3. Header: Change tenant site and obtain user profile setting information.

4. Add:- Adds a new canned script.

5. Script columns: The list of Script columns.

   Script columns

   • Script Name: Unique name of the account.
   • Description: A brief description of the Account Group.
   • Team Availability: Set a code name for integration purposes. If you do not set a code name, one is created automatically.
   • Categories: Set a code name for integration purposes. If you do not set a code name, one is created automatically.
   • Resource File: Set a code name for integration purposes. If you do not set a code name, one is created automatically.

6. Script list options: Copy, edit or delete an account policy.

7. Categories: Adds a new category.

8. Categories columns: The list of Categories columns.

   Categories columns

   • Category Name: Unique name of the category.

9. Categories options: Deletes a category.

10. Resources: Adds a resource file.

11. Resources columns: The list of Resources columns.

    Resources columns

    • Filename: The file name of the resource.
    • Size: The size of the resource. The max size of the Resource folder is 100 megabytes (MB).

12. Resources options: Deletes a resource file.

Add Scripts

Add a new canned script

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts tab displays.
4. Click Add.
5. For Script Name, create a unique name to help identify this script. This name should help users locate the script they wish to run.
6. For Description, add a brief description to summarize the purpose of this script. This description displays on the prompt to confirm that the user wants to run the selected script.
7. For Command Sequence, write the command sequence. Scripts are written in command line format, similar to writing a batch file or shell script.

   📘

   Note

   Only the last line of the script may be interactive; you cannot prompt for input in the middle of the script.

8. For Team Availability, select which teams should be able to use this item.
9. For Categories, select the category under which this item should be listed.
10. For Resource File, include a resource with the canned script.

    📘

    Note

    • Within the script, reference an associated resource file using "%RESOURCE_FILE%", making sure to include the quotation marks. The command sequence is case sensitive.
    • You can access the resource file's temporary directory using %RESOURCE_DIR%. When you run a script with an associated resource file, that file will be temporarily uploaded to the customer's computer.

Edit a canned script

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts tab displays.
4. Select a canned script from the list.
5. Click the pencil to edit the custom link.
6. Make the necessary changes, and click Save.

Delete a canned script

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts page displays.
4. Select a canned script from the list.
5. Click the trash can .
6. A confirmation dialog box displays, click Yes.

Categories

Add a category

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts page displays.
4. From the Categories section, enter a category name.
5. Click Add Category.

The confirmation message: Canned Script Category "" was successfully added displays, where <Category Name> is the name of the category you added. The category name displays in the table where you can delete the category name.

Delete a category

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts page displays.
4. Select a category from the list.
5. Click the trash can .
6. A confirmation dialog box displays, click Yes.

Resources

Add a resource

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts page displays.
4. From the Resources section, click Choose and Upload Resource.
5. An Open dialog box displays, select a resource file. Add any resource files you want to access from within your scripts. You may upload up to 100 megabytes (MBs) to your resource file folder.

   📘

   Note

   If you upload a resource file with the same name as an existing resource file, there is a prompt to confirm replacing the file.

   • If you click Yes, the updated resource file is uploaded and used for all applicable canned scripts.
   • If you click No, the file is not uploaded.

6. Click Open.

The resource file displays in the resource list table.

Delete a resource

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the main menu, click Privileged Remote Access > Console Settings.
   The Console Settings page opens and the Manage Access Console Settings tab displays by default.
3. Click the Canned Scripts tab.
   The Canned Scripts page displays.
4. Select a resource from the resource list table.
5. Click the trash can .
6. A confirmation dialog box displays, click Yes.