Citrix Virtual Apps and Desktops SDK

about_CitrixCommonParameters

March 11, 2024

Contributed by:

Short description

Describes the parameters that can be used with most Citrix DaaS cmdlets.

Long description

You can use the common Citrix parameters with most Citrix DaaS cmdlet, but they might not have an effect on all cmdlets.

Many of these parameters are used internally for passing trace information between processes.

The following list displays the common Citrix parameters.

AdminAddress
AdminClientIP
BearerToken
TraceParent
TraceState
VirtualSiteId

Common Citrix parameter descriptions

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

Type	String
Position	Named
Default value	Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Required	False
Accept pipeline input	False
Accept wildcard characters	False

-AdminClientIP

Specifies the Client IP of the calling user.

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

-BearerToken

Specifies the bearer token assigned to the calling user.

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

-TraceParent

Specifies the OpenTelemetry distributed tracing trace parent for this cmdlet call.

This property should follow the W3C Trace Context format for a traceparent header.

Note this property will also detect any ambient Activity provided by the caller provided by Activity.Current.

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

-TraceState

Specifies the OpenTelemetry distributed tracing trace state for this cmdlet call.

This property will be ignored if no TraceParent is specified.

This property should follow the W3C Trace Context format for a tracestate header.

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

-VirtualSiteId

Specifies the virtual site the PowerShell snap-in will connect to.

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

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

about_CitrixCommonParameters

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

about_CitrixCommonParameters

Short description

Long description

Common Citrix parameter descriptions

-AdminAddress

-AdminClientIP

-BearerToken

-TraceParent

-TraceState

-VirtualSiteId

In this article