GetSystemRestoreSettings.ps1<\/B><\/P>Param($computer = “localhost”, $help)<\/p>\nfunction funHelp()\n{\n$helpText=@”\nDESCRIPTION:\nNAME: GetOffLineFiles.ps1 \nPrints the offline files config on a local or remote machine.<\/p>\n
PARAMETERS: \n-computer Specifies name of the computer upon which to run the script\n-help prints help file<\/p>\n
SYNTAX:\nGetSystemRestoreSettings.ps1 -computer MunichServer<\/p>\n
Lists system restore config on a computer named MunichServer<\/p>\n
GetSystemRestoreSettings.ps1 <\/p>\n
Lists system restore config on local computer<\/p>\n
GetSystemRestoreSettings.ps1 -help ?<\/p>\n
Displays the help topic for the script<\/p>\n
“@\n$helpText\nexit\n}<\/p>\n
if($help){ funline(“Obtaining help …”) ; funhelp }<\/p>\n
New-Variable -Name SecInDay -option constant -value 86400 \n$objWMI = Get-WmiObject -Namespace root\\default `\n -Class SystemRestoreConfig -computername $computer\nfor($i=0; $i -le 15; $i++)\n{\n Write-Host -ForegroundColor $i “Retrieving System Restore Settings”\n Start-Sleep -Milliseconds 60\n cls\n}<\/p>\n
if($computer -eq “localhost”)\n { \n Write-Host “System Restore Settings on $env:computername”\n }\n ELSE\n { \n Write-Host “System Restore Settings on $computer”\n }<\/p>\n
format-table -InputObject $objWMI -property `\n @{\n Label=”Max disk utilization” ; \nexpression={ “{0:n0}”-f ($_.DiskPercent ) + ” %”} \n},\n @{\n Label=”Scheduled Backup” ; \nexpression={ “{0:n2}”-f ($_.RPGlobalInterval \/ $SecInDay) + ” days”} \n},\n @{\n Label=”Max age of backups” ; \nexpression={ “{0:n2}”-f ($_.RPLifeInterval \/ $SecInDay) + ” days” }\n<\/PRE>\n
BB, there are basically two WMI classes that can be used to manage system restore on a machine. The only thing that is tricky about these classes is that they exist in the Root\\Default<\/B> WMI namespace, which by the way is not the default WMI namespace. The default WMI namespace is Root\\Cimv2<\/B>. (See, we told you it was tricky.) These two WMI classes are listed here:<\/P>\n\n- Systemrestore<\/LI>\n
- Systemrestoreconfig<\/LI><\/UL>\n
In the GetSystemRestoreSettings.ps1<\/B> script, we first use the param<\/B> statement to permit the use of command-line arguments to the script. We define two parameters: -computer<\/B> and \u2013help<\/B>. This will allow us to target a remote computer, and to get Help if required. The \u2013computer<\/B> parameter is set to a default value of localhost<\/B>. This line of code is seen here:<\/P>Param($computer = “localhost”, $help)\n<\/PRE>\nWe then have the funhelp<\/B> function. The funhelp<\/B> function is used to print out a Help file when the script is run with the \u2013help<\/B> parameter specified. To create the Help file, we use the variable $helpText<\/B> and set it equal to a Here-String<\/B>. The Here-String<\/B> allows us to ignore quoting rules while typing out the text in the script. In the Here-String<\/B>, we define a description, the parameters, and the syntax of the script. Once the Here-String<\/B> is created, we then print out the value contained in the $helpText<\/B> variable, and exit the script. This is seen here:<\/P>function funHelp()\n{\n$helpText=@”\nDESCRIPTION:\nNAME: GetOffLineFiles.ps1 \nPrints the offline files config on a local or remote machine.<\/p>\nPARAMETERS: \n-computer Specifies name of the computer upon which to run the script\n-help prints help file<\/p>\n
SYNTAX:\nGetSystemRestoreSettings.ps1 -computer MunichServer<\/p>\n
Lists system restore config on a computer named MunichServer<\/p>\n
GetSystemRestoreSettings.ps1 <\/p>\n
Lists system restore config on local computer<\/p>\n
GetSystemRestoreSettings.ps1 -help ?<\/p>\n
Displays the help topic for the script<\/p>\n
“@\n$helpText\nexit\n}\n<\/PRE>\n
To determine if the script will need to display Help, we look for the presence of the $help<\/B> variable. If we find the $help<\/B> variable, we first call the funline<\/B> function and print out a progress indicator that is underlined. Next, we call the funhelp<\/B> function. This code is seen here:<\/P>if($help){ funline(“Obtaining help …”) ; funhelp }\n<\/PRE>\nWe then create a constant. This constant is called SecInDay<\/B> and is set to a value of 86400. To create a constant, we need to use the New-Variable<\/B> cmdlet and specify the \u2013option<\/B> parameter with the constant<\/B> argument. This is seen here:<\/P>New-Variable -Name SecInDay -option constant -value 86400\n<\/PRE>\nNow it is time to make the connection into WMI. To do this, we use the Get-Wmiobject<\/B> cmdlet and connect to the root\\default<\/B> WMI namespace. We use the \u2013class<\/B> parameter to specify the SystemRestoreConfig<\/B> WMI class name, and the \u2013computername<\/B> parameter to allow us to target a specific computer. We then store the resulting management object in the $objWMI<\/B> variable. This code is seen here:<\/P>$objWMI = Get-WmiObject -Namespace root\\default `\n -Class SystemRestoreConfig -computername $computer\n<\/PRE>\nNext we use the for<\/B> statement to count from 0 to 15 and increment the $i<\/B> variable. In the code block of the for<\/B> statemement, we use the Write-Host<\/B> cmdlet and supply the $i<\/B> variable to the \u2013foregroundcolor<\/B> parameter. We then print out a status prompt, wait for 60 milliseconds, clear the screen, and then repeat. The effect is like a multicolored rolling progress indicator that will grab the users\u2019 attention and alert them to the progress. This section of code is seen here:<\/P>for($i=0; $i -le 15; $i++)\n{\n Write-Host -ForegroundColor $i “Retrieving System Restore Settings”\n Start-Sleep -Milliseconds 60\n cls\n}\n<\/PRE>\nNow we need to decide if we are going to use the computername<\/B> environment variable from the Windows PowerShell PSDrive, or if we will use the value that was supplied to the \u2013computer<\/B> parameter. The reason for this is that the Windows PowerShell PSDrive is only available for the local machine. If the computer is localhost<\/B>, it is local. <\/P>if($computer -eq “localhost”)\n { \n Write-Host “System Restore Settings on $env:computername”\n }\n<\/PRE>\nHowever, if the computer name is some other value, we will use that value instead. This logic is seen here:<\/P>
ELSE\n { \n Write-Host “System Restore Settings on $computer”\n }\n<\/PRE>\nWe next need to format our output. To do this we will use the Format-Table<\/B> cmdlet. In this example we use the \u2013inputobject<\/B> parameter and supply the management<\/B> object stored in the $objWMI<\/B> variable to the cmdlet. Next, we use the \u2013property<\/B> parameter to specify the properties to be listed in the table. The unusual aspect of this script is using a hash table to change the formatting of the printout of the property values. The hash table begins with an at symbol (@<\/B>) and an opening code block. We then specify the label to use and the expression to calculate the property value. When this is printed out, we will report the backup time in days, instead of seconds. We also display the percent disk utilization with the percentage symbol. This section of code is seen here:<\/P>format-table -InputObject $objWMI -property `\n @{\n Label=”Max disk utilization” ; \nexpression={ “{0:n0}”-f ($_.DiskPercent ) + ” %”} \n},\n @{\n Label=”Scheduled Backup” ; \nexpression={ “{0:n2}”-f ($_.RPGlobalInterval \/ $SecInDay) + ” days”} \n},\n @{\n Label=”Max age of backups” ; \nexpression={ “{0:n2}”-f ($_.RPLifeInterval \/ $SecInDay) + ” days” } \n}\n<\/PRE>\nWhen the GetSystemRestoreSettings.ps1<\/B> script is run, this is what is displayed:<\/P>![\"Image](\"http:\/\/img.microsoft.com\/library\/media\/1033\/technet\/images\/scriptcenter\/qanda\/hsg\/2009\/june\/hey0604\/hsg-06-04-09-01.jpg\")
\n
<\/P>\n
BB, that is all there is to the GetSystemRestoreSettings.ps1<\/B> script. This also brings us to the end of Managing User Data week on the Script Center. Join us next week as we begin to reveal the Summer Scripting Games events. Tomorrow we open up the virtual mail bag, and grab a bunch of short answer questions. That\u2019s right, it\u2019s time for another edition of Quick-Hits Friday! See you tomorrow.<\/P>\n
<\/P>\n
Ed Wilson and Craig Liebendorfer, Scripting Guys<\/B><\/P><\/p>\n","protected":false},"excerpt":{"rendered":"
Hey, Scripting Guy! I was looking at System Restore on my Windows Vista computer, and I had an idea. Wouldn\u2019t it be great if I could script the collection of information for System Restore? I would like it to tell me how much disk space is being consumed, as well as when it is scheduled […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[423,3,723,45,725],"class_list":["post-53583","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-backup-and-system-restore","tag-scripting-guy","tag-system-restore","tag-windows-powershell","tag-windows-vista"],"acf":[],"blog_post_summary":"
Hey, Scripting Guy! I was looking at System Restore on my Windows Vista computer, and I had an idea. Wouldn\u2019t it be great if I could script the collection of information for System Restore? I would like it to tell me how much disk space is being consumed, as well as when it is scheduled […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/53583","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=53583"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/53583\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=53583"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=53583"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=53583"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
![\"Hey,](\"https:\/\/devblogs.microsoft.com\/wp-content\/uploads\/sites\/29\/2019\/02\/q-for-powertip.jpg\" "\\"Hey,")
<\/H2>\n![\"Spacer\"](\"https:\/\/devblogs.microsoft.com\/scripting\/wp-content\/uploads\/sites\/29\/2019\/05\/spacer.gif\")
![\"Hey,](\"https:\/\/devblogs.microsoft.com\/wp-content\/uploads\/sites\/29\/2019\/02\/a-for-powertip.jpg\" "\\"Hey,")
\n