New-CsSimpleUrl
Creates a new simple URL, which can then be added to a simple URL configuration collection. Simple URLs make it easier for users to join meetings and conferences, and also make it easier for administrators to log on to the Skype for Business Server Control Panel. This cmdlet was introduced in Lync Server 2010.
Syntax
New-CsSimpleUrl
-Component <String>
-Domain <String>
[-SimpleUrlEntry <PSListModifier>]
[-ActiveUrl <String>]
[<CommonParameters>] Description
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.
Skype for Business 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 Skype for Business Server Control Panel.
Dialin - Used for the dial-in conferencing webpage.
Simple URLs are stored in simple URL configuration collections. When you install Skype for Business 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.
To add an actual URL to a simple URL collection, you must first create the URL by using the New-CsSimpleUrl cmdlet and the New-CsSimpleUrlEntry cmdlet.
The New-CsSimpleUrlEntry cmdlet creates a URL entry: a URL (such as https://meet.litwareinc.com) that can be used as a simple URL (for meeting, administration, or dial-in conferencing purposes).
The object created by the New-CsSimpleUrlEntry cmdlet is added to the SimpleUrlEntry property of a new simple URL.
You must use a separate cmdlet to create the object because the SimpleUrlEntry property can hold multiple URLs.
(However, only one such URL can be designated as the active URL.
The active URL represents the actual URL used for meetings, administration, or dial-in conferencing.)
After creating a simple URL entry, you then use the New-CsSimpleUrl cmdlet to create an in-memory-only instance of a simple URL, defining such things as the component (the type of simple URL), the domain, the active URL, and all of the simple URL entries. After you have created an object representing the simple URL, that object can then be added to a new (or existing) simple URL collection. After updating a simple URL collection, you must then run the Enable-CsComputer cmdlet.
Examples
-------------------------- EXAMPLE 1 --------------------------
$urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com"
$simpleUrl = New-CsSimpleUrl -Component "meet" -Domain "fabrikam.com" -SimpleUrlEntry $urlEntry -ActiveUrl "https://meet.fabrikam.com"
Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl @{Add=$simpleUrl}Example 1 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 the New-CsSimpleUrlEntry cmdlet to create a URL entry that points to https://meet.fabrikam.com; this URL entry is stored in a variable named $urlEntry.
In the second command, 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 Meet; the domain is set to fabrikam.com; the ActiveUrl is set to https://meet.fabrikam.com; and the SimpleUrl property is set to $urlEntry, with $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 Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl parameter, and the parameter value @{Add=$simpleUrl}. This syntax causes the URL stored in the object reference $simpleUrl to be added to the SimpleUrl property.
Parameters
-ActiveUrl
Indicates the URL that is actually to be accessed by users. The SimpleUrlEntry property can contain multiple URLs, but only one of those URLs can be active at a given time. An error will occur if you try to set the ActiveUrl to a value not found in the SimpleUrlEntry property.
To assign an active URL, simply use the URL itself as the parameter value. For example:
-ActiveUrl "https://meet.litwareinc.com"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Component
Indicates the type of simple URL being created. Valid values are:
Meet - URL used for managing meetings.
Admin - URL that points to the Skype for Business Server Control Panel.
Dialin - URL used for dial-in conferencing.
WebScheduler - URL used for schedule meetings.
For example:
-Component "Meet"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Domain
SIP domain for the simple URL. For example:
-Domain "litwareinc.com"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-SimpleUrlEntry
Collection of URLs for the specified component.
For example, both https://meet.litwareinc.com and https://litwareinc.com/meet might be configured as URL entries for the Meet component.
However, only one of those URLs can be (and must be) configured as the active URL.
Simple URL entries must be created by using the New-CsSimpleUrlEntry cmdlet.
| Type: | PSListModifier |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
None. The New-CsSimpleUrl cmdlet does not accept pipelined data.
Outputs
The New-CsSimpleUrl cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrl object.