Partager via

Invoke-DscResource

Module:
PSDesiredStateConfiguration Module

Exécute une méthode d’une ressource DSC (Desired State Configuration) PowerShell spécifiée.

Syntaxe

Default (Par défaut) 

Invoke-DscResource
    [-Name] <String>
    [[-ModuleName] <ModuleSpecification>]
    [-Method] <String>
    [-Property] <Hashtable>
    [<CommonParameters>]

Description

L’applet Invoke-DscResource de commande exécute une méthode d’une ressource DSC (Desired State Configuration) PowerShell spécifiée.

Cette applet de commande appelle directement une ressource DSC, sans créer de document de configuration. À l’aide de cette applet de commande, les produits de gestion de la configuration peuvent gérer Windows ou Linux avec des ressources DSC.

Cette applet de commande ne fonctionne pas avec les ressources composites. Les ressources composites sont des configurations paramétrables. L’utilisation de ressources composites nécessite le gestionnaire de configuration local.

Exemples

Exemple 1 : Appeler la méthode Set d’une ressource en spécifiant ses propriétés obligatoires

Cet exemple appelle la méthode Set d’une ressource nommée WindowsProcess et fournit les propriétés Path et Arguments obligatoires pour démarrer le processus Windows spécifié.

Invoke-DscResource -Name WindowsProcess -Method Set -ModuleName PSDesiredStateConfiguration -Property @{
    Path      = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
    Arguments = ''
}

Exemple 2 : Appeler la méthode test d’une ressource pour un module spécifié

Cet exemple appelle la méthode Test d’une ressource nommée WindowsProcess, qui se trouve dans le module nommé PSDesiredStateConfiguration.

$SplatParam = @{
    Name       = 'WindowsProcess'
    ModuleName = 'PSDesiredStateConfiguration'
    Method     = 'Test'
    Property   = @{
        Path      = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'
        Arguments = ''
    }
}

Invoke-DscResource @SplatParam

Paramètres

-Method

Spécifie la méthode de la ressource appelée par cette applet de commande. Les valeurs acceptables pour ce paramètre sont : Get, Set et Test.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:Get, Set, Test
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:2
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ModuleName

Spécifie le nom du module fournissant la ressource DSC spécifiée à appeler.

Propriétés du paramètre

Type:ModuleSpecification
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:1
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Name

Spécifie le nom de la ressource DSC à appeler.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Property

Spécifie le nom de la propriété de ressource et sa valeur dans une table de hachage en tant que clé et valeur, respectivement.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:3
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

String

ModuleSpecification

Sorties

Object

Notes

  • Dans Windows PowerShell 5.1, les ressources s’exécutent sous le contexte système, sauf si elles sont spécifiées avec le contexte utilisateur à l’aide de la clé PsDscRunAsCredential. Dans PowerShell 7.0, les ressources s’exécutent dans le contexte de l’utilisateur et PsDscRunAsCredential n’est plus pris en charge. L’utilisation de cette clé entraîne la levée d’une exception par l’applet de commande.

  • À partir de PowerShell 7, Invoke-DscResource ne prend plus en charge l’appel des ressources WMI DSC. Cela inclut les ressources File et Log dans PSDesiredStateConfiguration.