lowlydba.sqlserver.dba_multitool (2.3.2) — module

Install collection

Install with ansible-galaxy collection install lowlydba.sqlserver:==2.3.2

Add to requirements.yml

  collections:
    - name: lowlydba.sqlserver
      version: 2.3.2

Description

A wrapper for C(Install-DbaMultiTool) to fetch the latest version of the scripts, or install from a local cached version.

Requirements

• L(dbatools,https://www.powershellgallery.com/packages/dbatools/) PowerShell module

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Install DBA MultiTool
  lowlydba.sqlserver.dba_multitool:
    sql_instance: test-server.my.company.com
    database: dba_tools

Inputs

    
force:
    default: false
    description:
    - If this switch is enabled, the DBA MultiTool will be downloaded from the internet
      even if previously cached.
    type: bool

branch:
    choices:
    - master
    - development
    description:
    - Specifies an alternate branch of the DBA MultiTool to install.
    required: false
    type: str

database:
    description:
    - Name of the target database.
    required: true
    type: str

local_file:
    description:
    - 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 option is not specified, the latest version will be downloaded and installed
      from https://github.com/LowlyDBA/dba-multitool/.
    required: false
    type: str

sql_instance:
    description:
    - The target SQL Server instance or instances. Server version must be SQL Server version
      2005 or higher.
    required: true
    type: str

sql_password:
    description:
    - Password for SQL Authentication.
    required: false
    type: str

sql_username:
    description:
    - Username for SQL Authentication.
    required: false
    type: str

Outputs

data:
  description: Modified output from the C(Install-DbaMultitool) function.
  returned: success, but not in check_mode.
  type: dict