Returns information about the conference directories configured for use in your organization. Conference directories are used to help dial-in conferencing users locate Web conference information.
Syntax
Get-CsConferenceDirectory [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsConferenceDirectory [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Numeric identifier (e.g., 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 Identies 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 |
Detailed Description
When you create a dial-in conferencing URI, those URIs are assigned a unique SIP address. However, SIP addresses are difficult to translate to devices that are not SIP-aware; for example, a SIP address means nothing to a PSTN (Public Switched Telephone Network) telephone. Because of that, Communications 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 then use these numbers (rather than a SIP URI) when they connect to conferences; in fact, 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.
Return Types
Get-CsConferenceDirectory returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PstnConf.ConferenceDirectories object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsConferenceDirectory |
|
The command shown in Example 1 returns information about all the conference directories configured for use in your organization.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
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 ------------------------
| Copy Code |
|
|---|---|
Get-CsConferenceDirectory | Where-Object {$_.ServiceID -eq "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 is equal to UserServer:atl-cs-001.litwareinc.com.