commands

^

Save-DbaCommunitySoftware

Author Andreas Jordan, @JordanOrdix
Availability Windows, Linux, macOS

 

Synopsis

Download and extract software from Github to update the local cached version of that software.

Description

Download and extract software from Github to update the local cached version of that software. This command is run from inside of Install-Dba* and Update-Dba* commands to update the local cache if needed.

Syntax

Save-DbaCommunitySoftware
    [[-Software] <String>]
    [[-Branch] <String>]
    [[-LocalFile] <String>]
    [[-Url] <String>]
    [[-LocalDirectory] <String>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Save-DbaCommunitySoftware -Software MaintenanceSolution

Updates the local cache of Ola Hallengren's Solution objects.

Optional Parameters

-Software

Name of the software to download. Options include:

Alias
Required False
Pipeline false
Default Value
Accepted Values MaintenanceSolution,FirstResponderKit,DarlingData
-Branch

Specifies the branch. Defaults to master or main. Can only be used if Software is used.

Alias
Required False
Pipeline false
Default Value
-LocalFile

Specifies the path to a local file to install from instead of downloading from Github.

Alias
Required False
Pipeline false
Default Value
-Url

Specifies the URL to download from. Is not needed if Software is used.

Alias
Required False
Pipeline false
Default Value
-LocalDirectory

Specifies the local directory to extract the downloaded file to. Is not needed if Software is used.

Alias
Required False
Pipeline false
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Save-DbaCommunitySoftware on GitHub.
Want to see the Bill Of Health for this command? Check out Save-DbaCommunitySoftware.