Developer Documentation
Citrix Virtual Apps and Desktops SDK
2511 CR 2507 LTSR 2503 CR 2411 CR 2407 CR 2402 LTSR 2311 CR 2305 CR 2303 CR 2212 CR 2209 CR 2206 CR 2203 LTSR 2112 CR 2109 CR 2103 CR 1912 LTSR
View PDF

Set-MonitorLogServerConfiguration

January 13, 2026
Contributed by: 
C

Introduced in: Citrix Virtual Apps and Desktop 7 2511

Set log server configuration detail to Monitor DB.

Syntax

Set-MonitorLogServerConfiguration
   -LogServerName <String>
   -LogServerPort <Int32>
   [-LogServerResourceLocationId <Guid>]
   [-LogServerApiKey <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Set log server configuration detail to Monitor DB. This setting can be used to add or update a log server configuration.

Examples

EXAMPLE 1

Set log server configuration detail to Monitor DB.

Set-MonitorLogServerConfiguration -LogServerName "https://logserver.com" -LogServerPort 443 -LogServerResourceLocationId "00000000-0000-0000-0000-000000000000" -LogServerApiKey "api_key"
<!--NeedCopy-->

Parameters

-LogServerName

Log server address with protocol and FQDN/IP address (e.g., https://logserver.com, http://192.168.1.100).

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

-LogServerPort

Port of log server.

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

-LogServerResourceLocationId

Guid of CC resource location proximate to the log server, only for cloud customers, null for onprem customers.

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

-LogServerApiKey

API key for the log server.

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -SkipCertificateValidation, -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

Boolean

Returns a boolean stating whether log server information is successfully configured.

Set-MonitorLogServerConfiguration
January 13, 2026
Contributed by: 
C
January 13, 2026
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.