Export (0) Print
Expand All
Expand Minimize

New-CsSimpleUrlConfiguration

 

Topic Last Modified: 2012-10-17

Creates a new simple URL configuration collection. Simple URLs make it easier for users to join meetings and conferences. They also make it easier for Administrators to sign in to the Microsoft Lync Server 2010 Control Panel.

New-CsSimpleUrlConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-SimpleUrl <PSListModifier>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]

In Microsoft Office Communications Server 2007 R2, 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

However, such URLs are not especially intuitive, and not easy to convey to someone else. The simple URLs introduced in Lync Server 2010 help overcome those problems by providing users with URLs that look more like this:

https://meet.litwareinc.com/kenmyer/071200

Simple URLs are an improvement over the URLs used in Office Communications Server. However, simple URLs are not automatically created for you; instead, you must configure the URLs yourself. In addition, you must also do such things as create Domain Name System (DNS) records for each URL; configure reverse proxy rules for external access; add the simple URLs to the your Front End Server certificates; and so on.

Lync Server enables you to create three different simple URLs:

Meet – Used for meetings. You must have at least one Meet URL for each of your SIP domains.

Admin – Used to point administrators toward the Lync Server 2010 Control Panel.

Dialin – Used for the dial-in conferencing webpage.

Simple URLs are stored in simple URL configuration collections. When you install Lync 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 by 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 updating a simple URL collection you must then run the Enable-CsComputer cmdlet.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsSimpleUrlConfiguration cmdlet locally: 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 "New-CsSimpleUrlConfiguration"}

 

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 by 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 occur when running the command.

Tenant

Optional

Guid

This parameter is not used with the on-premises version of Lync Server.

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.

New-CsSimpleUrlConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object.

-------------------------- Example 1 ------------------------

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. This command will fail if the Redmond site already hosts a simple URL collection.

-------------------------- Example 2 ------------------------

$urlEntry = New-CsSimpleUrlEntry -Url "https://dialin.fabrikam.com"
$simpleUrl = New-CsSimpleUrl -Component "dialin" -Domain "*" -SimpleUrlEntry $urlEntry -ActiveUrl "https://dialin.fabrikam.com"

$urlEntry2 = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com"
$simpleUrl2 = New-CsSimpleUrl -Component "meet" -Domain "fabrikam.com" -SimpleUrlEntry $urlEntry2 

New-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUrl,$simpleUrl2}

The preceding example shows how you can create a new collection of simple URLs that includes two simple URLs (one for meeting management and one for dial-in conferencing). To do this, the first command in the example uses New-CsSimpleUrlEntry to create a URL entry that points to https://dialin.litwareinc.com; this URL entry is stored in a variable named $urlEntry. The second command then creates another URL entry, this one pointing to https://meet.fabrikam.com.

Next, the New-CsSimpleUrl cmdlet is used to create an in-memory-only instance of a simple URL. In this example, the URL Component is set to dialin; the domain is set to an asterisk (*); the ActiveUrl is set to https://dialin.fabrikam.com; and the SimpleUrl property is set to $urlEntry. (The variable $urlEntry represents the URL entry created in the first command.) A similar command is then used to create a simple URL for meet.fabrikam.com.

After the URLs have been created (and stored in the object references $simpleUrl and $simpleUrl2) the final command in the example creates a new simple URL collection for the Redmond site, adding the two new in-memory-only URLs to that collection. The new URLs are added to the collection by using the New-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter, and the parameter value @{Add=$simpleUrl, $simpleUrl2}. That syntax causes the URLs stored in the object references $simpleUrl and $simpleUrl2 to be added to the SimpleUrl property.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft