Set-CsImConfiguration

  • Reference
Module:
SkypeForBusiness
Applies to:
Skype for Business Server 2015, Skype for Business Server 2019

Use the Set-CsImConfiguration cmdlet to modify an existing Instant Messaging (IM) configuration. This cmdlet was introduced in Skype for Business June 2016 Cumulative Update.

Syntax

Set-CsImConfiguration
   [[-Identity] <XdsIdentity>]
   [-Confirm]
   [-EnableOfflineIm <Boolean>]
   [-Force]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]
Set-CsImConfiguration
   [-Confirm]
   [-EnableOfflineIm <Boolean>]
   [-Force]
   [-Instance <PSObject>]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Description

Use the Set-CsImConfiguration cmdlet to modify an existing Instant Messaging (IM) configuration.

Examples

-------------------------- Example 1 --------------------------

Set-CsImConfiguration -Identity "Site:Redmond" -EnableOfflineIm $false

This example modifies the existing Redmond site IM configuration to disable the offline IM feature.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-EnableOfflineIm

Enables or disables Offline Instant Messaging.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-Force

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-Identity

A unique identifier specifying the scope and, in some cases the name, of the IM configuration.

Type:XdsIdentity
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-Instance

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type IMConfiguration and can be retrieved by calling the Get-CsImConfiguration cmdlet.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-Tenant

This parameter is reserved for internal Microsoft use.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

Inputs

System.Management.Automation.PSObject

Outputs

System.Object