Modifies the properties of a Conference Server. The Conference Server provides audio and video capabilities to your online conferences.
Syntax
Set-CsConferenceServer [-Identity <XdsGlobalRelativeIdentity>] [-AppSharingPortCount <UInt16>] [-AppSharingPortStart <UInt16>] [-AppSharingSipPort <UInt16>] [-AudioPortCount <UInt16>] [-AudioPortStart <UInt16>] [-AudioVideoSipPort <UInt16>] [-Confirm [<SwitchParameter>]] [-DataPsomPort <UInt16>] [-EdgeServer <String>] [-Force <SwitchParameter>] [-ImSipPort <UInt16>] [-MeetingPsomPort <UInt16>] [-PhoneSipPort <UInt16>] [-VideoPortCount <UInt16>] [-VideoPortStart <UInt16>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Service location of the Conference Server to be modified. For example: -Identity "ConferenceServer:atl-cs-001.litwareinc.com". |
|
EdgeServer |
Optional |
String |
Service location of the Edge Server to be associated with the Conference Server. For example: -EdgeServer "EdgeServer:atl-edge-001.litwareinc.com". |
|
ImSipPort |
Optional |
Integer |
Port used for instant messaging traffic. |
|
DataPsomPort |
Optional |
Integer |
Port used by the PSOM (Persistent Shared Object Model) protocol. |
|
AudioVideoSipPort |
Optional |
Integer |
Port used for audio and video traffic. |
|
PhoneSipPort |
Optional |
Integer |
Port used for telephony traffic. |
|
AppSharingSipPort |
Optional |
Integer |
Port used for application sharing. |
|
AudioPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving audio traffic. For example –AudioPortStart 60000. |
|
AudioPortCount |
Optional |
Integer |
Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100 then ports 600000 through 60099 will be used for audio traffic. |
|
AppSharingPortStart |
Optional |
Integer |
First port in the range of ports allocated for application sharing. For example –AppSharingPortStart 60000. |
|
AppSharingPortCount |
Optional |
Integer |
Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 600000 through 60099 will be used for application sharing. |
|
VideoPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving video traffic. For example –VideoPortStart 60000. |
|
VideoPortCount |
Optional |
Integer |
Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100 then ports 600000 through 60099 will be used for video traffic. |
|
MeetingPsomPort |
Optional |
Integer |
Port used for the Persistent Shared Object Model protocol, a Microsoft protocol used for online conferences. |
|
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
Conference Servers (also known as A/V Conferencing Servers) are used to provide audio and video capabilities to online conferences and meetings. In turn, the Set-CsConferenceServer cmdlet can be used to modify the properties of these servers. In particular, you can specify which ports are used for such things as audio traffic, video traffic, and application sharing. You can also use Set-CsConferenceServer to associate a given server with a particular Edge Server or Archiving Server.
Return Types
Set-CsConferenceServer does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayConferenceServer object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Set-CsConferenceServer -Identity "ConferenceServer:atl-cs-001.litwareinc.com" -ImSipPort 5075 |
|
The command shown in Example 1 modifies the instant messaging SIP port for the conference server ConferenceServer:atl-cs-001.litwareinc.com. In this example, the port is changed to 5075.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsService -ConferenceServer | Set-CsConferenceServer -ImSipPort 5075 |
|
Example 2 is a variation of the command shown in Example 1; in this case, however, the instant messaging SIP port is changed for all the conference servers in the organization. To do this, the command first uses Get-CsService and the –ConferenceServer parameter to return a collection of all the conference servers currently in use. That collection is then piped to Set-CsConferenceServer, which takes each server in the collection and sets the ImSipPort property to 5075.