Recursos de DSC PackageDSC Package Resource

Se aplica a: Windows PowerShell 4.0, Windows PowerShell 5.xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

El recurso Package de la configuración de estado deseado (DSC) de Windows PowerShell ofrece un mecanismo para instalar o desinstalar paquetes, como los paquetes de Windows Installer y setup.exe, en un nodo de destino.The Package resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to install or uninstall packages, such as Windows Installer and setup.exe packages, on a target node.

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

Package [string] #ResourceName
{
    Name = [string]
    Path = [string]
    ProductId = [string]
    [ Arguments = [string] ]
    [ Credential = [PSCredential] ]
    [ LogPath = [string] ]
    [ ReturnCode = [UInt32[]] ]
    [ 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 which you want to ensure a specific state.
PathPath Indica la ruta de acceso donde reside el paquete.Indicates the path where the package resides.
ProductIdProductId Indica el id. de producto que identifica el paquete.Indicates the product ID that uniquely identifies the package.
ArgumentosArguments Muestra una cadena de argumentos que se pasarán al paquete tal y como se faciliten.Lists a string of arguments that will be passed to the package exactly as provided.
Credential:Credential Proporciona acceso al paquete en un origen remoto.Provides access to the package on a remote source. Esta propiedad no se utiliza para instalar el paquete.This property is not used to install the package. El paquete siempre se instala en el sistema local.The package is always installed on the local system.
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.
ReturnCodeReturnCode Indica el código de retorno esperado.Indicates the expected return code. Si el código de retorno real no a coincide con el valor esperado facilitado aquí, la configuración devolverá un error.If the actual return code does not match the expected value provided here, the configuration will return an error.

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. El valor predeterminado es Present .The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Establece la credencial con la que se ejecutará todo el recurso.Sets the credential for running the entire resource as.

Nota

Se ha agregado la propiedad común PsDscRunAsCredential en WMF 5.0 para permitir la ejecución de cualquier recurso de DSC en el contexto de otras credenciales.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Para obtener más información, vea Uso de las credenciales con recursos de DSC.For more information, see Use Credentials with DSC Resources.

EjemploExample

En este ejemplo se ejecuta al instalador .msi que se encuentra en la ruta de acceso especificada y tiene el identificador de producto especificado.This example runs the .msi installer that is located at the specified path and has the specified product ID.

Configuration PackageTest
{
    Package PackageExample
    {
        Ensure      = "Present"  # You can also set Ensure to "Absent"
        Path        = "$Env:SystemDrive\TestFolder\TestProject.msi"
        Name        = "TestPackage"
        ProductId   = "ACDDCDAF-80C6-41E6-A1B9-8ABD8A05027E"
    }
}