Set-CsClientPolicy

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

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

After a failed connection attempt, specifies the amount of time Skype for Business waits before again trying to connect to Skype for Business Server. The AutoDiscoveryRetryInterval can be set to value between 1 second and 60 minutes (1 hour), inclusive.

When specifying the AutoDiscoveryRetryInterval you must use the format hours:minutes:seconds. For example, to set the interval to 25 minutes use this syntax:

-AutoDiscoveryRetryInterval 00:25:00

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.

Specifies the amount of time, in seconds, that Skype for Business waits before retrieving calendar information from 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

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

Prompts you for confirmation before executing the command.

URL for custom Skype for Business help set up by an organization. This parameter has been deprecated for use with Skype for Business Server.

Customized help will not be available unless you also set EnableEnterpriseCustomizedHelp to True.

URL for the website that can be added to error messages that appear in Skype for Business. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Skype for Business. Users can then click that link and be taken to a custom website that contains additional information, troubleshooting tips, etc.

Specifies the location of the XML file used to add custom presence states to Skype for Business. (Skype for Business 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.

Allows administrators to provide additional information about a policy. For example, the Description might indicate the users that the policy should be assigned to.

Indicates the amount of time Skype for Business 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.

When set to True, calendar data taken from 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.

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

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

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

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.

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:[email protected]). When set to False, the notification dialog will use the federated user's display name (for example, Ken Myer) instead.

When set to True, the activity feeds tab will not be displayed in Skype for Business. When set to False, the feeds tab will be available within Skype for Business.

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

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

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

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

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

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.

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. To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True.

When set to True, the ability to start OneNote from within Skype for Business (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 Skype for Business. 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.

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

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

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:[email protected]). When set to False, the notification dialog box will use the person's display name (for example, Ken Myer) instead.

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

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

When set to True, any Out of Office message you configure in 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.

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.

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

Note that setting this value to True removes the menu options that make it easy for users to save instant 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.

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

NoPhoto - Photos are not displayed in Skype for Business.

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

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

The default value is AllPhotos.

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

When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in 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.

When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team.

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.

When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window.

When set to False, supplemental information will not be displayed in a separate browser window.

This parameter has been deprecated for use with Skype for Business Server.

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

This parameter has been deprecated for use with Skype for Business Server.

When set to True, detailed information about Skype for Business will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Skype for Business Server) are recorded in the event log.

When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients.

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

When set to True, a user that has been configured in Outlook will be allowed to schedule online Lync Calendar meetings for that user (this happens via Lync UCMAPI delegation, without the need of the Enterprise Voice feature).

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

When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. However, this improved performance will reduce the system resources and network bandwidth available to other applications.

When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. The default value is False.

When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business 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.

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 Outlook. When set to False, these transcripts will not be saved automatically. (However, users will have the option to manually save instant message transcripts.)

When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. Media redirection typically results in lower bandwidth usage, higher server scalability and a more-optimal user experience compared to similar techniques such as device remoting or codec compression.

This parameter is reserved for internal Microsoft use.

When set to True you will receive notification any time you are added to someone else's Contacts list. In addition, the notification dialog box will provide options for you to add that person to your Contacts list, or to block them from viewing your presence information.

When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client.

When set to true, allows users to provide screenshots of their clients when reporting problems.

When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. This makes it easier for users to retrieve that information from a mobile device.

The default value is False ($False).

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

When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Improvement Program. However, Skype for Business 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, Skype for Business will not give users the option of joining the program.

When set to True, software tracing will be enabled in Skype for Business; 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.

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.

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 parameter is reserved for internal Microsoft use.

When set to True, a Skype for Business 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.

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

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

When set to "Office 365", the Office 365 client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. You can either set HelpEnvironment to "Office 365" or to a null value ($Null). If set to a null value (the default value) then the on-premises help will be shown to users.

Timeout interval for a user logged on to a "hot-desk" phone. (A hot-desk phone is a phone running Skype for Business Phone Edition that is located in a shared workspace and that users can log on to using their Skype for Business 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).

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.

If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER.

Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed.

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.

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.

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

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business 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

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.

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.

Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business.

The default value is 30 kilobytes.

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.

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.

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

Provides a way to add settings not covered by the default parameters. For example, when testing pre-release versions Microsoft Lync Server 2010 it was possible to add a Send Feedback option to Microsoft Lync 2010. That was done by using code similar to this:

$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"

Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}

For more details and examples, see the New-CsClientPolicyEntry cmdlet help topic.

This parameter is reserved for internal Microsoft use.

When set to True ($True), enables a text box for users to type feedback when prompted.

The RateMyCallDisplayPercentage setting adjusts how often users are prompted for feedback, ranging from 0 to 100. The default value is 10, meaning that users will get prompted for feedback 10% of the time after they finish a call. Setting this to 0 means users will never get prompted. When set to 100, users will get prompted after every call.

This parameter is reserved for internal Microsoft use.

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

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

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

Note that this setting applies only to Lync 2010. Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True.

The default value is False.

This parameter has no effect on the client.

If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on SharePoint. The default value is False, which means that Skype for Business will not include a link to SharePoint.

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 Skype for Business. 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 Skype for Business 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.

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 Skype for Business. 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 Skype for Business 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.

External URL for the SharePoint site used for keyword searches (also known as expert searches). Skype for Business 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.

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

This parameter is reserved for internal Microsoft use.

Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. This parameter has been deprecated for use with Skype for Business Server.

This parameter is reserved for internal Microsoft use.

Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being modified. For example:

-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can return the tenant ID for each of your Skype for Business Online tenants by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

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

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

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

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

By default TracingLevel is set to Light.

For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business 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.

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