Set-CsConferenceServer
Topic Last Modified: 2012-03-26
Modifies the properties of an A/V Conferencing Server (also known as a Conference Server). The Conference Server provides audio and video (A/V) capabilities to your 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>]]
Detailed Description
Conference Servers (also known as A/V Conferencing Servers) are used to provide audio and video capabilities to conferences. 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 Edge Server or Archiving Server.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsConferenceServer 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-CsConferenceServer"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Xds Identity |
Service location of the Conference Server to be modified. For example: -Identity "ConferencingServer:atl-cs-001.litwareinc.com". Note that you can leave off the prefix "ConferencingServer:" when specifying a Conference Server. For example: -Identity "atl-cs-001.litwareinc.com". |
AppSharingSipPort |
Optional |
Integer |
SIP port used to listen for requests for application sharing. The ports actually used for application sharing are configured using AppSharingPortStart and AppSharingPortCount. |
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 60000 through 60099 will be used for application sharing. |
AppSharingPortStart |
Optional |
Integer |
First port in the range of media ports allocated for application sharing. For example: –AppSharingPortStart 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 60000 through 60099 will be used for audio traffic. |
AudioPortStart |
Optional |
Integer |
First port in the range of media ports allocated for sending and receiving audio traffic. For example: –AudioPortStart 60000. |
AudioVideoSipPort |
Optional |
Integer |
SIP port used to listen for incoming requests for audio and video service. The ports actually used for audio and video traffic are configured using AudioPortCount, AudioPortStart, VideoPortCount, and VideoPortStart. |
DataPsomPort |
Optional |
Integer |
Data port used by the Persistent Shared Object Model (PSOM) protocol. |
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. |
MeetingPsomPort |
Optional |
Integer |
Port used for the Persistent Shared Object Model (PSOM) protocol, a Microsoft protocol used for conferences. |
PhoneSipPort |
Optional |
Integer |
Port used for telephony traffic. |
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 60000 through 60099 will be used for video traffic. |
VideoPortStart |
Optional |
Integer |
First port in the range of ports allocated for sending and receiving video traffic. For example: –VideoPortStart 60000. |
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. |
Input Types
None. Set-CsConferenceServer does not accept pipelined input.
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.
Example
-------------------------- Example 1 ------------------------
Set-CsConferenceServer -Identity "ConferencingServer:atl-cs-001.litwareinc.com" -ImSipPort 5075
The command shown in Example 1 modifies the instant messaging SIP port for the Conference Server ConferencingServer:atl-cs-001.litwareinc.com. In this example, the port is changed to 5075.
-------------------------- Example 2 ------------------------
Get-CsService -ConferencingServer | ForEach-Object {Set-CsConferenceServer -Identity $_.Identity -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 ConferencingServer parameter to return a collection of all the Conferencing Servers currently in use. That collection is then piped to the ForEach-Object cmdlet, which runs the Set-CsConferenceServer against each server in the collection, setting the ImSipPort to 5075.