blob: 65b6b3273f767aed5d94ef04c607573d22a81129 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2022, John McCall (@lowlydba)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r'''
---
module: memory
short_description: Sets the maximum memory for a SQL Server instance
description:
- Sets the maximum memory for a SQL Server instance.
version_added: 0.1.0
options:
max:
description:
- The maximum memory in MB that the SQL Server instance can utilize. C(0) will automatically calculate the ideal value.
type: int
required: false
default: 0
author: "John McCall (@lowlydba)"
requirements:
- L(dbatools,https://www.powershellgallery.com/packages/dbatools/) PowerShell module
extends_documentation_fragment:
- lowlydba.sqlserver.sql_credentials
- lowlydba.sqlserver.attributes.check_mode
- lowlydba.sqlserver.attributes.platform_all
'''
EXAMPLES = r'''
- 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 = r'''
data:
description: Output from the C(Set-DbaMaxMemory) function.
returned: success, but not in check_mode.
type: dict
'''
|