Topic Last Modified: 2010-10-27
Creates a new collection of meeting configuration settings at the site or service scope. Meeting configuration settings help dictate the type of meetings (also called “conferences”) that users can create, in addition to controlling how (or even if) anonymous users and dial-in conferencing users can join these meetings.
Syntax
New-CsMeetingConfiguration -Identity <XdsIdentity>
[-AdmitAnonymousUsersByDefault <$true | $false>]
[-AssignedConferenceTypeByDefault <$true | $false>] [-Confirm
[<SwitchParameter>]] [-DesignateAsPresenter <None |
Company | Everyone>] [-EnableAssignedConferenceType <$true |
$false>] [-Force <SwitchParameter>] [-InMemory
<SwitchParameter>] [-PstnCallersBypassLobby <$true |
$false>] [-Tenant <Nullable>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Xds Identity |
Unique identifier for the new collection of meeting configuration settings. Meeting configuration settings can only be created at the site or service scope. To create new settings at the site scope, use syntax similar to this: -Identity "site:Redmond". To create new settings at the service scope, use syntax like this: -Identity "service:UserServer:atl-cs-001.litwareinc.com". Note that the call to New-CsMeetingConfiguration will fail if the specified site or service already has a collection of meeting configuration settings. |
AdmitAnonymousUsersByDefault |
Optional |
Boolean |
Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. The default value is True. |
AssignedConferenceTypeByDefault |
Optional |
Boolean |
Determines whether new meetings will be configured, by default, as public meetings. Set this value to True to use public meetings by default; set this value to False to use private meetings by default. The default value is True. |
DesignateAsPresenter |
Optional |
PS List Modifier |
Indicates which users (besides the meeting organizer) are automatically designated as presenters when they join a meeting. Valid choices are: None; Company; and Everyone. By default, DesignateAsPresenter is set to Company, meaning everyone in your organization has presenter rights the moment they join a meeting. |
EnableAssignedConferenceType |
Optional |
Boolean |
Indicates whether users are allowed to schedule public meetings. With a public meeting, the conference ID and the meeting link remain consistent each time the meeting is held. With a private meeting, the conference ID and meeting link change from meeting to meeting. |
PstnCallersBypassLobby |
Optional |
Boolean |
Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. If set to True PSTN callers will automatically be admitted to the meeting. If set to False PSTN callers will initially be routed to the conference lobby. At that point, they will be put on hold until a conference presenter grants them access to the meeting. The default value is True. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
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. |
Tenant |
Optional |
Guid |
This parameter is not used with the on-premises version of Lync Server 2010. |
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
Meetings (also called “conferences”) are an integral part of Microsoft Lync Server 2010. The CsMeetingConfiguration cmdlets enable administrators to control the type of meetings that users can create and to determine how meetings deal with anonymous users and dial-in conferencing users. For example, you can configure meetings so that anyone dialing in over the public switched telephone network (PSTN) is automatically admitted to the meeting. Alternatively, you can configure meetings so that dial-in users are not automatically admitted the meeting, but are instead routed to the meeting lobby. These dial-in users remain on hold in the lobby until a presenter admits them to the meeting.
The New-CsMeetingConfiguration cmdlet enables you to create new meeting configuration collections at either the site or the service scope (albeit only for the User Services). Meeting settings cannot be created at the global scope because there is already a global collection of meeting settings.
Note that each site or service can only have, at most, one collection of meeting configuration settings. If you try to create new settings for the Redmond site, and the Redmond site already has a collection of meeting configuration settings, then your command will fail.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsMeetingConfiguration 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 "New-CsMeetingConfiguration"}
Input Types
None. New-CsMeetingConfiguration does not accept pipelined data.
Return Types
New-CsMeetingConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object.
Example
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
New-CsMeetingConfiguration -Identity site:Redmond -EnableAssignedConferenceType $False -AssignedConferenceTypeByDefault $False -AdmitAnonymousUsersByDefault $False |
The preceding command creates a new collection of meeting configuration settings for the Redmond site (-Identity site:Redmond). In addition to specifying the Identity, three optional parameters are included in this command: EnableAssignedConferenceType, AssignedConferenceTypeByDefault, and AdmitAnonymousUsersByDefault. In all three cases, these parameters are set to False. That means that public meeting types will be disabled; the default meeting type will not be set to public meeting; and anonymous users will not be admitted to meetings by default.
Note that this command will fail if a collection of meeting configuration settings with the Identity site:Redmond already exists. That’s because only one collection of meeting configuration settings can be applied to a given site.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
$x = New-CsMeetingConfiguration -Identity site:Redmond -InMemory $x.EnableAssignedConferenceType = $False $x.AssignedConferenceTypeByDefault = $False $x.AdmitAnonymousUsersByDefault = $False Set-CsMeetingConfiguration -Instance $x |
Example 2 shows an alternate way to create a new collection of meeting configuration settings for the Redmond site; in this case, the settings are initially created in memory only, and are only later applied to the site. To do this, the first command in the example uses New-CsMeetingConfiguration to create new meeting settings for the Redmond site. The InMemory parameter is added to the end of the command to ensure that these new settings are created in memory only, and are not immediately applied to the Redmond site. (Because these settings exist only in memory, they must be stored in a variable. In this example, they are stored in a variable named $x.)
After these virtual meeting settings have been created, commands 2, 3, and 4 are used to modify properties of those settings (EnableAssignedConferenceType, AssignedConferenceTypeByDefault, and AdmitAnonymousUsersByDefault). In the final command, Set-CsMeetingConfiguration and the Instance parameter are used to actually apply the virtual settings to the Redmond site. Note that this final step is crucial: if you do not call Set-CsMeetingConfiguration, the new meeting configuration settings will never be applied to the Redmond site. Instead, your virtual settings will disappear as soon as you end your Windows PowerShell session or delete the variable $x.