lowlydba.sqlserver.resource_governor module – Configures the resource governor on a SQL Server instance

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.resource_governor.

New in lowlydba.sqlserver 0.1.0

Synopsis

  • Enables or disables and optionally sets the classifier function for the resource governor feature.

Requirements

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

Parameters

Parameter

Comments

classifier_function

string

The name of the classifier function that resource governor will use. To clear the function, use the string NULL.

enabled

boolean

Whether to enable or disable resource governor.

Choices:

  • false

  • true ← (default)

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: Enable resource governor
  lowlydba.sqlserver.resource_governor:
    sql_instance: sql-01.myco.io
    enabled: 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 Set-DbaResourceGovernor function.

Returned: success, but not in check_mode.

Authors

  • John McCall (@lowlydba)