diff --git a/docs/modules/device-lab-management/nav.adoc b/docs/modules/device-lab-management/nav.adoc index 9710e481d..5b4740edd 100644 --- a/docs/modules/device-lab-management/nav.adoc +++ b/docs/modules/device-lab-management/nav.adoc @@ -21,3 +21,4 @@ * xref:device-lab-management:device-management-page.adoc[] ** xref:device-lab-management:search-host-machines.adoc[] ** xref:device-lab-management:tidy-up-devices.adoc[] +** xref:device-lab-management:enable-virtualusb-on-host-machines.adoc[] diff --git a/docs/modules/device-lab-management/pages/device-management-page.adoc b/docs/modules/device-lab-management/pages/device-management-page.adoc index 9aed5d9f4..e6dbd1664 100644 --- a/docs/modules/device-lab-management/pages/device-management-page.adoc +++ b/docs/modules/device-lab-management/pages/device-management-page.adoc @@ -28,6 +28,19 @@ Displays the default location assigned to your organization. New host machines i The field is read-only. To change the default location for your organization, contact https://support.kobiton.com/hc/en-us/requests/new[Kobiton Support]. +=== Settings + +Opens the **Settings** dialog, which applies to every host machine in the organization. Changes in both tabs are saved together. + +**virtualUSB**:: +Enables virtualUSB on specific host machines and sets how virtualUSB connections are routed to each one. Available only to organizations whose plan includes virtualUSB. See xref:device-lab-management:enable-virtualusb-on-host-machines.adoc[]. + +**Max Parallel Tests**:: +Limits the number of parallel sessions each host machine accepts. See xref:device-lab-management:deviceConnect/control-host-capacity.adoc[]. + +// REVIEWER NOTE: The Settings dialog replaces the per-machine Settings window (KOB-52820). Confirm +// the Settings button placement and add a screenshot (KOB-52819). + === Tidy up Opens the **Remove unused devices** window, where you can hide offline or unplugged devices from the device list. Hidden devices stay hidden until they are reconnected. @@ -96,9 +109,6 @@ Saves the deviceConnect logs from the last three days. Select the dropdown icon, **Restart services**:: Restarts the deviceConnect services on the host machine. See xref:device-lab-management:deviceConnect/restart-deviceconnect-services.adoc[]. -**Settings**:: -Opens the **Settings** window, where **Max Parallel Tests** limits the number of parallel sessions the host machine accepts. See xref:device-lab-management:deviceConnect/control-host-capacity.adoc[]. - Expand or collapse icon:: Shows or hides the device table for that host machine. @@ -149,6 +159,8 @@ Restarts the device. * xref:device-lab-management:tidy-up-devices.adoc[] +* xref:device-lab-management:enable-virtualusb-on-host-machines.adoc[] + * xref:device-lab-management:deviceConnect/control-host-capacity.adoc[] * xref:device-lab-management:deviceConnect/retrieve-deviceconnect-logs.adoc[] diff --git a/docs/modules/device-lab-management/pages/deviceConnect/control-host-capacity.adoc b/docs/modules/device-lab-management/pages/deviceConnect/control-host-capacity.adoc index ab5e0b0e6..b72c5fae7 100644 --- a/docs/modules/device-lab-management/pages/deviceConnect/control-host-capacity.adoc +++ b/docs/modules/device-lab-management/pages/deviceConnect/control-host-capacity.adoc @@ -25,29 +25,49 @@ For this reason, capacity limits are generally required only when more than 26 d == Set the Max Parallel Tests -To configure a capacity limit for a host machine: +Set capacity limits in the *Max Parallel Tests* tab of the *Settings* dialog in *Device Management*. The tab lists every host machine in the organization, so you can set limits for one machine, several machines, or all machines in one save. -. Sign in to the Kobiton Portal using an account with the *ADMIN* predefined role. +. Sign in to Kobiton Portal using an account with the *ADMIN* predefined role. . Select your profile picture, then choose *Settings*. . Open *Device Management*. -. Select *Settings* for the target host machine. +. Select *Settings* at the top of the page. + -image:host-machine-capacity-settings.png[width=1000,alt="The Settings option of a host machine in Device Management"] +// REVIEWER NOTE: Replace the retired per-machine screenshots (host-machine-capacity-settings.png, +// host-machine-set-capacity.png) with captures of the new Settings dialog. Confirm the Settings +// button placement. Source: KOB-52820; button placement is delivered by KOB-52819. -. In the pop-up, choose one of the following options: +. Select the *Max Parallel Tests* tab. ++ +Organizations without virtualUSB see only this tab. + +. To find a host machine, enter its name or IP address in the search field. + +. Set the limit for each host machine: * *Unlimited* (default): no limit for the host machine. -* *Set custom limit*: set a limit between 1 and 999. +* *Custom limit*: enter a limit between 1 and 999 in the field that appears. + The recommended value is *26*. + +. To apply one limit to every host machine, use the *All machines* row at the top of the list: + +* Select *Unlimited* to remove the limit from every host machine. + +* Select *Custom limit*, then enter a value to apply it to every host machine. + -image:host-machine-set-capacity.png[width=500,alt="The available options for setting capacity limit of a host machine"] +When host machines have different limits, the *All machines* row shows *Mixed*. If you change an individual host machine after setting *All machines*, the row returns to *Mixed*. . Select *Save*. ++ +*Save* is blocked until every *Custom limit* has a value. A message appears next to each missing value. + +Save applies all changes made in the *Settings* dialog. If the save fails, an error message appears, the dialog stays open, and your changes are kept so you can try again. + +To close the dialog without saving, select *Cancel* or the close icon, then confirm *You have unsaved changes. Leave anyway?* == How the capacity limit affects sessions diff --git a/docs/modules/device-lab-management/pages/enable-virtualusb-on-host-machines.adoc b/docs/modules/device-lab-management/pages/enable-virtualusb-on-host-machines.adoc new file mode 100644 index 000000000..c7fb13c9c --- /dev/null +++ b/docs/modules/device-lab-management/pages/enable-virtualusb-on-host-machines.adoc @@ -0,0 +1,84 @@ += Enable virtualUSB on host machines +:navtitle: Enable virtualUSB on host machines + +Enable virtualUSB on specific host machines so end users can connect to remote devices on those machines directly from their local machine or development environment. + +// REVIEWER NOTE: Source is KOB-52820 (Settings dialog, virtualUSB tab). Confirm rollout state of the +// Settings dialog for all organizations before publishing. + +== Before you start + +* Sign in with an account that has the *ADMIN* predefined role. + +* The *virtualUSB* tab is available only to organizations whose plan includes virtualUSB. Organizations without virtualUSB see only the *Max Parallel Tests* tab. + +* For self-managed host machines, confirm the IP address you plan to use is reachable from your end users' machines. + +== Enable virtualUSB + +. In Kobiton Portal, select your profile name or picture, then choose *Settings*. + +. Select the *Device Management* tab. + +. Select *Settings* at the top of the page. ++ +The *virtualUSB* tab opens first. ++ +// REVIEWER NOTE: Add a screenshot of the virtualUSB tab. Confirm the Settings button placement +// (delivered by KOB-52819). + +. Find the host machine. Enter its name or IP address in the search field, or select *Show enabled only* to list only host machines that already have virtualUSB enabled. + +. Turn on the *Enabled* toggle for the host machine. + +. Review the *Network Routing* and *Connection Address* values for the host machine: ++ +[cols="1,1,2"] +|=== +|Host machine |Network Routing |Connection Address + +|Hosted by Kobiton +|*Managed by Kobiton* +|Shows *Auto-configured by Kobiton*. No input is required. + +|Hosted by your organization +|*Self-managed* +|Pre-filled with the host machine's current IP address, which you can edit. This field is required. + +|Standalone +|Not shown +|Enter the IP address. This field is required. +|=== ++ +The connection address is the IP address used to route virtualUSB connections to the host machine. Make sure it is reachable from your end users' machines before saving. + +. Repeat for each host machine you want to enable. To disable virtualUSB on a host machine, turn off its *Enabled* toggle. + +. Select *Save*. ++ +*Save* is blocked until every enabled host machine has a *Network Routing* value and every required *Connection Address* has an IP address. A message appears next to each missing value. + +== Verify + +After a successful save, the dialog closes and the *Device Management* page updates to show the new virtualUSB state of each host machine. + +If no host machines match the search or the *Show enabled only* filter, the list shows *No machines found*. + +== Troubleshooting + +Save fails:: +An error message appears and the dialog stays open with your changes kept. Select *Save* again. + +Host machine list does not load:: +The dialog shows an error with an option to retry. Select the retry option to reload the list. + +Close the dialog without saving:: +Select *Cancel* or the close icon. When the dialog has unsaved changes, confirm *You have unsaved changes. Leave anyway?* to discard them, or cancel to return to the dialog with your changes intact. + +== Related guides + +* xref:device-lab-management:device-management-page.adoc[] + +* xref:device-lab-management:deviceConnect/control-host-capacity.adoc[] + +* xref:debugging:set-up-virtualusb.adoc[] diff --git a/docs/modules/release-notes/partials/KOB-52820.adoc b/docs/modules/release-notes/partials/KOB-52820.adoc new file mode 100644 index 000000000..cdf1c79fd --- /dev/null +++ b/docs/modules/release-notes/partials/KOB-52820.adoc @@ -0,0 +1,23 @@ +// Release-note partial for KOB-52820. +// REVIEWER NOTE: The Cloud September 18, 2026 release notes already announce this change under +// "Device Management" (sourced from parent epic KOB-52659). Use this partial only if a separate +// entry is still needed, or to reconcile wording with the published entry. Do not publish both. + +== Device Management + +=== Unified Settings dialog for host machines + +Configure virtualUSB and Max Parallel Tests for every host machine from one *Settings* dialog in *Device Management*. The dialog replaces the per-machine *Settings* window. + +*Highlights* + +- The *Max Parallel Tests* tab sets a limit of *Unlimited* or a custom value between 1 and 999 for each host machine. The *All machines* row applies one setting to every host machine at once. +- Organizations whose plan includes virtualUSB also see a *virtualUSB* tab. Enable virtualUSB on specific host machines and set how connections are routed: *Managed by Kobiton* for Kobiton-hosted machines, or *Self-managed* with an editable IP address for machines hosted by your organization. +- Search by host machine name or IP address in both tabs. In the *virtualUSB* tab, select *Show enabled only* to list only enabled host machines. +- One *Save* applies changes from both tabs. If a save fails, the dialog stays open and keeps your changes. Closing the dialog with unsaved changes asks for confirmation. + +*Availability* + +Organization admins with the *ADMIN* predefined role. The *virtualUSB* tab requires a plan that includes virtualUSB. + +// Source: KOB-52820