Set-CsClientPolicy

 

Topic Last Modified: 2017-05-17

ImportantImportant:
This only applies to Skype for Business Online and not to Skype for Business Server or Lync on-premises deployments.
ImportantImportant:
Please note that if your organization utilizes custom policies, then the UI will no longer correctly reflect the policy values. Once they are implemented they must continue to be managed via PowerShell.

Modifies the property values of an existing client policy. Among other things, client policies help determine the features of the Skype for Business app that are available to users; for example, you might give some users the right to transfer files while denying this right to other users.

Set-CsClientPolicy [-Identity <XdsIdentity>] <COMMON PARAMETERS>

Set-CsClientPolicy [-Instance <PSObject>] <COMMON PARAMETERS>

COMMON PARAMETERS:  [-Description <String>]  [-DisableCalendarPresence <$true | $false>] [-DisableEmailComparisonCheck <$true | $false>] [-DisableEmoticons <$true | $false>] [-DisableFreeBusyInfo <$true | $false>] [-DisableHandsetOnLockedMachine <$true | $false>] [-DisableHtmlIm <$true | $false>] [-DisableInkIM <$true | $false>] [-DisablePoorDeviceWarnings <$true | $false>] [-DisablePoorNetworkWarnings <$true | $false>] [-DisablePresenceNote <$true | $false>] [-DisableRTFIM <$true | $false>] [-DisableSavingIM <$true | $false>] [-DisplayPhoto <NoPhoto | PhotosFromADOnly | AllPhotos>] [-EnableAppearOffline <$true | $false>] [-EnableCallLogAutoArchiving <$true | $false>] [-EnableClientAutoPopulateWithTeam <$true | $false>] [-EnableClientMusicOnHold <$true | $false>] [-EnableConversationWindowTabs <$true | $false>] [-EnableEnterpriseCustomizedHelp <$true | $false>] [-EnableExchangeContactSync <$true | $false>] [-EnableIMAutoArchiving <$true | $false>] [-EnableSkypeUI <$true | $false>] [-EnableUnencryptedFileTransfer <$true | $false>] [-EnableURL <$true | $false>] [-ExcludedContactFolders <String>] [-Force <SwitchParameter>] [-MusicOnHoldAudioFile <String> [-PlayAbbreviatedDialTone <$true | $false>] [-ShowManagePrivacyRelationships <$true | $false>] [-ShowRecentContacts <$true | $false>] [-ShowSharepointPhotoEditLink <$true | $false>] [-TracingLevel <Off | Light | Full>] [-WhatIf [<SwitchParameter>]]

In Example 1, three different property values are modified for the client policy RedmondClientPolicy: the properties DisableEmoticons, DisableHtmlIm, and DisableRTFIm are all set to true.

Set-CsClientPolicy -Identity RedmondClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True

Example 2 also modifies the properties DisableEmoticons, DisableHtmlIm, and DisableRTFIm. In this example, however, the modifications are made to all the client policies that have been configured at the site scope. To do this, the command first uses the Get-CsClientPolicy cmdlet and the Filter property to return all the client policies where the Identity begins with the characters "tag:"; by definition, those are policies configured at the site scope. This filtered collection is then piped to the Set-CsClientPolicy cmdlet, which takes each policy in the collection and modifies the values of DisableEmoticons, DisableHtmlIm, and DisableRTFIm.

Get-CsClientPolicy -Filter "*tag:*" | Set-CsClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True

Client policies are applied each time a user accesses the system, regardless of where the user logs on from and regardless of the type of device the user logs on with. In addition, client policies, like other policies, can readily be targeted toward selected groups of users. You can even create a custom policy that gets assigned to a single user.

Client policies can be configured at the per-user scopes. The Set-CsClientPolicy cmdlet enables you to modify any (or all) of the client policies that have been configured for use in your organization.

NoteNote:
Keep in mind that client policies differ from many other policies in that most of the policy settings do not have default values.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsIdentity

Unique Identity to be assigned to the new policy. New client policies can be created at the per-user scope. To create a new per-user policy, use an identity similar to this: -Identity SalesClientPolicy.

DisableCalendarPresence

Optional

System.Boolean

When set to True, calendar data taken from Microsoft Outlook will not be included in your presence information. When set to False, calendar data will be included in your presence information. For example, free/busy information will be reported in your contact card. Likewise, your status will automatically be set to Busy any time Outlook shows that you are in a meeting.

DisableEmailComparisonCheck

Optional

System.Boolean

When set to True, Skype for Business will not attempt to verify that any currently running instance of Microsoft Outlook belongs to the same user running Skype for Business; for example, the software will not verify that both Outlook and Skype for Business are running under Ken Myer’s user account. Instead, it will be assumed that the two applications are running under the same account and, in turn, will include contact and calendar data in Outlook with Skype for Business.

When set to False, Skype for Business will use SMTP addresses to verify that Outlook and Skype for Business are running under the same account. If the SMTP addresses do not match, then contact and calendar data in Outlook will not be incorporated into Skype for Business.

DisableEmoticons

Optional

System.Boolean

When set to True, users will not be able to send or receive emoticons in their instant messages; instead they will be see the text equivalent of those emoticons. For example, instead of seeing a graphical "smiley face," users will see the text equivalent:

When set to False, users will be able to include emoticons in their instant messages, and to view emoticons in instant messages they receive.

DisableFreeBusyInfo

Optional

System.Boolean

When set to True, free/busy information retrieved from Microsoft Outlook will not be displayed in your contact card. When set to False, free/busy information is displayed in your contact card. For example, your contact card might include a note similar to this:

Calendar: Free until 2:00 PM

DisableHandsetOnLockedMachine

Optional

System.Boolean

When set to True, users will not be able to use their Polycom handset if the computer that the handset is connected to is locked. To use the handset, users will first have to unlock the computer.

When set to False, users will be allowed to use their Polycom handset even if the computer the handset is connected to is locked.

DisableHtmlIm

Optional

System.Boolean

When set to True, any HTML text copied from a webpage will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, drop-down lists, and buttons) will be retained when pasted into an instant message.

Note that, even when set to False, scripts and other potentially malicious items (such as tags that play a sound) will not be copied into an instant message. You can copy and paste buttons and other controls into a message, but any scripts attached to those controls will automatically be removed.

DisableInkIM

Optional

System.Boolean

When set to True, users will not be allowed to receive instant messages containing Tablet PC ink. (Ink is a technology that enables you to insert handwritten notes into a document.) When set to False, users will be allowed to receive messages that contain Tablet PC ink.

DisablePoorDeviceWarnings

Optional

System.Boolean

When set to True, Skype for Business won't issue warnings (for example, upon startup, in the Tuning Wizard, and in the Conversation window) if an audio or video device is not working correctly. When set to False, these warnings will be issued.

DisablePoorNetworkWarnings

Optional

System.Boolean

When set to True, Skype for Business will not display warnings about poor network quality.

DisablePresenceNote

Optional

System.Boolean

When set to True, any Out of Office message you configure in Microsoft Outlook will not be displayed as part of your presence information. When set to False, your Out of Office message will be displayed any time a user holds the mouse over your name in their Contacts list.

DisableRTFIM

Optional

System.Boolean

When both this setting and the DisableHtmlIm setting are set to True, prevents rich text formatting (for example, different fonts, font sizes, and font colors) from being used in instant messages; instead, all messages sent and received will be converted to plain text format. When set to False, rich text formatting will be allowed in instant messages.

DisableSavingIM

Optional

System.Boolean

When set to True, the options for saving an instant messaging session are removed from the menu bar in the Skype for Business Conversation window. When set to False, these options are available in the Conversation window.

Note that setting this value to True removes the menu options that make it easy for users to save instant messaging transcripts. However, it does not prevent users from copying all the text in a transcript to the clipboard, pasting that text into another application, and then saving the transcript that way.

DisplayPhoto

Optional

Microsoft.Rtc.Management.WritableConfig.Policy.Client.DisplayPhoto

Determines whether or not photos (of both the user and his or her contacts) will be displayed in Skype for Business. Valid settings are:

NoPhoto - Photos are not displayed in Skype for Business.

PhotosFromADOnly - Only photos that have been published in Active Directory can be displayed.

AllPhotos - Either Active Directory or custom photos can be displayed.

The default value is AllPhotos.

EnableAppearOffline

Optional

System.Boolean

When set to True an additional presence state, Appear Offline, is available in Skype for Business. This state makes it appear as though the user is offline; however, he or she will actually be online and available to answer phone calls and respond to instant messages. When set to False, the Appear Offline presence state will not be available in Skype for Business.

EnableCallLogAutoArchiving

Optional

System.Boolean

When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in Microsoft Outlook. (The actual call itself is not recorded. What is recorded is information such as who took part in the call; the length of the call; and whether this was an incoming or an outgoing call.) When set to False, this information is not saved to Outlook.

EnableClientMusicOnHold

Optional

System.Boolean

When set to True, music will be played any time a caller is placed on hold. When set to False, music will not be played any time a caller is placed on hold. The default value is False.

EnableConversationWindowTabs

Optional

System.Boolean

When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window. This type of information is available only for custom applications that use the Microsoft Unified Communications APIs. For example, customer service or support team personnel can automatically access related information while chatting with someone.

When set to False, supplemental information will not be displayed in a separate browser window. Although the user can still take part in an instant messaging session he or she will not have access to any additional information that accompanies the session.

EnableEnterpriseCustomizedHelp

Optional

System.Boolean

When set to True, users who click the Help menu in Skype for Business will be given custom help set up by the organization.

EnableExchangeContactSync

Optional

System.Boolean

When set to True (the default value) Skype for Business creates a corresponding personal contact in Microsoft Outlook for each person on a user’s Skype for Business Contacts list.

EnableIMAutoArchiving

Optional

System.Boolean

When set to True, a transcript of every instant messaging session that a user takes part in will be saved to the Conversation History folder in Microsoft Outlook. When set to False, these transcripts will not be saved automatically. (However, users will have the option to manually save instant messaging transcripts.)

EnableSkypeUI

Optional

System.Boolean

When set to True, this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client.

EnableUnencryptedFileTransfer

Optional

System.Boolean

When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers.

EnableURL

Optional

System.Boolean

When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. When set to False, hyperlinks will appear in instant messages as plain text. To navigate to the location, users will need to copy the link text and paste it into their web browser.

ExcludedContactFolders

Optional

System.String

Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. Multiple folders can be specified by separating the folder names using semicolons; for example, -ExcludedContactFolders "SenderPhotoContacts;OtherContacts".

Force

Optional

System.Management.Automation.SwitchParameter

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

IMWarning

Optional

System.String

When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session.

If set to a null value ($Null), then no message appears in the Conversation window.

Your warning message should be limited to 256 characters, and can only contain plain text. You can't use any formatting (such as boldface or italics) and you can't have clickable URLs within the text.

MusicOnHoldAudioFile

Optional

System.String

Path to the audio file to be played when a caller is placed on hold. If a value is configured for this property, then music on hold will be enabled and users will not be allowed to disable the feature. If no value is configured for this property, then users can specify their own music-on-hold file, provided that EnableClientMusicOnHold is set to True.

PlayAbbreviatedDialTone

Optional

System.Boolean

When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. (A Skype for Business handset looks like a standard telephone, but plugs into a USB port on a computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook.

ShowManagePrivacyRelationships

Optional

System.Boolean

When set to True, shows the Relationships option in the Skype for Business Contacts list window. When set to False, hides the Relationships option.

The default value is False.

ShowRecentContacts

Optional

System.Boolean

When set to true, users that have been recently contacted (for example, in IM), will be automaticallly added to recent contacts in the Skype for Business client.

ShowSharepointPhotoEditLink

Optional

System.Boolean

If set to true, Skype for Business will include a link that enables users to edit the personal photo stored on SharePoint. The default value is false, which means that Skype for Business won't include a link to SharePoint.

TracingLevel

Optional

Microsoft.Rtc.Management.WritableConfig.Policy.Client.TracingLevel

Enables you to manage event tracing and logging in Skype for Business. Allowed values are:

Off – Tracing is disabled and the user cannot change this setting.

Light – Minimal tracing is performed, and the user cannot change this setting.

Full – Verbose tracing is performed, and the user cannot change this setting.

By default TracingLevel is set to Light.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. The Set-CsClientPolicy cmdlet accepts pipelined instances of the client policy object.

The Set-CsClientPolicy cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object.

 
Show: