Set-CsDirector

Modifies the properties of one or more Directors. Directors can be used to authenticate user requests, but do not host user accounts. This cmdlet was introduced in Lync Server 2010.

Syntax

Set-CsDirector
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-ArchivingServer <String>]
   [-EdgeServer <String>]
   [-MonitoringServer <String>]
   [-SipPort <UInt16>]
   [-WebPort <UInt16>]
   [-WebServer <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [-SipHealthPort <UInt16>]
   [-SipServerTcpPort <UInt16>]
   [-MirrorMonitoringDatabase <String>]
   [-MonitoringDatabase <String>]
   [<CommonParameters>]

Description

The Director authenticates users and responds to user requests without actually hosting user accounts. Directors are typically used for organizations that allow external access to the network through Edge Servers. In that scenario, Directors not only help alleviate the strain on Front End Servers (by handling authentication requests), but also help shield the internal network from denial-of-service attacks and other malicious traffic. Directors are also useful any time multiple Front End Servers are deployed in a central site. In that case, Directors receive all user requests and then channel those requests to the appropriate server pool. This, again, helps to ease the burden placed on the Front End Servers.

The Set-CsDirector cmdlet enables you to modify the property values for any of the Directors currently in use in your organization. This includes changing such things as the Archiving Server or Edge Server associated with the Director, or changing the port used for sending and receiving SIP traffic.

Examples

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

Set-CsDirector -Identity "Director:atl-cs-001.litwareinc.com" -ArchivingServer "ArchivingServer:dublin-cs-001.litwareinc.com"

The command shown in Example 1 changes the Archiving Server associated with the Director Director:atl-cs-001.litwareinc.com. In this example, the Archiving Server is switched to ArchivingServer:dublin-cs-001.litwareinc.com.

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

Get-CsService -Director | ForEach-Object {Set-CsDirector -Identity $_.Identity -SipPort 5072}

Example 2 changes the SIP port for all the Directors currently in use in the organization. To do this, the command first uses the Get-CsService cmdlet and the Director parameter to return a collection of all the Directors in the organization. That collection is then piped to the ForEach-Object. In turn, the ForEach-Object cmdlet runs the Set-CsDirector cmdlet against each site in the collection, changing the value of the SipPort property to 5072.

Optional Parameters

-ArchivingServer

Service location of the Archiving Server to be associated with the Director. For example: -ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com".

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-EdgeServer

Service location of the Edge Server to be associated with the Director. For example: -EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Identity

Service location of the Director to be modified. For example: -Identity "Director:atl-cs-001.litwareinc.com".

Note that you can leave off the prefix "Director:" when specifying a Director. For example: -Identity "atl-cs-001.litwareinc.com".

Type:XdsGlobalRelativeIdentity
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-MirrorMonitoringDatabase

Service location of the mirror monitoring database to be associated with the Director.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MonitoringDatabase

Service location of the monitoring database to be associated with the Director.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-MonitoringServer

Service location of the Monitoring Server to be associated with the Director. For example: -MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com".

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-SipHealthPort

Port used for monitoring server health.

Type:UInt16
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-SipPort

Port used for Session Initiation Protocol (SIP) traffic.

Type:UInt16
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-SipServerTcpPort

SIP listening port. The default value is 5060.

Type:UInt16
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-WebPort

Port used for communicating with Web Services.

Type:UInt16
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-WebServer

Web Services location of the server to be associated with the Director. For example: -WebServer "WebServer:atl-cs-001.litwareinc.com"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015

Inputs

None. The Set-CsDirector cmdlet does not accept pipelined input.

Outputs

The Set-CsDirector cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayDirector object.