Creates a new Simple URL configuration collection. 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
New-CsSimpleUrlConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-SimpleUrl <PSListModifier>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Xds Identity |
Unique identifier for the new Simple URL configuration collection. Because new collections can only be created at the site scope, the Identity must be the prefix site: followed by the name of the site. For example, this syntax creates a new collection for the Redmond site: -Identity "site:Redmond". |
|
SimpleUrl |
Optional |
PS List Modifier |
Simple URLs that have been configured for this collection. These URLs must be created using the New-SimpleUrl and New-SimpleUrlEntry cmdlets. |
|
InMemory |
Optional |
Switch Parameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
Tenant |
Optional |
Guid |
|
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
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-CsSimpleUrl and Set-CsSimpleUrlConfiguration) to populate these collections with Simple URLs.
Return Types
New-CsSimpleUrlConfiguration creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
New-CsSimpleUrlConfiguration -Identity "site:Redmond" |
|
The command shown in Example 1 creates a new Simple URL collection for the Redmond site. Because no parameters other than –Identity are included with this command, the new collection will not contain any Simple URLs. Note that this command will fail if the Redmond site already hosts a Simple URL collection.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
$urlEntry = New-CsSimpleUrlEntry -Url "https://meet.litwareinc.com"
$simpleUrl = New-CsSimpleUrl -Component "meet" -Domain "litwareinc.com" -SimpleUrl $urlEntry -ActiveUrl "https://meet.litwareinc.com"
New-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUrl}
|
|
The preceding example shows how you can create a new collection of Simple URLs that includes a Simple URL (one for meeting management). To do this, the first command in the example uses New-CsSimpleUrlEntry to create a URL entry that points to https://meet.litwareinc.com; this URL entry is stored in a variable named $urlEntry.
In the second command, New-CsSimpleUrl is used to create an in-memory-only instance of a Simple URL. In this example, the URL Component is set to Meet; the domain is set to litwareinc.com; the ActiveUrl is set to https://meet.litwareinc.com; and the SimpleUrl property is set to $urlEntry, $urlEntry representing the URL entry created in the first command.
After the URL has been created (and stored in the object reference $simpleUrl) the final command in the example creates a new Simple URL collection for the Redmond site, and adds the new in-memory-only URL to do that collection. The new URL is added to the collection by using the –SimpleUrl parameter and the parameter value @{Add=$simpleUrl}. This syntax simply says that the URL stored in the object reference $simpleUrl should be added to the SimpleUrl property.
Note that this command will fail if the Redmond site already contains a Meet URL.