Edit

Share via

Set-CsWebServer

Module:
Skype for Business Server PowerShell

Modifies one or more of the Web Server services used by Skype for Business Server. This cmdlet was introduced in Lync Server 2010.

Syntax

Default (Default) 

Set-CsWebServer
    [[-Identity] <XdsGlobalRelativeIdentity>]
    [-AppSharingPortCount <UInt16>]
    [-AppSharingPortStart <UInt16>]
    [-ExternalFqdn <Fqdn>]
    [-ExternalHttpPort <UInt16>]
    [-ExternalHttpsPort <UInt16>]
    [-PrimaryHttpPort <UInt16>]
    [-PrimaryHttpsPort <UInt16>]
    [-ReachExternalPsomServerPort <UInt16>]
    [-ReachPrimaryPsomServerPort <UInt16>]
    [-UserServer <String>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [-InternalFqdn <Fqdn>]
    [-PublishedExternalHttpPort <UInt16>]
    [-PublishedExternalHttpsPort <UInt16>]
    [-PublishedPrimaryHttpPort <UInt16>]
    [-PublishedPrimaryHttpsPort <UInt16>]
    [-McxSipExternalListeningPort <UInt16>]
    [-McxSipPrimaryListeningPort <UInt16>]
    [-RmWebSipExternalListeningPort <UInt16>]
    [-RmWebSipPrimaryListeningPort <UInt16>]
    [-SupportConferenceConsoleSipExternalListeningPort <UInt16>]
    [-SupportConferenceConsoleSipPrimaryListeningPort <UInt16>]
    [-UcwaSipExternalListeningPort <UInt16>]
    [-UcwaSipPrimaryListeningPort <UInt16>]
    [-MeetingRoomAdminPortalExternalListeningPort <UInt16>]
    [-MeetingRoomAdminPortalInternalListeningPort <UInt16>]
    [-UcapSipPrimaryListeningPort <UInt16>]
    [-VxmlSipPrimaryListeningPort <UInt16>]
    [<CommonParameters>]

Description

Skype for Business Server makes extensive use of Web servers and web services. For example, Address Book queries can be conducted using web services (the Address Book Query Web service). Skype for Business Server also hosts webpages that enable users to do such things as configure their dial-in conferencing personal identification number (PINs). Considering the important role played by Web servers and web services, it is critical that administrators know how these servers and services are configured. That 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.

Examples

Example 1

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

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, the PrimaryHttpPort is modified for all the Web Service pools in the organization. To do this, the command starts off by using the Get-CsService cmdlet and the WebServer parameter to return a collection of all the Web Services pools 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 the ForEach-Object cmdlet because the Set-CsWebServer cmdlet cannot accept pipelined data itself.

Parameters

-AppSharingPortCount

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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 60000 through 60099 will be used for application sharing. The default value is 16383.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AppSharingPortStart

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExternalFqdn

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Fully qualified domain name (FQDN) used by people connecting to the Web Services pool from outside the internal network. For example:

-ExternalFqdn "www.litwareinc.com"

Parameter properties

Type:Fqdn
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExternalHttpPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExternalHttpsPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Unique identifier for the Web Services pool. For example:

-Identity "WebServer:atl-cs-001.litwareinc.com"

Note that you can leave off the prefix "WebServer:" when specifying a Web server. For example:

-Identity "atl-cs-001.litwareinc.com"

Parameter properties

Type:XdsGlobalRelativeIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InternalFqdn

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Fully qualified domain name for the Mobility Services. The InternalFqdn should only be accessible from inside the organization's firewall.

Parameter properties

Type:Fqdn
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-McxSipExternalListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

External listening port for the Mobility service.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-McxSipPrimaryListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Internal listening port for the Mobility service.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MeetingRoomAdminPortalExternalListeningPort

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

External listening port for the Skype for Business Meeting Room Admin Portal. The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MeetingRoomAdminPortalInternalListeningPort

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Internal listening port for the Skype for Business Meeting Room Admin Portal. The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrimaryHttpPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrimaryHttpsPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublishedExternalHttpPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Port number for the published external HTTP port.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublishedExternalHttpsPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

External port for the Mobility service.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublishedPrimaryHttpPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Port number for the published primary HTTP port.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublishedPrimaryHttpsPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Internal port for the Mobility service.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReachExternalPsomServerPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReachPrimaryPsomServerPort

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RmWebSipExternalListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

External listening port for the Persistent Chat Room Management Web App. This application is available only if you have installed and configured Persistent Chat.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RmWebSipPrimaryListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Primary listening port for the Persistent Chat Room Management Web App. This application is available only if you have installed and configured Persistent Chat.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupportConferenceConsoleSipExternalListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Listening port for the Support Conferencing Console. The default value is 6007.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupportConferenceConsoleSipPrimaryListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Port used by the Office 365 Support Conference Console. This console is used by support personnel to troubleshoot problems with conferences and online meetings.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UcapSipPrimaryListeningPort

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

Primary listening port for the UCAP (Unified Communication Application Platform).

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UcwaSipExternalListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

External SIP listening port for the Unified Communications Web API (UCWA). The default value is 5088.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UcwaSipPrimaryListeningPort

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Internal SIP listening port for the Unified Communications Web API (UCWA). The default value is 5089.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserServer

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Service ID for the User Services pool associated with the Web Services pool. For example:

-UserServer "UserServer:atl-cs-001.litwareinc.com"

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VxmlSipPrimaryListeningPort

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

This parameter is not currently used with Skype for Business Server.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

The Set-CsWebServer cmdlet does not accept pipelined input.

Outputs

None

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