Set-MonitorLogServerConfiguration
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>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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"
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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| 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, -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
Returns a boolean stating whether log server information is successfully configured.