Modifies an existing 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
Set-CsSimpleUrlConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SimpleUrl <PSListModifier>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]] |
Set-CsSimpleUrlConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-SimpleUrl <PSListModifier>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Xds Identity |
Unique identifier for the collection of Simple URLs to be modified. To modify the global collection, use this syntax: -Identity global. To modify a collection from the site scope, use syntax similar to this: -Identity "site:Redmond." If this parameter is not specified then the global collection will be modified. |
|
Instance |
Optional |
SimpleUrlConfiguration object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
|
SimpleUrl |
Optional |
PS List Modifier |
Simple URLs configured for this collection. These URLs must be created using the New-SimpleUrl and New-SimpleUrlEntry cmdlets. |
|
Tenant |
Optional |
Guid |
|
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
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. After the collections have been created, Set-CsSimpleUrlConfiguration also gives you the ability to modify the URLs stored in those collections.
It should be noted that adding a Simple URL to a collection is reasonably straightforward. To begin with, you use New-CsSimpleUrl and New-CsSimpleUrlEntry to create an in-memory-only URL. You then use the Add command to add the new URL to the existing collection. Alternatively, you could use the Replace method to replace all the existing URLs with the new one.
Removing a URL from a collection is a little more difficult; that’s because you must first create a new object reference to that URL (one that mimics the existing URL), then use that object reference and the Remove method to delete the URL.
Return Types
Set-CsSimpleUrlConfiguration does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl $Null |
|
The command shown in Example 1 removes all the Simple URLs from the Redmond site, but does not remove the actual collection of Simple URLs. (The collection will still exist, but will no longer contain any URLs.) To do this, the command uses the –SimpleUrl parameter and sets the parameter value to a null value ($Null). This removes all the Simple URLs from the 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"
Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUrl}
|
|
The preceding example shows how a new URL can be added to an existing collection of Simple URLs. To begin with, 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 being 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 adds the new URL to the Simple URL collection for the Redmond site. This is done by using the –SimpleUrl parameter and the parameter value @{Add=$simpleUrl}. This syntax simply says that the URL stored in the object reference $y should be added to the SimpleUrl property.
Note that this command will fail if the Redmond site already contains a Meet URL.
-------------------------- Example 3 ------------------------
| 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"
Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Remove=$simpleUrl}
|
|
The commands shown in Example 3 demonstrate how you can delete a single URL from a Simple URL collection. Because Set-CsSimpleUrlConfiguration needs to work with URL objects, the example starts by creating a new object that contains the exact same property values as the URL to be deleted. To do that, the first command 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.
After the URL entry has been created, the second command uses New-CsSimpleUrl 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 being the URL entry created in the first command. This creates an in-memory URL ($simpleUrl) that has the same property values as the URL to be deleted.
The final command in the example then deletes the URL from the Simple URL collection for the Redmond site. This is done by using the –SimpleUrl parameter and the parameter value @{Remove=$simpleUrl}. This syntax simply says that the URL stored in the object reference $simpleUrl should be removed from the SimpleUrl property.