Merge pull request #6 from QualiSystems/2024.1/ongoing

2024.1/ongoing

.wordlist.txt

@@ -1612,3 +1612,15 @@ Ei
 Gi
 Dpa
 EE
+Setuptools
+TooManyOpenSockets
+UseRabbitServer
+ZeroMQ
+setuptools
+urllib
+DeleteExecutionServer
+GetExecutionServers
+GetResourceAttributeValues
+GetResourceDetails
+GetResourcesAttributeValues
+performant

docs/admin/cloudshell-event-queue.md

@@ -48,11 +48,17 @@ To do so, create a file titled ServerEventsWhiteList.csv in the application dire
 Typically this is `%Program Files(x86)%\Qualisystems\Server`
 The contents of the CSV should be the events you *allow* to be published
 
+:::note
+ServerEventsWhiteList.csv should be line-break separated, not comma separated.
+:::
+
 [See](#supported-events) which [events](#supported-events) are supported (all are sent by default)
 
 :::info[Example csv]
-``` csv
-UserCreatedEvent, UserGroupsListUpdatedEvent, LoginEvent
+```
+UserCreatedEvent
+UserGroupsListUpdatedEvent
+LoginEvent
 ```
 :::
 

docs/admin/cloudshell-manage-dashboard/manage-app-templates/app-template/deployment-path/aws-ec2-dp-attributes.md

@@ -82,7 +82,7 @@ If not specified, the protocol defaults to TCP.
 
 :::tip Tips
 - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-- To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html) method instead. Unlike the Inbound Ports attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
+- To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html) method instead. Unlike the Inbound Ports attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
 :::
             </td>
         </tr>

docs/admin/cloudshell-manage-dashboard/manage-app-templates/app-template/deployment-path/azure-custom-image-dp-attributes.md

@@ -214,7 +214,7 @@ If not specified, the protocol defaults to TCP.
 :::
 :::tip Tips
 - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-- To set more specific security groups, it is recommended to use the TestShell API's [SetAppSecurityGroups](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
+- To set more specific security groups, it is recommended to use the TestShell API's [SetAppSecurityGroups](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
 :::
             </td>
         </tr>

docs/admin/cloudshell-manage-dashboard/manage-app-templates/app-template/deployment-path/azure-galery-dp-attributes.md

@@ -191,7 +191,7 @@ If not specified, the protocol defaults to TCP.
 :::
 :::tip Tips
 - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-- To set more specific security groups, it is recommended to use the TestShell API's [SetAppSecurityGroups](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
+- To set more specific security groups, it is recommended to use the TestShell API's [SetAppSecurityGroups](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
 :::
             </td>
         </tr>

docs/admin/cloudshell-manage-dashboard/manage-app-templates/app-template/deployment-path/azure-marketplace-dp-attributes.md

@@ -217,7 +217,7 @@ If not specified, the protocol defaults to TCP.
 :::
 :::tip Tips
 - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-- To set more specific security groups, it is recommended to use the TestShell API's [SetAppSecurityGroups](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the Inbound Ports attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
+- To set more specific security groups, it is recommended to use the TestShell API's [SetAppSecurityGroups](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the Inbound Ports attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../../../supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/setappsecuritygroups-code-example.md).
 :::
             </td>
         </tr>

docs/admin/setting-up-cloudshell/assembly-lab/configure-assembly-lab-domain.md

@@ -5,7 +5,7 @@ sidebar_position: 2
 
 To leverage the capabilities of Assembly Lab, a domain must be configured to the Assembly Lab domain. Once the domain is configured, all sandboxes created within this domain will adhere to the specific rules of Assembly Lab.
 
-:::note
+:::warning
 Once a domain has been configured as an assembly lab domain, do not try to change it back to a non-assembly lab domain. Assembly Lab domains have a different set of rules for resource management and blueprint resolution which are not compatible with standard domain operation.
 :::
 

docs/admin/setting-up-cloudshell/assembly-lab/index.md

@@ -60,25 +60,4 @@ The matching resource must be of the same model as the requirement and have valu
 
 ### Hierarchical Completion
 
-Each of the work order resources in their hierarchy must also be marked as "completed" for the entire resource to be considered completed.
-
-
-### User Interaction and Negotiation
-
-#### Sandbox Interaction
-
-The sandbox environment enables lab managers and customers to negotiate over requirements and make adjustments as needed. This can involve shifting devices around or changing requirements to something more feasible.
-
-#### Capability Sets
-
-User groups can be managed through capability sets, ensuring that each group has the appropriate access levels and permissions.
-
-#### Sticky Notes
-
-Sticky notes can be placed in blueprints and sandboxes to clarify requirements and communicate important information.
-
-#### Work Order Comments
-
-Lab managers can leave comments on each record in the work order, allowing customers to track progress and stay informed about the status of their requests.
-
-
+Each of the work order resources in their hierarchy must also be marked as "completed" for the entire resource to be considered completed.

docs/admin/setting-up-cloudshell/assembly-lab/note.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 10
+---
+# Limitations
+
+
+:::warning
+Recurring sandboxes are not currently supported in assembly lab
+:::
+
+:::warning
+Once a domain has been configured as an assembly lab domain, do not try to change it back to a non-assembly lab domain. Assembly Lab domains have a different set of rules for resource management and blueprint resolution which are not compatible with standard domain operation.
+:::

docs/admin/setting-up-cloudshell/cloudshell-configuration-options/advanced-cloudshell-customizations.md

@@ -1860,7 +1860,7 @@ Apps based on a public cloud provider, such as AWS EC2 and Azure, cannot be used
 
 By default, when trying to open a URL to a sandbox from a domain you can access but are not currently logged into, CloudShell prompts the user to switch to the domain (assuming the blueprint is public and the user is permitted to access the sandbox/blueprint). If the user confirms the switch, CloudShell will then open the sandbox/blueprint in its domain. However, you can choose to prevent this domain switch by setting the `AutoSwitchDomain` key. For additional information, see [Opening Sandboxes](../../../portal/sandboxes/opening-sandboxes.md).
 :::note
-When opening a blueprint from a URL, the domain switch only works if the blueprint URL includes the domain ID. To obtain a blueprint URL with the domain ID, use the CloudShell Automation API's [GetTopologyUrls](pathname:///api-docs/2023.3/python-api/cloudshell.api.html?#cloudshell.api.cloudshell_api.CloudShellAPISession.GetTopologyUrls) method.
+When opening a blueprint from a URL, the domain switch only works if the blueprint URL includes the domain ID. To obtain a blueprint URL with the domain ID, use the CloudShell Automation API's [GetTopologyUrls](pathname:///api-docs/2024.1/python-api/cloudshell.api.html?#cloudshell.api.cloudshell_api.CloudShellAPISession.GetTopologyUrls) method.
 :::
 **To disable the domain switch when accessing a sandbox/blueprint link:**
 
@@ -2305,3 +2305,4 @@ Shared tests and assets are stored in the MS SQL database
 ## Related topics
 
 - [Customer Configuration Keys Repository](./customer-configuration-keys-repository)
+

docs/admin/setting-up-cloudshell/cloudshell-configuration-options/customer-configuration-keys-repository/general.md

@@ -662,3 +662,33 @@ Python 3 automation requires Microsoft Visual C++ Redistributable 2015 x86 and x
 		</tr>
 	</tbody>
 </table>
+
+## Keep ports in reservation when removing visual connectors
+<table>
+	<tbody>
+		<tr>
+			<td>Key</td>
+			<td>`<add key="EnableVisualConnectorDisconnectRemovePorts" value="false"/>`</td>
+		</tr>
+		<tr>
+			<td>Possible values</td>
+			<td>Boolean</td>
+		</tr>
+		<tr>
+			<td>Where to add/change</td>
+			<td>`customer.config` CloudShell Server installation directory</td>
+		</tr>
+		<tr>
+			<td>true</td>
+			<td>false</td>
+		</tr>
+		<tr>
+			<td>Affected CloudShell Component</td>
+			<td>CloudShell Server</td>
+		</tr>
+		<tr>
+			<td>Version</td>
+			<td>2024.1 and above</td>
+		</tr>
+	</tbody>
+</table>

docs/admin/supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/aws-integration-and-configuration/aws-integration/add-an-aws-ec2-app-template.md

@@ -164,7 +164,7 @@ The App template defines the settings and configurations of the VM to be deploye
             :::
             :::tip Tips:
             - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
+            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
             :::
                         </td>
                     </tr>

docs/admin/supported-cloud-providers-in-cloudshell/public-cloud-provider-support-in-cloudshell/microsoft-azure-integration-and-configuration/microsoft-azure-integration/add-an-azure-app-template.md

@@ -289,7 +289,7 @@ The App template defines the settings and configurations of the VM to be deploye
             :::
             :::tip Tips:
             - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Port**s attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
+            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Port**s attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
             :::
                         </td>
                     </tr>
@@ -537,7 +537,7 @@ The App template defines the settings and configurations of the VM to be deploye
             :::
             :::tip Tips:
             - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Port**s attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
+            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Port**s attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
             :::
                         </td>
                     </tr>
@@ -759,7 +759,7 @@ The App template defines the settings and configurations of the VM to be deploye
             :::
             :::tip Tips:
             - To allow QualiX in-browser connections to the VM from the sandbox, include port "22".
-            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2023.3/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
+            - To set more specific security groups, it is recommended to use the TestShell API's [SetAppsSecurityGroup](pathname:///api-docs/2024.1/TestShell-API/TestShell%20XML%20RPC%20API.html#SetAppSecurityGroups) method instead. Unlike the **Inbound Ports** attribute, it enables you to define different port settings per subnet and allow inbound access to specific source CIDRs. For additional information, see [SetAppSecurityGroups Code Example](../../setappsecuritygroups-code-example.md).
             :::
                         </td>
                     </tr>

docs/api-guide/cs-api-overview.md

@@ -29,17 +29,17 @@ A RESTful API designed to facilitate the consumption of public blueprints for CI
 
 ## Automation API
 
-This API is an official Python package utilizing XMLRPC protocol to communicate with CloudShell. It's designed to automate CloudShell from Python scripts and drivers. The CloudShell Automation API is based on the XML RPC API. For details, see the [CloudShell Automation API](./shell-dev-blueprint-design-api/cs-automation-api.md) article, or check out our API guides. The Python package [API guide](pathname:///api-docs/2023.3/Python-API/) includes additional information like return objects and is intended for experienced Python developers, while for beginners, we recommend to use the [TestShell API Python Reference Guide](pathname:///api-docs/2023.3/TestShell-API/TestShell%20Python%20API.html), which features an easy to understand format and code examples.
+This API is an official Python package utilizing XMLRPC protocol to communicate with CloudShell. It's designed to automate CloudShell from Python scripts and drivers. The CloudShell Automation API is based on the XML RPC API. For details, see the [CloudShell Automation API](./shell-dev-blueprint-design-api/cs-automation-api.md) article, or check out our API guides. The Python package [API guide](pathname:///api-docs/2024.1/Python-API/) includes additional information like return objects and is intended for experienced Python developers, while for beginners, we recommend to use the [TestShell API Python Reference Guide](pathname:///api-docs/2024.1/TestShell-API/TestShell%20Python%20API.html), which features an easy to understand format and code examples.
 
 To learn how to implement this API in .NET or XML RPC, see [TestShell API](./shell-dev-blueprint-design-api/testshell-api.md).
 
 ## Quali API
 
 A RESTful API designed to control the scheduling and queuing of test automation suites. Quali API can be used in several protocols (C#, TCL). This API is also used for importing and exporting packages and Shells, getting sandbox attachments, and execution server details. For details, see [Quali API](./quali-api.md), or check out the appropriate Quali API reference guide:
 
-- [Quali API Library Reference Guide](pathname:///api-docs/2023.3/Quali-API/Quali%20API%20Library.html): is available by default in the TestShell Studio tools and can be added as a DLL asset to a project in CloudShell Authoring.
-- [Quali API C# Reference Guide](pathname:///api-docs/2023.3/Quali-API/Quali%20cSharp%20API.html "Quali API C# Reference Guide"): for .NET
-- [Quali API REST Reference Guide](pathname:///api-docs/2023.3/Quali-API/Quali%20REST%20API.html "Quali API REST Reference Guide"): for APIs using the REST client
+- [Quali API Library Reference Guide](pathname:///api-docs/2024.1/Quali-API/Quali%20API%20Library.html): is available by default in the TestShell Studio tools and can be added as a DLL asset to a project in CloudShell Authoring.
+- [Quali API C# Reference Guide](pathname:///api-docs/2024.1/Quali-API/Quali%20cSharp%20API.html "Quali API C# Reference Guide"): for .NET
+- [Quali API REST Reference Guide](pathname:///api-docs/2024.1/Quali-API/Quali%20REST%20API.html "Quali API REST Reference Guide"): for APIs using the REST client
 
 The default port for Quali API in the Quali Server is 9000.
 

docs/api-guide/new-jss-rest-api/api-support-for-jss-and-js.md

@@ -4,7 +4,7 @@ sidebar_position: 20
 
 # API Support for New Job Scheduling and Job Scheduling (1st Gen)
 
-The section compares the APIs for the different Job Scheduling features. The New Job Scheduling has a dedicated RESTful API while the original Job Scheduling uses the [Quali API](pathname:///api-docs/2023.3/Quali-API/Quali%20API%20Library.html).
+The section compares the APIs for the different Job Scheduling features. The New Job Scheduling has a dedicated RESTful API while the original Job Scheduling uses the [Quali API](pathname:///api-docs/2024.1/Quali-API/Quali%20API%20Library.html).
 
 :::note
 For brevity, the term "Job Scheduling (1st Gen)" denotes the original Job Scheduling which is accessed via CloudShell Portal.