Поделиться через

Invoke-DscResource

Модуль:
PSDesiredStateConfiguration Module

Запускает метод указанного ресурса конфигурации требуемого состояния (DSC) PowerShell.

Синтаксис

Default (по умолчанию) 

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

Описание

Командлет Invoke-DscResource выполняет метод указанного ресурса конфигурации требуемого состояния (DSC) PowerShell.

Этот командлет вызывает ресурс DSC напрямую, не создавая документ конфигурации. С помощью этого командлета продукты для управления конфигурацией могут управлять Windows или Linux с помощью ресурсов DSC.

Этот командлет не работает с составными ресурсами. Составные ресурсы — это параметризованные конфигурации. Для использования составных ресурсов требуется LCM.

Примеры

Пример 1. Вызов метода Set ресурса путем указания его обязательных свойств

В этом примере вызывается метод Set ресурса с именем WindowsProcess и предоставляются обязательные свойства Path и Arguments для запуска указанного процесса Windows.

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

Пример 2. Вызов метода test ресурса для указанного модуля

В этом примере вызывается метод Test ресурса с именем WindowsProcess, который находится в модуле с именем PSDesiredStateConfiguration.

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

Invoke-DscResource @SplatParam

Параметры

-Method

Указывает метод ресурса, вызываемого этим командлетом. Допустимыми значениями для этого параметра являются: Get, Set и Test.

Свойства параметра

Тип:String
Default value:None
Допустимые значения:Get, Set, Test
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:2
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ModuleName

Указывает имя модуля, предоставляющего указанный ресурс DSC для вызова.

Свойства параметра

Тип:ModuleSpecification
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:False
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Name

Указывает имя вызываемого ресурса DSC.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Property

Указывает имя свойства ресурса и его значение в хэш-таблице в качестве ключа и значения соответственно.

Свойства параметра

Тип:Hashtable
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:3
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

String

ModuleSpecification

Выходные данные

Object

Примечания

  • В Windows PowerShell 5.1 ресурсы запускались в системном контексте, если не указан пользовательский контекст с использованием ключа PsDscRunAsCredential. В PowerShell 7.0 ресурсы выполняются в контексте пользователя, и PsDscRunAsCredential больше не поддерживается. Использование этого ключа приводит к тому, что командлет генерирует исключение.

  • Начиная с PowerShell 7, Invoke-DscResource больше не поддерживает вызов ресурсов WMI DSC. Это включает в себя ресурсы File и Log в PSDesiredStateConfiguration.