Topic Last Modified: 2010-10-01

Retrieves information about how Microsoft Lync Server 2010 responds when users join or leave a dial-in conference.

Syntax

Get-CsDialInConferencingConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsDialInConferencingConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter Required Type Description

Identity

Optional

XdsIdentity

Indicates the Identity of the dial-in conferencing configuration settings to be retrieved. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. You cannot use wildcards when specifying an Identity. To do that, use the Filter parameter instead.

If called without any parameters Get-CsDialInConferencingConfiguration returns information about all the dial-in conferencing configuration settings in use in your organization.

Filter

Optional

String

Provides a way for you to use wildcard characters when specifying dial-in conferencing configuration settings. For example, to return a collection of all the configuration settings that have been applied at the site scope use this syntax: -Filter "site:*". To return all the settings that have the term "EMEA" in their Identity use this syntax: -Filter "*EMEA*". Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other dial-in conferencing configuration properties.

LocalStore

Optional

Switch Parameter

Retrieves the dial-in conferencing data from the local replica of the Central Management store rather than from the Central Management store itself.

Detailed Description

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. (Settings configured at the site scope take precedence over settings configured at the global scope.) The Get-CsDialInConferencingConfiguration cmdlet enables you to retrieve information about the dial-in conferencing 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 Get-CsDialInConferencingConfiguration 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-CsDialInConferencingConfiguration"}

Input Types

None. Get-CsDialInConferencingConfiguration does not accept pipelined input.

Return Types

Get-CsDialInConferencingConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object.

Example

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

Copy Code 
Get-CsDialInConferencingConfiguration

The preceding command returns a collection of all the dial-in conferencing configuration settings currently in use in the organization. Calling Get-CsDialInConferencingConfiguration without any additional parameters always returns the complete collection of dial-in conferencing settings.

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

Copy Code 
Get-CsDialInConferencingConfiguration -Identity site:Redmond

Example 2 returns the dial-in conferencing configuration settings with the Identity site:Redmond.

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

Copy Code 
Get-CsDialInConferencingConfiguration -Filter "site:*"

In Example 3, the Filter parameter is used to return all the dial-in conferencing settings that have been configured at the site scope. The filter value "site:*" instructs Get-CsDialInConferencingConfiguration to return only those settings where the Identity begins with the string value "site:". By design, any dial-conferencing settings that have an Identity beginning with "site:" represent settings configured at the site scope.

-------------------------- Example 4 ------------------------

Copy Code 
Get-CsDialInConferencingConfiguration | Where-Object {$_.EnableNameRecording -eq $False}

The preceding command uses the Get-CsDialInConferencingConfiguration cmdlet and the Where-Object cmdlet to return a collection of all the dial-in conferencing configuration settings where the EnableNameRecording property is set to False. To do this, Get-CsDialInConferencingConfiguration is called without any parameters in order to return a collection of all the dial-in conferencing settings. That collection is then piped to Where-Object, which picks out only those settings where the EnableNameRecording property is equal to False.

See Also