[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Creates a new client policy. Among other things, client policies help determine the features of Microsoft Communicator "14" that are made available to users; for example, you might give some users the right to transfer files while denying this right to other users. Many of the client policies used in Microsoft Communications Server 2010 are derived from the Group Policy settings used in Microsoft Office Communications Server 2007 R2.

Syntax

New-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>] [-EnableFullScreenVideoPreviewDisabled <Nullable>] [-EnableHotdesking <Nullable>] [-EnableIMAutoArchiving <Nullable>] [-EnableNotificationForNewSubscribers <Nullable>] [-EnableSQMData <Nullable>] [-EnableTracing <Nullable>] [-EnableUnencryptedFileTransfer <Nullable>] [-EnableURL <Nullable>] [-EnableVOIPCallDefault <$true | $false>] [-ExchangeContactStoreAllowed <$true | $false>] [-ExcludedContactFolders <String>] [-Force <SwitchParameter>] [-HotdeskingTimeout <Nullable>] [-IMWarning <String>] [-InMemory <SwitchParameter>] [-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>]]

Parameters

Parameter Required Type Description

Identity

Optional

ClientPolicy object

Indicates the unique Identity to be assigned to the new policy. New client policies can be created at the site or per-user scope. To create a new site policy, use the prefix "site:" and the name of the site as your Identity. For example, use this syntax to create a new policy for the Redmond site: -Identity site:Redmond. To create a new per-user policy, use an identity similar to this: -Identity SalesClientPolicy.Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsClientPolicy cmdlet instead. Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use Set-CsClientPolicy.

PolicyEntry

Optional

PolicyEntry collection

Provides a way to add settings not covered by the default parameters. For example, in the pre-beta version of Microsoft Communicator it was possible to add a Send Feedback option to Communicator. 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}

See the help topic New-CsClientPolicyEntry for more examples and for additional information. Note that new settings cannot be arbitrarily added by administrators. Instead, changes will first have to be made to Communicator itself. After those changes have been made, administrators can then use the -PolicyEntry parameter to add the new settings to a client policy.

ShowRecentContacts

Optional

Boolean

When set to True, the contact list will include an auto-generated category named Frequent Contacts. When set to False, the Frequent Contacts category will not be auto-generated.

The default value is True.

ShowManagePrivacyRelationships

Optional

Boolean

When set to True, shows the "Manage privacy relationships" option in the View By menu. When set the True, hides the Manage privacy relationships" option in the View By menu.

The default value is False.

MaxPhotoSizeKb

Optional

Integer

Indicates the maximum size (in kilobytes) for photos displayed in Microsoft Communicator. Setting the MaxPhotoSize to 0 prevents any photos from being displayed in Communicator.

The default value is 10 kilobytes.

ExchangeContactStoreAllowed

Optional

Boolean

When set to True, a user’s contacts will be kept on his or her Microsoft Exchange server rather than being kept by Microsoft Communications Server. This setting has no effect unless the user’s mailbox is stored on Microsoft Exchange Server 2010, Service Pack 1 or later.

AttendantSafeTransfer

Optional

Boolean

When set to True, 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.

CustomLinkInErrorMessages

Optional

String

URL for the Web site that can be added to error messages that appear in Microsoft Communicator. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Communicator. Users can then click that link and be taken to a Web site that (ostensibly) contains additional information, troubleshooting tips, etc.

CustomStateUrl

Optional

String

Specifies the location of the XML file used to add custom presence states to Microsoft Communicator. (Communicator allows up to 4 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."

DisablePoorDeviceWarnings

Optional

Boolean

When set to True, Communicator 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.

BlockConversationFromFederatedContacts

Optional

Boolean

When set to True, contacts from outside your organization (both federated contacts and PIC contacts) will not be allowed to initiate instant message conversations with any use this policy applies to. However, outside users will be able to participate in conversations as long as one of your users 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 Communicator waits before retrieving calendar information from Microsoft Outlook and adding this data to your presence information. The calendar state publication interval can be set to any integer value between 5 minutes and 480 minutes (8 hours). The default value is 15 minutes, meaning that any calendar data published as part of your presence information will be updated every 15 minutes.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Time interval to publish calendar data to presence."

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 phone call 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."

EnableAppearOffline

Optional

Boolean

When set to True an additional presence state - Appear Offline - is available in Communicator. 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 Communicator.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable the state Appear Offline."

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 Unified Communications APIs. 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 the additional information that accompanies the session.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Enable conversation window tabs."

EnableEventLogging

Optional

Boolean

When set to True, detailed information about Microsoft Communicator (and seemingly-everything that happens when you use it) will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Microsoft Communications 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."

EnableFullScreenVideoPreviewDisabled

Optional

Boolean

When set to True, this parameter does two things: 1) enables full screen video (with the correct aspect ratio) for Microsoft Communicator calls; and, 2) disables video preview for Communicator calls. When set to False then full screen video is not available in Communicator, but video preview is.

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."

EnableSQMData

Optional

Boolean

When set to True, the user will be enrolled in the Customer Experience Improvement Program (CEIP); this means that each time the user runs Microsoft Communicator 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 set to False, the user will not be enrolled in CEIP.

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 things like how many people use Communicator to transfer files, or the average number of contacts that people have on their Contact 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 Microsoft Communicator; 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."

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."

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 still 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."

DisableEmailComparisonCheck

Optional

Boolean

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

When set to False, Communicator will use SMTP addresses to verify that Outlook and Communicator 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 Communicator.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable email comparison check for Outlook OIM integration."

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."

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 contact list will use the federated user’s SIP address (e.g., sip:kenmyer@fabrikam.com). When set to False, the notification dialog will use the federated user’s display name (e.g., 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."

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 Microsoft Communicator Phone Edition phone any time the computer the phone is connected to is locked. To use the phone, users will first have to unlock the computer.

When set to False, users will be allowed to user tier Communicator phone even if the compute the handset is connected to is locked.

This setting is equivalent to the Office 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 Web page will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, dropdown 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 (like 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."

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."

DisableRTFIM

Optional

Boolean

When both this setting and the DisableHtmlIm settings are set to True, prevents rich text formatting (e.g., 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 (Save; Save As; and Save As Email) are removed from the menu bar in the Microsoft Communicator 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."

DisableMeetingAndSubjectLocation

Optional

Boolean

When set to True, 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 the False, this detailed information will not be displayed. (However, free/bust 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 launch Microsoft OneNote from within Office Communicator (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 Communicator. 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 contact 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 contact 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, Microsoft Communicator 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 generated when you are added to a PIC user’s contact list will use the PIC user’s SIP address (e.g., sip:kenmyer@aol.com). When set to False, the notification dialog will use the PIC user’s display name (e.g., Ken Myer) instead.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Prevent showing the display name of PIC contacts in the notification dialog."

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 contact list.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable presence note."

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. (Meaning, of course, that all file transfers will be encrypted.)

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Allow transferring unencrypted files."

AutoDiscoveryRetryInterval

Optional

TimeSpan

After a failed connection attempt, specifies the amount of time Microsoft Communicator waits before trying again to connect to Microsoft Communications Server. The AutoDiscoveryRetryInterval can be set to any integer value between 15 and 480 minutes (8 hours), inclusive. The default value is 30 minutes.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Time interval to try autodiscovery."

DGRefreshInterval

Optional

TimeSpan

Indicates the amount of time Microsoft Communicator waits before automatically refreshing the membership list of any distribution group that has been "expanded" in the contact list. (Expanding a distribution group simply means that you are 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."

DisableICE

Optional

Boolean

When set to True, Microsoft Communicator will not use the Interactive Connectivity Establishment (ICE) to traverse firewalls and Network Address Translation devices; this effectively prevents users from making Communicator calls across the Internet. When set to False, Communicator will use the ICE protocol to enable Communicator calls to traverse firewalls and Network Address Translation devices.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Disable Interactive Connectivity Establishment (ICE)."

ExcludedContactFolders

Optional

String

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

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 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.

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 Microsoft Communicator retrieves calendar data from the Exchange public folders. MAPIPollInterval can be set to any integer value between 5 minutes and 480 minutes (8 hours); inclusive. The default value is 30 minutes.

Note that this setting does not apply to users whose email account is on Microsoft Exchange Server 2003. 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."

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."

EnableNotificationsForNewSubscribers

Optional

Boolean

When set to True, any time you are added to someone’s contact 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 contact 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 contact list.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Show notification for new presence subscribers."

PlayAbbreviatedDialTone

Optional

Boolean

When set to True, a 3-second dial tone will be played any time a Microsoft Communicator-compatible handset is taken off the hook. (A Communicator-handset looks like a standard telephone, but plugs into a USB port on your computer and is used to make Microsoft Communicator calls rather than "regular" phone calls.) When set to True, a 30-second dial tone is played any time a Communicator-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."

SearchPrefixFlags

Optional

Integer

Represents the Address Book attributes that should be searched any time a user searches for a new contact. The search prefix flags are originally constructed as a binary number similar (e.g., 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

In the binary value 1110111 this 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)

EnableSIPCompression

Optional

Boolean

When set to True, Microsoft Communicator transmissions are compressed before being set. When set to False, Communicator transmissions are not compressed. Compressed transmissions require less network bandwidth; however, when compression is employed it might take longer to log on to Communicator, and Communicator might run a little slower than expected.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Configure SIP compression mode."

TabURL

Optional

String

Specifies the location of the XML file used to create custom tabs located at the bottom of the Microsoft Communicator contact list window. Custom tabs provide access to Web pages (for example, help desk Web pages) from within Microsoft Communicator.

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 or later, WebServicePollInterval specifies how often Microsoft Communicator retrieves calendar data from Exchange Web Services. WebServicePollInterval can be set to any integer value between 5 minutes and 480 minutes (8 hours); inclusive. The default value is 30 minutes.

Note that this setting does not apply to users whose email account is on Microsoft Exchange Server 2003. For those users, calendar retrieval is managed using MAPIPollInterval.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Time interval to load calendar data from Web service provider."

DisableFeedsTab

Optional

Boolean

When set to True, the RSS feeds tab will not be displayed in Microsoft Communicator. When set to False, the feeds tab will be available within Communicator.

EnableEnterpriseCustomizedHelp

Optional

Boolean

When set to True, users who click the Help menu in Microsoft Communicator 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 Microsoft Communicator product help.

When you enable customized help you must also specify the URL for the custom help Web site; this is done using the -CustomizedHelpUrl parameter. If this parameter is not specified, or if the URL is not valid, then users will receive the default product help.

This setting is equivalent to the Office Communications Server 2007 R2 Group Policy setting "Help menu."

CustomizedHelpUrl

Optional

String

URL for custom Microsoft Communicator 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 Communicator.

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."

DisableContactCardOrganizationTab

Optional

Boolean

When set to True, the contact card organization tab is not visible within the Microsoft Communicator user interface. When set to False, the contact card organization tab is available in Communicator.

EnableHotdesking

Optional

Boolean

When set to True, enables a user to log on to a Microsoft Communicator Phone Edition phone in a shared workspace using his or her Microsoft Communications Server account. (Among other things, this provides the user access to his or her contacts.) When set to False, the user is not allowed to log on to a "hotdesked" phone.

HotdeskingTimeout

Optional

TimeSpan

Timeout interval for a user logged on to a "hotdesked" phone. (A hotdesked phone is a Microsoft Communicator Phone Edition phone that is located in a shared workspace, and that users can log on to using their Microsoft Communications Server account.) The hotdesk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hotdesked phone.

SPSearchInternalURL

Optional

String

Internal URL for the SharePoint site used for keyword searches (also known as expert searches). Microsoft Communicator 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.

SPSearchExternalURL

Optional

String

External URL for the SharePoint site used for keyword searches (also known as expert searches). Microsoft Communicator will use the SharePoint site located at this URL any time an external user (that is, a user who has access the system from outside the organization’s firewall) conducts a keyword search.

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 any of keyword search results that appear in Microsoft Communicator. 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 Communicator 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.

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 any of keyword search results that appear in Microsoft Communicator. 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 Communicator 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.

DisplayPhoto

Optional

PS List Modifier

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

NoPhoto - Photos are not displayed in Communicator.

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.

The default value is WebSearchAndFileDownload.

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 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

The default value is WebSearchAndFileDownload.

InMemory

Optional

Switch Parameter

Creates an object reference without actually committing the object as a permanent change. If the output of the cmdlet is not assigned to a variable, the object will be lost and nothing will be created.

LocalStore

Optional

Switch Parameter

This parameter is for testing purposes only.

ConferenceIMIdelTimeout

Optional

Numeric

Description

Optional

String

DisablePoorNetworkWarnings

Optional

Boolean

EnableClientMusicOnHold

Optional

Boolean

EnableExchangeContactSync

Optional

Boolean

EnableExchangeDelegateSync

Optional

Boolean

EnableVOIPCalldefault

Optional

Boolean

MaximumDGsAllowedInContactList

Optional

Numeric

MusicOnHoldAudioFile

Optional

String

P2PAppSharingEncryption

Optional

ShowSharepointPhotoEditLink

Optional

Force

Optional

Switch Parameter

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.

Detailed Description

In Communications 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 was used to help determine what users could do with Communicator and with Live Meeting; 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, and as powerful, as Group Policy is, however, the technology still has some limitations, especially when applied to Microsoft Communications Server. For one thing, Group Policy is designed to be applied on a per-domain or per-OU basis; that makes it difficult to target policies towards 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 Microsoft Communications Server over the Internet or who access the system by using a cell phone. This means that the same user can have a very different experience depending on the device her or she uses to log on, and where he or she logs on from.

To help address these inconsistencies Communications Server uses client management policies instead of Group Policies. 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 he or she is using. In addition, client policies - like other Microsoft Communications Server policies - can readily be targeted towards select groups of users; you can even create a custom policy that’s assigned to a single user.

In case you’re wondering, many of the Group Policy settings from Office Communications Server 2007 R2 have been migrated to the new client policies; client policies contain a number of settings - DisableRTFIM; DisableOneNote12Integration; EnableTracing - that have been carried over from Office Communications Server 2007 R2. In addition, client policies also include settings such as DisablePoorNetworkWarnings and DisplayPhoto - that are unique to Microsoft Communications Server 2010.

New-CsClientPolicy enables you to create new client policies at either the site or the per-user scope. Note that any given site can have, at most, a single client policy; if you try to create a policy for the Redmond site and that site already hosts a client policy you command will fail. Likewise, your command will fail if you try to create a new client policy at the global scope; that’s because the global scope already contains a client policy. If you need to make changes to the global policy, use the Set-CsClientPolicy cmdlet instead.

Return Types

New-CsClientPolicy creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Client.ClientPolicy object.

Examples

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

Copy Code
New-CsClientPolicy -Identity RedmondClientPolicy -DisableCalendarPresence $True -DisablePhonePresence $True -DisplayPhoto "PhotosFromADOnly"

The command shown in Example 1 creates a new client policy with the Identity RedmondClientPolicy. (Keep in mind that this command will fail if your organization already has a client policy with the Identity RedmondClientPolicy.) In addition to specifying the Identity, this command also includes three optional parameters and their parameter values: -DisableCalendarPresence; -DisablePhonePresence; and DisplayPhotos.

-------------------------- Example 2 --------------------------

Copy Code
$x = New-CsClientPolicy -Identity RedmondClientPolicy -InMemory
$x.DisableCalendarPresence = $True 
$x.DisablePhonePresence = $True 
$x.DisplayPhoto = "PhotosFromADOnly"
Set-CsClientPolicy -Instance $x

Example 2 also creates a new client policy with the Identity RedmondClientPolicy; the difference between these commands and the command used in Example 1 is that, in Example 2, the new policy is created in memory only, and is only later turned into an actual client policy. To do this, New-CsClientPolicy is first called along with two parameters: -Identity (to specify the Identity for the new policy), and -InMemory, which specifies that the new policy should be created in memory only and not immediately put into use. Because this policy is created in memory only, it must be stored in a variable; in this example, that’s a variable named $x.

After the virtual policy has been created, the next three commands are used to modify properties on this in-memory-only policy; for example, command 2 sets the value of the DisableCalendarPresence property to True ($True). After all the desired modifications have been made, the final command uses Set-CsClientPolicy to turn this virtual policy into an actual client policy that can be assigned to users. Note that this final command is critical. If you do not call Set-CsClientPolicy then the policy RedmondClientPolicy will not be created, and the virtual policy will disappear as soon as you terminate your Windows PowerShell session or delete the variable $x.