Recurso WindowsPackageCab de DSCDSC WindowsPackageCab Resource

Se aplica a: Windows PowerShell 5.1Applies To: Windows PowerShell 5.1

El recurso WindowsPackageCab de Desired State Configuration (DSC) de Windows PowerShell ofrece un mecanismo para instalar o desinstalar paquetes de archivos .cab de Windows en un nodo de destino.The WindowsPackageCab resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to install or uninstall Windows cabinet (.cab) packages on a target node.

El nodo de destino debe tener instalado el módulo PowerShell de DISM.The target node must have the DISM PowerShell module installed. Para información, consulte Use DISM in Windows PowerShell (Uso de DISM en Windows PowerShell).For information, see Use DISM in Windows PowerShell.

Nota

Esta documentación de este recurso de DSC abarca la versión que se incluye con PowerShell.This documentation of this DSC resource covers the version that is included with PowerShell. El módulo PSDscResources contiene recursos nuevos y actualizados que Microsoft admite oficialmente.The PSDscResources module contains new and updated that are officially supported by Microsoft. El módulo PSDscResources está disponible en la Galería de PowerShell.The PSDscResources module is available from the PowerShell Gallery.

Para obtener más información y documentación actualizada, consulte el archivo Léame en el repositorio de GitHub.For more information and updated documentation, see the README in the GitHub repository.

SintaxisSyntax

{
    Name = [string]
    SourcePath = [string]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    Ensure = [string] { Absent | Present }
    [ PsDscRunAsCredential = [PSCredential] ]
}

PropiedadesProperties

PropiedadProperty DescripciónDescription
NombreName Indica el nombre del paquete para el que quiere garantizar un estado específico.Indicates the name of the package for you want to ensure a specific state.
SourcePathSourcePath Indica la ruta de acceso donde reside el paquete.Indicates the path where the package resides.
LogPathLogPath Indica la ruta de acceso completa donde quiere que el proveedor guarde un archivo de registro para instalar o desinstalar el paquete.Indicates the full path where you want the provider to save a log file to install or uninstall the package.

Propiedades comunesCommon properties

PropiedadProperty DescripciónDescription
DependsOnDependsOn Indica que la configuración de otro recurso debe ejecutarse antes de que se configure este recurso.Indicates that the configuration of another resource must run before this resource is configured. Por ejemplo, si el elemento ID del bloque del script de configuración del recurso que quiere ejecutar primero es ResourceName y su tipo es ResourceType, la sintaxis para usar esta propiedad es DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
EnsureEnsure Indica si el paquete está instalado.Indicates if the package is installed. Establezca esta propiedad en Absent para asegurarse de que el paquete no esté instalado (o se desinstale el paquete si está instalado).Set this property to Absent to ensure the package is not installed (or uninstall the package if it is installed). Establézcala en Present para asegurarse de que el paquete esté instalado.Set it to Present to ensure the package is installed. Ensure es una propiedad obligatoria en el recurso WindowsPackageCab .Ensure is a required property on the WindowsPackageCab resource.
PsDscRunAsCredentialPsDscRunAsCredential Establece la credencial con la que se ejecutará todo el recurso.Sets the credential for running the entire resource as.

EjemploExample

La configuración de ejemplo siguiente toma parámetros de entrada y se asegura de que el archivo .cab especificado en el parámetro $Name esté instalado.The following example configuration takes input parameters, and ensures that the .cab file specified by the $Name parameter is installed.

Configuration Sample_WindowsPackageCab
{
    param
    (
        [Parameter (Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [String]
        $Name,

        [Parameter (Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [String]
        $SourcePath,

        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [String]
        $LogPath
    )

    Import-DscResource -ModuleName 'PSDscResources'

    WindowsPackageCab WindowsPackageCab1
    {
        Name = $Name
        Ensure = 'Present'
        SourcePath = $SourcePath
        LogPath = $LogPath
    }
}