lowlydba.sqlserver.maintenance_solution module – Install/update Maintenance Solution by Ola Hallengren

Note

This module is part of the lowlydba.sqlserver collection (version 2.3.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install lowlydba.sqlserver. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: lowlydba.sqlserver.maintenance_solution.

New in lowlydba.sqlserver 0.1.0

Synopsis

  • A wrapper for Install-DbaMaintenanceSolution to fetch the latest version of the Ola Hallengren’s Maintenance Solution, or install from a local cached version.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

backup_location

string

Location of the backup root directory. If this is not supplied, the default backup directory will be used.

cleanup_time

integer

Time in hours, after which backup files are deleted.

Default: 0

database

string / required

Name of the target database.

force

boolean

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

Choices:

  • false ← (default)

  • true

install_jobs

boolean

If this switch is enabled, the corresponding SQL Agent Jobs will be created.

Choices:

  • false ← (default)

  • true

install_parallel

boolean

If this switch is enabled, the Queue and QueueDatabase tables are created, for use when @DatabasesInParallel = 'Y' are set in the jobs.

Choices:

  • false ← (default)

  • true

local_file

string

Specifies the path to a local file to install Ola’s solution 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 the Maintenance Solution Github.

log_to_table

boolean

If this switch is enabled, the Maintenance Solution will be configured to log commands to a table.

Choices:

  • false ← (default)

  • true

output_file_dir

string

Specify the output file directory where the Maintenance Solution will write to.

replace_existing

boolean

If this switch is enabled, objects already present in the target database will be dropped and recreated.

Choices:

  • false

  • true

solution

string

Specifies which portion of the Maintenance Solution to install.

Choices:

  • "All" ← (default)

  • "Backup"

  • "IntegrityCheck"

  • "IndexOptimize"

sql_instance

string / required

The SQL Server instance to modify.

sql_password

string

Password for SQL Authentication.

sql_username

string

Username for SQL Authentication.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

platform

Platforms: all

Target OS/families that can be operated against.

Examples

- name: Install/Update Maintenance Solution
  lowlydba.sqlserver.multitool:
    sql_instance: sql-01.myco.io
    database: main
    replace_existing: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

data

dictionary

Output from the Install-MaintenanceSolution function.

Returned: success, but not in check_mode.

Authors

  • John McCall (@lowlydba)