[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies one or more of the Web Servers used by Microsoft Communications Server 2010.

Syntax

Set-CsWebServer [-Identity <XdsGlobalRelativeIdentity>] [-AppSharingPortCount <UInt16>] [-AppSharingPortStart <UInt16>] [-Confirm [<SwitchParameter>]] [-ExternalFqdn <Fqdn>] [-ExternalHttpPort <UInt16>] [-ExternalHttpsPort <UInt16>] [-Force <SwitchParameter>] [-InternalFqdn <Fqdn>] [-PrimaryHttpPort <UInt16>] [-PrimaryHttpsPort <UInt16>] [-PublishedExternalHttpPort <UInt16>] [-PublishedExternalHttpsPort <UInt16>] [-PublishedPrimaryHttpPort <UInt16>] [-PublishedPrimaryHttpsPort <UInt16>] [-ReachExternalPsomServerPort <UInt16>] [-ReachPrimaryPsomServerPort <UInt16>] [-UserServer <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Unique Identifier for the Web Services pool. For example: -Identity "WebServer:atl-cs-001.litwareinc.com".

UserServer

Service ID for the User Services pool associated with the Web Services pool. For example: -UserServer "UserServer:atl-cs-001.litwareinc.com".

PrimaryHttpPort

Port number for internal Web connections made using the HTTP protocol. The default value is port 80.

PrimaryHttpsPort

Port number for internal Web connections made using the HTTPS protocol. The default value is port 443.

ExternalHttpPort

Port number for external Web connections made using the HTTP protocol. The default value is port 8080.

ExternalHttpsPort

Port number for external Web connections made using the HTTPS protocol. The default value is port 4443.

ExternalFqdn

Fully qualified domain name used for people connecting to the Web Services pool from outside the internal network. For example: -ExternalFqdn www.litwareinc.com.

AppSharingPortCount

Integer

Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 600000 through 60099 will be used for application sharing. The default value is 16383.

AppSharingPortStart

Integer

First port in the range of ports allocated for application sharing. The default value is 49152.

ReachExternalPsomServerPort

Integer

External port number for the Persistent Shared Object Model Protocol, a Microsoft protocol used for online conferences. The default port number is 8061.

ReachPrimaryPsomServerPort

Integer

Primary port number for the Persistent Shared Object Model Protocol, a Microsoft protocol used for online conferences. The default port number is 8060.

Force

Suppresses the display of any non-fatal error message that might arise when running the command.

WhatIf

Describes what would happen if you executed the command without actually executing the command.

Confirm

Prompts you for confirmation before executing the command.

Detailed Description

Microsoft Communications Server 2010 makes extensive use of Web servers and Web services. For example, Address Book queries are conducted using Web services; likewise, Communications Server hosts Web pages that enable users to do such things as configure their dial-in conferencing PIN numbers. Considering the important role played by Web servers and Web services, it’s critical that administrators know how these servers and services are configured. That’s information that can be returned using the following command:

Get-CsService –WebServer

There are also times where it is critical that administrators be able to change the way their Web servers are configured; for example, you might need to modify the port used for external HTTP or HTTPS connections. Port changes like these (and other modifications) can be made using the Set-CsWebServer cmdlet.

Return Types

Set-CsWebServer modifies instances of the Microsoft.Rtc.Management.Xds.DisplayWebServer object.

Examples

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

Copy Code
Set-CsWebServer -Identity "WebServer:atl-cs-001.litwareinc.com" -PrimaryHttpPort 89

The command shown in Example 1 changes the PrimaryHttpPort for a single Web Service pool: the pool with the Identity WebServer:atl-cs-001.litwareinc.com. In this example, the port is changed to port number 89.

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

Copy Code
Get-CsService -WebServer | ForEach-Object {Set-CsWebServer -Identity $_.Identity -PrimaryHttpPort 89}

The command shown in Example 2 is a variation of the command shown in Example 1; in this case, however, the PrimaryHttpPort is modified for all the Web Service pools in the organization. To do this, the command starts off by using Get-CsService and the –WebServer parameter to return a collection of all the Web Service pool currently in use. This collection is then piped to the ForEach-Object cmdlet, which takes each pool in the collection and sets the PrimaryHttpPort to port 89. The data must be piped to ForEach-Object because the Set-CsWebServer cmdlet cannot accept pipelined data itself.