Export (0) Print
Expand All
Expand Minimize

Set-CsDirector

 

Topic Last Modified: 2012-03-27

Modifies the properties of one or more Directors. Directors can be used to authenticate user requests, but do not host user accounts.

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

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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsDirector cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsDirector"}

 

Parameter Required Type Description

Identity

Optional

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

ArchivingServer

Optional

String

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

EdgeServer

Optional

String

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

MonitoringServer

Optional

String

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

SipPort

Optional

Integer

Port used for Session Initiation Protocol (SIP) traffic.

SipHealthPort

Optional

Integer

Port used for monitoring server health.

SipServerTcpPort

Optional

Integer

SIP listening port. The default value is 5060.

WebPort

Optional

Integer

Port used for communicating with Web Services.

WebServer

Optional

String

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

Force

Optional

Switch Parameter

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

WhatIf

Optional

Switch Parameter

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

Confirm

Optional

Switch Parameter

Prompts you for confirmation before executing the command.

None. Set-CsDirector does not accept pipelined input.

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

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

The preceding command changes the SIP port for all the Directors currently in use in the organization. To do this, the command first uses Get-CsService 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, ForEach-Object runs Set-CsDirector against each site in the collection, changing the value of the SipPort property to 5072.

Other Resources

Get-CsService

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft