lowlydba.sqlserver.first_responder_kit (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-DbaFirstResponderKit) 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 FRK
  lowlydba.sqlserver.first_responder_kit:
    sql_instance: test-server.my.company.com
    database: dba_tools

Inputs

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

branch:
    choices:
    - main
    - dev
    description:
    - Specifies an alternate branch of the First Responder Kit 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 FRK 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
      Github.
    required: false
    type: str

only_script:
    choices:
    - Install-All-Scripts.sql
    - Install-Core-Blitz-No-Query-Store.sql
    - Install-Core-Blitz-With-Query-Store.sql
    - sp_Blitz.sql
    - sp_BlitzFirst.sql
    - sp_BlitzIndex.sql
    - sp_BlitzCache.sql
    - sp_BlitzWho.sql
    - sp_BlitzQueryStore.sql
    - sp_BlitzAnalysis.sql
    - sp_BlitzBackups.sql
    - sp_BlitzInMemoryOLTP.sql
    - sp_BlitzLock.sql
    - sp_AllNightLog.sql
    - sp_AllNightLog_Setup.sql
    - sp_DatabaseRestore.sql
    - sp_ineachdb.sql
    - SqlServerVersions.sql
    - Uninstall.sql
    default: Install-All-Scripts.sql
    description:
    - Specifies the name(s) of the script(s) to run for installation. Wildcards are permitted.
    - This way only part of the First Responder Kit can be installed.
    required: false
    type: str

sql_instance:
    description:
    - The SQL Server instance to modify.
    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-DbaFirstResponderKit) function.
  returned: success, but not in check_mode.
  type: dict