Share via

  • Article

Get-CsConferenceDirectory

 

Topic Last Modified: 2012-03-23

Returns information about the conference directories configured for use in your organization. Conference directories are used to help dial-in conferencing users locate conference information.

Syntax

Get-CsConferenceDirectory [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]

Get-CsConferenceDirectory [-Filter <String>] [-LocalStore <SwitchParameter>]

Detailed Description

When you create a dial-in conferencing Uniform Resource Identifier (URI), those URIs are assigned unique SIP addresses. However, SIP addresses are difficult for devices that are not SIP-aware to translate; for example, a public switched telephone network (PSTN) telephone can’t translate a SIP address. Because of that, Microsoft Lync Server 2010 uses conference directories as a way to help these devices locate, and connect to, dial-in conferences. This is done by creating a SIP conference directory that is associated with each dial-in conferencing URI, and is identified by an integer value rather than a SIP URI. PSTN telephones and other devices can use these numbers (rather than a SIP URI) when connecting to conferences; the directory number is included in the PSTN conference identification users enter when connecting to a dial-in conference.

The Get-CsConferenceDirectory cmdlet enables you to return information about all the conference directories configured for use in your organization.

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

Parameters

Parameter Required Type Description

Identity

Optional

Xds Identity

Numeric identifier (for example, 7) of the conference directory to be returned. If this parameter is omitted, then Get-CsConferenceDirectory returns information about all the conference directories in use in your organization.

Filter

Optional

String

Enables you to use wildcards to specify the Identity of the conference directory (or directories) to be retrieved. Because directory Identities are numeric, this parameter might be of minimal value. However, this syntax will return all the conference directories that have an Identity that begins with the number 3: -Filter "3*".

LocalStore

Optional

Switch Parameter

Retrieves the conference directory data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsConferenceDirectory does not accept pipelined input.

Return Types

Get-CsConferenceDirectory returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object.

Example

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

Get-CsConferenceDirectory

The command shown in Example 1 returns information about all the conference directories configured for use in your organization.

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

Get-CsConferenceDirectory -Identity 2

Example 2 returns information about the conference directory with the Identity 2. Because identities must be unique this command will never return more than a single conference directory.

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

Get-CsConferenceDirectory | Where-Object {$_.ServiceID -match "UserServer:atl-cs-001.litwareinc.com"}

The preceding command returns all the conference directories housed on the service UserServer:atl-cs-001.litwareinc.com. To do this, the command first calls Get-CsConferenceDirectory without any parameters in order to return a collection of all the conference directories found in your organization. This collection is then piped to the Where-Object cmdlet, which selects only those directories where the ServiceID matches the string value "UserServer:atl-cs-001.litwareinc.com".