Export (0) Print
Expand All
Expand Minimize

Set-CsDialInConferencingConfiguration

 

Topic Last Modified: 2012-03-25

Modifies settings that determine how Microsoft Lync Server 2010 responds when users join or leave a dial-in conference.

Set-CsDialInConferencingConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableNameRecording <$true | $false>] [-EntryExitAnnouncementsEnabledByDefault <$true | $false>] [-EntryExitAnnouncementsType <UseNames | ToneOnly>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Set-CsDialInConferencingConfiguration [-Confirm [<SwitchParameter>]] [-EnableNameRecording <$true | $false>] [-EntryExitAnnouncementsEnabledByDefault <$true | $false>] [-EntryExitAnnouncementsType <UseNames | ToneOnly>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]

When users join (or leave) a dial-in conference, Lync Server 2010 can respond in different ways. For example, participants might be asked to record their name before they can enter the conference itself. Likewise, administrators can decide whether they want to have Lync Server announce that dial-in participants have either left or joined a conference.

These conference "join behaviors" are managed using dial-in conferencing configuration settings; these settings can be configured at the global scope or at the site scope. When you first install Lync Server, the only dial-in conferencing configuration settings you will have are the ones at the global scope; however, you can create new settings at the site scope by using the New-CsDialInConferencingConfiguration cmdlet. In addition, you can modify any of these configuration settings (at either the global or site scopes) by using the Set-CsDialInConferencingConfiguration cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsDialInConferencingConfiguration 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-CsDialInConferencingConfiguration"}

 

Parameter Required Type Description

Identity

Optional

Indicates the Identity of the dial-in conferencing configuration settings to be modified. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity.

Instance

Optional

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

EnableNameRecording

Boolean

Determines whether or not users are asked to record their name before entering the conference. Set to True to enable name recording; set to False to bypass name recording. The default value is True.

EntryExitAnnouncementsEnabledByDefault

Boolean

If set to True announcements will be played each time a participant enters or exits a conference. If set to False (the default value), entry and exit announcements will not be played.

EntryExitAnnouncementsType

String

Indicates the action taken by the system any time a participant enters or leaves a conference. (Announcements are made only if the EntryExitAnnouncementsEnabledByDefault is set to True.) Valid values are:

UseNames. The person's name is announced any time her or she enters or leaves a conference (for example, "Ken Myer is exiting the conference").

ToneOnly. A tone is played any time a participant enters or leaves a conference.

The default value is UseNames.

Force

Switch Parameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Switch Parameter

Prompts you for confirmation before executing the command.

Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. Set-CSDialInConferencingConfiguration accepts pipelined instances of the dial-in conferencing configuration object.

Set-CSDialInConferencingConfiguration does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object.

-------------------------- Example 1 ------------------------

Set-CsDialInConferencingConfiguration -Identity site:Redmond -EntryExitAnnouncementsType "ToneOnly"

The command shown in Example 1 modifies the EntryExitAnnoucements property for the dial-in configuration settings for the Redmond site. In this case, the EntryExitAnnouncementsType property is set to ToneOnly.

-------------------------- Example 2 ------------------------

Get-CsDialInConferencingConfiguration | Set-CsDialInConferencingConfiguration -EnableNameRecording $True

Example 2 modifies all the dial-in conferencing configurations settings in use in the organization. To do this, the command first uses Get-CsDialInConferencingConfiguration to return a collection of all dial-in conferencing settings. That collection is then piped to Set-CsDialInConferencingConfiguration, which sets the EnableNameRecording property for each item in the collection to True ($True).

-------------------------- Example 3 ------------------------

Get-CsDialInConferencingConfiguration -Filter "site:*" | Set-CsDialInConferencingConfiguration -EnableNameRecording $True -EntryExitAnnouncementsType "UseNames"

The preceding command modifies all the dial-in conferencing settings that have been configured at the site scope. To carry out this task, the command first uses Get-CsDialInConferencingConfiguration and the Filter parameter to return a collection of all the settings configured at the site scope; the filter value "site:*" restricts returned data to settings that have an Identity beginning with the string value "site:". That filtered collection is then piped to Set-CsDialInConferencingConfiguration, which modifies the EnableNameRecording property and the EntryExitAnnouncementsType property for each item in the collection. When the command finishes running, all the dial-in conferencing settings configured at the site scope will have their EnableNameRecording property set to True and their EntryExitAnnoucements property set to "UseNames".

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft