Topic Last Modified: 2014-02-19
Set-CsMeetingConfiguration enables you to modify 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 also control how (or even if) anonymous users and dial-in conferencing users can join these meetings. Note that these settings only affect scheduled meetings; they do not affect ad-hoc meetings created by clicking the Meet Now option in Lync. This cmdlet was introduced in Lync Server 2010.
Syntax
Set-CsMeetingConfiguration [-Identity
<XdsIdentity>] <COMMON PARAMETERS>
|
Set-CsMeetingConfiguration [-Instance <PSObject>]
<COMMON PARAMETERS>
|
COMMON PARAMETERS: [-AdmitAnonymousUsersByDefault
<$true | $false>] [-AssignedConferenceTypeByDefault <$true
| $false>] [-Confirm [<SwitchParameter>]]
[-CustomFooterText <String>] [-DesignateAsPresenter <None
| Company | Everyone>] [-EnableAssignedConferenceType <$true
| $false>] [-EnableMeetingReport <$true | $false>] [-Force
<SwitchParameter>] [-HelpURL <String>] [-LegalURL
<String>] [-LogoURL <String>] [-PstnCallersBypassLobby
<$true | $false>] [-RequireRoomSystemsAuthorization <$true
| $false>] [-Tenant <Guid>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
The command shown in Example 1 modifies the meeting configuration settings assigned to the Redmond site (-Identity site:Redmond). In this case, the value of the DesignateAsPresenter property is set to Everyone.
Copy Code | |
---|---|
Set-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter Everyone |
EXAMPLE 2
The command shown in Example 2 is a variation of the command shown in Example 1. In this case, however, the value of the DesignateAsPresenter property is modified for all the meeting configuration settings in use in the organization. To do this, the Get-CsMeetingConfiguration cmdlet is called without any parameters in order to return a collection of all the meeting configuration settings currently in use. This collection is then piped to the Set-CsMeetingConfiguration cmdlet, which modifies the DesignateAsPresenter property for each item in the collection.
Copy Code | |
---|---|
Get-CsMeetingConfiguration | Set-CsMeetingConfiguration -DesignateAsPresenter Everyone |
EXAMPLE 3
In Example 3, all the meeting configuration settings that do not allow the default admission of anonymous users are modified. To perform this task, the command first calls the Get-CsMeetingConfiguration cmdlet to return a collection of all the meeting configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the AdmitAnonymousUsersByDefault property is equal to False. In turn, this filtered collection is piped to the Set-CsMeetingConfiguration cmdlet, which takes each item in the collection and sets the PstnCallersBypassLobby property to True.
Copy Code | |
---|---|
Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $False} | Set-CsMeetingConfiguration -PstnCallersBypassLobby $True |
Detailed Description
Meetings (also called conferences) are an integral part of Lync Server. 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.
As noted previously, these settings only affect scheduled meetings; they do not affect ad-hoc meetings created by clicking Meet Now in Microsoft Lync. When you create a meeting by clicking Meet Now, participant access is automatically open to all everyone, and anonymous users can join the meeting without having to wait in the lobby. This will occur regardless of how you have configured your meeting settings using the CsMeetingConfiguration cmdlets.
The Set-CsMeetingConfiguration cmdlet enables you to modify any of the meeting configuration settings currently in use in your organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-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 "Set-CsMeetingConfiguration"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
AdmitAnonymousUsersByDefault |
Optional |
System.Boolean |
Determines whether meetings will, by default, allow attendance by anonymous users (that is, by 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 |
System.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. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
CustomFooterText |
Optional |
System.String |
Text to be used on custom meeting invitations. |
DesignateAsPresenter |
Optional |
Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.DesignateAsPresenter |
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 will have presenter rights the moment they join a meeting. |
EnableAssignedConferenceType |
Optional |
System.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. The default value is True. |
EnableMeetingReport |
Optional |
System.Boolean |
PARAMVALUE: $true | $false |
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
HelpURL |
Optional |
System.String |
URL to a website where users can obtain assistance on joining the meeting. |
Identity |
Optional |
Microsoft.Rtc.Management.Xds.XdsIdentity |
Indicates the unique identifier for the collection of meeting configuration settings you want to modify. 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 referenced using syntax like this: -Identity "service:UserServer:atl-cs-001.litwareinc.com". If this parameter is not specified, then the Set-CsMeetingConfiguration cmdlet will modify the global settings. |
Instance |
Optional |
MeetingConfiguration object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
LegalURL |
Optional |
System.String |
URL to a website containing legal information and meeting disclaimers. |
LogoURL |
Optional |
System.String |
URL for the image to be used on custom meeting invitations. |
PstnCallersBypassLobby |
Optional |
System.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 ($True), PSTN callers will automatically be admitted to the meeting. If set to False ($False), then PSTN callers will initially be routed to the conference lobby. At that point, they will have to wait, on hold, until a conference presenter grants them access to the meeting. The default value is True. |
RequireRoomSystemsAuthorization |
Optional |
System.Boolean |
When set to True ($True) all users must be authenticated before they can join a meeting using the Lync Room System. The default value is False ($False). |
Tenant |
Optional |
System.Guid |
Globally unique identifier (GUID) of the Lync Online tenant account for which the meeting configuration settings are being modified. For example: –Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" You can return the tenant ID for each of your tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID If you are using a remote session of Windows PowerShell and are connected only to Lync Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. The Set-CsMeetingConfiguration cmdlet accepts pipelined instances of the meeting configuration object.
Return Types
The Set-CsMeetingConfiguration cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object.