Modifies the properties of one or more Directors. Directors can be used to authenticate user requests, but do not host user accounts.
Syntax
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>]] |
Parameters
| 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". |
|
MonitoringServer |
Optional |
String |
Service location of the Monitoring Server to be associated with the Director. For example: -MonitoringServer "MonitoringServer: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". |
|
WebServer |
Optional |
String |
Service location of the Web Server to be associated with the Director. For example: -WebServer "WebServer:atl-cs-001.litwareinc.com" |
|
SipPort |
Optional |
Integer |
Port used for SIP (Session Initiation Protocol) traffic. |
|
WebPort |
Optional |
Integer |
Port used for communicating with Web servers. |
|
EdgeServer |
Optional |
String |
Service location of the Edge Server to be associated with the Director. For example: -EdgeServer "EdgeServer:atl-edge-001.litwareinc.com" |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise 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. |
Detailed Description
The Director is a Microsoft Communications Server role that can authenticate users and respond 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 severs are deployed in a central site. In that case, Directors will 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.
Return Types
Set-CsDirector does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayDirector object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
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 ------------------------
| Copy Code |
|
|---|---|
Get-CsService -Director | Set-CsDirector -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 Set-CsDirector, which takes each Director in the collection and changes the value of the SipPort property to 5072.