lowlydba.sqlserver.memory module – Sets the maximum memory for 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.memory
.
New in lowlydba.sqlserver 0.1.0
Synopsis
Sets the maximum memory for a SQL Server instance.
Requirements
The below requirements are needed on the host that executes this module.
dbatools PowerShell module
Parameters
Parameter |
Comments |
---|---|
The maximum memory in MB that the SQL Server instance can utilize. Default: |
|
The SQL Server instance to modify. |
|
Password for SQL Authentication. |
|
Username for SQL Authentication. |
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: Automatically configure SQL max memory
lowlydba.sqlserver.memory:
sql_instance: sql-01.myco.io
- name: Manually configure SQL max memory
lowlydba.sqlserver.memory:
sql_instance: sql-01.myco.io
max: 10240
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Output from the Returned: success, but not in check_mode. |