Lync Powershell - Ls admin windows_power_shell_supplement

Microsoft Lync Server 2010
Administration Guide –
Windows PowerShell
Supplement
Microsoft Lync Server 2010

Published: October 2011

This document is provided “as-is”. Information and views expressed in this document, including
URL and other Internet Web site references, may change without notice.
Some examples depicted herein are provided for illustration only and are fictitious. No real
association or connection is intended or should be inferred.
This document does not provide you with any legal rights to any intellectual property in any
Microsoft product. You may copy and use this document for your internal, reference purposes.
Copyright © 2011 Microsoft Corporation. All rights reserved.
Microsoft, Active Directory, ActiveSync, ActiveX, DirectX, Excel, Forefront, Groove, Hyper-V,
Internet Explorer, Lync, MSDN, MSN, OneNote, Outlook, PowerPoint, RoundTable, SharePoint,
Silverlight, SQL Server, Visio, Visual C++, Visual Studio, Windows, Windows Live, Windows
Media, Windows PowerShell, Windows Server, and Windows Vista, are trademarks of the
Microsoft group of companies. All other trademarks are property of their respective owners.

Contents
Introduction................................................................................................................................................. 1
Managing Archiving.................................................................................................................................... 2
Configuring Support for Archiving of Internal and External Communications.......................................... 2
Change the Global Policy for Archiving of Internal and External Communications ............................... 2
Create a Site Policy for Archiving......................................................................................................... 2
Enable or Disable Archiving for a Site.................................................................................................. 2
Create a User Policy for Archiving........................................................................................................ 2
Enable or Disable Archiving for Users.................................................................................................. 2
Delete an Archiving Policy.................................................................................................................... 2
Apply an Archiving Policy to a User or User Group.............................................................................. 3
Enable or Disable Archiving..................................................................................................................... 3
Specify the Types of Communications to Be Archived............................................................................. 3
Enable or Disable Purging for Archiving.................................................................................................. 4
Block or Allow IM and Web Conferencing Sessions If Archiving Fails..................................................... 4
Enable or Disable Sending an Archiving Disclaimer to Federated Partners............................................ 4
Configuring Support for Clients and Devices.............................................................................................. 5
Specify the Client Versions Supported in Your Organization................................................................... 5
View the Status of Services Running on a Computer.............................................................................. 5
Modify the Default Action for Clients Not Explicitly Supported or Restricted ............................................ 5
View Software Updates for Devices in Your Organization....................................................................... 6
Add a Device to Test Update Functionality.............................................................................................. 6
Modify Settings for Log Files of Device Update Activity........................................................................... 6
Configure Security Settings for Lync 2010 Phone Edition....................................................................... 7
Configure Voice Quality of Service for Lync 2010 Phone Edition............................................................ 7
Configure Phone Lock for Lync 2010 Phone Edition............................................................................... 7
Configuring Incoming Call Handling Features............................................................................................. 7
Configure Phone Number Extensions for Parking Calls.......................................................................... 7
Create a Call Park Orbit Range............................................................................................................ 7
Change a Call Park Orbit Range.......................................................................................................... 8
Delete a Call Park Orbit Range............................................................................................................ 8
Configure Routing of Unassigned Phone Numbers................................................................................. 8
Change an Unassigned Number Range.............................................................................................. 8
Delete an Unassigned Number Range................................................................................................. 8
Configuring Voice Routing.......................................................................................................................... 9
Configuring Dial Plans and Normalization Rules..................................................................................... 9
Create a Dial Plan................................................................................................................................ 9
Modify a Dial Plan................................................................................................................................ 9
Create or Modify a Normalization Rule Manually..................................................................................... 9
Configuring Voice Policies, PSTN Usage Records, and Voice Routes.................................................... 9
Configuring Voice Policies and PSTN Usage Records to Authorize Calling Features and Privileges . .9
Configuring Voice Routes for Outbound Calls.................................................................................... 10
Configuring Trunks and Translation Rules............................................................................................. 10
Configure Media Bypass on a Trunk.................................................................................................. 10

Configure a Trunk Without Media Bypass.......................................................................................... 11
Defining Translation Rules.................................................................................................................. 11
Exporting and Importing Voice Routing Configuration........................................................................... 11
Export a Voice Route Configuration File............................................................................................. 11
Import a Voice Route Configuration File............................................................................................. 11
Test Voice Routing................................................................................................................................. 12
Create a Voice Routing Test Case..................................................................................................... 12
Run Voice Routing Test Cases........................................................................................................... 12
Managing External Connectivity............................................................................................................... 12
Enable or Disable External User Access for Your Organization............................................................. 12
Enable or Disable Remote User Access for Your Organization.......................................................... 12
Enable or Disable Federation for Your Organization.......................................................................... 12
Enable or Disable Anonymous User Access for Your Organization.................................................... 12
Manage Communications with External Users...................................................................................... 13
Manage Remote User Access............................................................................................................ 13
Manage Federated Partner Access.................................................................................................... 13
Manage IM Provider Support................................................................................................................. 14
Configure Policies to Control Access by Users of IM Service Providers ............................................ 14
Specify Supported IM Service Providers............................................................................................ 14
Configure Conferencing Policies to Support Anonymous Users......................................................... 14
Apply Policies for External User Access to Users.................................................................................. 15
Apply External User Access Policies to Users.................................................................................... 15
Apply Conferencing Policies to Support Anonymous Users............................................................... 15
Reset or Delete External User Access Policies.................................................................................. 15
Filtering Instant Messages and Client Versions........................................................................................ 16
Configuring Filtering for Instant Messaging (IM).................................................................................... 16
Modify the Default File Transfer Filter................................................................................................ 16
Create a New File Transfer Filter for a Specific Site........................................................................... 16
Modify the Default URL Filter............................................................................................................. 16
Create a New URL Filter to Handle Hyperlinks in IM Conversations.................................................. 17
Specify Client Versions Supported for Sign-in by a User....................................................................... 17
Managing Computers in Your Topology.................................................................................................... 17
View a List of Computers Running Lync Server 2010............................................................................ 17
View the Status of Services Running on a Computer............................................................................ 18
View Details About a Service................................................................................................................. 19
Start or Stop Lync Server 2010 Services............................................................................................... 19
Prevent Sessions for Services............................................................................................................... 19
View Microsoft SIP Processing Language (MSPL) Server Applications................................................ 20
Enable or Disable a Microsoft SIP Processing Language (MSPL) Server Application ........................... 20
Mark a Microsoft SIP Processing Language (MSPL) Application as Critical or Not Critical................... 20
View a List of Trusted Applications........................................................................................................ 21
View the Simple URL Details................................................................................................................. 21
Managing Users........................................................................................................................................ 21
Search for Lync Server 2010 Users....................................................................................................... 21
Add a New User to Lync Server 2010.................................................................................................... 21

Enable or Disable Users for Lync Server 2010...................................................................................... 22
Set, View, and Send a User's Dial-in Conferencing PIN........................................................................ 22
Move Users to Another Pool.................................................................................................................. 23
Assign Policies to Users........................................................................................................................ 23
Assign a Conferencing Policy to Modify a User's Default Meeting Experience.................................. 23
Specify Client Versions Supported for Sign-in by a User................................................................... 24
Assign Specific Dial-in Conferencing PIN Security Settings to a User ............................................... 24
Apply External User Access Policies to Users.................................................................................... 24
Configure Archiving of a User's Communications............................................................................... 24
Assign a Location Policy to a User..................................................................................................... 25
Enable a User for Enterprise Voice........................................................................................................ 25
Configure Telephony for Users.............................................................................................................. 25
Managing On-Premises Meetings............................................................................................................. 26
Configuring Conferencing Settings........................................................................................................ 26
Modify the Default Conferencing User Experience............................................................................. 26
Create or Modify Conferencing User Experience for a Site or Group of Users .................................. 26
Delete a Conferencing Policy for a Site or Group of Users................................................................ 26
Configuring the Meeting Join Experience.............................................................................................. 27
Modify the Default Meeting Join Experience...................................................................................... 27
Create or Modify Meeting Join Settings for a Site or Pool.................................................................. 27
Delete Meeting Join Settings for a Site or Pool.................................................................................. 27
Configure Settings for a Dial-in Conferencing Access Number.............................................................. 28
Delete a Dial-in Conferencing Access Number.................................................................................. 28
Configure Dial-in Conferencing Personal Identification Number (PIN) Rules........................................ 28
Modify the Default Dial-in Conferencing PIN Settings........................................................................ 28
Create or Modify Dial-in Conferencing PIN Settings for a Site or Group of Users .............................. 29
Delete Dial-in Conferencing PIN Settings for a Site or Group of Users.............................................. 29
Managing Monitoring................................................................................................................................ 29
Create a Site Policy for Call Detail Recording....................................................................................... 29
Create a Site Policy for Quality of Experience....................................................................................... 29
Enable Call Detail Recording................................................................................................................. 30
Enable Quality of Experience................................................................................................................ 30
Configure Call Detail Recording............................................................................................................ 30
Configure Quality of Experience............................................................................................................ 30
Delete a Site Policy for Call Detail Recording........................................................................................ 30
Delete a Site Policy for Quality of Experience....................................................................................... 31
Configuring Your Network......................................................................................................................... 31
Enabling Call Admission Control............................................................................................................ 31
Enabling Media Bypass......................................................................................................................... 31
Configuring Location Policy................................................................................................................... 32
Configuring Bandwidth Policy Profile..................................................................................................... 32
Configuring Network Regions................................................................................................................ 33
Configuring Network Sites..................................................................................................................... 33
Configuring Network Subnets................................................................................................................ 34
Configuring Network Region Links........................................................................................................ 35

Configuring Network Region Routes..................................................................................................... 35
Prevent New Connections to Lync Server 2010 for Server Maintenance ................................................. 36
Prevent New Connections to Lync Server............................................................................................. 36
Delegating Control of Lync Server 2010................................................................................................... 36
Assigning an RBAC Role to a User....................................................................................................... 36
Assigning a User to a Security Group................................................................................................ 36
Managing Response Groups.................................................................................................................... 37
Managing Agent Groups........................................................................................................................ 37
Create an Agent Group...................................................................................................................... 37
Change Agent Group Settings or Members........................................................................................ 37
Delete an Agent Group....................................................................................................................... 38
Managing Response Group Queues..................................................................................................... 38
Create a Response Group Queue...................................................................................................... 38
Change a Response Group Queue.................................................................................................... 38
Delete a Response Group Queue...................................................................................................... 38
Managing Response Group Workflows................................................................................................. 39
Create a Response Group Workflow.................................................................................................. 39
Change a Response Group Workflow................................................................................................ 40
Delete a Response Group Workflow.................................................................................................. 41
Configuring Security.................................................................................................................................. 41
Create a New Registrar......................................................................................................................... 41
Modify an Existing Registrar.................................................................................................................. 41
Delete a Registrar.................................................................................................................................. 41
Create a New Web Service................................................................................................................... 42
Modify an Existing Web Service............................................................................................................ 42
Delete a Web Service............................................................................................................................ 42
Create a New PIN Policy....................................................................................................................... 43
Modify an Existing PIN Policy................................................................................................................ 43
Delete a PIN Policy................................................................................................................................ 43
Edit or Configure Simple URLs................................................................................................................. 43
Configure Simple URLs......................................................................................................................... 43
Configure a New Trusted Application Server............................................................................................ 44
Configure a Trusted Application Pool..................................................................................................... 44
Change the Web Services URL................................................................................................................ 44
Change the Web Services URL............................................................................................................. 44

Introduction
This document is provided as a supplement to the Microsoft Lync Server 2010 Administration Guide,
available from the Microsoft Download Center at http://go.microsoft.com/fwlink/?LinkId=207913. The
Microsoft Lync Server 2010 Administration Guide contains useful information about Lync Server
management. However, there is one thing that's missing from the Administration Guide: Lync Server
Windows PowerShell commands. Granted, there are a handful of commands scattered throughout the
Guide, but those are primarily commands used for tasks (such as configuring an Address Book server)
that can't be done using the Lync Server Control Panel. For most management activities (creating an
archiving policy, removing a dial-in conferencing access number, putting a domain on the list of blocked
domains) the Guide provides step-by-step instructions for performing the task using the Control Panel,
but doesn't let you know how (or even if) you can do the same thing using Lync Server Windows
PowerShell.
Which is exactly why we've put together this supplement to the Administration Guide. What we've done is
gone through the Administration Guide, identified all the tasks that don't include a Windows PowerShell
option, and provided the Windows PowerShell option. For example, the Administration Guide offers these
steps for locking a Lync Phone Edition phone:
1. Open a browser window, and then enter the Admin URL to open the Lync Server Control Panel.
For details about the different methods you can use to start Lync Server Control Panel, see Open
Lync Server Administration Tools.
2. Click Clients, and then click Device Configuration.
3. On the Device Configuration tab, in the list of device configurations, double-click the
configuration for which you want to change the phone lock settings.
4. In the Edit Device Configuration dialog box, verify that the Enforce device locking check box
is selected.
5. In Minimum PIN length, accept the default value or specify a new value.
6. In Phone lock time-out, accept the default value or specify a new value.
7. Click Commit.
To supplement those instructions, we've offered a Lync Server Windows PowerShell equivalent:
Set-CsUCPhoneConfiguration -Identity global –EnforcePhoneLock $True –
PhoneLockTimeout 00:30:00

Like we said, we consider this to be a supplement to the Administration Guide; it's definitely not a
replacement for the Guide. The Administration Guide includes a lot of useful information that explains
what phone locking is and why you might want to use it. We don't offer any of that kind of information; we
just provide you with a one-sentence introduction and then a Windows PowerShell command that shows
you how to do something along the lines of enabling phone locking.
The ideal way to do things here would be to download the Administration Guide, then copy our Windows
PowerShell commands and paste them into the appropriate sections in that Guide. That way you'd have
the best of both worlds: all the explanatory information and Control Panel steps found in the Guide, and
all the Windows PowerShell commands found here. What could be better than that?
In the meantime, this document provides the management tasks discussed in the Administration Guide. It
also includes links to supplemental information available online.
If you’d like to view this guide online, it’s available on the Lync Server 2010 Windows PowerShell blog at
http://go.microsoft.com/fwlink/?LinkId=230860. For details about Windows PowerShell in Lync Server,
see the Lync Server Windows PowerShell blog at http://go.microsoft.com/fwlink/?LinkId=203150.

1

Microsoft Lync Server 2010 Administration Guide – Windows PowerShell Supplement

Managing Archiving
Configuring Support for Archiving of Internal and External
Communications
Change the Global Policy for Archiving of Internal and External
Communications
 To change the global policy for archiving
To modify the global archiving policy, use the Set-CsArchivingPolicy cmdlet and set the Identity to
global:
Set-CsArchivingPolicy -Identity global -ArchiveInternal $True –ArchiveExternal
$True

Alternatively, you can leave off the Identity parameter. If you do not specify an Identity, Set-
CsArchivingPolicy will automatically modify the global policy:
Set-CsArchivingPolicy -ArchiveInternal $True –ArchiveExternal $True

Create a Site Policy for Archiving
 To create an archiving policy for a site
To create a new archiving policy at the site scope, use the New-CsArchivingPolicy cmdlet:
New-CsArchivingPolicy -Identity "site:Redmond" -ArchiveInternal $True –
ArchiveExternal $True

Enable or Disable Archiving for a Site
 To change a site policy
To modify an archiving policy configured at the site scope, use the Set-CsArchivingPolicy cmdlet:
Set-CsArchivingPolicy -Identity "site:Redmond" -ArchiveInternal $False –
ArchiveExternal $False

Create a User Policy for Archiving
 To create a user policy for archiving
To create a new per-user archiving policy, use the New-CsArchivingPolicy cmdlet:
New-CsArchivingPolicy -Identity "RedmondArchivingPolicy" -ArchiveInternal
$True –ArchiveExternal $True

Enable or Disable Archiving for Users
 To change a user policy for archiving
To modify a per-user archiving policy, use the Set-CsArchivingPolicy cmdlet:
Set-CsArchivingPolicy -Identity "RedmondArchivingPolicy" -ArchiveInternal
$False

Delete an Archiving Policy
 To delete a user or site policy for archiving
To delete a per-user or per-site archiving policy use the Remove-CsArchivingPolicy cmdlet:
Remove-CsArchivingPolicy -Identity "RedmondArchivingPolicy"

This command removes all the archiving policies configured at the site scope:

2


Get-CsArchivingPolicy –Filter "site:*" | Remove-CsArchivingPolicy

And this one removes all the archiving policies configured at the per-user scope:
Get-CsArchivingPolicy –Filter "tag:*" | Remove-CsArchivingPolicy

Apply an Archiving Policy to a User or User Group
 To apply an archiving user policy to a user account
To assign a per-user archiving policy to a user, use the Grant-CsArchivingPolicy cmdlet:
Grant-CsArchivingPolicy –Identity "Ken Myer" –PolicyName "RedmondArchiving"

To unassign a per-user archiving policy, use the Grant-CsArchivingPolicy cmdlet and set the value of
the PolicyName property to null:
Grant-CsArchivingPolicy –Identity "Ken Myer" –PolicyName $Null

For More Information
• Haiku #53: The CsArchivingPolicy Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230861
• The Edit Archiving Policy Dialog at http://go.microsoft.com/fwlink/?LinkId=230863

Enable or Disable Archiving
 To enable or disable archiving for a policy
To disable archiving, use the Set-CsArchivingConfiguration cmdlet and set the EnableArchiving
property to None:
Set-CsArchivingConfiguration –Identity global –EnableArchiving None

• Haiku #70: The CsArchivingConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230864
• The Archiving Setting Dialog at http://go.microsoft.com/fwlink/?LinkId=230865

Specify the Types of Communications to Be Archived
 To specify the communications to be archived
To archive only instant message sessions, use the Set-CsArchivingConfiguration cmdlet and set the
EnableArchiving property to ImOnly:
Set-CsArchivingConfiguration –Identity global –EnableArchiving ImOnly

To archive both instant message sessions and conferences, set EnableArchiving to ImAndWebConf:
Set-CsArchivingConfiguration –Identity global –EnableArchiving ImAndWebConf

To disable archiving altogether, set EnableArchiving to None:
Set-CsArchivingConfiguration –Identity global –EnableArchiving None

LinkId=230864

3


Enable or Disable Purging for Archiving
 To enable or disable purging for archiving
To enable the purging of old records from the archiving database, use the Set-
CsArchivingConfiguration cmdlet to set the EnablePurging property to True:
Set-CsArchivingConfiguration –Identity global –EnablePurging $True –
KeepArchivingDataForDays 30

As shown above, you can also use the KeepArchivingDataForDays parameter to specify the number of
days that records should be kept in the database.
To disable purging, set the EnablePurging property to False:
Set-CsArchivingConfiguration –Identity global –EnablePurging $False

LinkId=230864

Block or Allow IM and Web Conferencing Sessions If Archiving Fails
 To enable or disable blocking of IM and web conferencing sessions if archiving fails
To disable instant message sessions and conferences if archiving fails, use the Set-
CsArchivingConfiguration cmdlet and set the BlockOnArchiveFailure property to True:
Set-CsArchivingConfiguration –Identity global –BlockOnArchiveFailure $True

To allow instant message sessions and conferences if archiving fails set the BlockOnArchiveFailure
property to False:
Set-CsArchivingConfiguration –Identity global –BlockOnArchiveFailure $False

LinkId=230864

Enable or Disable Sending an Archiving Disclaimer to Federated
Partners
 To enable or disable sending an archiving disclaimer to federated partners
To display an archiving disclaimer to federated partners at the beginning of an instant messaging session,
use the Set-CsAccessEdgeConfiguration cmdlet and set the EnableArchivingDisclaimer property to
True:
Set-CsAccessEdgeConfiguration –Identity global -EnableArchivingDisclaimer
$True

To prevent the display of the archiving disclaimer, set the EnableArchivingDisclaimer property to False:
$False

• Haiku #83: The CsAccessEdgeConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230866
• The Access Edge Configuration Dialog at http://go.microsoft.com/fwlink/?LinkId=230867

4


Configuring Support for Clients and Devices
Specify the Client Versions Supported in Your Organization
 To edit the default client version policy
As a general rule, client version policies are most-easily edited by modifying the client version policy rules
associated with those policies. However, there might be times when you find it useful to use the Set-
CsClientVersionPolicy cmdlet to directly modify a policy. For example, the following set of commands
removes all the current client version policy rules from the Redmond site policy, copies the client version
policy rules from the Dublin site policy, and then assigns those same rules to the Redmond site:
Set-CsClientVersionPolicy -Identity site:Redmond -Rules $Null

$x = Get-CsClientVersionPolicy -Identity site:Dublin | Select-Object
-ExpandProperty Rules

Set-CsClientVersionPolicy -Identity site:Redmond -Rules $x

• Haiku #125: The CsClientVersionPolicy Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230868
• The Edit Client Version Policy Dialog at http://go.microsoft.com/fwlink/?LinkId=230869

View the Status of Services Running on a Computer
 To view the status of services running on a computer
To view the status of all the Lync Server services running on all of your computers, use the following
command:
Get-CsService | Select-Object Role, PoolFqdn | Sort-Object PoolFqdn, Role

To view the services running on a specific computer, use this command, replacing atl-cs-
001.litwareinc.com with the fully qualified domain name of the computer to be viewed:
Get-CsService | Where-Object {$_.PoolFqdn –eq "atl-cs-001.litwareinc.com"} |
Select-Object Role, PoolFqdn | Sort-Object PoolFqdn, Role

• Haiku #71: The CsService Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230871

Modify the Default Action for Clients Not Explicitly Supported or
Restricted
 To modify the default action for clients not explicitly supported or restricted
To modify the default action for client applications that do not appear in a client version policy, use the
Set-CsClientVersionConfiguration cmdlet and set the value of the DefaultAction property.
Set-CsClientVersionConfiguration –Identity global -DefaultAction
"BlockWithUrl" -DefaultURL "https://litwareinc.com/csclients"

 To disable client version control
To disable client version control, use the Set-CsClientVersionConfiguration cmdlet and set the Enabled
property to False:
Set-CsClientVersionConfiguration –Identity global –Enabled $False

To enable client version control, set the Enabled property to True:

5


Set-CsClientVersionConfiguration –Identity global –Enabled $True

• Haiku #115: The CsClientVersionConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230879
• The Edit Client Version Configuration Dialog at http://go.microsoft.com/fwlink/?LinkId=230881

View Software Updates for Devices in Your Organization
 To view software updates for UC devices
To review all the device update rules currently in use in your organization, use the Get-
CsDeviceUpdateRule cmdlet:
Get-CsDeviceUpdateRule

This command returns all the device update rules assigned to a specified Web Server:
Get-CsDeviceUpdateRule -Filter "service:WebServer:atl-cs-001.litwareinc.com*"

To approve a device update rule for widespread use, use the Approve-CsDeviceUpdate cmdlet:
Approve-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-
001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9

To reject a device update rule, use the Reset-CsDeviceUpdateRule cmdlet:
Reset-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-

To rollback a previously-approved device update rule, use the Restore-CsDeviceUpdateRule cmdlet:
Restore-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-

• The Device Update Dialog at http://go.microsoft.com/fwlink/?LinkId=230882
• Approve-CsDeviceUpdateRule Cmdlet at http://go.microsoft.com/fwlink/?LinkId=230883
• The Reset-CsDeviceUpdateRule Cmdlet at http://go.microsoft.com/fwlink/?LinkId=230886
• The Restore-CsDeviceUpdateRule Cmdlet at http://go.microsoft.com/fwlink/?LinkId=230885

Add a Device to Test Update Functionality
 To add a test device
The New-CsTestDevice cmdlet enables you to create a new test device. The following command creates
a new test device, using the serial number of the device as the unique identifier:
New-CsTestDevice -Identity site:Redmond/UCPhone -IdentifierType SerialNumber
-Identifier "07823-A345"

• Haiku #40: The CsTestDevice Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230884
• The New Test Device Dialog http://go.microsoft.com/fwlink/?LinkId=23088

Modify Settings for Log Files of Device Update Activity
 To change logging settings
To modify logging settings for the device update service, use the Set-CsDeviceUpdateConfiguration
cmdlet:

6


Set-CsDeviceUpdateConfiguration -Identity global -MaxLogFileSize 2048000
-MaxLogCacheLimit 1024000

• Haiku #127: The CsDeviceUpdateConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230887
• The Log Setting Dialog at http://go.microsoft.com/fwlink/?LinkId=230888.

Configure Security Settings for Lync 2010 Phone Edition
 To configure security settings for Lync 2010 Phone Edition
To change the security mode for Lync 2010 Phone Edition, use the Set-CsUCPhoneConfiguration
cmdlet:
Set-CsUCPhoneConfiguration -Identity global -SIPSecurityMode "Medium"

• Haiku #15: The CsUCPhoneConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230889

Configure Voice Quality of Service for Lync 2010 Phone Edition
 To configure Voice Quality of Service for Lync 2010 Phone Edition
To modify the quality of service settings for Lync 2010 Phone Edition, use the Set-
CsUCPhoneConfiguration cmdlet and the VoiceDiffServTag property:
Set-CsUCPhoneConfiguration -Identity global –VoiceDiffServTag 50

LinkId=230889

Configure Phone Lock for Lync 2010 Phone Edition
 To configure the phone lock
To enforce phone locking for Lync 2010 Phone Edition, use the Set-CsUCPhoneConfiguration cmdlet
and set the EnforcePhoneLock property to True. If desired, you can also change the value of the
PhoneLockTimeout property:
Set-CsUCPhoneConfiguration -Identity global –EnforcePhoneLock $True –
PhoneLockTimeout 00:30:00

LinkId=230889
Configuring Incoming Call Handling Features
Configure Phone Number Extensions for Parking Calls
Create a Call Park Orbit Range
 To create a new range of numbers for parking calls
To create a new Call Park orbit range use the New-CsCallParkOrbit cmdlet and specify both the start and
end numbers in the range:

7


New-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 100
-NumberRangeEnd 199 -CallParkService ApplicationServer:pool0.litwareinc.com

Change a Call Park Orbit Range
 To change a range of numbers for parking calls
To modify a Call Park Orbit range use the Set-CsCallParkOrbit cmdlet:
Set-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 500
-NumberRangeEnd 699

Delete a Call Park Orbit Range
 To delete a Call Park orbit range
To delete a Call Park Orbit range, use the Remove-CsCallParkOrbit cmdlet:
Remove-CsCallParkOrbit -Identity "Redmond CPO 1"

Use this command to remove all your Call Park orbit ranges:
Get-CsCallParkOrbit | Remove-CsCallParkOrbit

• Haiku #27: The CsCallParkOrbit Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230890

Configure Routing of Unassigned Phone Numbers
 To configure routing of unassigned phone numbers
The New-CsUnassignedNumber cmdlet enables you to create a new unassigned number range:
New-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000"
-NumberRangeEnd "+14255551100" -AnnouncementService
ApplicationServer:redmond.litwareinc.com -AnnouncementName "Welcome
Announcement"

Change an Unassigned Number Range
 To change routing of unassigned phone numbers
To change an existing unassigned number range, use the Set-CsUnassignedNumber cmdlet. This
command changes both the starting number and ending number for an unassigned number range:
Set-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000"
-NumberRangeEnd "+14255551900"

Delete an Unassigned Number Range
 To delete an unassigned number range
To delete an unassigned number range, use the Remove-CsUnassignedNumber cmdlet:
Remove-CsUnassignedNumber -Identity UNSet1

The following command enables you to delete all your unassigned number ranges:
Get-CsUnassignedNumber | Remove-CsUnassignedNumber

• Haiku #4: The CsUnassignedNumber Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230891
• The New Unassigned Number Range Dialog (Announcement) at http://go.microsoft.com/fwlink/?
LinkId=230892
• The New Unassigned Number Range Dialog (Exchange UM) at http://go.microsoft.com/fwlink/?
LinkId=230893

8


Configuring Voice Routing
Configuring Dial Plans and Normalization Rules
Create a Dial Plan
 To create a dial plan
To create a new dial plan, use the New-CsDialPlan cmdlet:
New-CsDialPlan -Identity site:Redmond -SimpleName RedmondSiteDialPlan

The following command creates a new dial plan, then uses the New-CsVoiceNormalizationRule cmdlet
to immediately add a new normalization rule to that dial plan:
New-CsDialPlan -Identity site:Redmond -SimpleName RedmondSiteDialPlan

New-CsVoiceNormalizationRule -Identity "site:Redmond/SeattlePrefix" -Pattern
"^9(d*){1,5}$" -Translation "+1206$1"

Modify a Dial Plan
 To modify a dial plan
To modify a dial plan, use the Set-CsDialPlan cmdlet:
Set-CsDialPlan -Identity RedmondDialPlan –ExternalAccessPrefix 8

• Haiku #92: The CsDialPlan Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230984
• The Edit Dial Plan Dialog at http://go.microsoft.com/fwlink/?LinkId=230985
• The New Normalization Rule Dialog at http://go.microsoft.com/fwlink/?LinkId=230986

Create or Modify a Normalization Rule Manually
 To define a normalization rule manually
To create a new voice normalization rule, use the New-CsVoiceNormalizationRule cmdlet. The
following rule has the name SeattleFourDigit and will be assigned to the dial plan SeattleUser:
New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit
-Description "Dialing with internal four-digit extension" -Pattern '^(d{4})$'
-Translation '+1206555$1'

• The New Normalization Rule Dialog at http://go.microsoft.com/fwlink/?LinkId=230986

Configuring Voice Policies, PSTN Usage Records, and Voice Routes
Configuring Voice Policies and PSTN Usage Records to Authorize Calling
Features and Privileges
Create a Voice Policy and Configure PSTN Usage Records
 To create a voice policy
To create a new voice policy, use the New-CsVoicePolicy cmdlet:
New-CsVoicePolicy –Identity UserVoicePolicy2 -AllowSimulRing $False
-PstnUsages @{Add = "Local"}

9


Modify a Voice Policy and Configure PSTN Usage Records
 To modify a voice policy
To modify an existing voice policy, use the Set-CsVoicePolicy cmdlet:
Set-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $False -PstnUsages @{add =
"Long Distance"}

View PSTN Usage Records
 To view a PSTN usage record
To view all your PSTN usage records, use the Get-CsPstnUsage cmdlet:
Get-CsPstnUsage | Select-Object –ExpandProperty Usage

Configuring Voice Routes for Outbound Calls
Create a Voice Route
 To create a voice route
To create a new voice route, use the New-CsVoiceRoute cmdlet:
New-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"}
-PstnGatewayList @{add="PstnGateway:redmondpool.litwareinc.com"}

Modify a Voice Route
 To modify a voice route
To modify a voice route, use the Set-CsVoiceRoute cmdlet:
Set-CsVoiceRoute -Identity Route1 -Description "Test Route"

The following commands use both the Get-CsVoiceRoute and Set-CsVoiceRoute cmdlets to add a new
PSTN gateway to a voice route:
$y = Get-CsVoiceRoute -Identity Route1
$y.PstnGatewayList.Add("PstnGateway:192.168.0.100")
Set-CsVoiceRoute -Instance $y

• Haiku #36: The CsVoicePolicy Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230987
• Haiku #78: The CsPstnUsage Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230988
• The Edit Voice Policy Dialog at http://go.microsoft.com/fwlink/?LinkId=230990
• The Edit Voice Route Dialog at http://go.microsoft.com/fwlink/?LinkId=230991
• The Edit PSTN Usage Record Dialog at http://go.microsoft.com/fwlink/?LinkId=230993

Configuring Trunks and Translation Rules
Configure Media Bypass on a Trunk
 To configure media bypass on a trunk
To enable media bypass for a new SIP trunk, use the New-CsTrunkConfiguration cmdlet and set the
EnableBypass property to True:
New-CsTrunkConfiguration -Identity site:Redmond -EnableBypass $True –
MaxEarlyDialogs 40 –SRTPMode Required

10


Configure a Trunk Without Media Bypass
 To configure a trunk without media bypass
To disable media bypass for a new SIP trunk, use the New-CsTrunkConfiguration cmdlet and set the
EnableBypass property to False:
New-CsTrunkConfiguration -Identity site:Redmond -EnableBypass $False –
MaxEarlyDialogs 40 –SRTPMode Required

Defining Translation Rules
Create or Modify a Translation Rule Manually
 To define a translation rule manually
To create a new translation rule use the New-CsSipResponseCodeTranslationRule cmdlet:
New-CsSipResponseCodeTranslationRule -Identity
"PstnGateway:192.168.0.240/Rule404" -ReceivedResponseCode 434
-TranslatedResponseCode 404

• Haiku #2: The CsTrunkConfiguration Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230994
• Haiku #45: The CsSipResponseCodeTranslationRule Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230995
• The Edit Trunk Configuration Dialog at http://go.microsoft.com/fwlink/?LinkId=230996

Exporting and Importing Voice Routing Configuration
Export a Voice Route Configuration File
 To export a voice routing configuration
With Windows PowerShell you cannot directly export a voice route in the VCFG file format used by the
Lync Server Control Panel. However, it is possible to export a voice route in an XML format that can later
be imported using Windows PowerShell:
Get-CsVoiceRoute –Identity "RedmondRoute" | Export-Clixml –Path
"C:RoutesRedmondRoute.xml"

Import a Voice Route Configuration File
 To import a voice routing configuration
To import a voice route that was previously exported using the Export-Clixml cmdlet, use the following
command:
Import-Clixml –Path "C:RoutesRedmondRoute.xml" | Set-CsVoiceRoute

• The Get-CsVoiceRoute Cmdlet at http://go.microsoft.com/fwlink/?LinkId=230999
• The Edit Voice Route Dialog at http://go.microsoft.com/fwlink/?LinkId=230991
• The Import-Clixml Cmdlet at http://go.microsoft.com/fwlink/?LinkId=113340
• The Export-Clixml Cmdlet at http://go.microsoft.com/fwlink/?LinkId=113297

11


Test Voice Routing
Create a Voice Routing Test Case
 To create a test case
To create a new test case for voice routing, use the New-CsVoiceTestConfiguration cmdlet:
New-CsVoiceTestConfiguration -Identity TestConfig1 -DialedNumber 5551212
-ExpectedTranslatedNumber +5551212

Run Voice Routing Test Cases
 To run all voice routing test cases
Use the following command to run all your voice routing test cases, one after another:
Get-CsVoiceTestConfiguration | Test-CsVoiceTestConfiguration

 To run one or more selected voice routing test cases
Use the following command to run a specific voice routing test case:
Get-CsVoiceTestConfiguration -Identity TestConfig1 | Test-
CsVoiceTestConfiguration

• The Test-CsVoiceTestConfiguration Cmdlet at http://go.microsoft.com/fwlink/?LinkId=23100
Managing External Connectivity
Enable or Disable External User Access for Your Organization
Enable or Disable Remote User Access for Your Organization
 To enable or disable remote user access for your organization
To enable remote user access, use the Set-CsAccessEdgeConfiguration cmdlet to set the
AllowOutsideUsers property to True:
Set-CsAccessEdgeConfiguration –Identity global –AllowOutsideUsers $True

To disable remote user access, set the AllowOutsideUsers property to False:
Set-CsAccessEdgeConfiguration –Identity global –AllowOutsideUsers $False

Enable or Disable Federation for Your Organization
 To enable or disable federated user access for your organization
To enable federated user access, use the Set-CsAccessEdgeConfiguration cmdlet to set the
AllowFederatedUsers property to True:
Set-CsAccessEdgeConfiguration –Identity global –AllowFederatedUsers $True

To disable federated user access, set the AllowFederatedUsers property to False:
Set-CsAccessEdgeConfiguration –Identity global –AllowFederatedUsers $False

Enable or Disable Anonymous User Access for Your Organization
 To enable or disable anonymous user access for your organization
To enable anonymous user access, use the Set-CsAccessEdgeConfiguration cmdlet to set the
AllowAnonymousUsers property to True:
Set-CsAccessEdgeConfiguration –Identity global –AllowAnonymousUsers $True

12


To disable anonymous user access, set the AllowAnonymousUsers property to False:
Set-CsAccessEdgeConfiguration –Identity global –AllowAnonymousUsers $False

• Haiku #83: The CsAccessEdgeConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230866

Manage Communications with External Users
Manage Remote User Access
 To configure an external access policy to support remote user access
To create an external user access policy that allows access by remote users, use the New-
CsExternalAccessPolicy cmdlet and set the EnableOutsideAccess property to True:
New-CsExternalAccessPolicy –Identity "RedmondExternalAccess" –
EnableOutsideAccess $True

Manage Federated Partner Access
Configure Policies to Control Federated User Access
 To configure a policy to support access by users of federated domains
To create an external user access policy that allows access by federated users, use the New-
CsExternalAccessPolicy cmdlet and set the EnableFederationAccess property to True:
New-CsExternalAccessPolicy –Identity "RedmondExternalAccess" –
EnableFederationAccess $True

Enable or Disable Discovery of Federation Partners
 To enable or disable automatic discovery of federated domains for your organization
To enable automatic discovery of federated domains, use the Set-CsAccessEdgeConfiguration cmdlet
and the UseDnsSrvRouting parameter, and set EnablePartnerDiscovery to True:
Set-CsAccessEdgeConfiguration -UseDnsSrvRouting -EnablePartnerDiscovery $True

To disable automatic routing, use the UseDefaultRouting parameter, and set DefaultRouteFqdn to the
fully qualified domain name of the Edge Server used for federation requests:
Set-CsAccessEdgeConfiguration -UseDefaultRouting -DefaultRouteFqdn "atl-edge-
001.litwareinc.com"

Control Access by Individual Federated Domains
 To add an external domain to the list of allowed domains
To add a domain to the list of domains your users are allowed to communicate with, use the New-
CsAllowedDomain cmdlet followed by the fully qualified domain name of the allowed domain:
New-CsAllowedDomain -Identity "fabrikam.com"

 To add an external domain to the list of blocked domains
To add a domain to the list of domains your users are not allowed to communicate with, use the New-
CsBlockedDomain cmdlet followed by the fully qualified domain name of the "outlawed" domain:
New-CsBlockedDomain -Identity "contoso.com"

13


Enable or Disable Sending an Archiving Disclaimer to Federated Partners
 To enable or disable sending an archiving disclaimer to federated partners
To display an archiving disclaimer to federated partners at the beginning of an instant messaging session,
use the Set-CsAccessEdgeConfiguration cmdlet and set the EnableArchivingDisclaimer property to
True:
$True

To prevent the display of the archiving disclaimer, set the EnableArchivingDisclaimer property to False:
$False

• Haiku #107: The CsExternalAccessPolicy Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=231001
• Haiku # 83: The CsAccessEdgeConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=230866
• Haiku #3: The CsBlockedDomain Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231002
• The Edit External Access Policy Dialog at http://go.microsoft.com/fwlink/?LinkId=231003
• The New Federated Domains Dialog (Allowed Domains) at http://go.microsoft.com/fwlink/?
LinkId=231004
• The New Federated Domains Dialog (Blocked Domains) at http://go.microsoft.com/fwlink/?
LinkId=231005

Manage IM Provider Support
Configure Policies to Control Access by Users of IM Service Providers
 To configure an external access policy to support public user access
To enable users to communicate with a public provider such as MSN or AOL, use the Set-
CsExternalAccessPolicy cmdlet to set the EnablePublicCloudAccess property of the appropriate
external access policy to True:
New-CsExternalAccessPolicy -Identity site:Redmond -EnablePublicCloudAccess
$True

Specify Supported IM Service Providers
 To configure support for an IM service provider
To enable users to communicate with a new public provider, use the New-CsPublicProvider cmdlet to
add the new organization to the list of approved providers:
New-CsPublicProvider -Identity "Fabrikam" -ProxyFqdn
"proxyserver.fabrikam.com" -Enabled $True -VerificationLevel
"AlwaysUnverifiable"

Configure Conferencing Policies to Support Anonymous Users
 To configure policies to allow anonymous participation in meetings
To allow users to host meetings that include anonymous users, use the Set-CsConferencingPolicy
cmdlet to set the AllowAnonymousParticipantsInMeetings property of the appropriate conferencing policy
to True:

14


Set-CsConferencingPolicy –Identity global
-AllowAnonymousParticipantsInMeetings $True

LinkId=231001
• Haiku #128: The CsPublicProvider Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231006
• No Conferencing Policy is an Island at http://go.microsoft.com/fwlink/?LinkId=231008
• The Edit Provider Dialog at http://go.microsoft.com/fwlink/?LinkId=231013
• The Edit Conferencing Policy Dialog at http://go.microsoft.com/fwlink/?LinkId=231014

Apply Policies for External User Access to Users
Apply External User Access Policies to Users
 To apply an external user policy to a user account
To assign a per-user external access policy to a user, use the Grant-CsExternalAccessPolicy cmdlet.
Grant-CsExternalAccessPolicy –Identity "Ken Myer" –PolicyName
"RedmondExternalAccess"

To unassign a per-user policy, use Grant-CsExternalUserAccess and set the PolicyName to a null
value:
Grant-CsExternalAccessPolicy –Identity "Ken Myer" –PolicyName $null

Apply Conferencing Policies to Support Anonymous Users
 To configure a user policy for anonymous participation in meetings
To allow users to host meetings that include anonymous participants, use the Set-
CsConferencingPolicy cmdlet and set AllowAnonymousParticipantsInMeetings to True:
Set-CsConferencingPolicy –Identity site:Redmond

To prevent users from hosting meetings that include anonymous participants, set
AllowAnonymousParticipantsInMeetings to False:

-AllowAnonymousParticipantsInMeetings $False

Reset or Delete External User Access Policies
Delete a Site or User Policy for External User Access
 To delete a site or user policy for external user access
To delete a per-site external access policy, use the Remove-CsExternalAccessPolicy cmdlet followed
by the policy Identity:
Remove-CsExternalAccessPolicy –Identity site:Redmond

You can also use this command to remove all the per-site policies:
Get-CsExternalAccessPolicy –Filter "site:*" | Remove-CsExternalAccessPolicy

To delete a per-user policy, use the Remove-CsExternalAccessPolicy cmdlet followed by the policy
Identity:

15


Remove-CsExternalAccessPolicy –Identity "RedmondExternalAccessPolicy"

This command removes all the per-user policies:
Get-CsExternalAccessPolicy –Filter "tag:*" | Remove-CsExternalAccessPolicy

Reset the Global Policy for External User Access
 To reset the global policy to the default settings
To reset all the properties in the global external user access policy to their default values, use the
Remove-CsExternalAccessPolicy cmdlet:
Remove-CsExternalAccessPolicy –Identity global

Note that this command will not remove the global policy. However, all the properties in that policy will be
reset to their default values.

LinkId=231001
Filtering Instant Messages and Client Versions
Configuring Filtering for Instant Messaging (IM)
Modify the Default File Transfer Filter
 To modify the default file transfer filter
To modify the default file transfer filter, use the Set-CsFileTransferFilterConfiguration cmdlet and set
the Identity to global. For example, this command adds the file extension .ps1 (the file extension used for
Windows PowerShell scripts) to the set of file types that cannot be transferred using Lync:
Set-CsFileTransferFilterConfiguration -Identity global -Extensions
@{Add=".ps1"}

And this command removes the .ps1 file extension from the list of file types that cannot be transferred
using Lync:
Set-CsFileTransferFilterConfiguration -Identity global -Extensions
@{Remove=".ps1"}

Create a New File Transfer Filter for a Specific Site
 To create a file transfer filter for a specific site
To create a new collection of file transfer filter configuration settings, use the New-
CsFileTransferFilterConfiguration cmdlet:
New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions
@{Add=".ps1"}

Modify the Default URL Filter
To modify the default URL filter, use the Set-CsFileTransferFilterConfiguration cmdlet and set the
Identity to global. For example, this command adds the prefix .urn to the set of Uniform Resource
Identifiers (URIs) that either cannot be included in an instant message or cannot be configured as a
clickable link within an instant message:

16


Set-CsImFilterConfiguration -Identity global -Prefixes @{Add="urn:"}

This command removes the prefix .urn from the collection of blocked URIs:
Set-CsImFilterConfiguration -Identity global -Prefixes @{Remove="urn:"}

Create a New URL Filter to Handle Hyperlinks in IM Conversations
 To create a new URL filter
To create a new collection of URL filter configuration settings use the New-CsImFilterConfiguration
cmdlet:
Set-CsImFilterConfiguration -Identity "site:Redmond" -Prefixes @{Add="urn:"}

• Haiku #77: The CsImFilterConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=231016
• Haiku #56: The CsFileTransferFilterConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=231017
• The Edit File Filter Dialog at http://go.microsoft.com/fwlink/?LinkId=231018
• The Edit URL Filter Dialog (Allow) at http://go.microsoft.com/fwlink/?LinkId=231019
• The Edit URL Filter Dialog (Block) at http://go.microsoft.com/fwlink/?LinkId=231021
• The Edit URL Filter Dialog (Allow With Warning) at http://go.microsoft.com/fwlink/?
LinkId=231022.

Specify Client Versions Supported for Sign-in by a User
 To assign a per-user client version policy
To assign a per-user client version policy, use the Grant-CsClientVersionPolicy cmdlet:
Grant-CsClientVersionPolicy –Identity "Ken Myer" –PolicyName
"RedmondClientVersionPolicy"

To unassign a per-user policy, use the Grant-CsClientVersionPolicy cmdlet and set the PolicyName
parameter to a null value:
Grant-CsClientVersionPolicy –Identity "Ken Myer" –PolicyName $Null

• Haiku #125: The CsClientVersionPolicy Cmdlets at http://go.microsoft.com/fwlink/?LinkId=230868
• The Edit Client Version Policy Dialog at http://go.microsoft.com/fwlink/?LinkId=230869
Managing Computers in Your Topology
View a List of Computers Running Lync Server 2010
 To view a list of computers running Lync Server
Although not quite a perfect match, the following script largely replicates the information found on the
Status area on the Topology page in the Lync Server Control Panel:
$errorPref = $errorActionPreference
$errorActionPreference = "SilentlyContinue"

$arrObjects = @()
$computers = Get-CsComputer | Sort-Object Identity

foreach ($objComputer in $computers)
{

17


$objSite = Get-CsPool -Identity $objComputer.pool | Select-Object Site
$objReplication = $Null
$objReplication = Get-CsManagementStoreReplicationStatus -ReplicaFqdn
`
$objComputer.Identity | Select-Object UpToDate
$strReplication = $objSite.site -replace("Site:","")

$objDisplayObject = New-Object PSObject
Add-Member -InputObject $objDisplayObject -memberType NoteProperty `
-Name Identity -Value $objComputer.Identity
-Name Pool -Value $objComputer.Pool
-Name Site -Value $strReplication
-Name UpToDate -Value $objReplication.UpToDate

$arrObjects += $objDisplayObject
}

$labels = @{Expression={$_.Identity};Label="Computer"}, `
@{Expression={$_.Pool};Label="Pool"}, `
@{Expression={$_.Site};Label="Site"}, `
@{Expression={$_.UpToDate};Label="Replication"}

$arrObjects | Format-Table $labels
$errorActionPreference = $errorPref
To use this script, copy the code, paste it into a text editor, and then save the file using a .ps1 file
extension (for example, C:ScriptsStatus.ps1). From there all you have to do is run the script from within
the Lync Server Management Shell. For example:
C:ScriptsStatus.ps1

• Haiku #81: The CsPool Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231025
• Haiku #67: The CsManagementStoreReplicationStatus Cmdlets at
http://go.microsoft.com/fwlink/?LinkId=231026
• Get-CsComputer Cmdlet at http://go.microsoft.com/fwlink/?LinkId=231027

View the Status of Services Running on a Computer
 To view the status of services running on a computer
To view the status of all the Lync Server services running on all your computers, use the following
command:
Get-CsService | Select-Object Role, PoolFqdn | Sort-Object PoolFqdn, Role

To view the services running on a specific computer, use this command, replacing atl-cs-
001.litwareinc.com with the fully qualified domain name of the computer to be checked:
Get-CsService | Where-Object {$_.PoolFqdn –eq "atl-cs-001.litwareinc.com"} |
Select-Object Role, PoolFqdn | Sort-Object PoolFqdn, Role

18



View Details About a Service
 To view details for a service
To view detailed information for a particular Lync Server service or server role, use the Get-CsService
cmdlet followed by the service Identity:
Get-CsService –Identity service:Registrar:atl-cs-001.litwareinc.com
To view detailed information for all your Lync Server services or server roles, call Get-CsService without
any parameters:

Get-CsService


Start or Stop Lync Server 2010 Services
 To start or stop all Lync Server services on a computer
To start all the Lync Server services on a computer, use the Start-CsWindowsService cmdlet:
Start-CsWindowsService -ComputerName atl-cs-001.litwareinc.com

Note that the ComputerName parameter is not required if you are starting the Lync Server services on the
local computer.
To stop all the Lync Server services on a computer, use the Stop-CsWindowsService cmdlet:
Stop-CsWindowsService -ComputerName atl-cs-001.litwareinc.com

 To start or stop a specific service
To start a specific service, use the Start-CsWindowsService cmdlet along with the Name parameter:
Start-CsWindowsService –Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com
Use the Stop-CsWindowsService cmdlet to stop a specified service:
Stop-CsWindowsService –Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com

• Haiku #51: The CsWindowsService Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231028

Prevent Sessions for Services
 To prevent new sessions for all Lync Server services on a computer
To prevent new sessions for all the Lync Server services on a computer use the following command:
Get-CsWindowsService | Stop-CsWindowsService -ComputerName atl-cs-
001.litwareinc.com –Graceful
The Graceful parameter used with the Stop-CsWindowsService cmdlet ensures that all existing
sessions will be honored but no new sessions will be allowed.
 To prevent new sessions for a specific service
To prevent new sessions for a specific Lync Server service, use the following command:
Stop-CsWindowsService -Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com
-Graceful

19


• Haiku #51: The CsWindowsService Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231028

View Microsoft SIP Processing Language (MSPL) Server Applications
To return information for all of your MSPL server applications, use the Get-CsServerApplication cmdlet:
Get-CsServerApplication

The following command returns information for a specific application:
Get-CsServerApplication -Identity "service:Registrar:atl-cs-
001.litwareinc.com/ExumRouting"

And this command returns information about all the applications running under a specific service:
Get-CsServerApplication -Identity "service:EdgeServer:atl-edge-
001.litwareinc.com"

• The Server Application Dialog at http://go.microsoft.com/fwlink/?LinkId=231029

Enable or Disable a Microsoft SIP Processing Language (MSPL)
Server Application
 To enable or disable an MSPL server application
To enable an MPSL server application, use the Set-CsServerApplication cmdlet and set the Enabled
property to True:
Set-CsServerApplication -Identity "Registrar:atl-cs-
001.litwareinc.com/ExumRouting" -Enabled $True

To disable an MPSL server application, set the Enabled property to False:
001.litwareinc.com/ExumRouting" -Enabled $False


Mark a Microsoft SIP Processing Language (MSPL) Application as
Critical or Not Critical
 To mark or unmark an MSPL server application as critical
To mark an MPSL server application as critical, use the Set-CsServerApplication cmdlet and set the
Critical property to True:
001.litwareinc.com/QoEAgent" -Critical $True

To mark an MPSL server application as not being critical, set the Critical property to False:
001.litwareinc.com/QoEAgent" -Critical $False


20


View a List of Trusted Applications
 To view a list of trusted applications
To return information for all your trusted applications, call Get-CsTrustedApplication without any
parameters:
Get-CsTrustedApplication

To return information about a single application, use the Identity parameter followed by the application
Identity:
Get-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2

• The Trusted Application Dialog at http://go.microsoft.com/fwlink/?LinkId=231030

View the Simple URL Details
 To view Simple URL details
To return information about the Simple URLs configured for use in your organization, use the following
command:
Get-CsSimpleUrlConfiguration | Select-Object –Expand SimpleUrl

• Haiku #29: The CsSimpleUrlConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=231035
Managing Users
Search for Lync Server 2010 Users
 To search for one or more users
To search for a user based on the value of a Lync Server-specific attribute, use the Get-CsUser cmdlet
and the Filter parameter. For example, this command searches for all users who have not been assigned
a per-user voice policy:
Get-CsUser -Filter {VoicePolicy -eq $Null}

To search for a user based on the value of a generic Active Directory attribute, use the Get-CsUser
cmdlet and the LdapFilter parameter. For example, this command searches for all users who are
members of the Finance department:
Get-CsUser -LDAPFilter "Department=Finance"

• 21 User Information Cmdlets to Run Before You Die at http://go.microsoft.com/fwlink/?
LinkId=231038

Add a New User to Lync Server 2010
 To create a new Lync Server user
To enable a user to use Lync Server, use the Enable-CsUser cmdlet:
Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-
001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com

The preceding command includes the SipAddressType and SipDomain parameters; this causes Lync
Server to automatically create a SIP address for the user based (in this case) on the user's

21


SamAccountName and the domain name litwareinc.com. Alternatively, you can use the SipAddress
parameter to assign a specific SIP address to a user:
Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-
001.litwareinc.com" –SipAddress "sip:pilar@litwareinc.com"

• 21 User Information Cmdlets to Run Before You Die at http://go.microsoft.com/fwlink/?
LinkId=231038
• Enabling a User for Microsoft Lync Server 2010 at http://go.microsoft.com/fwlink/?LinkId=231040
• Enabling a User for Microsoft Lync Server 2010 and Enterprise Voice at
• The New Communications Server User Dialog at http://go.microsoft.com/fwlink/?LinkId=231044
• Enable-CsUser Cmdlet at http://go.microsoft.com/fwlink/?LinkId=212121

Enable or Disable Users for Lync Server 2010
 To disable or re-enable a previously enabled user account for Lync Server
To permanently disable a Lync Server user account, use the Disable-CsUser cmdlet:
Disable-CsUser –Identity "Ken Myer"

When you run the preceding command, the user's Lync account will be disabled and all Lync Server-
related attributes (including the policies assigned to that user) will be deleted from the user account. (Note
that the user's Active Directory user account will not be deleted.) If you later decide to once more give the
user access to Lync Server you will need to re-run the Enable-CsUser cmdlet, reassign any per-user
policies, and reset property values such as the user's line URI and SIP address.
To temporarily disable a Lync Server user account, use the Set-CsUser cmdlet to set the account's
Enabled property to False:
Set-CsUser –Identity "Ken Myer" –Enabled $False

When you run the preceding command the user will still have a valid Lync Server account, and that
account will retain all its current settings (including any per-user policies that have been assigned to the
user). However, the user will not be able to log on to Lync Server until his or her account has been re-
enabled.
To re-enable a user whose Lync Server account has been temporarily disabled, use the Set-CsUser
cmdlet to set the account's Enabled property to True:
Set-CsUser –Identity "Ken Myer" –Enabled $True

• When is a Boolean Not a Boolean? at http://go.microsoft.com/fwlink/?LinkId=231045
• Disable-CsUser at http://go.microsoft.com/fwlink/?LinkId=231046
• Set-CsUser at http://go.microsoft.com/fwlink/?LinkId=231047

Set, View, and Send a User's Dial-in Conferencing PIN
 To set a user’s PIN
Lync Server Windows PowerShell provides two different ways to assign a PIN number to a user. To have
Lync Server randomly generate a PIN number for the user, use a command similar to this one:
Set-CsClientPin -Identity "Ken Myer"

The assigned PIN number will appear onscreen, like this:
Identity Pin PinReset
-------- --- --------

22


Sip:kmyer@litwareince.com 55279 True
Note. It will be up to you to notify the user of his or her new PIN number; Lync Server will not automatically
send these notifications for you.
Alternatively, you can include the Pin parameter and assign a specific PIN number to a user:
Set-CsClientPin -Identity "Ken Myer" -Pin 18723834
You can also pipe multiple user accounts to Set-CsClientPin and Lync Server will automatically assign a
new PIN number to each of those accounts. For example:
Get-CsUser –LdapFilter "Department=IT" | Set-CsClientPin

• Haiku #95: The CsClientPin Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231048

Move Users to Another Pool
 To move selected users to a different server or pool
To move a user from one Registrar pool to another, use the Move-CsUser cmdlet:
Move-CsUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com"

You can also move multiple users by piping more than one user Identity (in this case, the Active Directory
display name) to the Move-CsUser cmdlet:

"Ken Myer", "Pilar Ackerman", "Aidan Delaney" | Move-CsUser -Target "atl-cs-
001.litwareinc.com"
 To move all users from one server or pool to a different server or pool
To move all the users from a specified pool to a different pool, first use the Get-CsUser cmdlet to retrieve
all the users from that pool; in the following command, the Filter value {RegistrarPool –eq "dublin-cs-
001.litwareinc.com"} limits the returned user accounts to those users homed on the pool dublin-cs-
001.litwareinc.com. That collection of user accounts can then be piped to the Move-CsUser cmdlet:
Get-CsUser -Filter {RegistrarPool –eq "dublin-cs-001.litwareinc.com"}| Move-
CsUser -Target "atl-cs-001.litwareinc.com"

 To move users from one pool to a different pool by using a filter
To move a selected group of users (based on an Active Directory attribute) first use the Get-CsUser
cmdlet and the LdapFilter parameter to retrieve the desired set of users. After retrieving the appropriate
user accounts you can then pipe all those accounts to the Move-CsUser cmdlet:
Get-CsUser -LdapFilter "Department=Finance" | Move-CsUser -Target "atl-cs-
001.litwareinc.com"

• Haiku #10: The CsUser Cmdlets at http://go.microsoft.com/fwlink/?LinkId=231049

Assign Policies to Users
Assign a Conferencing Policy to Modify a User's Default Meeting
Experience
 To assign a per-user conferencing policy
To assign a per-user conferencing policy to a user, use a command similar to this, specifying the Identity
of the per-user policy as the parameter value for the PolicyName parameter:
Grant-CsConferencingPolicy –Identity "Ken Myer" –PolicyName
"RedmondConferencingPolicy"

23


If you later decide to remove that conferencing policy (and thus have the user managed by the global
policy or his or her site policy) use the following command, which sets the PolicyName property to a null
value:
Grant-CsConferencingPolicy –Identity "Ken Myer" –PolicyName $Null

Specify Client Versions Supported for Sign-in by a User
 To assign a per-user client version policy
To assign a per-user client version policy to a user, use a command similar to this, specifying the Identity
Grant-CsClientVersionPolicy –Identity "Ken Myer" –PolicyName
"RedmondClientVersionPolicy"

If you later decide to remove that client version policy (and thus have the user managed by the global
policy, a service policy, or his or her site policy) use the following command, which sets the PolicyName
property to a null value:
Grant-CsClientVersionPolicy –Identity "Ken Myer" –PolicyName $Null

Assign Specific Dial-in Conferencing PIN Security Settings to a User
 To assign a per-user PIN policy
To assign a per-user PIN policy to a user, use a command similar to this, specifying the Identity of the
per-user policy as the parameter value for the PolicyName parameter:
Grant-CsPinPolicy –Identity "Ken Myer" –PolicyName "RedmondPinPolicy"

If you later decide to remove that PIN policy (and thus have the user managed by the global policy or his
or her site policy) use the following command, which sets the PolicyName property to a null value:
Grant-CsPinPolicy –Identity "Ken Myer" –PolicyName $Null

Apply External User Access Policies to Users
 To apply an external user policy to a user account
To assign a per-user external access policy to a user, use a command similar to this, specifying the
Identity of the per-user policy as the parameter value for the PolicyName parameter:
Grant-CsExternalAccessPolicy –Identity "Ken Myer" –PolicyName
"RedmondExternalAccessPolicy"

If you later decide to remove that external access policy (and thus have the user managed by the global
policy or his or her site policy) use the following command, which sets the PolicyName property to a null
value:
Grant-CsExternalAccessPolicy –Identity "Ken Myer" –PolicyName $Null

Configure Archiving of a User's Communications
 To assign a per-user archiving policy
To assign a per-user archiving policy to a user, use a command similar to this, specifying the Identity of
the per-user policy as the parameter value for the PolicyName parameter:
Grant-CsArchivingPolicy –Identity "Ken Myer" –PolicyName
"RedmondArchivingPolicy"

If you later decide to remove that archiving policy (and thus have the user managed by the global policy
or his or her site policy) use the following command, which sets the PolicyName property to a null value:
Grant-CsArchivingPolicy –Identity "Ken Myer" –PolicyName $Null

24


Assign a Location Policy to a User
 To assign a per-user location policy
To assign a per-user conferencing policy to a user, use a command similar to this, specifying the Identity
Grant-CsLocationPolicy –Identity "Ken Myer" –PolicyName
"RedmondLocationPolicy"

• Assigning Policies at http://go.microsoft.com/fwlink/?LinkId=231050

Enable a User for Enterprise Voice
 To enable a user account for Enterprise Voice
To enable a user for Enterprise Voice, use Set-CsUser to set the EnterpriseVoiceEnabled property to
True and to assign the user a unique line URI:
Set-CsUser –Identity "Ken Myer" -EnterpriseVoiceEnabled $True –LineUri "TEL:
+14255551297"

• Enabling a User for Microsoft Lync Server 2010 and Enterprise Voice at
• How Can I Configure the Telephony Options for a User? at http://go.microsoft.com/fwlink/?
LinkId=231051

Configure Telephony for Users
 To configure telephony for a specific user account
To configure telephony options for a user, use the Set-CsUser cmdlet. The following command enables a
user for Enterprise Voice and assigns that user a line URI:
Set-CsUser –Identity "Ken Myer" –EnterpriseVoiceEnabled $True –LineUri "TEL:
+14255551219"

To enable remote call control for a user, use the following command:
Set-CsUser –Identity "Ken Myer" -RemoteCallControlTelephonyEnabled $True –
LineUri "TEL:+14255551219"

This command enables PC-to-PC audio communications for the user, but without enabling either remote
call control or Enterprise Voice:
Set-CsUser –Identity "Ken Myer" –EnterpriseVoiceEnabled $False
-RemoteCallControlTelephonyEnabled $False –LineUri "TEL:+14255551219"

• How Can I Configure the Telephony Options for a User? at http://go.microsoft.com/fwlink/?
LinkId=231051

25


Managing On-Premises Meetings
Configuring Conferencing Settings
Modify the Default Conferencing User Experience
 To modify the global conferencing policy
To modify the global policy, use the Set-CsConferencingPolicy cmdlet and set the Identity to global:
Set-CsConferencingPolicy –Identity global
-AllowAnonymousParticipantsInMeetings $False -EnableDialInConferencing $False

Note that you can also modify the global policy by leaving out the Identity parameter altogether:
Set-CsConferencingPolicy -AllowAnonymousParticipantsInMeetings $False
-EnableDialInConferencing $False

Create or Modify Conferencing User Experience for a Site or Group of
Users
 To create a new user or site conferencing policy
To create a per-site conferencing policy, use the site: prefix and the name of the site as the Identity:
New-CsConferencingPolicy –Identity site:Redmond

To create a per-user conferencing policy, simply use a unique name for the policy Identity:
New-CsConferencingPolicy –Identity "RedmondConferencingPolicy"
 To modify an existing user or site policy
Use the Set-CsConferencingPolicy cmdlet to modify a per-user or per-site policy:
-AllowAnonymousParticipantsInMeetings $True -EnableDialInConferencing $True

Be sure to specify a policy Identity. If you leave off the Identity Set-CsConferencingPolicy will modify the
global policy instead.
To make the same modification to all your conferencing policies (including the global policy), use a
command similar to this one:
Get-CsConferencingPolicy | Set-CsConferencingPolicy

This command modifies only your per-user conferencing policies:
Get-CsConferencingPolicy –Filter "tag:*" | Set-CsConferencingPolicy

Delete a Conferencing Policy for a Site or Group of Users
 To delete a user or site conferencing policy
To delete a per-user or per-site policy, using a command similar to this:
Remove-CsConferencingPolicy –Identity site:Redmond

If you try to remove a per-user policy that is currently assigned to one or more users you will be prompted
to first unassign the policy from each user and then delete the policy. (You can remove a policy without
unassigning it, but, from then on, any time you call a user management cmdlet you will receive warnings
about policies that can no longer be found.) To unassign a per-user policy and then remove that policy
use commands similar to these:

26


Get-CsUser -Filter {ConferencingPolicy -eq "RedmondConferencingPolicy"} |
Grant-CsConferencingPolicy -PolicyName $Null

Remove-CsConferencingPolicy –Identity "RedmondConferencingPolicy"


Configuring the Meeting Join Experience
Modify the Default Meeting Join Experience
 To modify the default meeting join settings
To modify the default meeting join settings use the Set-CsMeetingConfiguration cmdlet and set the
Identity to global:
Set-CsMeetingConfiguration -Identity global -DesignateAsPresenter Everyone

Alternatively, you can omit the Identity altogether:
Set-CsMeetingConfiguration -DesignateAsPresenter Everyone

If you leave off the Identity, Set-CsMeetingConfiguration will automatically modify the global settings.

Create or Modify Meeting Join Settings for a Site or Pool
 To create new meeting join settings
To create new meeting configuration settings for a site, use a command similar to this:
New-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter
Everyone

To create new meeting configuration settings for a pool, set the Identity parameter to the service location
for the User Server used in that pool:
New-CsMeetingConfiguration -Identity "service:UserServer:atl-cs-
001.litwareinc.com" -DesignateAsPresenter Everyone
 To modify an existing site or pool meeting join configuration
To modify an existing collection of meeting configuration settings, use the Set-CsMeetingConfiguration
cmdlet:
Set-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter None

When calling Set-CsMeetingConfiguration, be sure to include the Identity for the meeting configuration
settings to be modified. If you do not, Set-CsMeetingConfiguration will automatically modify the global
settings instead.

Delete Meeting Join Settings for a Site or Pool
 To delete meeting join settings for a site or pool
To remove the meeting configuration settings for a site, use a command similar to this:
Remove-CsMeetingConfiguration -Identity site:Redmond

To remove the meeting configuration settings for a pool, use a command similar to this one, which
specifies the identity of the User Server in the pool:
Remove-CsMeetingConfiguration -Identity "service:UserServer:atl-cs-
001.litwareinc.com"

27


• Haiku #84: The CsMeetingConfiguration Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=231052
• The Edit Meeting Configuration Dialog at http://go.microsoft.com/fwlink/?LinkId=231053

Configure Settings for a Dial-in Conferencing Access Number
 To create or modify a dial-in access number
To create a new dial-in conferencing access number, use the New-
CsDialInConferencingAccessNumber cmdlet:
New-CsDialInConferencingAccessNumber -PrimaryUri
"sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri
"tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US"
-Regions "Redmond"

Use the Set-CsDialInConferencingAccessNumber cmdlet to modify an existing access number:
Set-CsDialInConferencingAccessNumber -Identity
"sip:RedmondDialIn@litwareinc.com" -Regions "Redmond", "Seattle"

Delete a Dial-in Conferencing Access Number
 To delete a dial-in conferencing access number
To delete a dial-in access number, use the Remove-CsDialInConferencingAccessNumber cmdlet and
specify the number's SIP address as the Identity:
Remove-CsDialInConferencingAccessNumber -Identity
"sip:RedmondDialIn@litwareinc.com"

You can also use a command like this one to delete all your dial-in access numbers:
Get-CsDialInConferencingAccessNumber | Remove-CsDialInConferencingAccessNumber

• Haiku #126: The CsDialInConferencingAccessNumber Cmdlets at http://go.microsoft.com/fwlink/?
LinkId=231054
• The New Dial-in Access Number Dialog at http://go.microsoft.com/fwlink/?LinkId=231055

Configure Dial-in Conferencing Personal Identification Number (PIN)
Rules
Modify the Default Dial-in Conferencing PIN Settings
 To modify the global PIN policy
To modify the global PIN policy, use the Set-CsPinPolicy cmdlet and set the Identity to global:
Set-CsPinPolicy -Identity global -MinPasswordLength 10

Alternatively, you can leave out the Identity parameter altogether:
Set-CsPinPolicy -MinPasswordLength 10

If you do not specify an Identity, Set-CsPinPolicy will modify the global policy.

28

Lync Powershell - Ls admin windows_power_shell_supplement

Lync Powershell - Ls admin windows_power_shell_supplement

Recommended

Recommended

More Related Content

What's hot

What's hot (17)

Similar to Lync Powershell - Ls admin windows_power_shell_supplement

Similar to Lync Powershell - Ls admin windows_power_shell_supplement (20)

More from Peter Diaz

More from Peter Diaz (20)

Recently uploaded

Recently uploaded (20)

Lync Powershell - Ls admin windows_power_shell_supplement