Enhancements:<\/h3>\n\n\n\n\n- Screen recording permissions for Background Tools mode is disabled because it is not necessary for the working of Background Tools.<\/li>\n<\/ul>\n\n\n\n
Considerations<\/h3>\n\n\n\n\n- Ensure your device meets the requirements for the Remote Assist Agent. For more information, see Understand the Remote Assist Agent<\/a>.<\/li>\n<\/ul>\n\n\n\n
![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/note-icon.png\")
<\/p><\/div>
Note:<\/strong> \n\n- During a Background Tools session, Remote Assist using Consent Prompt or Unattended Access mode cannot be used simultaneously.<\/li>\n\n\n\n
- The JumpCloud Background Tools CLI currently supports Windows and Mac operating systems. After connecting to the end-user, Admins will automatically launch a browser-based PowerShell terminal for Windows devices, and a browser-based Bash terminal for Mac devices. After accessing the command line interface for a device, Admins will have root level access for both Mac and Windows systems.<\/li>\n\n\n\n
- The RFM tool is available for use in both Background Tools and standard remote assist session types (One-time Access Code, Consent Prompt, and Unattended Access).<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Enable and Launch Background Tools (Admin) <\/h3>\n\n\n\n\n- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n<\/ol>\n\n\n\n
![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/important-icon.png\"\/)
<\/p><\/div>
Important:<\/strong> \nIf your data is stored outside of the US, check which login URL you should be using depending on your region. If your organization uses LDAP, RADIUS, or requires firewall allow list configuration, the Fully Qualified Domain Names (FQDNs) will also be region specific. See JumpCloud Data Centers<\/a> for the URLs, FQDNs, and IP addresses.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n\n- Go to Settings<\/strong>. <\/li>\n\n\n\n
- Click the Features <\/strong>tab.<\/li>\n\n\n\n
- In the Remote Access<\/strong> section, click the Background Tools Service On <\/strong>toggle to enable Background Tools.
![\"JumpCloud](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/Background-Tools-Service-On.png\")
<\/li>\n\n\n\n- Click Save<\/strong>.<\/li>\n<\/ol>\n\n\n\n
![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/important-icon.png\")
<\/p><\/div>
Important:<\/strong> \n\n- To enable or disable Background Tools, you must be an Admin with manager permissions or higher. To launch a Background Tools session, you must be an Admin with HelpDesk role permissions, Admin with Manager role permissions, or higher.<\/li>\n\n\n\n
- If the Remote Assist Service<\/strong> or Background Tools Service<\/strong> toggles are enabled, then the Admin also has access to enable or disable the Session Timeout<\/strong> and Experience Survey<\/strong> toggles. However, if both are disabled, then the Session Timeout <\/strong>and Experience Survey <\/strong>toggles will be inaccessible.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
\n- Go to Device Management<\/strong> > Devices<\/strong> and click the Devices<\/strong> tab. <\/li>\n\n\n\n
- Select the device you want to provide remote assistance for. <\/li>\n\n\n\n
- Select the Actions<\/strong> menu, then click Launch Background Tools<\/strong>.
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/Launch-BG-Tools.png\")
<\/li>\n\n\n\n- Wait for the connection to load and establish to the end-user device. After the connection is established, a new Background Tools session browser tab opens.
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/Terminal.png\")
<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>
Note:<\/strong> \n\n- On the Terminal <\/strong>tab, your system automatically connects to the proper CLI type based on the user\u2019s device OS. For Mac devices, it will default to a Bash<\/strong> terminal type, and for Windows devices, it will default to a PowerShell<\/strong> terminal type.<\/li>\n\n\n\n
- Linux support will come in future releases.<\/li>\n\n\n\n
- You can hover over the information icon<\/strong> to see the OS details for the connected device.
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/Info-Icon-Terminal.png\")
<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n\n- Enter commands in the interface as needed. <\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>
Important:<\/strong> \n\n- If you need to enter sensitive information such as passwords, do NOT enter them directly in the CLI because they will be logged. Instead, if you need to enter a password, first put it into a script on your local machine in which the password can be specified, and then transfer the script to the end-user device through RFM, and run the script\/file in the CLI. Background Tools does not look into scripts to see passwords, and will avoid passwords being logged. <\/li>\n\n\n\n
- Admins should NOT write scripts during a remote session. Write the script on your local machine and then transfer it to the remote end-user device using the RFM. <\/li>\n\n\n\n
- The maximum string length for a single input command is 8000 characters. If you paste or run a command that exceeds 8000 characters, such as a large text file, this can result in session hanging, and you will have to close and restart the Background Tools session. <\/li>\n\n\n\n
- The maximum string length to paste into the Terminal is 8000 characters. If you have to paste a large file (exceeding 8000 characters), you should paste it in smaller chunks to avoid session hanging.<\/li>\n\n\n\n
- The maximum scroll limit in the Terminal shell is 5000 lines. You can scroll up to see the history of the previous 5000 lines, but anything after that will be replaced.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
\n- When you are finished, click End Session<\/strong>. <\/li>\n<\/ol>\n\n\n\n
Security Best Practices: Commonly Masked Commands<\/h3>\n\n\n\n
Any commands entered into the Background Tools command line interface are logged into the Admin Portal’s Directory Insights<\/strong>, including sensitive information. To improve some of these security vulnerabilities, Background Tools masks common sensitive commands so that they are not visible in the logs. <\/p>\n\n\n\nA list of the currently masked commands include: <\/p>\n\n\n\n
\n-p<\/code><\/li>\n\n\n\n-k<\/code><\/li>\n\n\n\n-cp<\/code><\/li>\n\n\n\n--key<\/code><\/li>\n\n\n\n--api-key<\/code><\/li>\n\n\n\n--password<\/code><\/li>\n\n\n\n--certpassword<\/code><\/li>\n\n\n\n--install-arguments-sensitive<\/code><\/li>\n\n\n\n--package-parameters-sensitive<\/code><\/li>\n<\/ul>\n\n\n\n<\/p><\/div>
Important:<\/strong> \nAvoid running any commands or scripts with keys or passwords (sensitive information) as arguments in them. If you need to run a command with sensitive information, make sure you write a script on your local device, transfer it to a remote device using Remote File Manager, then run the script on the remote device using the remote command line interface. <\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Remote File Manager<\/strong><\/h2>\n\n\n\nThe Remote File Manager (RFM) lets you transfer (upload and download) files between Admin and end-user devices during Background Tools sessions and standard Remote Assist session types (One-time Access Code, Consent Prompt, and Unattended Access). <\/p>\n\n\n\n
Admins have access to the RFM at any time during a regular remote assist session type through the session toolbar, and during Background Tools sessions in the File Browser tab. <\/p>\n\n\n\n
Features<\/h3>\n\n\n\n
Supported file operations in RFM include:<\/p>\n\n\n\n
\n- Download<\/strong>: Admins can download files from an end-user device to their Admin device. <\/li>\n\n\n\n
- Upload<\/strong>: Admins can select files from their device and upload them to the end-user device. <\/li>\n\n\n\n
- Move<\/strong>: Admins can manually move files to and from different areas of the end-user device. <\/li>\n\n\n\n
- Delete<\/strong>: Admins can delete files from the end-user device. <\/li>\n\n\n\n
- Rename<\/strong>: Admins can rename files on the end-user device.<\/li>\n\n\n\n
- Browsing<\/strong>: Admins can browse the files on an end-user\u2019s device. <\/li>\n\n\n\n
- Copy<\/strong>: Admins can copy files to and from different areas of the end-user device.<\/li>\n<\/ul>\n\n\n\n
Limitations<\/h3>\n\n\n\n\n- Admins using the RFM on a Windows device can currently only browse the C: drive. Support for browsing the rest of the file drives will come in subsequent releases. <\/li>\n\n\n\n
- During a file transfer, Admins can not pause active downloads or uploads. Pausing and resuming active file transfers will be available in subsequent releases.<\/li>\n\n\n\n
- RFM does not support copy, move, download, upload, or rename functionalities for folders<\/strong>. <\/li>\n\n\n\n
- RFM can only perform one file operation at a time. It can\u2019t perform multiple file operations simultaneously. <\/li>\n\n\n\n
- The maximum file transfer size limit is 2 GB.<\/li>\n\n\n\n
- Linux is not currently supported.<\/li>\n\n\n\n
- Admins can not currently see all of the directory shortcuts during a Background Tools session.<\/li>\n\n\n\n
- Admins must manually dismiss notifications; notifications are not dismissed automatically. <\/li>\n<\/ul>\n\n\n\n
Known Issues<\/h3>\n\n\n\n\n- Upload files above 1 MB might be corrupted at the destination (RAA).<\/li>\n\n\n\n
- When an Admin is trying to upload an unauthorized file, or upload without the appropriate permissions and fails, there is no error message to communicate this failure. <\/li>\n\n\n\n
- Uploading several large files in sequence can freeze the upload operation. <\/li>\n\n\n\n
- When an Admin tries and fails to upload a file to a directory with read-only access, there is no error message to communicate this failure. <\/li>\n\n\n\n
- In the Volume<\/strong> file directory, Admins can create new folders, but can not currently upload files. This will be fixed in future releases.<\/li>\n\n\n\n
- Admins can not currently cancel a file during upload, they must wait for the file to finish uploading and then delete the file. This cancel functionality will be fixed in future releases.<\/li>\n\n\n\n
- Admins must manually click the text on a file or directory to select it. In future releases, Admins will be able to select items by clicking on the entire row. <\/li>\n\n\n\n
- Error messages for uploading duplicate files are very vague. These error messages will be more descriptive in future releases. <\/li>\n\n\n\n
- When creating a new folder, Admins must manually click Create<\/strong>. In future releases, Admins will be able to use the Enter <\/strong>key to confirm folder creation.<\/li>\n<\/ul>\n\n\n\n
Access Remote File Manager with Background Tools<\/h3>\n\n\n\n\n- Ensure that you have the proper permissions to use Remote File Manager. For more information, see Grant Screen Recording and Accessibility Permissions for the Remote Assist Agent<\/a>.<\/li>\n\n\n\n
- Launch a Background Tools session and connect to an end-user\u2019s device. For more information, see Enable and Launch Background Tools<\/a>.<\/li>\n\n\n\n
- In the Background Tools<\/strong> browser window, click the File Manager <\/strong>tab. <\/li>\n\n\n\n
- The File Manager interface displays.
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/File-Manager-Interface.png\")
<\/li>\n<\/ol>\n\n\n\n\n- For next steps on using the RFM, see Use Remote File Manager.<\/a><\/li>\n<\/ol>\n\n\n\n
Access Remote File Manager with Remote Assist<\/h3>\n\n\n\n\n- Start a standard Remote Assist session and connect to an end-user\u2019s device. For more information on initiating a Remote Assist session, see Get Started: Remote Assist<\/a>.<\/li>\n\n\n\n
- In the session toolbar, click Session Options<\/strong>.
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/Session-Options.png\")
<\/li>\n<\/ol>\n\n\n\n\n- Click File Manager<\/strong>. The file browser opens in a new window displaying the end-user\u2019s remote file systems.
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/File-Manager_Options.png\")
<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>
Note:<\/strong> \n\n- To close the File Manager window, click the X <\/strong>close icon. <\/li>\n\n\n\n
- You can quickly navigate between directories using the shortcuts in the left-hand navigation, such as the Home<\/strong>, Downloads<\/strong>, Documents<\/strong>, Desktop<\/strong>, Pictures<\/strong>, and Music<\/strong> file directories.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Considerations<\/h3>\n\n\n\n\n- Ensure your device meets the requirements for the Remote Assist Agent. For more information, see Understand the Remote Assist Agent<\/a>.<\/li>\n<\/ul>\n\n\n\n
<\/p><\/div>
Note:<\/strong> \n\n- During a Background Tools session, Remote Assist using Consent Prompt or Unattended Access mode cannot be used simultaneously.<\/li>\n\n\n\n
- The JumpCloud Background Tools CLI currently supports Windows and Mac operating systems. After connecting to the end-user, Admins will automatically launch a browser-based PowerShell terminal for Windows devices, and a browser-based Bash terminal for Mac devices. After accessing the command line interface for a device, Admins will have root level access for both Mac and Windows systems.<\/li>\n\n\n\n
- The RFM tool is available for use in both Background Tools and standard remote assist session types (One-time Access Code, Consent Prompt, and Unattended Access).<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Enable and Launch Background Tools (Admin) <\/h3>\n\n\n\n\n- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>
Important:<\/strong> \nIf your data is stored outside of the US, check which login URL you should be using depending on your region. If your organization uses LDAP, RADIUS, or requires firewall allow list configuration, the Fully Qualified Domain Names (FQDNs) will also be region specific. See JumpCloud Data Centers<\/a> for the URLs, FQDNs, and IP addresses.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n\n- Go to Settings<\/strong>. <\/li>\n\n\n\n
- Click the Features <\/strong>tab.<\/li>\n\n\n\n
- In the Remote Access<\/strong> section, click the Background Tools Service On <\/strong>toggle to enable Background Tools.
<\/li>\n\n\n\n- Click Save<\/strong>.<\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>
Important:<\/strong> \n\n- To enable or disable Background Tools, you must be an Admin with manager permissions or higher. To launch a Background Tools session, you must be an Admin with HelpDesk role permissions, Admin with Manager role permissions, or higher.<\/li>\n\n\n\n
- If the Remote Assist Service<\/strong> or Background Tools Service<\/strong> toggles are enabled, then the Admin also has access to enable or disable the Session Timeout<\/strong> and Experience Survey<\/strong> toggles. However, if both are disabled, then the Session Timeout <\/strong>and Experience Survey <\/strong>toggles will be inaccessible.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
\n- Go to Device Management<\/strong> > Devices<\/strong> and click the Devices<\/strong> tab. <\/li>\n\n\n\n
- Select the device you want to provide remote assistance for. <\/li>\n\n\n\n
- Select the Actions<\/strong> menu, then click Launch Background Tools<\/strong>.
<\/li>\n\n\n\n- Wait for the connection to load and establish to the end-user device. After the connection is established, a new Background Tools session browser tab opens.
<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>
Note:<\/strong> \n\n- On the Terminal <\/strong>tab, your system automatically connects to the proper CLI type based on the user\u2019s device OS. For Mac devices, it will default to a Bash<\/strong> terminal type, and for Windows devices, it will default to a PowerShell<\/strong> terminal type.<\/li>\n\n\n\n
- Linux support will come in future releases.<\/li>\n\n\n\n
- You can hover over the information icon<\/strong> to see the OS details for the connected device.
<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n\n- Enter commands in the interface as needed. <\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>
Important:<\/strong> \n\n- If you need to enter sensitive information such as passwords, do NOT enter them directly in the CLI because they will be logged. Instead, if you need to enter a password, first put it into a script on your local machine in which the password can be specified, and then transfer the script to the end-user device through RFM, and run the script\/file in the CLI. Background Tools does not look into scripts to see passwords, and will avoid passwords being logged. <\/li>\n\n\n\n
- Admins should NOT write scripts during a remote session. Write the script on your local machine and then transfer it to the remote end-user device using the RFM. <\/li>\n\n\n\n
- The maximum string length for a single input command is 8000 characters. If you paste or run a command that exceeds 8000 characters, such as a large text file, this can result in session hanging, and you will have to close and restart the Background Tools session. <\/li>\n\n\n\n
- The maximum string length to paste into the Terminal is 8000 characters. If you have to paste a large file (exceeding 8000 characters), you should paste it in smaller chunks to avoid session hanging.<\/li>\n\n\n\n
- The maximum scroll limit in the Terminal shell is 5000 lines. You can scroll up to see the history of the previous 5000 lines, but anything after that will be replaced.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
\n- When you are finished, click End Session<\/strong>. <\/li>\n<\/ol>\n\n\n\n
Security Best Practices: Commonly Masked Commands<\/h3>\n\n\n\n
Any commands entered into the Background Tools command line interface are logged into the Admin Portal’s Directory Insights<\/strong>, including sensitive information. To improve some of these security vulnerabilities, Background Tools masks common sensitive commands so that they are not visible in the logs. <\/p>\n\n\n\nA list of the currently masked commands include: <\/p>\n\n\n\n
\n-p<\/code><\/li>\n\n\n\n-k<\/code><\/li>\n\n\n\n-cp<\/code><\/li>\n\n\n\n--key<\/code><\/li>\n\n\n\n--api-key<\/code><\/li>\n\n\n\n--password<\/code><\/li>\n\n\n\n--certpassword<\/code><\/li>\n\n\n\n--install-arguments-sensitive<\/code><\/li>\n\n\n\n--package-parameters-sensitive<\/code><\/li>\n<\/ul>\n\n\n\n<\/p><\/div>
Important:<\/strong> \nAvoid running any commands or scripts with keys or passwords (sensitive information) as arguments in them. If you need to run a command with sensitive information, make sure you write a script on your local device, transfer it to a remote device using Remote File Manager, then run the script on the remote device using the remote command line interface. <\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Remote File Manager<\/strong><\/h2>\n\n\n\nThe Remote File Manager (RFM) lets you transfer (upload and download) files between Admin and end-user devices during Background Tools sessions and standard Remote Assist session types (One-time Access Code, Consent Prompt, and Unattended Access). <\/p>\n\n\n\n
Admins have access to the RFM at any time during a regular remote assist session type through the session toolbar, and during Background Tools sessions in the File Browser tab. <\/p>\n\n\n\n
Features<\/h3>\n\n\n\n
Supported file operations in RFM include:<\/p>\n\n\n\n
\n- Download<\/strong>: Admins can download files from an end-user device to their Admin device. <\/li>\n\n\n\n
- Upload<\/strong>: Admins can select files from their device and upload them to the end-user device. <\/li>\n\n\n\n
- Move<\/strong>: Admins can manually move files to and from different areas of the end-user device. <\/li>\n\n\n\n
- Delete<\/strong>: Admins can delete files from the end-user device. <\/li>\n\n\n\n
- Rename<\/strong>: Admins can rename files on the end-user device.<\/li>\n\n\n\n
- Browsing<\/strong>: Admins can browse the files on an end-user\u2019s device. <\/li>\n\n\n\n
- Copy<\/strong>: Admins can copy files to and from different areas of the end-user device.<\/li>\n<\/ul>\n\n\n\n
Limitations<\/h3>\n\n\n\n\n- Admins using the RFM on a Windows device can currently only browse the C: drive. Support for browsing the rest of the file drives will come in subsequent releases. <\/li>\n\n\n\n
- During a file transfer, Admins can not pause active downloads or uploads. Pausing and resuming active file transfers will be available in subsequent releases.<\/li>\n\n\n\n
- RFM does not support copy, move, download, upload, or rename functionalities for folders<\/strong>. <\/li>\n\n\n\n
- RFM can only perform one file operation at a time. It can\u2019t perform multiple file operations simultaneously. <\/li>\n\n\n\n
- The maximum file transfer size limit is 2 GB.<\/li>\n\n\n\n
- Linux is not currently supported.<\/li>\n\n\n\n
- Admins can not currently see all of the directory shortcuts during a Background Tools session.<\/li>\n\n\n\n
- Admins must manually dismiss notifications; notifications are not dismissed automatically. <\/li>\n<\/ul>\n\n\n\n
Known Issues<\/h3>\n\n\n\n\n- Upload files above 1 MB might be corrupted at the destination (RAA).<\/li>\n\n\n\n
- When an Admin is trying to upload an unauthorized file, or upload without the appropriate permissions and fails, there is no error message to communicate this failure. <\/li>\n\n\n\n
- Uploading several large files in sequence can freeze the upload operation. <\/li>\n\n\n\n
- When an Admin tries and fails to upload a file to a directory with read-only access, there is no error message to communicate this failure. <\/li>\n\n\n\n
- In the Volume<\/strong> file directory, Admins can create new folders, but can not currently upload files. This will be fixed in future releases.<\/li>\n\n\n\n
- Admins can not currently cancel a file during upload, they must wait for the file to finish uploading and then delete the file. This cancel functionality will be fixed in future releases.<\/li>\n\n\n\n
- Admins must manually click the text on a file or directory to select it. In future releases, Admins will be able to select items by clicking on the entire row. <\/li>\n\n\n\n
- Error messages for uploading duplicate files are very vague. These error messages will be more descriptive in future releases. <\/li>\n\n\n\n
- When creating a new folder, Admins must manually click Create<\/strong>. In future releases, Admins will be able to use the Enter <\/strong>key to confirm folder creation.<\/li>\n<\/ul>\n\n\n\n
Access Remote File Manager with Background Tools<\/h3>\n\n\n\n\n- Ensure that you have the proper permissions to use Remote File Manager. For more information, see Grant Screen Recording and Accessibility Permissions for the Remote Assist Agent<\/a>.<\/li>\n\n\n\n
- Launch a Background Tools session and connect to an end-user\u2019s device. For more information, see Enable and Launch Background Tools<\/a>.<\/li>\n\n\n\n
- In the Background Tools<\/strong> browser window, click the File Manager <\/strong>tab. <\/li>\n\n\n\n
- The File Manager interface displays.
<\/li>\n<\/ol>\n\n\n\n\n- For next steps on using the RFM, see Use Remote File Manager.<\/a><\/li>\n<\/ol>\n\n\n\n
Access Remote File Manager with Remote Assist<\/h3>\n\n\n\n\n- Start a standard Remote Assist session and connect to an end-user\u2019s device. For more information on initiating a Remote Assist session, see Get Started: Remote Assist<\/a>.<\/li>\n\n\n\n
- In the session toolbar, click Session Options<\/strong>.
<\/li>\n<\/ol>\n\n\n\n\n- Click File Manager<\/strong>. The file browser opens in a new window displaying the end-user\u2019s remote file systems.
<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>
Note:<\/strong> \n\n- To close the File Manager window, click the X <\/strong>close icon. <\/li>\n\n\n\n
- You can quickly navigate between directories using the shortcuts in the left-hand navigation, such as the Home<\/strong>, Downloads<\/strong>, Documents<\/strong>, Desktop<\/strong>, Pictures<\/strong>, and Music<\/strong> file directories.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
<\/p><\/div>
- \n
- During a Background Tools session, Remote Assist using Consent Prompt or Unattended Access mode cannot be used simultaneously.<\/li>\n\n\n\n
- The JumpCloud Background Tools CLI currently supports Windows and Mac operating systems. After connecting to the end-user, Admins will automatically launch a browser-based PowerShell terminal for Windows devices, and a browser-based Bash terminal for Mac devices. After accessing the command line interface for a device, Admins will have root level access for both Mac and Windows systems.<\/li>\n\n\n\n
- The RFM tool is available for use in both Background Tools and standard remote assist session types (One-time Access Code, Consent Prompt, and Unattended Access).<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Enable and Launch Background Tools (Admin) <\/h3>\n\n\n\n
- \n
- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>Important:<\/strong> \n
If your data is stored outside of the US, check which login URL you should be using depending on your region. If your organization uses LDAP, RADIUS, or requires firewall allow list configuration, the Fully Qualified Domain Names (FQDNs) will also be region specific. See JumpCloud Data Centers<\/a> for the URLs, FQDNs, and IP addresses.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- \n
- Go to Settings<\/strong>. <\/li>\n\n\n\n
- Click the Features <\/strong>tab.<\/li>\n\n\n\n
- In the Remote Access<\/strong> section, click the Background Tools Service On <\/strong>toggle to enable Background Tools.
<\/li>\n\n\n\n- Click Save<\/strong>.<\/li>\n<\/ol>\n\n\n\n
<\/p><\/div>Important:<\/strong> \n- \n
- To enable or disable Background Tools, you must be an Admin with manager permissions or higher. To launch a Background Tools session, you must be an Admin with HelpDesk role permissions, Admin with Manager role permissions, or higher.<\/li>\n\n\n\n
- If the Remote Assist Service<\/strong> or Background Tools Service<\/strong> toggles are enabled, then the Admin also has access to enable or disable the Session Timeout<\/strong> and Experience Survey<\/strong> toggles. However, if both are disabled, then the Session Timeout <\/strong>and Experience Survey <\/strong>toggles will be inaccessible.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- \n
- Go to Device Management<\/strong> > Devices<\/strong> and click the Devices<\/strong> tab. <\/li>\n\n\n\n
- Select the device you want to provide remote assistance for. <\/li>\n\n\n\n
- Select the Actions<\/strong> menu, then click Launch Background Tools<\/strong>.
<\/li>\n\n\n\n- Wait for the connection to load and establish to the end-user device. After the connection is established, a new Background Tools session browser tab opens.
<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>Note:<\/strong> \n- \n
- On the Terminal <\/strong>tab, your system automatically connects to the proper CLI type based on the user\u2019s device OS. For Mac devices, it will default to a Bash<\/strong> terminal type, and for Windows devices, it will default to a PowerShell<\/strong> terminal type.<\/li>\n\n\n\n
- Linux support will come in future releases.<\/li>\n\n\n\n
- You can hover over the information icon<\/strong> to see the OS details for the connected device.
<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n- \n
- Enter commands in the interface as needed. <\/li>\n<\/ol>\n\n\n\n<\/p><\/div>Important:<\/strong> \n
- \n
- If you need to enter sensitive information such as passwords, do NOT enter them directly in the CLI because they will be logged. Instead, if you need to enter a password, first put it into a script on your local machine in which the password can be specified, and then transfer the script to the end-user device through RFM, and run the script\/file in the CLI. Background Tools does not look into scripts to see passwords, and will avoid passwords being logged. <\/li>\n\n\n\n
- Admins should NOT write scripts during a remote session. Write the script on your local machine and then transfer it to the remote end-user device using the RFM. <\/li>\n\n\n\n
- The maximum string length for a single input command is 8000 characters. If you paste or run a command that exceeds 8000 characters, such as a large text file, this can result in session hanging, and you will have to close and restart the Background Tools session. <\/li>\n\n\n\n
- The maximum string length to paste into the Terminal is 8000 characters. If you have to paste a large file (exceeding 8000 characters), you should paste it in smaller chunks to avoid session hanging.<\/li>\n\n\n\n
- The maximum scroll limit in the Terminal shell is 5000 lines. You can scroll up to see the history of the previous 5000 lines, but anything after that will be replaced.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- \n
- When you are finished, click End Session<\/strong>. <\/li>\n<\/ol>\n\n\n\n
Security Best Practices: Commonly Masked Commands<\/h3>\n\n\n\n
Any commands entered into the Background Tools command line interface are logged into the Admin Portal’s Directory Insights<\/strong>, including sensitive information. To improve some of these security vulnerabilities, Background Tools masks common sensitive commands so that they are not visible in the logs. <\/p>\n\n\n\n
A list of the currently masked commands include: <\/p>\n\n\n\n
- \n
-p<\/code><\/li>\n\n\n\n-k<\/code><\/li>\n\n\n\n-cp<\/code><\/li>\n\n\n\n--key<\/code><\/li>\n\n\n\n--api-key<\/code><\/li>\n\n\n\n--password<\/code><\/li>\n\n\n\n--certpassword<\/code><\/li>\n\n\n\n--install-arguments-sensitive<\/code><\/li>\n\n\n\n--package-parameters-sensitive<\/code><\/li>\n<\/ul>\n\n\n\n<\/p><\/div>Important:<\/strong> \nAvoid running any commands or scripts with keys or passwords (sensitive information) as arguments in them. If you need to run a command with sensitive information, make sure you write a script on your local device, transfer it to a remote device using Remote File Manager, then run the script on the remote device using the remote command line interface. <\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n
Remote File Manager<\/strong><\/h2>\n\n\n\n
The Remote File Manager (RFM) lets you transfer (upload and download) files between Admin and end-user devices during Background Tools sessions and standard Remote Assist session types (One-time Access Code, Consent Prompt, and Unattended Access). <\/p>\n\n\n\n
Admins have access to the RFM at any time during a regular remote assist session type through the session toolbar, and during Background Tools sessions in the File Browser tab. <\/p>\n\n\n\n
Features<\/h3>\n\n\n\n
Supported file operations in RFM include:<\/p>\n\n\n\n
- \n
- Download<\/strong>: Admins can download files from an end-user device to their Admin device. <\/li>\n\n\n\n
- Upload<\/strong>: Admins can select files from their device and upload them to the end-user device. <\/li>\n\n\n\n
- Move<\/strong>: Admins can manually move files to and from different areas of the end-user device. <\/li>\n\n\n\n
- Delete<\/strong>: Admins can delete files from the end-user device. <\/li>\n\n\n\n
- Rename<\/strong>: Admins can rename files on the end-user device.<\/li>\n\n\n\n
- Browsing<\/strong>: Admins can browse the files on an end-user\u2019s device. <\/li>\n\n\n\n
- Copy<\/strong>: Admins can copy files to and from different areas of the end-user device.<\/li>\n<\/ul>\n\n\n\n
Limitations<\/h3>\n\n\n\n
- \n
- Admins using the RFM on a Windows device can currently only browse the C: drive. Support for browsing the rest of the file drives will come in subsequent releases. <\/li>\n\n\n\n
- During a file transfer, Admins can not pause active downloads or uploads. Pausing and resuming active file transfers will be available in subsequent releases.<\/li>\n\n\n\n
- RFM does not support copy, move, download, upload, or rename functionalities for folders<\/strong>. <\/li>\n\n\n\n
- RFM can only perform one file operation at a time. It can\u2019t perform multiple file operations simultaneously. <\/li>\n\n\n\n
- The maximum file transfer size limit is 2 GB.<\/li>\n\n\n\n
- Linux is not currently supported.<\/li>\n\n\n\n
- Admins can not currently see all of the directory shortcuts during a Background Tools session.<\/li>\n\n\n\n
- Admins must manually dismiss notifications; notifications are not dismissed automatically. <\/li>\n<\/ul>\n\n\n\n
Known Issues<\/h3>\n\n\n\n
- \n
- Upload files above 1 MB might be corrupted at the destination (RAA).<\/li>\n\n\n\n
- When an Admin is trying to upload an unauthorized file, or upload without the appropriate permissions and fails, there is no error message to communicate this failure. <\/li>\n\n\n\n
- Uploading several large files in sequence can freeze the upload operation. <\/li>\n\n\n\n
- When an Admin tries and fails to upload a file to a directory with read-only access, there is no error message to communicate this failure. <\/li>\n\n\n\n
- In the Volume<\/strong> file directory, Admins can create new folders, but can not currently upload files. This will be fixed in future releases.<\/li>\n\n\n\n
- Admins can not currently cancel a file during upload, they must wait for the file to finish uploading and then delete the file. This cancel functionality will be fixed in future releases.<\/li>\n\n\n\n
- Admins must manually click the text on a file or directory to select it. In future releases, Admins will be able to select items by clicking on the entire row. <\/li>\n\n\n\n
- Error messages for uploading duplicate files are very vague. These error messages will be more descriptive in future releases. <\/li>\n\n\n\n
- When creating a new folder, Admins must manually click Create<\/strong>. In future releases, Admins will be able to use the Enter <\/strong>key to confirm folder creation.<\/li>\n<\/ul>\n\n\n\n
Access Remote File Manager with Background Tools<\/h3>\n\n\n\n
- \n
- Ensure that you have the proper permissions to use Remote File Manager. For more information, see Grant Screen Recording and Accessibility Permissions for the Remote Assist Agent<\/a>.<\/li>\n\n\n\n
- Launch a Background Tools session and connect to an end-user\u2019s device. For more information, see Enable and Launch Background Tools<\/a>.<\/li>\n\n\n\n
- In the Background Tools<\/strong> browser window, click the File Manager <\/strong>tab. <\/li>\n\n\n\n
- The File Manager interface displays.
<\/li>\n<\/ol>\n\n\n\n- \n
- For next steps on using the RFM, see Use Remote File Manager.<\/a><\/li>\n<\/ol>\n\n\n\n
Access Remote File Manager with Remote Assist<\/h3>\n\n\n\n
- \n
- Start a standard Remote Assist session and connect to an end-user\u2019s device. For more information on initiating a Remote Assist session, see Get Started: Remote Assist<\/a>.<\/li>\n\n\n\n
- In the session toolbar, click Session Options<\/strong>.
<\/li>\n<\/ol>\n\n\n\n- \n
- Click File Manager<\/strong>. The file browser opens in a new window displaying the end-user\u2019s remote file systems.<\/li>\n<\/ol>\n\n\n\n<\/p><\/div>Note:<\/strong> \n
- \n
- To close the File Manager window, click the X <\/strong>close icon. <\/li>\n\n\n\n
- You can quickly navigate between directories using the shortcuts in the left-hand navigation, such as the Home<\/strong>, Downloads<\/strong>, Documents<\/strong>, Desktop<\/strong>, Pictures<\/strong>, and Music<\/strong> file directories.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n
- To close the File Manager window, click the X <\/strong>close icon. <\/li>\n\n\n\n
- In the session toolbar, click Session Options<\/strong>.
- Start a standard Remote Assist session and connect to an end-user\u2019s device. For more information on initiating a Remote Assist session, see Get Started: Remote Assist<\/a>.<\/li>\n\n\n\n
- Launch a Background Tools session and connect to an end-user\u2019s device. For more information, see Enable and Launch Background Tools<\/a>.<\/li>\n\n\n\n
- Upload<\/strong>: Admins can select files from their device and upload them to the end-user device. <\/li>\n\n\n\n
- When you are finished, click End Session<\/strong>. <\/li>\n<\/ol>\n\n\n\n
- Go to Device Management<\/strong> > Devices<\/strong> and click the Devices<\/strong> tab. <\/li>\n\n\n\n
- Click the Features <\/strong>tab.<\/li>\n\n\n\n
- Go to Settings<\/strong>. <\/li>\n\n\n\n
- Log in to the JumpCloud Admin Portal<\/a>.<\/li>\n<\/ol>\n\n\n\n
![\"This](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/FM_Download-Options.png\")
<\/li>\n<\/ol>\n\n\n\n![](\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/tip-icon.png\"){kind=icon}
<\/p><\/div>![\"\"](\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/08\/BA-updated-Add-icon.png\"){kind=icon}
<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n\n\n\n![\"\"](\"https:\/\/jumpcloud.com\/\/wp-content\/uploads\/2023\/08\/File-Transfer-Status-bar.png\"){kind=spacer}
<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n![\"JumpCloud](\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2023\/08\/Directory-Insights.png\")