Set-CsClientPolicy
Topic Last Modified: 2016-04-11
Modifies the property values of an existing client policy. Among other things, client policies help determine the features of Microsoft Lync 2010 that are available to users; for example, you might give some users the right to transfer files while denying this right to other users.
Syntax
Set-CsClientPolicy [-Identity <XdsIdentity>] [-AddressBookAvailability <WebSearchAndFileDownload | WebSearchOnly | FileDownloadOnly>] [-AttendantSafeTransfer <Nullable>] [-AutoDiscoveryRetryInterval <Nullable>] [-BlockConversationFromFederatedContacts <Nullable>] [-CalendarStatePublicationInterval <Nullable>] [-ConferenceIMIdleTimeout <Nullable>] [-Confirm [<SwitchParameter>]] [-CustomizedHelpUrl <String>] [-CustomLinkInErrorMessages <String>] [-CustomStateUrl <String>] [-Description <String>] [-DGRefreshInterval <Nullable>] [-DisableCalendarPresence <Nullable>] [-DisableContactCardOrganizationTab <Nullable>] [-DisableEmailComparisonCheck <Nullable>] [-DisableEmoticons <Nullable>] [-DisableFederatedPromptDisplayName <Nullable>] [-DisableFeedsTab <Nullable>] [-DisableFreeBusyInfo <Nullable>] [-DisableHandsetOnLockedMachine <Nullable>] [-DisableHtmlIm <Nullable>] [-DisableICE <Nullable>] [-DisableInkIM <Nullable>] [-DisableMeetingSubjectAndLocation <Nullable>] [-DisableOneNote12Integration <Nullable>] [-DisableOnlineContextualSearch <Nullable>] [-DisablePhonePresence <Nullable>] [-DisablePICPromptDisplayName <Nullable>] [-DisablePoorDeviceWarnings <Nullable>] [-DisablePoorNetworkWarnings <Nullable>] [-DisablePresenceNote <Nullable>] [-DisableRTFIM <Nullable>] [-DisableSavingIM <Nullable>] [-DisplayPhoto <NoPhoto | PhotosFromADOnly | AllPhotos>] [-EnableAppearOffline <Nullable>] [-EnableCallLogAutoArchiving <Nullable>] [-EnableClientMusicOnHold <$true | $false>] [-EnableConversationWindowTabs <Nullable>] [-EnableEnterpriseCustomizedHelp <Nullable>] [-EnableEventLogging <Nullable>] [-EnableExchangeContactSync <$true | $false>] [-EnableExchangeDelegateSync <Nullable>] [-EnableFullScreenVideo <Nullable>] [-EnableHotdesking <Nullable>] [-EnableIMAutoArchiving <Nullable>] [-EnableNotificationForNewSubscribers <Nullable>] [-EnableSQMData <Nullable>] [-EnableTracing <Nullable>] [-EnableUnencryptedFileTransfer <Nullable>] [-EnableURL <Nullable>] [-EnableVOIPCallDefault <$true | $false>] [-ExcludedContactFolders <String>] [-Force <SwitchParameter>] [-HotdeskingTimeout <TimeSpan>] [-IMWarning <String>] [-MAPIPollInterval <Nullable>] [-MaximumDGsAllowedInContactList <UInt32>] [-MaximumNumberOfContacts <Nullable>] [-MaxPhotoSizeKB <UInt32>] [-MusicOnHoldAudioFile <String>] [-P2PAppSharingEncryption <Supported | Enforced | NotSupported>] [-PlayAbbreviatedDialTone <Nullable>] [-PolicyEntry <PSListModifier>] [-SearchPrefixFlags <Nullable>] [-ShowManagePrivacyRelationships <$true | $false>] [-ShowRecentContacts <$true | $false>] [-ShowSharepointPhotoEditLink <$true | $false>] [-SPSearchCenterExternalURL <String>] [-SPSearchCenterInternalURL <String>] [-SPSearchExternalURL <String>] [-SPSearchInternalURL <String>] [-TabURL <String>] [-WebServicePollInterval <Nullable>] [-WhatIf [<SwitchParameter>]]
Set-CsClientPolicy [-AddressBookAvailability <WebSearchAndFileDownload | WebSearchOnly | FileDownloadOnly>] [-AttendantSafeTransfer <Nullable>] [-AutoDiscoveryRetryInterval <Nullable>] [-BlockConversationFromFederatedContacts <Nullable>] [-CalendarStatePublicationInterval <Nullable>] [-ConferenceIMIdleTimeout <Nullable>] [-Confirm [<SwitchParameter>]] [-CustomizedHelpUrl <String>] [-CustomLinkInErrorMessages <String>] [-CustomStateUrl <String>] [-Description <String>] [-DGRefreshInterval <Nullable>] [-DisableCalendarPresence <Nullable>] [-DisableContactCardOrganizationTab <Nullable>] [-DisableEmailComparisonCheck <Nullable>] [-DisableEmoticons <Nullable>] [-DisableFederatedPromptDisplayName <Nullable>] [-DisableFeedsTab <Nullable>] [-DisableFreeBusyInfo <Nullable>] [-DisableHandsetOnLockedMachine <Nullable>] [-DisableHtmlIm <Nullable>] [-DisableICE <Nullable>] [-DisableInkIM <Nullable>] [-DisableMeetingSubjectAndLocation <Nullable>] [-DisableOneNote12Integration <Nullable>] [-DisableOnlineContextualSearch <Nullable>] [-DisablePhonePresence <Nullable>] [-DisablePICPromptDisplayName <Nullable>] [-DisablePoorDeviceWarnings <Nullable>] [-DisablePoorNetworkWarnings <Nullable>] [-DisablePresenceNote <Nullable>] [-DisableRTFIM <Nullable>] [-DisableSavingIM <Nullable>] [-DisplayPhoto <NoPhoto | PhotosFromADOnly | AllPhotos>] [-EnableAppearOffline <Nullable>] [-EnableCallLogAutoArchiving <Nullable>] [-EnableClientMusicOnHold <$true | $false>] [-EnableConversationWindowTabs <Nullable>] [-EnableEnterpriseCustomizedHelp <Nullable>] [-EnableEventLogging <Nullable>] [-EnableExchangeContactSync <$true | $false>] [-EnableExchangeDelegateSync <Nullable>] [-EnableFullScreenVideo <Nullable>] [-EnableHotdesking <Nullable>] [-EnableIMAutoArchiving <Nullable>] [-EnableNotificationForNewSubscribers <Nullable>] [-EnableSQMData <Nullable>] [-EnableTracing <Nullable>] [-EnableUnencryptedFileTransfer <Nullable>] [-EnableURL <Nullable>] [-EnableVOIPCallDefault <$true | $false>] [-ExcludedContactFolders <String>] [-Force <SwitchParameter>] [-HotdeskingTimeout <TimeSpan>] [-IMWarning <String>] [-Instance <PSObject>] [-MAPIPollInterval <Nullable>] [-MaximumDGsAllowedInContactList <UInt32>] [-MaximumNumberOfContacts <Nullable>] [-MaxPhotoSizeKB <UInt32>] [-MusicOnHoldAudioFile <String>] [-P2PAppSharingEncryption <Supported | Enforced | NotSupported>] [-PlayAbbreviatedDialTone <Nullable>] [-PolicyEntry <PSListModifier>] [-SearchPrefixFlags <Nullable>] [-ShowManagePrivacyRelationships <$true | $false>] [-ShowRecentContacts <$true | $false>] [-ShowSharepointPhotoEditLink <$true | $false>] [-SPSearchCenterExternalURL <String>] [-SPSearchCenterInternalURL <String>] [-SPSearchExternalURL <String>] [-SPSearchInternalURL <String>] [-TabURL <String>] [-WebServicePollInterval <Nullable>] [-WhatIf [<SwitchParameter>]]
Detailed Description
In Lync Server 2010, client policies replace the Group Policy settings used in previous versions of the product. In Microsoft Office Communicator 2007 and Microsoft Office Communicator 2007 R2, Group Policy helped determine what users could do with Communicator and other clients; for example, there were Group Policy settings that determined whether or not users could save a transcript of their instant messaging sessions; whether information from Microsoft Outlook was incorporated into their presence information; and whether or not users could include emoticons or formatted text in instant messages.
As useful as Group Policy can be, however, the technology does have some limitations when applied to Lync Server 2010. For one thing, Group Policy is designed to be applied on a per-domain or per-organizational unit (OU) basis, which makes it difficult to target policies toward a more select group of users (for example, all the users who work in a particular department, or all the users who have a particular job title). For another, Group Policy is only applied to users who log on to the domain and who log on using a computer; Group Policy is not applied to users who access Lync Server 2010 over the Internet or who access the system by using a mobile phone. This means that the same user can have a different experience depending on the device he or she uses to log on, and where he or she logs on from.
To help address these inconsistencies, Lync Server 2010 uses client policies instead of Group Policy. 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 Lync Server 2010 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 global, site, and 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.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsClientPolicy cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsClientPolicy"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
ClientPolicy object |
Unique identifier assigned to the new policy. To reference the global policy, use this syntax: -Identity global. To reference a site policy, use the prefix "site:" and the name of the site as your Identity; for example: -Identity site:Redmond. To reference a per-user policy, use syntax similar to this: -Identity SalesClientPolicy. |
Instance |
Optional |
ClientPolicy object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
AddressBookAvailability |
Optional |
PS List Modifier |
Indicates how users are allowed to access information in the Address Book server (that is, by using the Address Book Web Query service and/or by downloading a copy of the Address Book to their local computer). AddressBookAvailability must be set to one of the following values: WebSearchAndFileDownload WebSearchOnly FileDownloadOnly |
AttendantSafeTransfer |
Optional |
Boolean |
When set to True, Microsoft Lync 2010 Attendant operates in "safe transfer" mode; this means that transferred calls that do not reach the intended recipient will reappear in the incoming area along with a "Failed Transfer" notice. When set to False, transferred calls that fail to reach the intended recipient will not reappear in the incoming area. |
BlockConversationFromFederatedContacts |
Optional |
Boolean |
When set to True, contacts from outside your organization will not be allowed to initiate instant message conversations with any user that this policy applies to. However, outside users will be able to participate in conversations as long the internal user initiates that conversation. When set to False, outside contacts are allowed to send unsolicited instant messages to users in your organization. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Block conversation from federated contacts." |
CalendarStatePublicationInterval |
Optional |
Integer |
Specifies the amount of time, in seconds, that Lync 2010 waits before retrieving calendar information from Microsoft Outlook and adding this data to your presence information. For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seconds) use this syntax: - CalendarStatePublicationInterval 600 This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Time interval to publish calendar data to presence." |
ConferenceIMIdleTimeout |
Optional |
Integer |
Indicates the number of minutes that a user can remain in an instant messaging session without either sending or receiving an instant message. The ConferenceIMIdleTimeout must be less than or equal to 1 hour, and must be specified using the format hours:minutes:seconds. For example, this syntax sets the timeout value to 45 minutes: -ConferenceIMIdleTimeout 00:45:00 |
CustomizedHelpUrl |
Optional |
String |
URL for custom Lync 2010 help set up by an organization. This help, rather than the default product help, will be displayed any time a user clicks the Help menu in Lync 2010. Customized help will not be available unless you also set EnableEnterpriseCustomizedHelp to True. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Help menu." |
CustomLinkInErrorMessages |
Optional |
String |
URL for the website that can be added to error messages that appear in Lync 2010. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Lync 2010. Users can then click that link and be taken to a custom website that contains additional information, troubleshooting tips, etc. |
CustomStateUrl |
Optional |
String |
Specifies the location of the XML file used to add custom presence states to Lync 2010. (Lync 2010 allows up to four custom presence states in addition to the built-in states such as Available, Busy, and Do Not Disturb.) The location of the XML file should be specified using the HTTPS protocol. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Custom presence states URL." |
Description |
Optional |
String |
Allows administrators to provide additional information about a policy. For example, the Description might indicate the users that the policy should be assigned to. |
DGRefreshInterval |
Optional |
TimeSpan |
Indicates the amount of time Lync 2010 waits before automatically refreshing the membership list of any distribution group that has been "expanded" in the Contacts list. (Expanding a distribution group means displaying all the members in that group.) DGRefreshInterval can be set to any integer value between 30 seconds and 28,800 seconds (8 hours), inclusive. The default value is 28,800 seconds. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Time interval to refresh the membership of each distribution group." |
DisableCalendarPresence |
Optional |
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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable calendar presence." |
DisableContactCardOrganizationTab |
Optional |
Boolean |
When set to True, the contact card organization tab is not visible within the Lync 2010 user interface. When set to False, the contact card organization tab is available in Lync 2010. |
DisableEmailComparisonCheck |
Optional |
Boolean |
When set to True, Lync 2010 will not attempt to verify that any currently running instance of Microsoft Outlook belongs to the same user running Lync 2010; for example, the software will not verify that both Outlook and Lync 2010 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 Lync 2010. When set to False, Lync 2010 will use SMTP addresses to verify that Outlook and Lync 2010 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 Lync 2010. |
DisableEmoticons |
Optional |
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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable emoticons in instant messages." |
DisableFederatedPromptDisplayName |
Optional |
Boolean |
When set to True, any notification dialog generated when you are added to a federated user’s Contacts list will use the federated user’s SIP address (for example, sip:kenmyer@fabrikam.com). When set to False, the notification dialog will use the federated user’s display name (for example, Ken Myer) instead. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Prevent showing the display name of federated, non-PIC contacts in the notification dialog." |
DisableFeedsTab |
Optional |
Boolean |
When set to True, the activity feeds tab will not be displayed in Lync 2010. When set to False, the feeds tab will be available within Lync 2010. |
DisableFreeBusyInfo |
Optional |
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 This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable publishing free/busy info." |
DisableHandsetOnLockedMachine |
Optional |
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 their Polycom handset even if the computer the handset is connected to is locked. This setting is equivalent to the Communications Server 2007 R2 Group Policy setting "Configure handset use on locked machine." |
DisableHtmlIm |
Optional |
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, etc.) 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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Prevent HTML text in instant messages." |
DisableICE |
Optional |
Boolean |
When set to True, Lync 2010 will not use the Interactive Connectivity Establishment (ICE) protocol to traverse firewalls and network address translation (NAT) devices; this effectively prevents users from making Lync 2010 calls across the Internet. When set to False, Lync 2010 will use the ICE protocol to enable Lync 2010 calls to traverse firewalls and (NAT) devices. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable Interactive Connectivity Establishment (ICE)." |
DisableInkIM |
Optional |
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 Table PC ink. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Prevent ink in instant messages." |
DisableMeetingSubjectAndLocation |
Optional |
Boolean |
When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. When set to True, this detailed information will not be displayed. However, free/busy information will be displayed unless you also set DisableCalendarPresence to True. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable publishing meeting subject and location information." |
DisableOneNote12Integration |
Optional |
Boolean |
When set to True, the ability to start Microsoft OneNote from within Lync 2010 (and the ability to automatically link instant message sessions and OneNote notes) is disabled. When set to False, the option Take Notes Using One Note is enabled in Lync 2010. In addition, if you locate an instant message transcript in Microsoft Outlook’s Conversation History you can retrieve any OneNote notes associated with that conversation just by clicking the Edit conversation notes button. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable OneNote 12 integration." |
DisableOnlineContextualSearch |
Optional |
Boolean |
When set to True, disables the Find Previous Conversations menu option that appears when you right-click a user in your Contacts list. (This option enables you to search the Microsoft Outlook Conversation History folder for previous instant messaging sessions involving the user in question.) When set to False, the Find Previous Conversations option will be available when you right-click a user in your Contacts list. Note that this setting only applies to users who are not running Microsoft Outlook in cached mode. That’s because any searches conducted by those users must take place on the Exchange Servers, and administrators might want to limit the network traffic causes by these searches. If you are running Outlook in cached mode, searches take place on a user’s locally-cached copy of his or her Inbox. Cached searches are not affected by this setting. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable online contextual search." |
DisablePhonePresence |
Optional |
Boolean |
When set to True, Lync 2010 does not take phone calls into consideration when determining your current status. When set to False, phone calls are taken into consideration when determining your status. For example, any time you are on the phone your status will automatically be set to Busy. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable call presence." |
DisablePICPromptDisplayName |
Optional |
Boolean |
When set to True, any notification dialog box generated when you are added to the Contacts list of a user with an account on a public instant messaging service such as MSN will display that person’s SIP address (for example, sip:kenmyer@litwareinc.com). When set to False, the notification dialog box will use the person’s display name (for example, Ken Myer) instead. This setting is equivalent to the Communications Server 2007 R2 Group Policy setting "Prevent showing the display name of PIC contacts in the notification dialog." |
DisablePoorDeviceWarnings |
Optional |
Boolean |
When set to True, Lync 2010 will not issue warnings (upon startup, in the Tuning Wizard, in the Conversation window, etc.) if an audio or video device is not working correctly. When set to False, these warnings will be issued. |
DisablePoorNetworkWarnings |
Optional |
Boolean |
When set to True, the network status indicator (which reports the network strength and quality during a Lync 2010 call) does not appear in the Lync 2010 interface. |
DisablePresenceNote |
Optional |
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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable presence note." |
DisableRTFIM |
Optional |
Boolean |
When both this setting and the DisableHtmlIm settings 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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Prevent rich text in instant messages." |
DisableSavingIM |
Optional |
Boolean |
When set to True, the options for saving an instant message session are removed from the menu bar in the Lync 2010 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 message 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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Prevent users from saving instant messages." |
DisplayPhoto |
Optional |
PS List Modifier |
Determines whether or not photos (of both the user and his or her contacts) will be displayed in Lync 2010. Valid settings are: NoPhoto - Photos are not displayed in Lync 2010. PhotosFromADOnly - Only photos that have been published in Active Directory Domain Services (AD DS) can be displayed. AllPhotos - Either Active Directory photos or custom photos can be displayed. The default value is AllPhotos. |
EnableAppearOffline |
Optional |
Boolean |
When set to True an additional presence state -- Appear Offline -- is available in Lync 2010. 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, respond to instant messages, etc. When set to False, the Appear Offline presence state will not be available in Lync 2010. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable the state Appear Offline." |
EnableCallLogAutoArchiving |
Optional |
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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable/disable automatic archiving of call logs to Outlook mailbox." |
EnableClientMusicOnHold |
Optional |
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 |
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 Managed API (UCMA). For example, customer service or help desk 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 message session, he or she will not have access to any additional information that accompanies the session. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable conversation window tabs." |
EnableEnterpriseCustomizedHelp |
Optional |
Boolean |
When set to True, users who click the Help menu in Lync 2010 will be given custom help set up by the organization. When set to False, users who click the Help menu will be given the default Lync 2010 product help. When you enable customized help you must also specify the URL for the custom help website; this is done using the CustomizedHelpUrl parameter. If this parameter is not specified, or if the URL is not valid, errors will likely occur when users try to schedule or join meetings. |
EnableEventLogging |
Optional |
Boolean |
When set to True, detailed information about Lync 2010 will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Lync Server) are recorded in the event log. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Turn on event logging for Communicator 2007." |
EnableExchangeContactSync |
Optional |
Boolean |
When set to True (the default value) Lync 2010 creates a corresponding personal contact in Microsoft Outlook for each person on a user’s Lync 2010 Contacts list. |
EnableExchangeDelegateSync |
Optional |
Boolean |
When set to True, delegates a user that has configured in Microsoft Exchange will be allowed to schedule meetings for that user. |
EnableFullScreenVideo |
Optional |
Boolean |
When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Lync 2010 calls; and, 2) disables video preview for Lync 2010 calls. When set to False then full-screen video is not available in Lync 2010, but video preview is available. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable full screen video and video preview disabled for all OC video calls." |
EnableHotdesking |
Optional |
Boolean |
When set to True, enables users to log on to a phone running Lync 2010 Phone Edition in a shared workspace by using their Lync Server account. (Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone in a shared workspace by using their own credentials. Note that this setting applies only to common area (shared workspace) accounts and not to user accounts. When set to True and applied to a common area account for a phone in a shared workspace, any user will be able to log on to that phone by using his or her credentials. When set to False, no one will be allowed to log on to that phone. |
EnableIMAutoArchiving |
Optional |
Boolean |
When set to True, a transcript of every instant message 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 message transcripts.) This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable/disable automatic archiving of IM conversations to Outlook mailbox." |
EnableNotificationForNewSubscribers |
Optional |
Boolean |
When set to True, any time you are added to someone’s Contacts list you will receive notification that you have been added to the list. In addition, the notification dialog box will provide options for you to add this person to your Contacts list, or to block them from viewing your presence information. When set to False, you will not be notified if you are added to someone’s Contacts list. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Show notification for new presence subscribers." |
EnableSQMData |
Optional |
Boolean |
The Customer Experience Improvement Program (CEIP) is designed to help Microsoft collect data on the real-world use of Lync 2010. When a user is enrolled in CEIP, then each time the user runs Lync 2010 information about what that user does, and how often they do it, will be sent back to Microsoft, stored in a database, and then analyzed to help identify usage trends. When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Improvement Program. However, Lync 2010 will provide the user with the option to join the program. When set to False, the user will not be enrolled in the Customer Experience Improvement Program. In addition, Lync 2010 will not give users the option of joining the program. The only way for a user to participate in the CEIP program is for EnableSQMData to be set to True and the user to then manually opt-in to the program. Note that no personally-identifiable information is sent to the CEIP. The CEIP does not keep track of such things as who you send instant messages to, and vice-versa. Instead, the program tracks information such how often people use Lync 2010 to transfer files or the average number of contacts that people have on their Contacts Lists. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Specify instrumentation." |
EnableTracing |
Optional |
Boolean |
When set to True, software tracing will be enabled in Lync 2010; when set to False software tracing will be disabled. Software tracing involves keeping an extremely detailed record of everything that a program does (including tracking API calls). As such tracing is mostly useful to developers and to application support personnel. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Turn on tracing for Communicator 2007." |
EnableUnencryptedFileTransfer |
Optional |
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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Allow transferring unencrypted files." |
EnableUrl |
Optional |
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 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. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Allow hyperlinks in instant messages." |
EnableVOIPCallDefault |
Optional |
Boolean |
When set to True, a Lync 2010 call will be placed any time a user employs the click-to-call feature. This policy setting only affects the initial state of the click-to-call feature. If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. |
ExcludedContactFolders |
Optional |
String |
Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Lync 2010 searches for new contacts. Multiple folders can be specified by separating the folder names using semicolons; for example: -ExcludedContactFolders "SenderPhotoContacts;OtherContacts". |
HotdeskingTimeout |
Optional |
TimeSpan |
Timeout interval for a user logged on to a "hot-desk" phone. (A hot-desk phone is a phone running Lync Phone Edition that is located in a shared workspace, and that users can log on to using their Lync Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desk phone. When specifying a hot desking timeout you must use the format hours:minutes:seconds. For example, this syntax sets the hot desking timeout interval to 45 minutes: -HotdeskingTimeout 00:45:00 Note that this policy setting applies only to common area phones and not to users. The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). |
IMWarning |
Optional |
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 Litware Inc" 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 cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Warning text." |
MAPIPollInterval |
Optional |
Boolean |
For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Lync 2010 retrieves calendar data from the Exchange public folders. MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. To configure the MAPI poll interval, use the format hours:minutes:seconds. For example, this command sets the MAPI poll interval to 45 minutes: -MapiPollInterval 00:45:00 Note that this setting does not apply to users whose email account is on Microsoft Exchange Server 2010 or Microsoft Exchange Server 2007. For those users, calendar retrieval is managed using WebServicePollInterval This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Time interval to load calendar data from MAPI provider." |
MaximumDGsAllowedInContactList |
Optional |
Integer |
Indicates the maximum number of distribution groups that a user can configure as a contact. MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. The default value is 10. |
MaximumNumberOfContacts |
Optional |
Integer |
Indicates the maximum number of contacts a user is allowed to have. The maximum contacts can be set to any integer value between 0 and 1000, inclusive. When set to 0, that prevents the user from having any contacts. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Maximum allowed number of contacts." |
MaxPhotoSizeKb |
Optional |
Integer |
Indicates the maximum size (in kilobytes) for photos displayed in Lync 2010. Setting the MaxPhotoSize to 0 prevents any photos from being displayed in Lync 2010. The default value is 30 kilobytes. |
MusicOnHoldAudioFile |
Optional |
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, assuming that EnableClientMusicOnHold is set to True. |
P2PAppSharingEncryption |
Optional |
Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. Allowed values are: Supported. Desktop and application sharing data will be encrypted, if possible. Enforced. Desktop and application sharing data must be encrypted. If the data cannot be encrypted then desktop and application sharing will not be enabled for the conversation. NotSupported. Desktop and application sharing data will not be encrypted. |
|
PlayAbbreviatedDialTone |
Optional |
Boolean |
When set to True, a 3-second dial tone will be played any time a Lync 2010-compatible handset is taken off the hook. (A Lync 2010-compatible handset looks like a standard telephone, but plugs into a USB port on your computer and is used to make Lync 2010 calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Lync 2010-compatible handset is taken off the hook. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Play abbreviated dial done." |
PolicyEntry |
Optional |
PolicyEntry collection |
Provides a way to add settings not covered by the default parameters. For example, in the pre-beta version of Lync 2010 it was possible to add a Send Feedback option to Lync 2010. That was done using code similar to this: $x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "http://www.litwareinc.com/feedback"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x} For more details and examples, see the New-CsClientPolicyEntry help topic. |
SearchPrefixFlags |
Optional |
Integer |
Represents the Address Book attributes that should be used any time a user searches for a new contact. The search prefix flags are constructed as a binary number such as 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. The attributes in the binary value are (from right to left): Primary email address Email alias All email addresses Company Display name First name Last name Thee binary value 1110111 means that all attributes should be searched except attribute 4: Company. To search only display name, first name, and last name you would construct this value: 1110000 After the binary value has been constructed it must then be converted to a decimal value before being assigned to SearchPrefixFlags. To convert a binary number to a decimal number you can use the following Windows PowerShell command: [Convert]::ToInt32("1110111", 2) Note Manual registry key creation is required for the search prefix flags to be implemented. A SearchPrefixFlags key must be created for either the machine or user as in the following examples. The "119" value is the integer equivalent of a "1110111" SearchPrefixFlags binary. The integer you enter will be based on your own search preferences.
HKEY_CURRENT_USER\SOFTWARE\Policies\Microsoft\Communicator\SearchPrefixFlags
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Office\<Office Version>\Lync\SearchPrefixFlags --> DWORD 119HKEY_LOCAL_USER\SOFTWARE\Policies\Microsoft\Office\<Office Version>\Lync\SearchPrefixFlags --> DWORD 119
|
ShowManagePrivacyRelationships |
Optional |
Boolean |
When set to True, shows the Relationships option in the Lync 2010 Contacts list window. When set to False, hides the Relationships option. The default value is False. |
ShowRecentContacts |
Optional |
Boolean |
This parameter has no effect on the client. |
ShowSharepointPhotoEditLink |
Optional |
Boolean |
If set to True, Lync 2010 will include a link that enables users to edit the personal photo stored on their SharePoint MySite. The default value is False, which means that Lync 2010 will not include a link to the SharePoint MySite. |
SPSearchCenterExternalURL |
Optional |
String |
External URL for the SharePoint site used for keyword searches (also known as expert searches). This URL will appear at the bottom of any keyword search results that appear in Lync 2010. If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint’s search capabilities. (SharePoint offers more search options than Lync 2010 does.) SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization’s firewall. The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. |
SPSearchCenterInternalURL |
Optional |
String |
Internal URL for the SharePoint site used for keyword searches (also known as expert searches). This URL will appear at the bottom of any keyword search results that appear in Lync 2010. If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint’s search capabilities. (SharePoint offers more search options than Lync 2010 does.) SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization’s firewall. The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. |
SPSearchExternalURL |
Optional |
String |
External URL for the SharePoint site used for keyword searches (also known as expert searches). Lync 2010 will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization’s firewall) conducts a keyword search. |
SPSearchInternalURL |
Optional |
String |
Internal URL for the SharePoint site used for keyword searches (also known as expert searches). Lync 2010 will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization’s firewall) conducts a keyword search. |
TabURL |
Optional |
String |
Specifies the location of the XML file used to create custom tabs located at the bottom of the Lync 2010 Contacts list window. Custom tabs provide access to webpages (for example, help desk webpages) from within Lync 2010. This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Tab URL." |
WebServicePollInterval |
Optional |
TimeSpan |
For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Lync 2010 retrieves calendar data from Microsoft Exchange Server Web Services. WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. To configure the Web Service poll interval, use the format hours:minutes:seconds. For example, this command sets the Web Service poll interval to 45 minutes: -WebServicePollInterval 00:45:00 Note that this setting does not apply to users whose email account is on Exchange 2003. For those users, calendar retrieval is managed using MAPIPollInterval. This setting is equivalent to the Communications Server 2007 R2 Group Policy setting "Time interval to load calendar data from Web service provider." |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. Set-CsClientPolicy accepts pipelined instances of the client policy object.
Return Types
Set-CsClientPolicy does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object.
Example
-------------------------- Example 1 --------------------------
Set-CsClientPolicy -Identity RedmondClientPolicy -WebServicePollInterval "00:15:00"
The command shown in Example 1 modifies the client policy RedmondClientPolicy. In this example, the WebServicePollInterval property is set to 15 minutes (00 hours: 15 minutes: 00 seconds).
-------------------------- Example 2 --------------------------
Set-CsClientPolicy -Identity RedmondClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True
In Example 2, three different property values are modified for the client policy RedmondClientPolicy: the properties DisableEmoticons, DisableHtmlIm, and DisableRTFIm are all set to True.
-------------------------- Example 3 --------------------------
Get-CsClientPolicy -Filter "*site:*" | Set-CsClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True
The preceding command 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 Get-CsClientPolicy and the Filter property to return all the client policies where the Identity begins with the characters "site:"; by definition, those are policies configured at the site scope. This filtered collection is then piped to Set-CsClientPolicy, which takes each policy in the collection and modifies the values of DisableEmoticons, DisableHtmlIm, and DisableRTFIm.
-------------------------- Example 4 --------------------------
Get-CsClientPolicy | Where-Object {$_.MaxPhotoSizeKb -gt 10} | Set-CsClientPolicy -MaxPhotoSizeKb 10
In Example 4, all the client policies that allow for photos larger than 10 kilobytes are modified; after the modifications these policies will have a maximum photo size of 10 KB. To carry out this task, Get-CsClientPolicy is first called without any parameters in order to return a collection of all the client policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those policies where the MaxPhotoSizeKb property is greater than (-gt) 10 KB. The filtered collection is then piped to Set-CsClientPolicy, which sets the value of the MaxPhotoSizeKb property for each policy in the collection to 10 KB.
See Also
Other Resources
Get-CsClientPolicy
Grant-CsClientPolicy
New-CsClientPolicy
Remove-CsClientPolicy