{"id":6211,"date":"2008-05-08T19:42:00","date_gmt":"2008-05-08T19:42:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2008\/05\/08\/fun-with-script-cmdlets\/"},"modified":"2019-02-18T13:15:57","modified_gmt":"2019-02-18T20:15:57","slug":"fun-with-script-cmdlets","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/fun-with-script-cmdlets\/","title":{"rendered":"Fun with Script Cmdlets"},"content":{"rendered":"

<\/font> <\/h2>\n

Script Cmdlets are one of the coolest things about the newer version of PowerShell.  <\/span>A Script cmdlet allows you to use all of the variety of cmdlet parameter sets inside of PowerShell functions. <\/font><\/p>\n

Since Script Cmdlets are PowerShell functions, and the PowerShell engine prefers to run functions rather than commands, you can use Script Cmdlets to override an existing cmdlet.  <\/span>You might want to do this to add or remove parameters from a cmdlet you use often.  <\/span>Also, you might just want to see what a cmdlet\u2019s parameters look like in a script cmdlet, so you can go write your own.<\/font><\/p>\n

Luckily, Powershell  <\/span>has a way to generate script cmdlets from an existing cmdlet.  <\/span>Below is a script cmdlet, called New-ScriptCmdlet, that I\u2019ll use to create other script cmdlets.<\/font><\/p>\n

You can use this to create new script cmdlets from existing cmdlets in a couple of different ways:<\/font><\/p>\n

# Create a new PowerShell cmdlet from an existing cmdlet<\/font><\/p>\n

Get-Command Get-Command | New-ScriptCmdlet Get-Command  <\/span>| Set-Content Get-Command.ps1<\/font><\/p>\n

# Create a new PowerShell cmdlet from an existing cmdlet\u2019s type<\/font><\/p>\n

[Microsoft.PowerShell.Commands.GetProcessCommand] | New-ScriptCmdlet Get-Process | Set-Content Get-Process.ps1<\/font><\/p>\n

# Creates a new PowerShell cmdlet from a random existing command and puts it into a file of the same name<\/p>\n

 Get-Command | Get-Random | Foreach-Object {
    $cmdlet = $_
    $scriptCmdlet  = $cmdlet | New-ScriptCmdlet $cmdlet.Name
    $scriptCmdlet | Set-Content “$($cmdlet.Name).ps1”
}<\/p>\n

Hope this helps,<\/font><\/p>\n

\n

James Brundage [MSFT]<\/font><\/p>\n<\/div>\n

function New-ScriptCmdlet()<\/font><\/span><\/p>\n

{<\/font><\/span><\/p>\n

cmdlet `<\/font><\/span><\/p>\n

 <\/span>-DefaultParameterSet Type<\/font><\/span><\/p>\n

    <\/span>param(<\/font><\/span><\/p>\n

    <\/span>[Parameter(ParameterSetName=”Type”,ValueFromPipeline=$true,Position=1)]<\/font><\/span><\/p>\n

    <\/span>[Type]<\/font><\/span><\/p>\n

    <\/span>$type,<\/font><\/span><\/p>\n

    <\/span><\/font><\/span><\/p>\n

    <\/span>[Parameter(ParameterSetName=”CommandInfo”,ValueFromPipeline=$true,Position=1)]<\/font><\/span><\/p>\n

    <\/span>[Management.Automation.CmdletInfo]<\/font><\/span><\/p>\n

    <\/span>$commandInfo,<\/font><\/span><\/p>\n

 <\/font><\/span><\/p>\n

    <\/span>[Parameter(Position=0)]<\/font><\/span><\/p>\n

    <\/span>[string]<\/font><\/span><\/p>\n

    <\/span>$name<\/font><\/span><\/p>\n

    <\/span>)<\/font><\/span><\/p>\n

 <\/font><\/span><\/p>\n

    <\/span>Process<\/font><\/span><\/p>\n

    <\/span>{<\/font><\/span><\/p>\n

        <\/span>if (! $type) {<\/font><\/span><\/p>\n

            <\/span>if ($commandInfo.ImplementingType) { $type = $commandInfo.ImplementingType }<\/font><\/span><\/p>\n

        <\/span>}<\/font><\/span><\/p>\n

 <\/font><\/span><\/p>\n

        <\/span>if ((! $type) -and (! $commandInfo)) {<\/font><\/span><\/p>\n

@”<\/font><\/span><\/p>\n

$(if ($name) { ‘function ‘ + $name + ‘() {‘ })<\/font><\/span><\/p>\n

cmdlet `<\/font><\/span><\/p>\n

param()<\/font><\/span><\/p>\n

begin {}<\/font><\/span><\/p>\n

process {}<\/font><\/span><\/p>\n

end {}<\/font><\/span><\/p>\n

$(if ($name) {‘}’ })<\/font><\/span><\/p>\n

“@               <\/span><\/font><\/span><\/p>\n

        <\/span>} else {<\/font><\/span><\/p>\n

            <\/span>if (! ($type.IsSubclassOf([Management.Automation.Cmdlet]))) {<\/font><\/span><\/p>\n

                <\/span>throw “Must provide a cmdlet to create a proxy”            <\/span><\/font><\/span><\/p>\n

            <\/span>}<\/font><\/span><\/p>\n

            <\/span>$commandMetaData = New-Object Management.Automation.CommandMetadata $type<\/font><\/span><\/p>\n

            <\/span>$proxyCommand =                                 <\/span><\/font><\/span><\/p>\n

@”<\/font><\/span><\/p>\n

$(if ($name) { ‘function ‘ + $name + ‘() {‘ })<\/font><\/span><\/p>\n

$([Management.Automation.ProxyCommand]::Create($commandMetaData))<\/font><\/span><\/p>\n

$(if ($name) {‘}’ })<\/font><\/span><\/p>\n

“@<\/font><\/span><\/p>\n

            <\/span>$executionContext.InvokeCommand.NewScriptBlock($proxyCommand)                          <\/span><\/font><\/span><\/p>\n

        <\/span>}<\/font><\/span><\/p>\n

    <\/span>}<\/font><\/span><\/p>\n

}<\/font><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

  Script Cmdlets are one of the coolest things about the newer version of PowerShell.  A Script cmdlet allows you to use all of the variety of cmdlet parameter sets inside of PowerShell functions. Since Script Cmdlets are PowerShell functions, and the PowerShell engine prefers to run functions rather than commands, you can use Script […]<\/p>\n","protected":false},"author":600,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[168,180,278,302],"class_list":["post-6211","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-get-command","tag-get-random","tag-proxy","tag-scriptcmdlet"],"acf":[],"blog_post_summary":"

  Script Cmdlets are one of the coolest things about the newer version of PowerShell.  A Script cmdlet allows you to use all of the variety of cmdlet parameter sets inside of PowerShell functions. Since Script Cmdlets are PowerShell functions, and the PowerShell engine prefers to run functions rather than commands, you can use Script […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/6211","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/600"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=6211"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/6211\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=6211"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=6211"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=6211"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}