Citrix Daas SDK

Start-EnvTestTask

August 9, 2024

Contributed by:

C C

Starts a new test task.

Syntax

Start-EnvTestTask
     [-IgnoreRelatedObjects]
     [-RunAsynchronously]
     [-ExcludeNotRunTests]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Start-EnvTestTask
     -TestId <String>
     [-TargetIdType <String>]
     [-TargetId <String>]
     [-CultureName <String>]
     [-IgnoreRelatedObjects]
     [-RunAsynchronously]
     [-ExcludeNotRunTests]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Start-EnvTestTask
     -TestSuiteId <String>
     [-TargetIdType <String>]
     [-TargetId <String>]
     [-CultureName <String>]
     [-IgnoreRelatedObjects]
     [-RunAsynchronously]
     [-ExcludeNotRunTests]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Start-EnvTestTask
     [-CultureName <String>]
     -InputObject <PSObject[]>
     [-IgnoreRelatedObjects]
     [-RunAsynchronously]
     [-ExcludeNotRunTests]
     [<CitrixCommonParameters>]
     [<CommonParameters>]
<!--NeedCopy-->

Description

Starts a new test task based on a set of criteria provided via parameters or piped input and either waits for the tests to run or returns immediately depending on how it is called. When running a test suite and providing a target object for that suite, the service will discover related objects by default, but this behavior may be disabled if desired.

Examples

EXAMPLE 1

Create and start a task with a single test and no target object.

$singleSimpleTestTask = Start-EnvTestTask -TestId Monitor_RegisteredWithConfigurationService
<!--NeedCopy-->

EXAMPLE 2

Create and start a task with a single test and no target object, with localized properties translated into Spanish.

$singleSimpleTestTaskInSpanish = Start-EnvTestTask -TestId Monitor_RegisteredWithConfigurationService -CultureName es-ES
<!--NeedCopy-->

EXAMPLE 3

Create and start a task with a single test suite and no target object.

$singleSimpleTestSuiteTask = Start-EnvTestTask -TestSuiteId Infrastructure
<!--NeedCopy-->

EXAMPLE 4

Create and start a task with a single test suite and a catalog target object.

$singleTestSuiteTask = Start-EnvTestTask -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid
<!--NeedCopy-->

EXAMPLE 5

Create and start a task with a single test suite and a catalog target object, and return immediately not waiting for the tests to complete.

$singleTestSuiteTask = Start-EnvTestTask -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid -RunAsynchronously
<!--NeedCopy-->

EXAMPLE 6

Create and start a task with a single test, a target object for that test, and no object discovery based on that target.

$adAccountPool = Get-AcctIdentityPool
$singleTestTaskWithNoObjectDiscovery = StartEnvTestTask -IgnoreRelatedObjects -TestId ADIdentity_IdentityPool_ValidatePoolIsUnlocked -TargetIdType IdentityPool -TargetId $adAccountPool.IdentityPoolUid
<!--NeedCopy-->

EXAMPLE 7

Create two different discovery target definitions, put them in an array, then start a task based on both via -InputObject.

$singleSimpleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Infrastructure
$singleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid
$inputObjects = @($singleSimpleTestSuiteTaskTarget, $singleTestSuiteTaskTarget)
Start-EnvTestTask -InputObject $inputObjects
<!--NeedCopy-->

Parameters

-TestId

Test identifiers. If specified, do not specify -TestSuiteId.

Type:	String
Position:	Named
Default value:	Empty
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-TestSuiteId

Test suite identifiers. If specified, do not specify -TestId.

Type:	String
Position:	Named
Default value:	Empty
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

One or more test targets defining the task, see Input Types for details about what kind of objects are permissible. Any valid object passed to this parameter may also be piped into this cmdlet.

Type:	PSObject[]
Position:	Named
Default value:	Empty
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-TargetIdType

Describes the type of corresponding object passed with -TargetId

Type:	String
Position:	Named
Default value:	Empty
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TargetId

The Ids that object tests or tests suites will target. By default, other components are queried for objects related to these.

Type:	String
Position:	Named
Default value:	Empty
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CultureName

The culture name in which to produce results. The culture name is in standard language/region-code format; for example “en-US”.

Type:	String
Position:	Named
Default value:	The current user interface culture
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IgnoreRelatedObjects

Do not ask other components for objects related to a specified target.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RunAsynchronously

Do not wait for the test run to complete, return immediately.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeNotRunTests

If set, tests that are not run because no object matching their requirements is found are NOT included in test counts and results.

Type:	SwitchParameter
Position:	Named
Default value:	False (include Not Run tests)
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition

A single EnvTestDiscoveryTargetDefinition can be specified to target one test or test suite.

Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition[]

An array of EnvTestDiscoveryTargetDefinition(s) can be specified to target any combination of tests and/or test suites.

PSCustomObject

A single PSCustomObject with properties matching the required EnvTestDiscoveryTargetDefinition properties can be specified to target one test or test suite.

PSCustomObject[]

An array of PSCustomObject(s) with properties matching the required EnvTestDiscoveryTargetDefinition properties can be specified to target any combination of tests and/or test suites.

Outputs

Ctrix.EnvTest.Sdk.EnvTestTask

The newly started task.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Start-EnvTestTask

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Start-EnvTestTask

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

EXAMPLE 5

EXAMPLE 6

EXAMPLE 7

Parameters

-TestId

-TestSuiteId

-InputObject

-TargetIdType

-TargetId

-CultureName

-IgnoreRelatedObjects

-RunAsynchronously

-ExcludeNotRunTests

CitrixCommonParameters

CommonParameters

Inputs

Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition

Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition[]

PSCustomObject

PSCustomObject[]

Outputs

Ctrix.EnvTest.Sdk.EnvTestTask

Related Links

In this article