Set-LogSite
Sets global configuration logging settings.
Syntax
Set-LogSite
[-State <LoggingState>]
[-Locale <String>]
[-LoggingDBPurgeDurationDays <Int32>]
[-PassThru]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet sets the global configuration logging settings.
Examples
EXAMPLE 1
Set the logging language to Chinese. The logging state will be unchanged.
Set-LogSite -Locale "zh-CN"
EXAMPLE 2
Set the logging state to mandatory. The logging locale will be unaffected. In this state, no configuration change will be allowed unless it is successfully logged.
Set-LogSite -State "Mandatory"
EXAMPLE 3
Set the logging language to German and the state to Enabled.
Set-LogSite -Locale "de" -State "Enabled"
Parameters
-State
Sets the state of configuration logging. Values can be:
-
Enabled - state changes will be logged. If logging isunavailable, the state change will still be permitted.
-
Disabled - state changes will not be logged.
-
Mandatory - state change will be logged. If logging isunavailable, the state change will not be permitted. When the state is set to Enabled or Mandatory, XenDesktop services will attempt to log operations (which perform configuration changes) before performing them.
| Type: | LoggingState |
| Accepted values: | Disabled, Enabled, Mandatory, NotSupported, Unknown |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Locale
Sets the language that logs should be recorded in. Values can be: 'en', 'ja', 'zh-CN', 'de', 'es' or 'fr'.
| Type: | String |
| Accepted values: | en, de, es, fr, ja, zh-CN |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingDBPurgeDurationDays
Sets the number of days for which the configuration logging logs will be retained. Any config logging data older than number of days set in this property will be purged.
The number of days for cloud sites must be between 1 and 180 days.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns the affected record. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| 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, -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
Citrix.ConfigurationLogging.Sdk.Site
Current logging settings
Notes
Configuration logging will automatically transition to a 'NotSupported' state if the logging feature is not licensed. Set-LogSite will reject request to set logging to 'Enabled' or 'Mandatory' while the logging feature is not licensed.