New-EnvTestDiscoveryTargetDefinition

Last published : Oct 31, 2026
Creates a new EnvTestDiscoveryTargetDefinition object
Related information
about_EnvTestEnvTestSnapIn

Syntax

New-EnvTestDiscoveryTargetDefinition
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-EnvTestDiscoveryTargetDefinition
   -TestId <String>
   [-TargetIdType <String>]
   [-TargetId <String>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-EnvTestDiscoveryTargetDefinition
   -TestSuiteId <String>
   [-TargetIdType <String>]
   [-TargetId <String>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Creates a new EnvTestDiscoveryTargetDefinition object that can be piped into Start-EnvTestTask to define one or more targets of execution, optionally including root objects for discovery.

Examples

EXAMPLE 1

Create a discovery target definition with a single test and no target object, then start a task based on it.
$singleSimpleTestTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestId Monitor_RegisteredWithConfigurationService
$singleSimpleTestTaskTarget | Start-EnvTestTask

EXAMPLE 2

Create a discovery target definition with a single test suite and no target object, then start a task based on it.
$singleSimpleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Infrastructure
$singleSimpleTestSuiteTaskTarget | Start-EnvTestTask

EXAMPLE 3

Create a discovery target definition with a single test suite and a catalog target object, then start a task based on it.
$singleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid
$singleTestSuiteTaskTarget | Start-EnvTestTask

EXAMPLE 4

Create two different discovery target definitions, put them in an array, then start a task based on both.
$singleSimpleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Infrastructure
$singleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid
@($singleSimpleTestSuiteTaskTarget, $singleTestSuiteTaskTarget) | Start-EnvTestTask

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

-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 test 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

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

None

You can't pipe objects to this cmdlet.

Outputs

Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition

Defines a target of a task