Invoke-DscResource

  • Reference
Modul:
PSDesiredStateConfiguration

Spustí metodu zadaného prostředku powershellového Desired State Configuration (DSC).

Syntax

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

Description

Rutina Invoke-DscResource spustí metodu zadaného prostředku powershellového Desired State Configuration (DSC).

Tato rutina vyvolá prostředek DSC přímo bez vytvoření konfiguračního dokumentu. Pomocí této rutiny můžou produkty pro správu konfigurace spravovat windows nebo Linux s prostředky DSC.

Poznámka

Před verzí PSDesiredStateConfiguration 2.0.6 vyžaduje použití Invoke-DscResource v PowerShellu 7 povolení experimentální funkce PowerShellu. Pokud chcete rutinu použít ve verzích 2.0.0 až 2.0.5, musíte ji povolit pomocí následujícího příkazu.

Enable-ExperimentalFeature PSDesiredStateConfiguration.InvokeDscResource

Příklady

Příklad 1: Vyvolání metody Set prostředku zadáním povinných vlastností

Tento příklad vyvolá metodu Set prostředku s názvem WindowsProcess a poskytuje povinné path a argumenty vlastnosti pro spuštění zadaného procesu Systému Windows.

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

Příklad 2: Vyvolání metody Test prostředku pro zadaný modul

Tento příklad vyvolá metodu Test prostředku s názvem WindowsProcess, který je v modulu s názvem PSDesiredStateConfiguration.

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

Invoke-DscResource @SplatParam

Parametry

-Method

Určuje metodu prostředku, který tato rutina vyvolá. Přijatelné hodnoty pro tento parametr jsou: Get, Set a Test.

Type:String
Accepted values:Get, Set, Test
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ModuleName

Určuje název modulu poskytujícího zadaný prostředek DSC, který se má vyvolat.

Type:ModuleSpecification
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Určuje název prostředku DSC, který se má vyvolat.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Property

Určuje název vlastnosti prostředku a její hodnotu v tabulce hash jako klíč a hodnotu v uvedeném pořadí.

Type:Hashtable
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

String

ModuleSpecification

Výstupy

Object

Poznámky

  • V Windows PowerShell 5.1 se prostředky spouštěly v kontextu systému, pokud nejsou zadány s kontextem uživatele pomocí klíče PsDscRunAsCredential. V PowerShellu 7.0 se prostředky spouští v kontextu uživatele a PsDscRunAsCredential se už nepodporuje. Použití tohoto klíče způsobí, že rutina vyvolá výjimku.

  • Od PowerShellu 7 Invoke-DscResource už nepodporuje vyvolání prostředků WMI DSC. To zahrnuje prostředky File a Log v PSDesiredStateConfiguration.