Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

New-Envtestdiscoverytargetdefinition

August 3, 2023
Contributed by: 
C

Creates a new EnvTestDiscoveryTargetDefinition object

Syntax

New-EnvTestDiscoveryTargetDefinition -TestId <String> [-TargetIdType <String>] [-TargetId <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

New-EnvTestDiscoveryTargetDefinition -TestSuiteId <String> [-TargetIdType <String>] [-TargetId <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed 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.

Parameters

Name Description Required? Pipeline Input Default Value
TestId Test identifiers. If specified, do not specify -TestSuiteId. true false Empty
TestSuiteId Test suite identifiers. If specified, do not specify -TestId. true false Empty
TargetIdType Describes the type of corresponding object passed with -TargetId false false Empty
TargetId The Ids that object tests or test suites will target. By default, other components are queried for objects related to these. false false Empty
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Envtest.Sdk.Envtestdiscoverytargetdefinition

Defines a target of a task

Examples

Example 1 

$singleSimpleTestTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestId Monitor_RegisteredWithConfigurationService

$singleSimpleTestTaskTarget | Start-EnvTestTask
<!--NeedCopy-->

Description

Create a discovery target definition with a single test and no target object, then start a task based on it.

Example 2 

$singleSimpleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Infrastructure

$singleSimpleTestSuiteTaskTarget | Start-EnvTestTask
<!--NeedCopy-->

Description

Create a discovery target definition with a single test suite and no target object, then start a task based on it.

Example 3 

$singleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid

$singleTestSuiteTaskTarget | Start-EnvTestTask
<!--NeedCopy-->

Description

Create a discovery target definition with a single test suite and a catalog target object, then start a task based on it.

Example 4 

$singleSimpleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Infrastructure

$singleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid

@($singleSimpleTestSuiteTaskTarget, $singleTestSuiteTaskTarget) | Start-EnvTestTask
<!--NeedCopy-->

Description

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

New-Envtestdiscoverytargetdefinition
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.