Set-CsDialInConferencingDtmfConfiguration
Topic Last Modified: 2012-03-27
Modifies the dual-tone multifrequency (DTMF) signaling settings used for dial-in conferencing. DTMF enables users who dial in to a conference to control conference settings (such as muting and unmuting themselves or locking and unlocking the conference) by using the keypad on their telephone.
Syntax
Set-CsDialInConferencingDtmfConfiguration [-Identity <XdsIdentity>] [-AdmitAll <String>] [-AudienceMuteCommand <String>] [-CommandCharacter <String>] [-Confirm [<SwitchParameter>]] [-EnableDisableAnnouncementsCommand <String>] [-Force <SwitchParameter>] [-HelpCommand <String>] [-LockUnlockConferenceCommand <String>] [-MuteUnmuteCommand <String>] [-PrivateRollCallCommand <String>] [-WhatIf [<SwitchParameter>]]
Set-CsDialInConferencingDtmfConfiguration [-AdmitAll <String>] [-AudienceMuteCommand <String>] [-CommandCharacter <String>] [-Confirm [<SwitchParameter>]] [-EnableDisableAnnouncementsCommand <String>] [-Force <SwitchParameter>] [-HelpCommand <String>] [-Instance <PSObject>] [-LockUnlockConferenceCommand <String>] [-MuteUnmuteCommand <String>] [-PrivateRollCallCommand <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Microsoft Lync Server 2010 enables users to join conferences by dialing in over the telephone. Dial-in users are not able to view video or exchange instant messages with other conference attendees, but they are able to fully participate in the audio portion of the meeting.
In addition to being able to join a conference, users are also able to manage selected portions of that conference by using their telephone keypad. (The specific conference settings users can and cannot manage depend on whether or not the user is a presenter.) For example, by default users can press the 6 key on their keypad to mute or unmute themselves. Participants can privately play the names of all the other people attending the meeting, while presenters can do such things as mute and unmute all the meeting participants and enable or disable the announcement that is played any time someone joins or leaves a conference.
The ability to make selections like these using a telephone keypad is known as dual-tone multifrequency (DTMF) signaling: if you have ever dialed a phone number and been instructed to do something along the order of "Press 1 for English or press 2 for Spanish," then you have used DTMF signaling.
The Set-CsDialInConferencingDtmfConfiguration cmdlet enables you to modify the keys used to trigger the commands supported in a Lync Server 2010 dial-in conference.
When modifying the DTMF commands keep two things in mind. First, you can only use the numeric keys 0 through 9; any other keys that might be found on your keypad (such as the # key) are not allowed. There is one exception to that rule: the CommandCharacter parameter allows you to use only the asterisk key (*), or the pound key (#); you cannot assign a numeric value to the CommandCharacter parameter. However, all the other command parameters will only accept numeric values.
Second, commands must be assigned unique keys; for example, the 4 key cannot be used both to mute and unmute yourself and to lock and unlock a conference. That means that, when modifying the keys assigned to a command, you might want to swap the keys used by two different commands. For example, if you want to assign the 4 key to EnableDisableAnnouncementsCommand (default value: 9) you should, in the same command, assign the 9 key to AudienceMuteCommand.
To disable a command, set its value to Null ($Null).
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsDialInConferencingDtmfConfiguration 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-CsDialInConferencingDtmfConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
String |
Indicates the unique identifier for the collection of DTMF 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. Note that you cannot use wildcards when specifying an Identity. If this parameter is not specified, then Set-CsDialInConferencingDtmfConfiguration will modify the global DTMF settings. |
Instance |
Optional |
DialInConferencingDtmfConfiguration object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
AdmitAll |
Optional |
String |
Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference. The default value is 8. |
AudienceMuteCommand |
Optional |
String |
Indicates the key a presenter can press to mute everyone else in the conference (that is, everyone other than the presenter will be muted). The default key is 4. |
CommandCharacter |
Optional |
String |
Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*); the only other allowed value is the pound key (#). |
EnableDisableAnnouncementsCommand |
Optional |
String |
Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9. |
HelpCommand |
Optional |
String |
Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1. |
LockUnlockConferenceCommand |
Optional |
String |
Indicates the key to be pressed to lock or unlock a conference. If a conference is locked then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. The default key is 7. |
MuteUnmuteCommand |
Optional |
String |
Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. The default key is 6. |
PrivateRollCallCommand |
Optional |
String |
Indicates the key to be pressed to privately play the name of each conference participant. The default key is 3. |
Force |
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
Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. Set-CsDialInConferencingDtmfConfiguration accepts pipelined instances of the dial-in conference DTMF configuration object.
Return Types
Set-CsDialInConferencingDtmfConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object.
Example
-------------------------- Example 1 ------------------------
Set-CsDialInConferencingDtmfConfiguration -Identity global -EnableDisableAnnouncementsCommand 4 -AudienceMuteCommand 9
The command shown in Example 1 swaps the keys assigned to the command for enabling and disabling announcements (default value: 9) and the command for muting and unmuting all participants (default value: 4) for the global DTMF settings. To do this two different parameters are used: EnableDisableAnnoucementsCommand, which is given the parameter value 4; and AudienceMuteCommand, which is given the value 9. Because no Identity is specified, these changes will affect the global DTMF settings.
-------------------------- Example 2 ------------------------
Set-CsDialInConferencingDtmfConfiguration -Identity site:Redmond -EnableDisableAnnouncementsCommand 4 -AudienceMuteCommand 9
The command shown in Example 2 is a variation of the command shown in the first example. In this case, however, the changes affect the DTMF settings that have the Identity site:Redmond.
-------------------------- Example 3 ------------------------
Set-CsDialInConferencingDtmfConfiguration -Identity "site:Redmond" -PrivateRollCallCommand $Null
The command shown in Example 3 disables the roll call command (the ability to play back a list of all the people participating in the conference) for the Redmond site. To disable this command, the PrivateRollCallCommand parameter is included, with the parameter value set to $Null. This means that no keypad key will be associated with the command, which makes the command unavailable to users.
-------------------------- Example 4 ------------------------
Get-CsDialInConferencingDtmfConfiguration -Filter "site:*" | Set-CsDialInConferencingDtmfConfiguration -PrivateRollCallCommand $Null
Example 4 is a variation on Example 3: in this example, the roll call command is disabled for all the DTMF settings configured at the site scope. To do this, the command first uses Get-CsDialInConferencingDtmfConfiguration and the Filter parameter to return a collection of all the settings configured at the site scope; the filter value "site:*" limits the returned data to those settings where the Identity begins with the characters "site:". This filtered collection is then piped to Set-CsDialInConferencingDtmfConfiguration, which sets the value of the PrivateRollCallCommand property to null ($Null).