Returns information about the simple URLs configured for use in your organization. Simple URLs make it easier for users to join meetings and conferences, as well as making it easier for Administrators to log on to the Communications Server Control Panel.
Syntax
Get-CsSimpleUrlConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>] |
Get-CsSimpleUrlConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier for the collection of Simple URLs to be returned. To return the global collection, use this syntax: -Identity global. To return a collection from the site scope, use syntax similar to this: -Identity "site:Redmond." Note that you cannot use wildcards when specifying an Identity. If you want to use wildcards, use the –Filter parameter instead. Calling Get-CsSimpleUrlConfiguration without any parameters returns all the Simple URLs configured for use in your organization. |
|
Filter |
Optional |
String |
Enables you to use wildcard characters to specify the Simple URL collection (or collections) to be returned. For example, this syntax returns all the Simple URL collections that have been configured at the site scope: -Filter "site:*". Note that you cannot use both the –Filter and the –Identity parameters in the same command. |
|
Tenant |
Optional |
Guid |
|
|
LocalStore |
Optional |
Switch Parameter |
Detailed Description
In Office Communications Server 2007 R2, online meetings had URLs similar to this:
https://imdf.litwareinc.com/Join?uri=sip%3Akenmyer%40litwareinc.com%3Bgruu%3Bopaque%3Dapp%3Aconf%3Afocus%3Aid%3A125f95a0b0184dcea706f1a0191202a8&key=EcznhLh5K5t
Needless to say, URLs such as that one are not especially intuitive, and not easy to convey to someone else. The Simple URLs introduced in Microsoft Communications Server “14” help overcome those problems by providing users with URLs that look more like this:
https://meet.litwareinc.com/071200
Simple URLs are obviously an improvement over the URLs used in the previous version of Office Communications Server. However, Simple URLs are not automatically created for you; instead, you must configure the URLs yourself. (You must also create DNS records for each URL; see the Microsoft Communications Server “14” Deployment Guide for more information.)
Communications Server “14” enables you to create three different Simple URLs:
Meet – Used for online meetings. You must have at least one Meet URL for each of your SIP domains.
Admin – Used to point administrators towards the Communications Server Control Panel.
Dialin – Used for dial-in conferencing.
Simple URLs are stored in Simple URL configuration collections. When you install Communications Server, a global collection is created for you; you can also create custom collections at the site scope. This gives you the ability to use different Simple URLs at each of your sites.
Simple URL configuration collections are created using the New-CsSimpleUrlConfiguration cmdlet; you can then use additional cmdlets (such as New-CsSimpleUrlEntry and Set-CsSimpleUrlConfiguration) to populate these collections with Simple URLs.
The Get-CsSimpleUrlConfiguration cmdlet provides a way for you to retrieve information about all the Simple URL configuration collections currently in use in your organization.
Return Types
Get-CsSimpleUrlConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsSimpleUrlConfiguration |
|
The preceding command returns information for all the simple URL configuration collections currently in use in the organization. This is achieved by calling Get-CsSimpleUrlConfiguration without any additional parameters.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsSimpleUrlConfiguration -Identity "site:Redmond" |
|
In Example 2, information is returned for a single simple URL configuration collection: the configuration with the Identity site:Redmond.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsSimpleUrlConfiguration -Filter "site:*" |
|
Example 3 returns information for all the simple URL configuration collections that have been assigned to the site scope. To do this, Get-CsSimpleUrlConfiguration is called along with the -Filter parameter; the filter value "site:*" limits the returned data to those collections that have an Identity that begins with the string value "site:".
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsSimpleUrlConfiguration | Select-Object -ExpandProperty SimpleUrl |
|
In Example 4, detailed information is displayed for each Simple URL configured for use in the organization. To carry out this task, the command first calls Get-CsSimpleUrlConfiguration to return a complete set of Simple URL information. This data is then piped to the Select-Object cmdlet, which uses the -ExpandProperty parameter to "expand" the value of the SimpleUrl property. Expanding a property value simply displays all the data stored in that property, displaying that data in an easy-to-read format.
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsSimpleUrlConfiguration | Select-Object -ExpandProperty SimpleUrl | Where-Object {$_.Component -eq "Meet"}
|
|
The command shown in Example 5 returns all the Simple URLs for meeting management currently in use in your organization. To do this, the command first calls Get-CsSimpleUrlConfiguration without any additional parameters; this returns a complete set of Simple URL information. This data is then piped to the Select-Object cmdlet, which uses the -ExpandProperty parameter to expand the value of the SimpleUrl property. This filtered collection is then piped to Where-Object, which picks out only those Simple URLs where the Component property is equal to (-eq) Meet.