Save-DbaCommunitySoftware

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.

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*, Update-Dba*, Invoke-DbaAzSqlDbTip commands to update the local cache if needed.

In case you don't have internet access on the target computer, you can download the zip files from the following URLs
at another computer, transfer them to the target computer or place them on a network share and then use -LocalFile
to update the local cache:

• MaintenanceSolution: https://github.com/olahallengren/sql-server-maintenance-solution
• FirstResponderKit: https://github.com/BrentOzarULTD/SQL-Server-First-Responder-Kit/releases
• DarlingData: https://github.com/erikdarlingdata/DarlingData
• SQLWATCH: https://github.com/marcingminski/sqlwatch/releases
• WhoIsActive: https://github.com/amachanic/sp_whoisactive/releases
• DbaMultiTool: https://github.com/LowlyDBA/dba-multitool/releases
• AzSqlTips: https://github.com/microsoft/azure-sql-tips/releases/

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.

Example: 2

PS C:\> Save-DbaCommunitySoftware -Software FirstResponderKit -LocalFile \\fileserver\Software\SQL-Server-First-Responder-Kit-20211106.zip

Updates the local cache of the First Responder Kit based on the given file.

Optional Parameters

-Software

Name of the software to download.
Options include:

• MaintenanceSolution: SQL Server Maintenance Solution created by Ola Hallengren (https://ola.hallengren.com)
• FirstResponderKit: First Responder Kit created by Brent Ozar (http://FirstResponderKit.org)
• DarlingData: Erik Darling's stored procedures (https://www.erikdarlingdata.com)
• SQLWATCH: SQL Server Monitoring Solution created by Marcin Gminski (https://sqlwatch.io/)
• WhoIsActive: Adam Machanic's comprehensive activity monitoring stored procedure sp_WhoIsActive (https://github.com/amachanic/sp_whoisactive)
• DbaMultiTool: John McCall's T-SQL scripts for the long haul: optimizing storage, on-the-fly documentation, and general administrative needs (https://dba-multitool.org)
• AzSqlTips: Azure SQL PM team scripts to review Azure SQL Database design, health and performance.
  

-Branch

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

-LocalFile

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

-Url

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

-LocalDirectory

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

-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.

-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.

-Confirm

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