Edit

Share via


Remove-CsConversationHistoryConfiguration

Resets the conversation history configuration settings for the organization. These settings manage conversation histories for mobile device users.

Syntax

Default (Default)

Remove-CsConversationHistoryConfiguration
    [-Identity] <XdsIdentity>
    [-Confirm]
    [-Force]
    [-WhatIf]
    [<CommonParameters>]

Description

Prior to the release of Skype for Business Server, conversation histories were stored in the Conversation History folder in users's mailbox, written by the Skype for Business rich client. Unfortunately, that proved to be a problem for mobile device users, because the Conversation History folder is typically not replicated to mobile devices. With Skype for Business Server, however, conversation histories, missed call notifications and missed IM notifications can be stored on the server in user mailboxes; this change makes these items readily available to mobile devices. Administrators can manage the server-side storage of these conversation histories by using the conversation history configuration settings. Just keep in mind that a single, global collection of these settings is used to manage conversation histories throughout your deployment. There is no option for creating additional conversation history settings at the site, service, or per-user scope.

Despite the name, the Remove-CsConversationHistoryConfiguration cmdlet does not actually delete the global collection of settings; that's because the global collection cannot be deleted. Instead, the Remove-CsConversationHistoryConfiguration cmdlet resets all the properties in the global collection to their default values. For example, when you install Skype for Business Server the CachedUserThreshold property is set to 1000000. Suppose you change this value to 500000. If you run the Remove-CsConversationHistoryConfiguration cmdlet then CachedUserThreshold will revert back to its default value of 1000000.

Examples

Example 1

Remove-CsConversationHistoryConfiguration -Identity "global"

The command shown in Example 1 resets all the properties in the global collection of conversation history configuration settings to their default values.

Parameters

-Confirm

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Suppresses the display of any non-fatal error message that might occur when running the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Unique identifier for the conversation history configuration settings to be deleted. Because there is only a single, global collection of settings per deployment, the only allowed syntax is the following:

-Identity "global"

Parameter properties

Type:XdsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings

Remove-CsConversationHistoryConfiguration accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object.

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings

Instead, Remove-CsConversationHistoryConfiguration resets instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object.