Install-DbaMultiTool

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

Synopsis

Installs or updates the DBA MultiTool stored procedures.

Description

Downloads, extracts and installs the DBA MultiTool stored procedures.

DBA MultiTool links:
https://dba-multitool.org
https://github.com/LowlyDBA/dba-multitool/

Syntax

Install-DbaMultiTool
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Branch] <String>]
    [[-Database] <Object>]
    [[-LocalFile] <String>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Install-DbaMultiTool -SqlInstance server1 -Database main

Logs into server1 with Windows authentication and then installs the DBA MultiTool in the main database.

Example: 2

PS C:\> Install-DbaMultiTool -SqlInstance server1\instance1 -Database DBA

Logs into server1\instance1 with Windows authentication and then installs the DBA MultiTool in the DBA database.

Example: 3

PS C:\> Install-DbaMultiTool -SqlInstance server1\instance1 -Database main -SqlCredential $cred

Logs into server1\instance1 with SQL authentication and then installs the DBA MultiTool in the main database.

Example: 4

PS C:\> Install-DbaMultiTool -SqlInstance sql2016\standardrtm, sql2016\sqlexpress, sql2014

Logs into sql2016\standardrtm, sql2016\sqlexpress and sql2014 with Windows authentication and then installs the DBA MultiTool in the main database.

Example: 5

PS C:\> $servers = "sql2016\standardrtm", "sql2016\sqlexpress", "sql2014"
PS C:\> $servers | Install-DbaMultiTool

Logs into sql2016\standardrtm, sql2016\sqlexpress and sql2014 with Windows authentication and then installs the DBA MultiTool in the main database.

Example: 6

PS C:\> Install-DbaMultiTool -SqlInstance sql2016 -Branch development

Installs the development branch version of the DBA MultiTool in the main database on sql2016 instance.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Branch

Specifies an alternate branch of the DBA MultiTool to install.
Allowed values:
main (default)
development

-Database

Specifies the database to install DBA MultiTool stored procedures into.

-LocalFile

Specifies the path to a local file to install DBA MultiTool from. This should be the zip file as distributed by the maintainers.
If this parameter is not specified, the latest version will be downloaded and installed from https://github.com/LowlyDBA/dba-multitool/.

-Force

If this switch is enabled, the DBA MultiTool will be downloaded from the internet even if previously cached.

-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

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts to confirm actions.