Compartir a través de

Invoke-DscResource

Módulo:
PSDesiredStateConfiguration Module

Ejecuta un método de un recurso de Configuración de estado deseado (DSC) de PowerShell especificado.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

El cmdlet Invoke-DscResource ejecuta un método de un recurso de Configuración de estado deseado (DSC) de PowerShell especificado.

Este cmdlet invoca directamente un recurso de DSC sin crear un documento de configuración. Con este cmdlet, los productos de administración de configuración pueden administrar windows o Linux con recursos de DSC.

Este cmdlet no funciona con recursos compuestos. Los recursos compuestos son configuraciones parametrizadas. El uso de recursos compuestos requiere el LCM.

Ejemplos

Ejemplo 1: Invocar el método Set de un recurso especificando sus propiedades obligatorias

En este ejemplo se invoca el método Set de un recurso denominado WindowsProcess y se proporcionan las propiedades obligatorias Path y Arguments para iniciar el proceso de Windows especificado.

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

Ejemplo 2: Invocar el método Test de un recurso para un módulo especificado

En este ejemplo se invoca el método Test de de un recurso denominado WindowsProcess, que se encuentra en el módulo denominado PSDesiredStateConfiguration.

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

Invoke-DscResource @SplatParam

Parámetros

-Method

Especifica el método del recurso al que invoca este cmdlet. Los valores aceptables para este parámetro son: Get, Sety Test.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Valores aceptados:Get, Set, Test
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:2
Mandatory:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ModuleName

Especifica el nombre del módulo que proporciona el recurso DSC especificado que se va a invocar.

Propiedades del parámetro

Tipo:ModuleSpecification
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Mandatory:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Name

Especifica el nombre del recurso de DSC que se va a invocar.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Property

Especifica el nombre de la propiedad de recurso y su valor en una tabla hash como clave y valor, respectivamente.

Propiedades del parámetro

Tipo:Hashtable
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:3
Mandatory:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

String

ModuleSpecification

Salidas

Object

Notas

  • En los recursos de Windows PowerShell 5.1 se ejecutó en el contexto del sistema, a menos que se especifique con el contexto de usuario mediante la clave PsDscRunAsCredential. En PowerShell 7.0, los recursos se ejecutan en el contexto del usuario y ya no se admite psDscRunAsCredential. El uso de esta clave hace que el cmdlet produzca una excepción.

  • A partir de PowerShell 7, Invoke-DscResource ya no admite la invocación de recursos de DSC de WMI. Esto incluye los recursos de de archivos de y Log en PSDesiredStateConfiguration.