Today the Compute Cluster group announced the release of their Tool Pack HERE. This includes a monitoring tool, a ping\/pong diagnostic tool and (drum roll please\u2026\u2026) a PowerShell Snap-in which provides a provider and a set of commands. I really like what they have done. I’ve include the text of their about file so that you can see for yourself.\nHere is a test – take a look at the file below but don’t read any of the text \u2013 just look at the command examples.\nSee if you can figure out what it is doing. Now go back and read it again with the text and ask yourself whether the text really added a lot more to your understanding.\nLet me be very quick to state that I’m NOT making the case against documentation. Heavens no! Great documentation is super important. What I’m trying to point out is the self-documenting nature of PowerShell scripts. This is why we are so hard core about the naming guidelines.\nAt some point, the mess is going to hit the fan and you are going to be under lots of pressure to figure out what a script is doing and modify it to meet some new requirement. We’ve all been there before, trying to figure out what the heck a script is doing. Now imagine that same scenario but the script is written in PowerShell. We are working our butts off to make sure that that is a good experience for you.\nBTW (I’m going to keep reminding you of this) you all play a super important role in making this come true. When you see anyone produce Cmdlets or Scripts which don’t conform to the naming guidelines \u2013 you should scream! Chaos is the natural state of things and everyone is going to argue that their world is “special” and they need their own terms. If you accept that, then we’ll end up with yet another incoherent mess. What those people should do is to use the standard terms and then define aliases from their “special” terms to the standard terms.\nAnyway \u2013 I love what they have done with PowerShell. It’s another example of a team delivering a great experience using PowerShell.\nThis train keeps gathering steam! SNOOPY DANCE!\nJeffrey Snover [MSFT]\nWindows Management Partner Architect\nVisit the Windows PowerShell Team blog at: http:\/\/blogs.msdn.com\/PowerShell\nVisit the Windows PowerShell ScriptCenter at: http:\/\/www.microsoft.com\/technet\/scriptcenter\/hubs\/msh.mspx\nTOPIC CCPPSH<\/p>\n
SHORT DESCRIPTION \nMicrosoft Compute Cluster Pack Snap-in for Windows PowerShell<\/p>\n
LONG DESCRIPTION<\/p>\n
The Compute Cluster Pack (CCP) snap-in lets you view and manage Compute Cluster \nPack features in Windows PowerShell. The snap-in adds Compute Cluster Pack \ncmdlets and a CCP Windows PowerShell provider that lets you view and navigate \ncluster data in Windows PowerShell. <\/p>\n
INSTALL THE SNAPIN<\/p>\n
To add the Compute Cluster Pack (CCP) snap-in to Windows PowerShell, at the \nWindows PowerShell prompt, type:<\/p>\n
Add-PSSnapin CCPSnapIn<\/p>\n
To display CCP data correctly, load the CCP type file and formatting files, at \nthe Windows PowerShell prompt, type:<\/p>\n
Update-TypeData -PrependPath “ccp.ps1xml” \nUpdate-FormatData -PrependPath “ccp.format.ps1xml”<\/p>\n
These commands affect only the current Windows PowerShell console. To add the \nfiles to all Windows PowerShell consoles, add these commands to your Windows \nPowerShell profile.<\/p>\n
1. To determine whether you have a Windows PowerShell profile, at the Windows \nPowerShell prompt, type:<\/p>\n
test-path $profile<\/p>\n
“True” means that you have a profile. “False” means that you do not. If \n“True”, skip to step 3.<\/p>\n
2. To create a Windows PowerShell profile, at the Windows PowerShell prompt, \ntype:<\/p>\n
new-item -type file -path $profile -force<\/p>\n
The $profile variable is a built-in variable that stores the path to your \nWindows PowerShell profile.<\/p>\n
3. To open the profile in Notepad, type:<\/p>\n
notepad $profile <\/p>\n
4. Copy and paste the commands into your profile. The new profile is \neffective when you restart Windows PowerShell.<\/p>\n
NEW FEATURES<\/p>\n
The CCP snap-in adds two features to Windows PowerShell:<\/p>\n
— CCPProvider, a Windows PowerShell provider that lets you browse and navigate \ncluster data. (For information about Windows PowerShell providers, type \n“get-help about_provider”.)<\/p>\n
— A set of CCP cmdlets for Windows PowerShell, including Get-Node, Get-Job, \nGet-Task, New-Job, and New-Task.<\/p>\n
NAVIGATING CCP DATA IN WINDOWS POWERSHELL<\/p>\n
You can use the features added by the CCP snap-in to manage CCP cluster in \nWindows PowerShell. <\/p>\n
The following command creates a new Windows PowerShell drive called CCP: and \nmounts a cluster onto the Windows PowerShell CCP: drive. The cluster is \nidentified by its head node, which is stored in the value of the \nCCP_SCHEDULER environment variable. <\/p>\n
New-PSDrive -name CCP -provider CCPProvider -root $Env:CCP_SCHEDULER<\/p>\n
After the drive is created, you can switch to this drive and access the data \nas though it were located in the drive.<\/p>\n
For example, the following command changes to the new CCP: drive. It uses the \n“cd” alias for the Set-Location cmdlet, and the “dir” alias for the \nGet-Childitem cmdlet. <\/p>\n
PS c:\\> cd ccp: \nPS ccp:\\> dir nodes<\/p>\n
Name Status Proc Idle \n—- —— —- —-\nHPC-HN-01 Pend… 2 2 \nHPC-CN-01 Ready 2 2 \n… \nHPC-CN-08 Ready 1 1<\/p>\n
PS ccp:\\> dir jobs <\/p>\n
ID SubmitBy Name Status Priority \n— ——– —- —— ——–\n96 CCP\\USER1 Job 1 Failed Normal<\/p>\n
EXAMPLES: USING CCP CMDLETS IN WINDOWS POWERSHELL<\/p>\n
The CCP cmdlets lets you manage clusters in Windows PowerShell. All of the CCP \ncmdlets have a Scheduler parameter that specifies the head node that the command \naffects. <\/p>\n
If the Scheduler parameter is not included in the command, the CCP cmdlets use \nthe value of the CCP_SCHEDULER environment variable ($ENV:CCP_SCHEDULER)as the \ndefault head node. You can use the Set-Content cmdlet to change the value of \nCCP_SCHEDULER. <\/p>\n
For help with any cmdlet, at the Windows PowerShell prompt, type:<\/p>\n
get-help For example:<\/p>\n get-help get-node<\/p>\n Get-Node: Gets all of the nodes under the head node.<\/p>\n This command uses the Get-Node cmdlet to list all of the nodes under the head \nnode.<\/p>\n PS ccp:\\jobs> get-node <\/p>\n Name Status Proc Idle \n—- —— —- —- \nHPC-DEMO-CN-11 Pend… 2 2 \nHPC-DEMO-CN-12 Pend… 2 2 \nHPC-DEMO-CN-13 Pend… 2 2 \nHPC-DEMO-CN-14 Pend… 2 2 \nHPC-DEMO-CN-15 Pend… 2 2 \nHPC-DEMO-HN-01 Pend… 2 2<\/p>\n Enable-Node: Approves any pending nodes under the head node. This changes the \nstatus of the node from Pending to Paused. Use the Resume-Node cmdlet to make \nthem ready.<\/p>\n The first command in this example uses the Get-Node cmdlet to get all of the \nnodes under the head node. Then, it uses the pipeline operator (|) to send the \nresults of the Get-Node command to the Enable-Node cmdlet, which approves the \npending nodes. As a result, the nodes that were in a Pending status are now in a \nPaused status.<\/p>\n The second command uses the Get-Node cmdlet to display the updated status of the \nnodes.<\/p>\n PS ccp:\\jobs> get-node | enable-node \nPS ccp:\\jobs> get-node<\/p>\n Name Status Proc Idle \n—- —— —- —- \nHPC-DEMO-CN-11 Paused 2 2 \nHPC-DEMO-CN-12 Paused 2 2 \nHPC-DEMO-CN-13 Paused 2 2 \nHPC-DEMO-CN-14 Paused 2 2 \nHPC-DEMO-CN-15 Paused 2 2 \nHPC-DEMO-HN-01 Paused 2 2<\/p>\n Resume-Node: Resumes any paused nodes under the head node. This changes their \nstatus from Paused to Ready. Because newly-enabled nodes are paused, you need to \nuse this cmdlet to change their status to Ready.<\/p>\n The first command in this example uses the Get-Node cmdlet to get all of the \nnodes under the head node. Then, it uses the pipeline operator (|) to send the \nresults of the Get-Node command to the Resume-Node cmdlet, which enables any \npaused nodes. As a result, the nodes that were in a Paused status are now in a \nReady status.<\/p>\n The second command uses Get-Node to display the updated status.<\/p>\n PS ccp:\\jobs> get-node | resume-node \nPS ccp:\\jobs> get-node<\/p>\n Name Status Proc Idle \n—- —— —- —- \nHPC-DEMO-CN-11 Ready 2 2 \nHPC-DEMO-CN-12 Ready 2 2 \nHPC-DEMO-CN-13 Ready 2 2 \nHPC-DEMO-CN-14 Ready 2 2 \nHPC-DEMO-CN-15 Ready 2 2 \nHPC-DEMO-HN-01 Ready 2 2<\/p>\n You can save a collection of nodes in a variable and use array notation to view\nand manage the node objects. (For more information, type “get-help \nabout_shell_variable” and “get-help about_array”.)<\/p>\n This command uses the assignment operator (=) to save the results of the \nGet-Node command in the $a variable.<\/p>\n PS ccp:\\> $a = get-node<\/p>\n This command displays the first node (element 0) in the $a variable.<\/p>\n PS ccp:\\> $a[0]<\/p>\n Name Status Proc Idle \n—- —— —- —- \nHPC-DEMO-CN-11 Ready 2 2<\/p>\n You can use the Windows PowerShell filtering cmdlets, such as Select-Object, \nWhere-Object, and Sort-Object, to manage CCP data. <\/p>\n The first command uses the Select-Object to assign only the first two nodes in \nthe collection to the $a variable. Because the pipeline operator (|) has \nprecedence over the assignment operator (=), the “get-node | select-object \nfirst 2” part of the command is completed first and the results are assigned \nto the $a variable.<\/p>\n The second command displays the two nodes that are stored in $a.<\/p>\n PS ccp:\\> $a = get-node | select-object -first 2 \nPS ccp:\\> $a<\/p>\n Name Status Proc Idle \n—- —— —- —- \nHPC-DEMO-CN-11 Ready 2 2 \nHPC-DEMO-CN-12 Ready 2 2<\/p>\n Suspend-Node: Suspends ready nodes. This changes their status from Ready to \nPaused.<\/p>\n The following command uses the Select-Object cmdlet and its First parameter to \nselect only the first three nodes returned by Get-Node. The second pipeline \noperator in the command sends the objects representing the three nodes to \nSuspend-Node, which pauses the nodes. <\/p>\n The second Get-Node command confirms that Suspend-Node affected only the first \nthree nodes.<\/p>\n PS ccp:\\> get-node | select-object -first 3 | Suspend-Node \nPS ccp:\\> get-node<\/p>\n Name Status Proc Idle \n—- —— —- —- \nHPC-DEMO-CN-11 Paused 2 2 \nHPC-DEMO-CN-12 Paused 2 2<\/p>\n Get-Job: Gets all of the jobs on the head node or any nodes under the head node.<\/p>\n This command gets all of the jobs on the default head node, that is, the value \nof the CCP_SCHEDULER parameter. <\/p>\n PS ccp:\\> get-job<\/p>\n ID SubmitBy Name Status Priority \n— ——– —- —— ——– \n96 CCP\\USER1 Job 1 Failed Normal<\/p>\n Restart-Job: Restarts jobs and returns them to the queue. <\/p>\n This command gets all of the jobs under the head node. It uses the pipeline \noperator (|) to send the jobs to the Restart-Job cmdlet, which restarts any jobs \nthat not started. As a result, a job that had failed is now requeued.<\/p>\n Unlike the Start-Job cmdlet, the Restart-Job cmdlets starts only jobs that were \nstarted, but failed, were cancelled, or were suspended.<\/p>\n PS ccp:\\> get-job | restart-job \nPS ccp:\\> get-job<\/p>\n ID SubmitBy Name Status Priority \n— ——– —- —— ——– \n96 CCP\\USER1 Job 1 Queued Normal<\/p>\n Stop-Job: Stops and cancels jobs.<\/p>\n This command gets all of the jobs under the head node. It uses the pipeline \noperator (|) to send the jobs to the Stop-Job cmdlet, which stops the jobs that \nit receives. As a result, a job that had been queued is now cancelled.<\/p>\n The second command uses Get-Job to display the cancelled jobs.<\/p>\n PS ccp:\\> get-job | stop-job PS ccp:\\> get-job<\/p>\n ID SubmitBy Name Status Priority \n— ——– —- —— ——– \n96 CCP\\USER1 Job 1 Cancelled Normal<\/p>\n Get-Task: Gets the tasks in one or more jobs.<\/p>\n This command gets the tasks in a job and displays them in order by task ID.<\/p>\n This command uses the Get-Job cmdlet to get the jobs under the head node. It \nuses array notation to select the second job ([1] in a zero-based array). The \npipeline operator (|) sends the job to the Get-Task cmdlet, which gets all of \nthe tasks in the job and sends them to the Sort-Object cmdlet, which sorts them \nin order by task ID.<\/p>\n By default, tasks are displayed in the order that they are discovered.<\/p>\n PS ccp:\\> (get-job)[1] | get-task | sort-object -property id <\/p>\n ID Status Name CommandLine \n— —— —- ———– \n1 Finished CCPDemo 10K Tasks Group 00 echo 1 \n2 Finished CCPDemo 10K Tasks Group 00 echo 2 \n… \n9998 Queued CCPDemo 10K Tasks Group 09 echo 998 \n9999 Queued CCPDemo 10K Tasks Group 09 echo 999 \n1… Queued CCPDemo 10K Tasks Group 09 echo 1000<\/p>\n This command gets the tasks in a selected job and uses the Where-Object cmdlet \nto select only the tasks with IDs greater than 500 and less than 530.<\/p>\n The Where-Object command uses the “$_.” notation, which refers to the current \nobject in the pipeline. The pipeline operator sends objects down the pipeline \none at a time. The “$_.” notation indicates that the operation should be \nperformed on each object as it arrives from the pipeline. When all objects have \nbeen processed, the results are sent down the pipeline to the next cmdlet.<\/p>\n PS ccp:\\> (get-job)[1] | get-task | where-object { ($_.id -gt 500) \u00a8Cand \n($_.id – lt 530)}<\/p>\n ID Status Name CommandLine \n— —— —- ———– \n521 Queued CCPDemo 10K Tasks Group 00 echo 521 \n522 Queued CCPDemo 10K Tasks Group 00 echo 522 \n… \n529 Queued CCPDemo 10K Tasks Group 00 echo 529 \n501 Finished CCPDemo 10K Tasks Group 00 echo 501 \n502 Finished CCPDemo 10K Tasks Group 00 echo 502 \n… \n520 Finished CCPDemo 10K Tasks Group 00 echo 520<\/p>\n Stop-Task: Stops one or more tasks. <\/p>\n The first command in this series stops any queued tasks in a selected job that \nhave IDs between 500 and 530 (exclusive). It uses the Get-Job cmdlet to get the \njobs in the second job in the system (job [1] in a zero-based array) and the \nGet-Task cmdlet to get the tasks in that job. It uses the Where-Object cmdlet to \nselect tasks with a status of “queued” and a task ID between 500 and 530. It \nsends the selected tasks to the Stop-Task cmdlet, which stops them.<\/p>\n The second command displays the tasks with task IDs between 500 and 530. The \nresults show that the affected tasks are cancelled.<\/p>\n PS ccp:\\> (get-job )[1] | get-task | where-object { ($_.id -gt 500) -and \n($_.id – lt 530) -and ($_.status -eq “queued”)} | stop-task <\/p>\n PS ccp:\\> (get-job)[1] | get-task | where-object { ($_.id -gt 500) -and \n($_.id – lt 530)}<\/p>\n ID Status Name CommandLine \n— —— —- ———– \n501 Finished CCPDemo 10K Tasks Group 00 echo 501 \n502 Finished CCPDemo 10K Tasks Group 00 echo 502 \n… \n520 Finished CCPDemo 10K Tasks Group 00 echo 520 \n521 Cancelled CCPDemo 10K Tasks Group 00 echo 521 \n… \n528 Cancelled CCPDemo 10K Tasks Group 00 echo 528 \n529 Cancelled CCPDemo 10K Tasks Group 00 echo 529<\/p>\n Restart-Task: Restarts (or starts) tasks. <\/p>\n The first command in this series starts the tasks in a selected job that have \nIDs between 500 and 530 (exclusive) and a status of “Cancelled”. It uses the \nGet-Job cmdlet to get the jobs in the second job in the system (job [1] in a \nzero-based array) and the Get-Task cmdlet to get the tasks in that job. It uses \nthe Where-Object cmdlet to select tasks with a status of “cancelled” and a task \nID between 500 and 530. It sends the selected tasks to the Restart-Task cmdlet, \nwhich starts them.<\/p>\n The second command displays the tasks with task IDs between 500 and 530. The \nresults show that the affected tasks are requeued.<\/p>\n PS ccp:\\> (get-job)[1] | get-task | where-object { ($_.id -gt 500) -and \n($_.id – lt 530) -and ($_.status -eq “cancelled”)} | Restart-Task\nPS ccp:\\> (get-job)[1] | get-task | where-object { ($_.id -gt 500) -and \n($_.id – lt 530)}<\/p>\n ID Status Name CommandLine \n— —— —- ———– \n501 Finished CCPDemo 10K Tasks Group 00 echo 501 \n… \n519 Finished CCPDemo 10K Tasks Group 00 echo 519 \n520 Finished CCPDemo 10K Tasks Group 00 echo 520 \n521 Queued CCPDemo 10K Tasks Group 00 echo 521 \n522 Queued CCPDemo 10K Tasks Group 00 echo 522 \n… \n529 Queued CCPDemo 10K Tasks Group 00 echo 529<\/p>\n New-Job: Creates a new job.<\/p>\n The first command in this series creates a new job and stores it in the $j \nvariable. <\/p>\n The second command names the job “CCPDemo”. It uses the