PowerShell V2 高级函数使用举例（01）

wuaji

　　大家好，今天这篇博客的主要目的是完成之前对给位的承诺，通过编写Windows Update Agent的PowerShell模块来深入了解如何充分利用PowerShell V2中的新功能高级函数。
　　关于高级函数，在PowerShell V2还处于CTP3阶段时，我已经撰写了三篇博客文章进行入门级的介绍。不过相比大家会认为当时举得一些例子可能在平时的工作中派不上什么用场，那么今天这篇博客就作为之前介绍的补充吧，希望大家通过这篇博客掌握高级函数的使用方法，并在今后的工作中学会使用高级函数和模块来实现自己的脚本库，从而完成一些常见的管理工作。
　　不过首先要说明一点，稍后我在提供的Windows Update Agent模块并非最终的完成版，因为原始API有限制，这个模块部分功能在PSRemoting下无法正常工作，偏离了我原来的设想，因此从我个人角度来说，我只能放弃。当然并不是说没有解决方法，大家如果在Codeplex上去查找相关实现的话，便会发现有一种方法是利用PSExec，然后在系统权限（System账号）下执行相关代码。这里我就不再展开了，如果有预算的话，建议使用SCCM。
　　啰嗦完一些背景资料后，接下来就来看看高级函数是如何在Windows Update Agent PowerShell Module中发挥作用的。我们先来看看名为Get-WUAutoUpdateSetting的命令，命令在一般情况下的运行结果如下图所示：

　　我们要通过这个函数中来看下如何在高级函数中实现通用参数。这个函数本身是不需要任何参数就能返回信息的，但是我希望使用通用参数-Verbose来跟踪这个命令的内部执行过程。为了实现这个目标，则必须使用$pscmdlet这个系统变量。$pscmdlet包含高级函数本身的一些属性和方法，比方说我们要确定用户输入的高级函数参数有哪些，则可以使用$pscmdlet.MyInvocation.BoundParameters对象或者同样也是系统变量的$PSBoundParameters。$pscmdlet的所包含的一级成员所下图所示：

　　简单说明$pscmdlet后，回到之前提到，我们需要实现-Verbose参数。首先给出实现后的代码以及运行结果：
　　Function Get-WUAutoUpdateSetting
　　{
　　[CmdletBinding(ConfirmImpact="none")]
　　Param()
　　Begin
　　{
　　$muAU = New-Object -ComObject Microsoft.Update.AutoUpdate
　　$result = @()
　　$resultItem = New-Object System.Object
　　}
　　Process
　　{
　　$pscmdlet.WriteVerbose("Gathering Last Installation Success Date")
　　$resultItem | Add-Member -MemberType NoteProperty -Name "LastInstallationSuccessDate(UTC)" `
　　                  -Value $muAU.Results.LastInstallationSuccessDate
　　$pscmdlet.WriteVerbose("Gathering Last Search Success Date")
　　$resultItem | Add-Member -MemberType NoteProperty -Name "LastSearchSuccessDate(UTC)" `
　　                   -Value $muAU.Results.LastSearchSuccessDate
　　$result += $resultItem
　　}
　　End
　　{
　　return $result
　　}
　　}
　　Get-WUAutoUpdateSetting -Verbose
　　而输出结果也是我们想要的：

　　这里需要注意一点$pscmdlet.WriteVerbose不需要脚本编写者进行额外的判断逻辑，可以直接使用，PowerShell会自动判断当前高级函数是不是添加了-Verbose参数。同样，当你在高级函数中需要在屏幕上输出错误时，可以使用$pscmdlet的WriteError方法。这里需要注意这几个Write方法的参数，千万不要想到然的使用String类型的值作为输入，比如WriteError方法的参数类型是ErrorRecord，如果你不想自己新建一个实例的话，则可以自动变量$Error[0]来获得最近一次的错误记录。当然使用WriteError方法通常意味着你不想让当前的高级函数停止运行。但是有些时候某些错误的信息，会导致后面的脚步代码无法正确执行，为此我们必须让高级函数停止运行，那么我们可以使用$pscmdlet的ThrowTerminatingError方法来终止高级函数的执行。在本文的最开始我提到了由于原始API的限制，我们的脚本模块在PSRemoting的情况下是无法正常运行的，因此当我们需要在某些函数中进行环境判断，当发现是在PSRemoting的条件下执行时，就终止高级函数的运行。下面的代码就是这个逻辑的实现：
　　Function Test-PSRemoting
　　{
　　if ($Host.Name -eq "ServerRemoteHost")
　　{
　　return $true
　　}
　　else
　　{
　　return $false
　　}
　　}
　　Function Test-AdvFunction
　　{
　　[CmdletBinding(ConfirmImpact="none")]
　　Param()
　　Process
　　{
　　$cmdletName = $pscmdlet.MyInvocation.InvocationName
　　if (Test-PSRemoting)
　　{
　　throw "Remote session is detected. $cmdletName will be terminated."
　　$pscmdlet.ThrowTerminatingError($Error[0])
　　}
　　else
　　{
　　$pscmdlet.WriteVerbose("Normal Session.")
　　}
　　}
　　}
　　Test-AdvFunction
　　代码的执行效果如下：

　　测试代码涉及到两个函数，其中Test-PSRemoting用于判断当前会话是不是远程会话，判断依据是自动变量$Host的Name属性。而Test-AdvFunction这是用来执行测试的高级函数。当Test-PSRemoting返回的结果为真时，就使用throw关键字抛出一个异常，同时该异常也被自动记录到$Error变量中。随后使用ThrowTerminatingError方法来终止当前高级函数的运行。
　　接下来的几篇文章，还将围绕$pscmdlet来进行探讨，敬请期待。
　　已发表 2011年9月5日 23:10 作者 ghjconan