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.
dbatools PowerShell module
Parameters
Parameter |
Comments |
---|---|
Name of the configuration that will be changed. |
|
The SQL Server instance to modify. |
|
Password for SQL Authentication. |
|
Username for SQL Authentication. |
|
New value the configuration will be set to. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target. |
|
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 |
---|---|
Output from the RestartRequired returned if the setting requires a service restart to take effect. Returned: success, but not in check_mode. |