commands

^

Install-DbaMultiTool

Author John McCall (@lowlydba), https://lowlydba.com/
Availability Windows, Linux, macOS

 

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 master

Logs into server1 with Windows authentication and then installs the DBA MultiTool in the master 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 master -SqlCredential $cred

Logs into server1\instance1 with SQL authentication and then installs the DBA MultiTool in the master 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 master 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 master database.

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

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

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required True
Pipeline true (ByValue)
Default Value

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.

Alias
Required False
Pipeline false
Default Value
-Branch

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

Alias
Required False
Pipeline false
Default Value master
Accepted Values master,development
-Database

Specifies the database to install DBA MultiTool stored procedures into.

Alias
Required False
Pipeline false
Default Value master
-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/.

Alias
Required False
Pipeline false
Default Value
-Force

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

Alias
Required False
Pipeline false
Default Value False
-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

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

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts to confirm actions.

Alias cf
Required False
Pipeline false
Default Value

 

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.