New-CsSipProxyTLS
Topic Last Modified: 2012-03-25
Creates a new SipProxy.TLS object, which can then be used to configure a static route to use Transport Layer Security (TLS) as its transport protocol.
Syntax
New-CsSipProxyTLS -Certificate <ITLSTLSChoice> -Fqdn <String>
Detailed Description
When you send a SIP message to someone, that message might need to traverse multiple subnets and networks before it is delivered; the path traveled by the message is often referred to as a route. In networking, there are two types of routes: dynamic and static. With dynamic routing, servers use algorithms to determine the next location (the next hop) where a message should be forwarded. With static routing, message paths are predetermined by system administrators. When a message is received by a server, the server checks the message address and then forwards the message to the next hop server that has been preconfigured by an administrator. If configured correctly, static routes help ensure timely, and accurate, delivery of messages, and with minimal overheard placed on servers. The downside to static routes is that messages are not dynamically rerouted in the event of a network failure.
Microsoft Lync Server 2010 enables you to set up static routes for proxy servers. These routes are composed of two primary pieces: proxy configuration settings and SIP proxy routes. In turn, SIP proxy routes have a number of properties; for example, each route must have a Transport, a property that defines the network protocol used for transmitting messages along the route.
Lync Server 2010 allows you to specify either Transmission Control Protocol (TCP) or Transport Layer Security (TLS) as your transport protocol. If you decide to use TLS as your protocol, you must first create a TLS object by using the New-CsSipProxyTLS cmdlet. You can then use that object to specify the protocol for the Transport object created by New-CsSipProxyTransport.
Note that you must also specify a certificate (to be used for authentication purposes) if you choose to use TLS as your transport protocol.
The New-CsSipProxyTLS cmdlet is not required if you use New-CsStaticRoute to create your static route.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsSipProxyTLS 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-CsSipProxyTLS"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Certificate |
Required |
X.509 certificate object |
Certificate to be used for TLS authentication. |
Fqdn |
Required |
String |
Fully qualified domain name (FQDN) of the next hop server. For example: -Fqdn atl-proxy-001.litwareinc.com. |
Input Types
None. New-CsSipProxyTLS does not accept pipelined input.
Return Types
New-CsSipProxyTLS creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TLS object.
Example
-------------------------- Example 1 --------------------------
$cert = New-CsSipProxyUseDefaultCert
$tls = New-CsSipProxyTLS -Certificate $cert -Fqdn atl-proxy-001.litwareinc.com
$transport = New-CsSipProxyTransport -TransportChoice $tls -Port 7500
The commands shown in Example 1 create a new SIP proxy transport object that uses TLS as its transport. Because TLS requires a certificate to be used for authentication purposes, the first command in the example uses New-CsSipProxyUseDefaultCert to configure a new SipProxy.UseDefaultCert. This object, stored in a variable named $cert, instructs Lync Server to use the default certificate for the TLS transport. After the UseDefaultCert object has been created, New-CsSipProxyTLS can be called to create a new SipProxy.TLS object, one that uses the default certificate and points to atl-proxy-001.litwareinc.com as the FQDN of the next hop server.
As soon as the TLS object exists, that object (and the TLS protocol) can be added to a Transport object, an object created by calling New-CsSipProxyTransport.