Invoke-DscResource

Runs a method of a specified DSC resource.
Invoke-DscResource [-Name*] <String> [-Method*] {Get | Set | Test} [-ModuleName [<ModuleSpecification>]] -Property*<Hashtable> [<CommonParameters>]

The Invoke-DscResource cmdlet runs a method of a specified Windows PowerShell Desired State Configuration (DSC) resource. Before you run this cmdlet, set the refresh mode of the Local Configuration Manager (LCM) to Disabled.

This cmdlet invokes a DSC resource directly, without creating a configuration document. Using this cmdlet, configuration management products can manage windows by using DSC resources. This cmdlet also enables debugging of resources when the DSC engine or LCM is running with debugging enabled.

Parameters
-Method <String>

Specifies the method of the resource that this cmdlet invokes. The acceptable values for this parameter are: Get, Set, and Test.

-ModuleName [<ModuleSpecification>]

Specifies the name of the module from which this cmdlet invokes the specified resource.

-Name <String>

Specifies the name of the DSC resource to start.

-Property <Hashtable>

Specifies the resource property name and its value in a hash table as key and value, respectively. Use the Get-DscResource cmdlet to discover resource properties and their types.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Outputs

Microsoft.Management.Infrastructure.CimInstance, System.Boolean

Examples
  1. Invoke the Set method of a resource by specifying its mandatory properties:
    PS C:> Invoke-DscResource -Name Log -Method Set -Property @{Message = 'Hello World'}
    

    This command invokes the Set method of a resource named Log and specifies a Message property for it.

  2. Invoke the Test method of a resource for a specified module:
    PS C:> Invoke-DscResource -Name WindowsProcess -Method Test -Property @{Path = 'C:WindowsSystem32WindowsPowerShellv1.0powershell.exe'; Arguments = ''} -ModuleName PSDesiredStateConfiguration
    

    This command invokes the Test method of a resource named WindowsProcess, which is in the module named PSDesiredStateConfiguration.

Related Links

Get-DscConfiguration
Get-DscConfigurationStatus
Get-DscResource
Restore-DscConfiguration
Set-DscLocalConfigurationManager
Start-DscConfiguration
Test-DscConfiguration