Topic Last Modified: 2010-10-01
Get-CsMeetingConfiguration enables you to return information about the meeting configuration settings currently in use in your organization. Meeting configuration settings help dictate the type of meetings (also called “conferences”) that users can create, and control how (or even if) anonymous users and dial-in conferencing users can join these meetings.
Syntax
Get-CsMeetingConfiguration [-Identity
<XdsIdentity>] [-LocalStore <SwitchParameter>] [-Tenant
<Nullable>]
|
Get-CsMeetingConfiguration [-Filter <String>]
[-LocalStore <SwitchParameter>] [-Tenant
<Nullable>]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Optional |
Xds identity |
Indicates the unique identifier for the collection of meeting configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. Settings configured at the service scope can be retrieved using syntax like this: -Identity service:UserServer:atl-cs-001.litwareinc.com. If this parameter is not specified, then Get-CsMeetingConfiguration will return a collection of all the meeting settings in use in the organization. Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards, then include the Filter parameter instead. |
Filter |
Optional |
String |
Enables you to use wildcard characters in order to return a collection (or collections) of meeting configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter *EMEA*. |
Tenant |
Optional |
Guid |
This parameter is not applicable to the on-premises version of Lync Server 2010. |
LocalStore |
Optional |
Switch Parameter |
Retrieves the meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. |
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 determine how meetings handle 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.
Get-CsMeetingConfiguration enables you to return information about the meeting configuration setting collections currently in use in your organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsMeetingConfiguration cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsMeetingConfiguration"}
Input Types
None. Get-CsMeetingConfiguration does not accept pipelined data.
Return Types
Get-CsMeetingConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object.
Example
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Get-CsMeetingConfiguration |
The command shown in Example 1 returns a collection of all the meeting configuration settings currently in use in the organization.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Get-CsMeetingConfiguration -Identity site:Redmond |
In Example 2, only one collection of meeting configuration settings is returned: the settings that have the Identity site:Redmond.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Get-CsMeetingConfiguration -Filter "service:*" |
The preceding command returns all the meeting configuration settings that have been configured at the service scope. This is done by including the Filter parameter and the filter value "service:*", which limits returned data to settings where the Identity property begins with the characters "service:".
-------------------------- Example 4 ------------------------
Copy Code | |
---|---|
Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $True} |
In Example 4, information is returned for all the meeting configuration settings where anonymous users are admitted by default. To accomplish this task, the command first uses Get-CsMeetingConfiguration without any parameters to return a collection of all the meeting configuration settings currently in use. That collection is then piped to the Where-Object cmdlet, which selects only those settings where the AdmitAnonymousByDefault property is equal to True.