lowlydba.sqlserver.sp_configure module – Make instance level system configuration changes via sp_configure

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

New in lowlydba.sqlserver 0.1.0

Synopsis

  • Read instance level system configuration for a given configuration and update to a new value as provided.

Requirements

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

Parameters

Parameter

Comments

name

string / required

Name of the configuration that will be changed.

sql_instance

string / required

The SQL Server instance to modify.

sql_password

string

Password for SQL Authentication.

sql_username

string

Username for SQL Authentication.

value

integer / required

New value the configuration will be set to.

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 remote DAC connection
  lowlydba.sqlserver.sp_configure:
    sql_instance: sql-01.myco.io
    name: RemoteDacConnectionsEnabled
    value: 1

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-DbaSpConfigure function.

RestartRequired returned if the setting requires a service restart to take effect.

Returned: success, but not in check_mode.

Authors

  • Sudhir Koduri (@kodurisudhir)