Edit

Share via

Set-CsDirector

Module:
Skype for Business Server PowerShell

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

Default (Default) 

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.

Parameters

-ArchivingServer

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EdgeServer

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:XdsGlobalRelativeIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MirrorMonitoringDatabase

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MonitoringDatabase

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MonitoringServer

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SipHealthPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Port used for monitoring server health.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SipPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Port used for Session Initiation Protocol (SIP) traffic.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SipServerTcpPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

SIP listening port. The default value is 5060.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WebPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Port used for communicating with Web Services.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WebServer

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

The Set-CsDirector cmdlet does not accept pipelined input.

Outputs

None

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.