Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-CsConferenceDirectory

 

Topic Last Modified: 2013-03-06

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. This cmdlet was introduced in Lync Server 2010.

Get-CsConferenceDirectory [-Identity <XdsGlobalRelativeIdentity>] <COMMON PARAMETERS>
Get-CsConferenceDirectory [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

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

Get-CsConferenceDirectory

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.

Get-CsConferenceDirectory -Identity 2

Example 3 returns all the conference directories housed on the service UserServer:atl-cs-001.litwareinc.com. To do this, the command first calls the Get-CsConferenceDirectory cmdlet 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".

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

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, Lync Server 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"}

 

Parameter Required Type Description

Filter

Optional

System.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*".

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity

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

LocalStore

Optional

System.Management.Automation.SwitchParameter

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

None. The Get-CsConferenceDirectory cmdlet does not accept pipelined input.

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

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.