Set-CsWebServiceConfiguration
上一次修改主题: 2012-04-23
修改现有的 Web 服务 配置设置集合。
语法
Set-CsWebServiceConfiguration [-Identity <XdsIdentity>] [-AllowAnonymousAccessToLWAConference <$true | $false>] [-CASigningKeyLength <UInt64>] [-Confirm [<SwitchParameter>]] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <$true | $false>] [-EnableGroupExpansion <$true | $false>] [-Force <SwitchParameter>] [-InferCertChainFromSSL <$true | $false>] [-MACResolverUrl <String>] [-MaxCSRKeySize <UInt64>] [-MaxGroupSizeToExpand <UInt32>] [-MaxValidityPeriodHours <UInt64>] [-MinCSRKeySize <UInt64>] [-MinValidityPeriodHours <UInt64>] [-SecondaryLocationSourceUrl <String>] [-ShowDownloadCommunicatorAttendeeLink <$true | $false>] [-ShowJoinUsingLegacyClientLink <$true | $false>] [-TrustedCACerts <PSListModifier>] [-UseCertificateAuth <$true | $false>] [-UsePinAuth <$true | $false>] [-UseWindowsAuth <None | Negotiate | NTLM>] [-WhatIf [<SwitchParameter>]]
Set-CsWebServiceConfiguration [-AllowAnonymousAccessToLWAConference <$true | $false>] [-CASigningKeyLength <UInt64>] [-Confirm [<SwitchParameter>]] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <$true | $false>] [-EnableGroupExpansion <$true | $false>] [-Force <SwitchParameter>] [-InferCertChainFromSSL <$true | $false>] [-Instance <PSObject>] [-MACResolverUrl <String>] [-MaxCSRKeySize <UInt64>] [-MaxGroupSizeToExpand <UInt32>] [-MaxValidityPeriodHours <UInt64>] [-MinCSRKeySize <UInt64>] [-MinValidityPeriodHours <UInt64>] [-SecondaryLocationSourceUrl <String>] [-ShowDownloadCommunicatorAttendeeLink <$true | $false>] [-ShowJoinUsingLegacyClientLink <$true | $false>] [-TrustedCACerts <PSListModifier>] [-UseCertificateAuth <$true | $false>] [-UsePinAuth <$true | $false>] [-UseWindowsAuth <None | Negotiate | NTLM>] [-WhatIf [<SwitchParameter>]]
详细说明
许多 Microsoft Lync Server 2010 组件都基于 Web:这些组件使用 Web 服务或网页来执行其任务。例如,用户在通讯簿中搜索新联系人,或者通过组展开来查看通讯组的各个成员时,可以使用 Web 服务。同样,范围从电话拨入式会议到 Microsoft Lync Server 2010 控制面板 的组件可使用网页作为 Lync Server 2010 与用户之间的界面。
通过 CsWebServiceConfiguration cmdlet,管理员可以管理整个组织中的 Web 服务配置设置。其中包括管理组扩展、证书设置和允许的身份验证方法。由于您可以在 global、site 和 service 作用域(但仅限“Web 服务”服务)配置不同的设置,因此可以为各个用户和各个位置自定义 Web 服务功能。通过 CsWebServiceConfiguration cmdlet(Get-CsWebServiceConfiguration、New-CsWebServiceConfiguration、Remove-CsWebServiceConfiguration 和 Set-CsWebServiceConfiguration),管理员可以管理整个组织中的 Web 服务配置设置。具体包括管理组扩展、证书设置以及允许的身份验证方法。由于您可以在 global、site 和 service 作用域(仅限“Web 服务”服务)配置不同的设置,因此可以为各个用户和各个位置自定义 Web 服务功能。
可以在创建新的 Web 服务配置设置集合时指定自定义设置(例如,自定义证书的有效期)。此外,通过使用 Set-CsWebServiceConfiguration cmdlet,您可以修改现有集合的属性值。
谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 Set-CsWebServiceConfiguration cmdlet:RTCUniversalServerAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsWebServiceConfiguration"}
参数
参数 | 必需 | 类型 | 描述 |
---|---|---|---|
Identity |
必需 |
Xds 标识 |
要修改的 Web 服务配置设置的唯一标识符。要修改在站点作用域配置的设置,请使用类似语法:-Identity "site:Redmond"。要修改服务范围内配置的设置,请使用与此类似的语法:-Identity "service:WebServer:atl-cs-001.litwareinc.com"。 要修改在全局作用域配置的设置,请使用类似语法:-identity global。 如果不使用 Identity 参数,则 Set-CsWebServiceConfiguration 将自动修改全局集合。 |
Instance |
必需 |
Web 服务设置对象 |
允许您将对对象的引用传递到 cmdlet,而不是设置单个参数值。 |
AllowAnonymousAccessToLWAConference |
可选 |
布尔值 |
设置为 True 时,允许匿名用户参加 Lync Web App (LWA) 会议。 |
CASigningKeyLength |
可选 |
整数 |
设置证书颁发机构 (CA) 签名密钥的大小,该密钥是 CA 用于对数字证书签名的私钥。签名密钥的长度可以设置为 2048 到 16384 之间的任意整数值,单位为字节;默认值为 2048。 |
DefaultValidityPeriodHours |
可选 |
整数 |
使用证书身份验证时,客户端可以请求证书的有效期长度(小时)。DefaultValidityPeriodHours 表示当客户未请求自定义有效期时证书的有效期长度。 DefaultValidityPeriodHours 可以是在 8 小时和 8760 小时(365 天)之间的任意整数值。默认值是 4320 天(180 天)。 |
EnableCertChainDownload |
可选 |
布尔值 |
如果设置为 True,具有身份验证证书的服务器将会为证书下载证书链。证书链可追溯单个证书的 CA。对于身份验证,只接受可信任的证书颁发机构颁发的证书。 |
EnableGroupExpansion |
可选 |
如果设置为 True,则会在 Microsoft Lync 2010 中启用组扩展。通过组扩展,用户可以将通讯组配置为联系人,然后“扩展”此组。扩展组后,用户可以查看组中单个成员及其当前的状态信息。 |
|
InferCertChainFromSSL |
可选 |
布尔值 |
如果设置为 True,服务器将使用包括在安全套接字层 (SSL) 协议中的证书信息来确定证书颁发机构。对于身份验证,只接受可信任的证书颁发机构颁发的证书。 |
MACResolverUrl |
可选 |
字符串 |
能够执行媒体访问控制 (MAC) 解析的 Web 服务的 URL。MAC 解析包括得到 IP 地址并确定与此 IP 地址关联的网卡的 MAC 地址。 |
MaxCSRKeySize |
可选 |
整数 |
设置证书签名请求 (CSR) 密钥的最大大小。(CSR 是由申请方发送到 CA 的消息,用来申请电子证书。)CSR 密钥的最大大小可以设置为 1024 到 16384 字节之间的任意整数值。默认值为 16384。 |
MaxGroupSizeToExpand |
可选 |
整数 |
表示扩展组后将显示的最大人数。例如,如果将 MaxGroupSizeToExpand 设置为 75,则每次扩展组后,仅会显示组中的前 75 名成员。 MaxGroupSizeToExpand 可以设置为 1 到 1000(包含边界值)之间的任意整数值。默认值为 100。 |
MaxValidityPeriodHours |
可选 |
整数 |
使用证书身份验证时,客户端可以请求证书的有效期长度(小时)。MaxValidityPeriodHours 表示客户端可以请求的最长时间。 MaxValidityPeriodHours 可以是 8 小时到 8760 小时(365 天)之间的任意整数值。默认值为 8760。 |
MinCSRKeySize |
可选 |
整数 |
设置证书签名请求 (CSR) 密钥的最小大小。最小大小可以设置为 1024 到 16384 字节之间的任意整数值。默认值为 16384。 |
MinValidityPeriodHours |
可选 |
整数 |
使用证书身份验证时,客户端可以请求证书的有效期长度(小时)。MinValidityPeriodHours 表示客户端可以请求的最短时间。 MinValidityPeriodHours 可以是在 8 小时和 4320 小时(180 天)之间的任意整数值。默认值为 8。 |
SecondaryLocationSourceUrl |
可选 |
字符串 |
可以处理位置请求的 Web 服务的 URL。只有当无法在本地解析位置请求时才会使用此服务。 |
ShowDownloadCommunicatorAttendeeLink |
可选 |
布尔值 |
如果设置为 True(默认值),则当通过 Lync 2010 之外的客户端应用程序加入会议时,用户会看到一个指向下载 Lync 2010 Attendee 的链接。 |
ShowJoinUsingLegacyClientLink |
可选 |
布尔值 |
如果设置为 True,则当通过客户端应用程序而非 Lync 2010 加入会议时,用户可使用其当前客户端应用程序加入会议。默认值为 False。 |
TrustedCACerts |
可选 |
证书集合 |
表示 Web 服务器信任的证书链的证书集合。必须使用 New-CsWebTrustedCACertificate cmdlet 创建将添加到集合中的新证书。 如果 InferCertChainFromSSL 属性设置为 True,则不会使用此集合。 |
UseCertificateAuth |
可选 |
布尔值 |
设置为 True(默认值)时,可使用证书对客户端进行身份验证。将该值设置为 False 可禁用证书身份验证。 |
UsePinAuth |
可选 |
布尔值 |
设置为 True(默认值)时,可使用个人标识号 (PIN) 对客户端进行身份验证。将该值设置为 False 可禁用 PIN 身份验证。 |
UseWindowsAuth |
可选 |
PS 列表修饰符 |
确定如何通过 Windows 身份验证来验证用户的身份;即,使用用户用以登录 Windows 的相同凭证。有效值包括: Negotiate – 客户端和服务器将协同工作以确定合适的身份验证协议(Kerberos 或 NTLM)。 NTLM – 允许 Windows 身份验证,仅限于使用 NTLM 协议。 None – 不允许 Windows 身份验证。 |
Force |
可选 |
开关参数 |
禁止显示运行此 cmdlet 时可能出现的任何确认提示或非严重错误消息。 |
WhatIf |
可选 |
开关参数 |
描述如果执行命令会发生什么情况(无需实际执行命令)。 |
Confirm |
可选 |
开关参数 |
在执行命令之前提示您进行确认。 |
输入类型
Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings 对象。Set-CsWebServiceConfiguration 接受通过管道传递的 Web 服务设置对象的输入。
返回类型
Set-CsWebServiceConfiguration 不会返回值或对象。此 cmdlet 会配置 Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings 对象的实例。
示例
-------------------------- 示例 1 ------------------------
Set-CsWebServiceConfiguration -Identity site:Redmond -EnableGroupExpansion $True
示例 1 为应用于 Redmond 站点 (-Identity site:Redmond) 的 Web 服务配置设置启用组扩展。通过包括 EnableGroupExpansion 属性并将参数值设置为 True,完成此操作。
-------------------------- 示例 2 ------------------------
Get-CsWebServiceConfiguration -Filter "site:*" | Set-CsWebServiceConfiguration -MaxValidityPeriodHours 16
在示例 2 中,应用于 site 作用域的所有 Web 服务配置设置的最长有效期均更改为 16 小时。为此,通过 Filter 参数调用 Get-CsWebServiceConfiguration;筛选器值“site:*”限制返回的数据只能来自 Identity 以“site:”开头的设置。然后,此集合通过管道传递到 Set-CsWebServiceConfiguration,它将针对集合中的每一项,将 MaxValidityPeriodHours 属性值更改为 16。
-------------------------- 示例 3 ------------------------
Get-CsWebServiceConfiguration | Where-Object {$_.EnableGroupExpansion -eq $True} | Set-CsWebServiceConfiguration -MaxGroupSizeToExpand 400
在上述命令中,对于每个 Web 服务配置设置集合(其允许组扩展),组扩展大小均设置为 400。为执行此操作,调用不带任何参数的 Get-CsWebServiceConfiguration;此操作将返回组织中使用的所有 Web 服务配置设置的集合。然后,将此集合通过管道传递到 Where-Object,后者将仅选择 EnableGroupExpansion 属性等于 True 的设置。最后,筛选出的集合通过管道传递到 Set-CsWebServiceConfiguration,它会针对集合中的每一项,将 MaxGroupSizeToExpand 属性值设为 400。
-------------------------- 示例 4 --------------------------
Set-CsWebServiceConfiguration -Identity global -ShowDownloadCommunicatorAttendeeLink $True
示例 4 中显示的命令说明如何配置全局 Web 服务设置,以使通过客户端应用程序而非 Lync 2010 加入会议的任何用户首先看到指向可下载 Lync 2010 Attendee 的站点链接。这是通过包含 ShowDownloadCommunicatorAttendeeLink 参数并将参数值设置为 $True 实现的。