Comment obtenir l’état de la restauration du système avec PowerShell pour les professionnels de l’informatique

Vous voulez savoir comment obtenir l’état de la restauration du système avec PowerShell? La restauration du système est une fonction essentielle des systèmes d’exploitation Windows, qui offre un filet de sécurité aux utilisateurs en leur permettant de rétablir l’état antérieur de leur système en cas de dysfonctionnement ou de modifications indésirables.

Pour les professionnels de l’informatique et les fournisseurs de services gérés (MSP), la surveillance de l’état de la restauration du système sur plusieurs appareils est essentielle pour maintenir la santé et la fiabilité du système. Le script PowerShell fourni est un outil puissant conçu pour vérifier l’état de la restauration du système sur un appareil et, éventuellement, enregistrer le résultat dans un champ personnalisé.

Contexte

Dans un paysage où la stabilité du système est primordiale, la restauration du système offre un service précieux en permettant une récupération rapide des défaillances du système. Pour les professionnels de l’informatique, en particulier ceux qui gèrent de nombreux appareils, s’assurer que la restauration du système est activée peut permettre d’éviter des temps d’arrêt importants et des pertes de données.

Ce script simplifie le processus de vérification de l’état de la restauration du système et s’intègre parfaitement à NinjaOne, une solution de gestion informatique populaire, pour enregistrer l’état dans un champ personnalisé si nécessaire.

Le script

#Requires -Version 5.1

<#
.SYNOPSIS
    Checks the status of System Restore on the device.
.DESCRIPTION
    Checks the status of System Restore on the device.
    When a Custom Field is specified the results will be saved to the Custom Field as "Enabled" or "Disabled".

.EXAMPLE
    (No Parameters)
    ## EXAMPLE OUTPUT WITHOUT PARAMS ##
    [Info] System Restore is Disabled

PARAMETER: -CustomFieldName "SystemRestore"
    Saves the results to a custom field.
.EXAMPLE
    -CustomFieldName "SystemRestore"
    ## EXAMPLE OUTPUT WITH CustomFieldName ##
    [Info] Attempting to set Custom Field 'SystemRestore'.
    [Info] Successfully set Custom Field 'SystemRestore'!
    [Info] System Restore is Enabled

.NOTES
    Minimum OS Architecture Supported: Windows 10, Windows Server 2016
    Release Notes: Renamed Script
By using this script, you indicate your acceptance of the following legal terms as well as our Terms of Use at https://www.ninjaone.com/terms-of-use.
    Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms. 
    Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party. 
    Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library or website belonging to or under the control of any other software provider. 
    Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations. 
    Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks. 
    Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script. 
    EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).
#>

[CmdletBinding()]
param (
    [Parameter()]
    [String]$CustomFieldName
)

begin {
    function Set-NinjaProperty {
        [CmdletBinding()]
        Param(
            [Parameter(Mandatory = $True)]
            [String]$Name,
            [Parameter()]
            [String]$Type,
            [Parameter(Mandatory = $True, ValueFromPipeline = $True)]
            $Value,
            [Parameter()]
            [String]$DocumentName
        )
    
        $Characters = $Value | Measure-Object -Character | Select-Object -ExpandProperty Characters
        if ($Characters -ge 10000) {
            throw [System.ArgumentOutOfRangeException]::New("Character limit exceeded, value is greater than 10,000 characters.")
        }
        
        # If we're requested to set the field value for a Ninja document we'll specify it here.
        $DocumentationParams = @{}
        if ($DocumentName) { $DocumentationParams["DocumentName"] = $DocumentName }
        
        # This is a list of valid fields that can be set. If no type is given, it will be assumed that the input doesn't need to be changed.
        $ValidFields = "Attachment", "Checkbox", "Date", "Date or Date Time", "Decimal", "Dropdown", "Email", "Integer", "IP Address", "MultiLine", "MultiSelect", "Phone", "Secure", "Text", "Time", "URL", "WYSIWYG"
        if ($Type -and $ValidFields -notcontains $Type) { Write-Warning "$Type is an invalid type! Please check here for valid types. https://ninjarmm.zendesk.com/hc/en-us/articles/16973443979789-Command-Line-Interface-CLI-Supported-Fields-and-Functionality" }
        
        # The field below requires additional information to be set
        $NeedsOptions = "Dropdown"
        if ($DocumentName) {
            if ($NeedsOptions -contains $Type) {
                # We'll redirect the error output to the success stream to make it easier to error out if nothing was found or something else went wrong.
                $NinjaPropertyOptions = Ninja-Property-Docs-Options -AttributeName $Name @DocumentationParams 2>&1
            }
        }
        else {
            if ($NeedsOptions -contains $Type) {
                $NinjaPropertyOptions = Ninja-Property-Options -Name $Name 2>&1
            }
        }
        
        # If an error is received it will have an exception property, the function will exit with that error information.
        if ($NinjaPropertyOptions.Exception) { throw $NinjaPropertyOptions }
        
        # The below types require values not typically given in order to be set. The below code will convert whatever we're given into a format ninjarmm-cli supports.
        switch ($Type) {
            "Checkbox" {
                # While it's highly likely we were given a value like "True" or a boolean datatype it's better to be safe than sorry.
                $NinjaValue = [System.Convert]::ToBoolean($Value)
            }
            "Date or Date Time" {
                # Ninjarmm-cli expects the GUID of the option to be selected. Therefore, the given value will be matched with a GUID.
                $Date = (Get-Date $Value).ToUniversalTime()
                $TimeSpan = New-TimeSpan (Get-Date "1970-01-01 00:00:00") $Date
                $NinjaValue = $TimeSpan.TotalSeconds
            }
            "Dropdown" {
                # Ninjarmm-cli is expecting the guid of the option we're trying to select. So we'll match up the value we were given with a guid.
                $Options = $NinjaPropertyOptions -replace '=', ',' | ConvertFrom-Csv -Header "GUID", "Name"
                $Selection = $Options | Where-Object { $_.Name -eq $Value } | Select-Object -ExpandProperty GUID
        
                if (-not $Selection) {
                    throw [System.ArgumentOutOfRangeException]::New("Value is not present in dropdown")
                }
        
                $NinjaValue = $Selection
            }
            default {
                # All the other types shouldn't require additional work on the input.
                $NinjaValue = $Value
            }
        }
        
        # We'll need to set the field differently depending on if its a field in a Ninja Document or not.
        if ($DocumentName) {
            $CustomField = Ninja-Property-Docs-Set -AttributeName $Name -AttributeValue $NinjaValue @DocumentationParams 2>&1
        }
        else {
            $CustomField = Ninja-Property-Set -Name $Name -Value $NinjaValue 2>&1
        }
        
        if ($CustomField.Exception) {
            throw $CustomField
        }
    }
    if ($env:customFieldName -and $env:customFieldName -ne "null") {
        $CustomFieldName = $env:customFieldName
    }
}
process {
    # If the registry value is 1, System Restore is enabled.
    $RegValue = Get-ItemPropertyValue -Path "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion\SystemRestore\" -Name "RPSessionInterval" -ErrorAction SilentlyContinue

    $SystemRestoreStatus = if ($RegValue -ge 1) {
        # If either of the above conditions are met, System Restore is enabled.
        Write-Output "Enabled"
    }
    else {
        Write-Output "Disabled"
    }

    # If a Custom Field Name is provided, set the Custom Field with the System Restore Status.
    if ($CustomFieldName) {
        try {
            Write-Host "[Info] Attempting to set Custom Field '$CustomFieldName'."
            Set-NinjaProperty -Name $CustomFieldName -Value $SystemRestoreStatus
            Write-Host "[Info] Successfully set Custom Field '$CustomFieldName'!"
        }
        catch {
            Write-Host "[Error] Failed to set Custom Field '$CustomFieldName'."
        }
    }
    Write-Host "[Info] System Restore is $SystemRestoreStatus"
}
end {
    
    
    
}

 

Description détaillée

Voyons maintenant comment fonctionne ce script PowerShell.

Initialisation du script

Le script commence par des métadonnées sous forme de commentaires, détaillant son objectif, des exemples d’utilisation et les systèmes d’exploitation pris en charge. Il prend en charge Windows 10 et Windows Server 2016, ce qui indique qu’il est conçu pour les environnements modernes.

Cette ligne indique que le script nécessite la version 5.1 ou supérieure de PowerShell.

Paramètres

Le script définit un seul paramètre facultatif, CustomFieldName, qui permet aux utilisateurs de spécifier un nom de champ personnalisé dans lequel le statut sera enregistré.

Fonction d’aide : Set-NinjaProperty

Le script comprend une fonction d’aide, Set-NinjaProperty, qui est responsable de la définition de la valeur du champ personnalisé dans NinjaOne. Cette fonction traite différents types de données et valide les entrées en fonction de critères prédéfinis.

Logique principale

Le script vérifie ensuite le registre pour déterminer si la restauration du système est activée. Il lit la valeur RPSessionInterval dans la clé de registre HKLM:NSOFTWARENMicrosoftNWindows NTNCurrentVersionNSystemRestore. Si la valeur est supérieure ou égale à 1, la restauration du système est considérée comme activée.

Si un nom de champ personnalisé est fourni, le script tente de définir ce champ avec l’état de la restauration du système à l’aide de la fonction Set-NinjaProperty.

Cas d’utilisation potentiels

Imaginez un professionnel de l’informatique qui gère un parc d’appareils Windows pour une entreprise de taille moyenne. Il est essentiel de s’assurer que la restauration du système est activée sur tous les appareils pour une récupération rapide en cas de problèmes potentiels. Le professionnel peut utiliser ce script en conjonction avec NinjaOne pour vérifier et enregistrer régulièrement l’état de la restauration du système sur tous les appareils, ce qui lui permet d’agir rapidement si la fonction est désactivée sur l’un d’entre eux.

Comparaisons

Il existe plusieurs méthodes pour vérifier l’état de la restauration du système, par exemple en utilisant l’interface graphique ou différents utilitaires de ligne de commande. Cependant, ce script PowerShell offre une approche rationalisée et automatisée qui s’intègre à NinjaOne, offrant ainsi une solution évolutive aux professionnels de l’informatique qui gèrent plusieurs systèmes. Contrairement aux contrôles manuels, ce script peut être programmé et exécuté sur tous les appareils, ce qui permet de gagner du temps et de réduire les erreurs humaines.

FAQ

Q : Ce script peut-il activer la restauration du système si elle est désactivée ?

R : Non, le script est conçu pour vérifier l’état de la restauration du système et l’enregistrer. L’activation de la restauration du système nécessiterait des commandes supplémentaires.

Q : Le script est-il compatible avec les anciennes versions de Windows ?

R : Le script est conçu pour Windows 10 et Windows Server 2016. La compatibilité avec les versions antérieures n’est pas garantie.

Q : Que se passe-t-il si le nom du champ personnalisé n’est pas fourni ?

R : Si aucun nom de champ personnalisé n’est fourni, le script affichera simplement l’état de la restauration du système sans tenter de l’enregistrer.

Implications

Connaître l’état de la restauration du système sur tous les appareils gérés permet aux professionnels de l’informatique de s’assurer que les systèmes sont récupérables en cas de défaillance. Cette approche proactive peut considérablement améliorer la fiabilité du système et réduire l’impact des problèmes potentiels.

Recommandations

Lorsque vous utilisez ce script, veillez à ce qu’il soit exécuté régulièrement afin de suivre l’état de la restauration du système. L’intégrer dans une stratégie plus large de surveillance et de gestion du système afin d’en préserver la santé. Testez toujours le script dans un environnement contrôlé avant de le déployer sur plusieurs appareils afin d’éviter les problèmes inattendus.

Conclusion

NinjaOne offre des outils robustes pour la gestion informatique, et des scripts comme celui-ci renforcent ses capacités en fournissant des solutions automatisées et évolutives pour les contrôles de routine. S’assurer que la restauration du système est activée sur tous les appareils n’est qu’une des nombreuses tâches qui peuvent être rationalisées avec NinjaOne, aidant les professionnels de l’informatique à maintenir l’intégrité, la fiabilité et l’efficacité du système.