Creates a new collection of Web Conference settings. Web conference settings determine such things as the maximum-allowed size for meeting content and handouts; the content grace period (that is, the amount of time content will be stored before being deleted); and the URLs for the internal and external downloads of the meeting client.
Syntax
New-CsConferencingConfiguration -Identity <XdsIdentity> [-ClientAppSharingPort <UInt16>] [-ClientAppSharingPortRange <UInt32>] [-ClientAudioPort <UInt16>] [-ClientAudioPortRange <UInt32>] [-ClientFileTransferPort <UInt16>] [-ClientFileTransferPortRange <UInt32>] [-ClientMediaPort <UInt16>] [-ClientMediaPortRange <UInt32>] [-ClientMediaPortRangeEnabled <$true | $false>] [-ClientSipDynamicPort <UInt16>] [-ClientSipDynamicPortRange <UInt32>] [-ClientVideoPort <UInt16>] [-ClientVideoPortRange <UInt32>] [-Confirm [<SwitchParameter>]] [-ConsoleDownloadExternalUrl <String>] [-ConsoleDownloadInternalUrl <String>] [-ContentGracePeriod <TimeSpan>] [-Force <SwitchParameter>] [-HelpdeskExternalUrl <String>] [-HelpdeskInternalUrl <String>] [-InMemory <SwitchParameter>] [-MaxBandwidthPerAppSharingServiceMb <UInt64>] [-MaxContentStorageMb <UInt16>] [-Organization <String>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier for the collection of conferencing configuration settings to be modified. To refer to a collection configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To refer to a collection at the service scope, use syntax like the following: -Identity "service:ConferenceServer:atl-cs-001.litwareinc.com". Note the Conference Server service is the only service that can host these configuration settings. |
|
ClientMediaPort |
Optional |
Integer |
Represents the starting port number used for client media. The ClientMediaPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. |
|
ClientMediaPortRange |
Optional |
Integer |
Indicates the total number of ports available for client media. (The default value is 40.) To determine the actual ports used for client media, use this value and the ClientMediaPort value. For example, if ClientMediaPort is set to 5350 and ClientMediaPortRange is set to 3, then the following 3 ports are available for client media: 5350; 5351; 5352. |
|
ClientMediaPortRangeEnabled |
Optional |
Boolean |
When set to True, clients will use the specified port range for media traffic. When set to False (the default value) any available port (from port 1024 through port 65535) will be used to accommodate media traffic. |
|
ClientSipDynamicPort |
Optional |
Integer |
Represents the starting port number used for SIP traffic. The ClientSipDynamicPort must be a value port number between 1024 and 65535, inclusive. The default value is 7100. |
|
ClientSipDynamicPortRange |
Optional |
Integer |
Indicates the total number of ports available for SIP traffic. (The default value is 3.) To determine the actual ports used for SIP traffic, use this value and the ClientSipDynamicPort value. For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRange is set to 3, then the following 3 ports are available for client media: 7100; 7101; 7102. |
|
ConsoleDownloadExternalUrl |
Optional |
String |
URL where external users can download a supported conferencing client. |
|
ContentGracePeriod |
Optional |
TimeSpan |
Indicates how long meeting content will remain on the server following the end of the meeting. The ContentGracePeriod must be specified using the format Days.Hours:Minutes:Seconds. For example, to set the content grace period to 30 days use this syntax: -ContentGracePeriod 30.00:00:00. The content grace period can be set to any value between 0and 180 days. The default value is 15 days (15.00:00:00). |
|
ConsoleDownloadInternalUrl |
Optional |
String |
URL where internal users can download a supported conferencing client. |
|
HelpdeskExternalUrl |
Optional |
String |
URL where external users who click Help during a conference will be directed. |
|
HelpdeskInternalUrl |
Optional |
String |
URL where internal users who click Help during a conference will be directed. |
|
MaxContentStorageMb |
Optional |
Integer |
Maximum amount of file space (in megabytes) allowed for the storage of meeting content. MaxContentStorageMb can be set to nay integer value between 50 and 1024 (1 gigabyte), inclusive. The default value is 100. |
|
MaxBandwidthPerAppSharingServiceMb |
Optional |
Integer |
Indicates the maximum amount of bandwidth (in megabytes) set aside for the application sharing service. MaxBandwidthPerAppSharingServiceMbcan be set to any integer value between 50 and 100000, inclusive. The default value is 375 megabytes. |
|
ClientAudioPort |
Optional |
Integer |
Represents the starting port number used for client audio. The ClientAudioPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. |
|
ClientAudioPortRange |
Optional |
Integer |
Indicates the total number of ports available for client audio. (The default value is 40.) To determine the actual ports used for client audio, use this value and the ClientAudioPort value. For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set to 3, then the following 3 ports are available for client audio: 5350; 5351; 5352. |
|
ClientVideoPort |
Optional |
Integer |
Represents the starting port number used for client video. The ClientVideoPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. |
|
ClientVideoPortRange |
Optional |
Integer |
Indicates the total number of ports available for client video. (The default value is 40.) To determine the actual ports used for client video, use this value and the ClientVideoPort value. For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set to 3, then the following 3 ports are available for client video: 5350; 5351; 5352. |
|
ClientAppSharingPort |
Optional |
Integer |
Represents the starting port number used for application sharing. The ClientAppSharingPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. |
|
ClientAppSharingPortRange |
Optional |
Integer |
Indicates the total number of ports available for application sharing. (The default value is 40.) To determine the actual ports used for application sharing, use this value and the ClientAppSharingPort value. For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRange is set to 3, then the following 3 ports are available for application sharing: 5350; 5351; 5352. |
|
ClientFileTransferPort |
Optional |
Integer |
Represents the starting port number used for file transfers. The ClientFileTransferPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. |
|
ClientFileTransferPortRange |
Optional |
Integer |
Indicates the total number of ports available for file transfers. (The default value is 40.) To determine the actual ports used for file transfers, use this value and the ClientFileTransferPort value. For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPortRange is set to 3, then the following 3 ports are available for file transfers: 5350; 5351; 5352. |
|
Organization |
Optional |
String |
Name of the organization hosting the conference. |
|
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
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
When it comes to Web conferences management and administration is split between two sets of cmdlets. If you want to dictate the things that users can and cannot do (for example, can users invite anonymous participants to join a conference; are users allowed to offer application sharing and/or file transfers within a conference; etc.) then you need to use the CsConferencingPolicy cmdlets. But that’s only one piece of the puzzle. The other piece: the need to manage Web conferencing servers and server settings. For example, administrators need to be able to do such things as specify the maximum amount of content storage allotted to a single meeting and to specify the grace period before that meeting content is automatically deleted. They also need to be able to specify the ports used for activities such as application sharing and file transfer.
The CsConferencingConfiguration cmdlets represent the missing piece to the Web conferencing management puzzle. These cmdlets enable you to manage the actual severs themselves. The CsConferencingConfiguration cmdlets (which can be applied to the global, the site, and the service scopes) aren’t used to specify whether or not a user can share applications during a conference; if application sharing is allowed, however, these cmdlets let you indicate which ports should be used for that activity. Likewise, the cmdlets also let you specify such thing as storage limits and expiration periods, as well as pointers to internal and external URLs where users can obtain conferencing help and resources.
When you install Microsoft Communications Server the system provides you with a single collection of conferencing configuration settings (the global collection). If you need to create custom settings for a site or service, you can do so using the New-CsConferencingConfiguration cmdlet. Note that new settings can be applied only at the site or service scope; you cannot create a new global collection of conferencing configuration settings. In addition, no site or service can host more than one collection of settings. If you try to create new settings for the Redmond site and the Redmond site already hosts a collection of conferencing configuration settings then your command will fail.
Return Types
New-CsConferencingConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
New-CsConferencingConfiguration -Identity site:Redmond -Organization Litwareinc |
|
The preceding command creates a new collection of conferencing configuration settings for the Redmond site (site:Redmond). In this example, one additional parameter is included - -Organization - which is used to set the value of the Organization property to Litwareinc. Note that this command will fail if the Redmond site already has a collection of conferencing configuration settings. That’s because you can have only one such collection per site.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
$x = New-CsConferencingConfiguration -Identity site:Redmond -InMemory $x.Organization = "Litwareinc" Set-CsConferencingConfiguration -Instance $x |
|
In Example 2, a new collection of conferencing configuration settings is initially created in memory only; these virtual settings are only later applied to the Redmond site. To do this, the first command in the example uses the New-CsConferencingConfiguration cmdlet to create a new, in-memory collection of settings stored in the variable $x; the -InMemory parameter specifies that the collection should be created in memory rather than immediately applied to the Redmond site. After the collection has been created, the second command sets the value of the Organization property to Litwareinc. Finally, the third command uses Set-CsConferencingConfiguration to actually apply the new settings to the Redmond site. (Note that this command will fail if conferencing configuration settings have already been applied to site:Redmond.) If you do not call Set-CsConferencingConfiguration the new settings will never take effect. Instead, they will disappear as soon as you terminate your Windows PowerShell session or delete the variable $x.