en-US/about_ChocolateyPackage.help.txt
|
.NAME
ChocolateyPackage .SYNOPSIS The ChocolateyPackage DSC resource is used to install or remove chocolatey packages. .DESCRIPTION The ChocolateyPackage DSC Resource helps with chocolatey package management. .PARAMETER Ensure Required - Ensure .PARAMETER Name Key - String The name of the ChocolateyPackage to set in the desired state. .PARAMETER Version Write - String The version of the package to install. If not set, it will only ensure the package is present/absent. If set to latest, it will always make sure the latest version available on the source is the one installed. If set to a version it will try to compare and make sure the installed version is greater or equal than the one desired. .PARAMETER ChocolateyOptions Write - hashtable Chocolatey parameters as per the Install or Update chocolateyPackage commands. .PARAMETER Credential Write - PSCredential .PARAMETER UpdateOnly Read - bool Only update the package if present. When absent do not attempt to install. .PARAMETER Reasons Read - ChocolateyReason[] Reason for compliance or non-compliance returned by the Get method. .EXAMPLE 1 This is an unofficial module with DSC resource to Install and configure Chocolatey. configuration Example { Import-DscResource -ModuleName Chocolatey Node localhost { ChocolateyPackage Putty { Ensure = 'Present' Name = 'Putty' Version = 'Latest' ChocolateyOptions = @{ source = 'https://chocolatey.org/api/v2/' } } } } .EXAMPLE 2 This is an unofficial module with DSC resource to Install and configure Chocolatey. configuration Example { Import-DscResource -ModuleName Chocolatey Node localhost { ChocolateyPackage Putty { Ensure = 'Absent' Name = 'Putty' } } } .EXAMPLE 3 This is an unofficial module with DSC resource to Install and configure Chocolatey. configuration Example { Import-DscResource -ModuleName Chocolatey Node localhost { ChocolateyPackage Putty { Ensure = 'Present' Name = 'Putty' ChocolateyOptions = @{ source = 'https://chocolatey.org/api/v2/' } } } } |