Citrix Virtual Apps and Desktops 2507 SDK

New-BrokerLogServerAddress

August 14, 2025

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2507

Creates a new centralized log server configuration.

Syntax

New-BrokerLogServerAddress
   [-Enabled <Boolean>]
   [-Endpoint <String>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command when you want to create a new log server configuration byte array from scratch, rather than modifying an existing one. You must define the endpoint for the log server, and some additional details.

This command does not, by itself, have any persistent effects within XenDesktop. To make the change persistent, the new configuration byte array must first be transformed into a machine configuration within the Citrix Broker Service. To do this, use the New-BrokerMachineConfiguration command. You can then use the Add-BrokerMachineConfiguration and Set-BrokerMachineConfiguration commands to fully associate the new configuration with a delivery group.

Examples

EXAMPLE 1

This example shows a new configuration byte array being created to specify a log server address. The configuration byte array is then provided as input to the Get-BrokerLogServerAddress command, which interprets and outputs the same fields.

$configuration = New-BrokerLogServerAddress -Enabled $true -Endpoint "logserver.mysite.com:5000"

Get-BrokerLogServerAddress -ByteArray $configuration

Enabled            Endpoint
----               ---
True               logserver.mysite.com:5000
<!--NeedCopy-->

Parameters

-Enabled

Specifies if the new log server address should be used log collection.

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

-Endpoint

Specifies the fully-qualified domain name and port number of the log server, such as “logserver.mysite.com:5000”

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Length range:	1 to 258

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

Byte[]

The new configuration byte array, with all of the given modifications applied.

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

New-BrokerLogServerAddress

August 14, 2025

Contributed by:

August 14, 2025

Contributed by:

New-BrokerLogServerAddress

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Enabled

-Endpoint

CommonParameters

Inputs

None

Outputs

Byte[]

Related Links

In this article