New-CsDiagnosticConfiguration

 

上一次修改主题: 2012-03-23

创建新的诊断配置设置。诊断配置设置用于确定是否将往返于给定域或统一资源标识符 (URI) 的流量记录在 Microsoft Lync Server 2010 日志文件中。

语法

New-CsDiagnosticConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Filter <Filter>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

详细说明

如果对 Lync Server 2010 启用日志记录,则默认情况下会将往返于任何域或 URI 的流量包括在这些日志文件中。这可确保将尽可能多的信息记录在日志文件中。

但是,这有时可能会导致信息过多。例如,如果特定域存在连接问题,则您可能要限制只对网络与该域之间的流量进行日志记录;这样便于您识别相关记录,从而可能便于您诊断和更正该问题。

通过诊断配置设置,您可以指定要记录在日志文件中的域或 URI;例如,可以将流量记录到指定域或者记录仅来自指定域的流量。通过 Lync Server,您可以在 site 作用域创建诊断配置设置。接下来,您就可以对某个站点(如 Redmond 站点)应用与其他站点不同的设置。

请注意,无法在 global 作用域创建诊断配置设置,这是因为 global 作用域已托管这些设置。同样,如果指定的站点已经包含诊断配置设置,则也无法在 site 作用域创建新设置集合。例如,如果尝试创建 Redmond 站点的新集合,但此站点已托管诊断配置设置,则命令将失败。

谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 New-CsDiagnosticConfiguration cmdlet:RTCUniversalServerAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDiagnosticConfiguration"}

参数

参数 必需 类型 描述

Identity

必需

Xds 标识

要创建的诊断配置设置的唯一标识符。由于只能在 site 作用域创建新设置,因此必须使用类似如下的语法:-Identity "site:Redmond"。

Filter

可选

PS 列表修饰符

域和 URI 的集合,启用诊断筛选时记录其通信。Filter 属性由三个单独项组成:

Fqdn - 要包含在筛选器中的域的集合。(更严密地说,这是 SIP 地址的主机部分。)例如,完全限定域名 (FQDN) 可能类似如下:fabrikam.com。此外,还可以使用通配符代表多个域:*.fabrikam.com。可以在单个筛选器中包括多个域。

Uri - 要包含在筛选器中的 URI 的集合。(Uri 是 SIP 地址的 user@host 部分。)URI 可以由下列任一模式构成:user@fabrikam.com、user@*、*@fabrikam.com。可以在单个筛选器中包括多个 URI。

Enabled - 指示是否需要激活筛选器。

LoggingShare

可选

字符串

可上载诊断日志的共享文件夹。

Force

可选

开关参数

禁止显示运行此命令时可能出现的任何非严重错误消息。

InMemory

可选

开关参数

创建对象引用,但并不作为永久性更改实际提交对象。如果将使用此参数调用的 cmdlet 的输出分配给一个变量,您可以更改对象引用的属性,然后通过调用与此 cmdlet 匹配的 Set- cmdlet 提交这些更改。

WhatIf

可选

开关参数

描述如果执行命令会发生什么情况(无需实际执行命令)。

Confirm

可选

开关参数

在执行命令之前提示您进行确认。

输入类型

无。New-CsDiagnosticConfiguration 不接受通过管道传递的输入。

返回类型

New-CsDiagnosticConfiguration 创建 Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings 的新实例。

示例

-------------------------- 示例 1 --------------------------

New-CsDiagnosticConfiguration -Identity site:Redmond

上述命令将创建 Redmond 站点的新诊断配置设置集合。

-------------------------- 示例 2 --------------------------

$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -Enabled $False 

New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x

示例 2 中显示的命令先创建新诊断筛选器,然后将所创建的筛选器分配给诊断设置的新集合。为执行此操作,第一个命令将调用 New-CsDiagnosticsFilter 创建仅存在于内存中的诊断筛选器,此命令会将 FQDN fabrikam.com 和 URI sip:user@fabrikam.com 添加到所创建筛选器中。此命令还会将 Enabled 属性设置为 True ($True),以便激活筛选器。然后将生成的虚拟筛选器存储在变量 $x 中。

在第 2 个命令中,使用 New-CsDiagnosticConfiguration 为 Redmond 站点创建新的诊断配置设置集合。这些新设置将使用存储在变量 $x 中的诊断筛选器。

-------------------------- 示例 3 --------------------------

$x = New-CsDiagnosticConfiguration -Identity site:Redmond -InMemory
$x.LoggingShare = "\\atl-fs-001\logs"
Set-CsDiagnosticConfiguration -Instance $x

示例 3 中显示的命令演示了如何创建最初仅存在于内存中的诊断配置设置。为执行此操作,第一个命调用带有以下两个参数的 New-CsDiagnosticConfiguration:Identity(指定设置标识)和 InMemory(指示仅应在内存中创建新设置)。生成的对象存储在变量 $x 中。

当创建了这些虚拟设置之后,将使用第二个命令将 LoggingShare 属性配置为 UNC 路径 \\atl-fs-001\logs。然后,最后一个命令用于将虚拟诊断配置设置转换成应用于 Redmond 站点的实际设置集合。请注意,最后一个命令是必需的。如果未调用 Set-CsDiagnosticConfiguration,则不会将任何设置应用于 Redmond 站点,并且一旦结束 Windows PowerShell 会话或删除变量 $x,虚拟设置将立即消失。