This role installs, configures, and starts Microsoft SQL Server.
The role also optimizes the operating system to improve performance and throughput for SQL Server by applying the mssql
Tuned profile.
The role currently works with SQL Server 2017 and 2019.
mssql_tcp_port
variable..sql
extension containing these SQL statements and procedures.mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula
Set this variable to true
to indicate that you accept EULA for installing the msodbcsql17
package.
The license terms for this product can be downloaded from https://aka.ms/odbc17eula and found in /usr/share/doc/msodbcsql17/LICENSE.txt
.
Default: false
Type: bool
mssql_accept_microsoft_cli_utilities_for_sql_server_eula
Set this variable to true
to indicate that you accept EULA for installing the mssql-tools
package.
The license terms for this product can be downloaded from http://go.microsoft.com/fwlink/?LinkId=746949 and found in /usr/share/doc/mssql-tools/LICENSE.txt
.
Default: false
Type: bool
mssql_accept_microsoft_sql_server_standard_eula
Set this variable to true
to indicate that you accept EULA for using Microsoft SQL Server.
The license terms for this product can be found in /usr/share/doc/mssql-server
or downloaded from https://go.microsoft.com/fwlink/?LinkId=2104078&clcid=0x409.
The privacy statement can be viewed at https://go.microsoft.com/fwlink/?LinkId=853010&clcid=0x409.
Default: false
Type: bool
mssql_version
The version of the SQL Server to configure.
The role currently supports versions 2017 and 2019.
Default: 2019
Type: int
mssql_upgrade
If you want to upgrade your SQL Server 2017 to 2019, set the mssql_version
variable to 2019
and this variable to true
.
Note that the role does not support downgrading SQL Server.
Default: false
Type: bool
mssql_password
The password for the database sa user.
The password must have a minimum length of 8 characters, include uppercase and lowercase letters, base 10 digits or non-alphanumeric symbols.
Do not use single quotes (‘), double quotes (“), and spaces in the password because sqlcmd
cannot authorize when the password includes those symbols.
This variable is required when you run the role to install SQL Server.
When running this role on a host that has SQL Server installed, the mssql_password
variable overwrites theexisting sa user password to the one that you specified.
Default: null
Type: str
mssql_edition
The edition of SQL Server to install.
This variable is required when you run the role to install SQL Server.
Use one of the following values:
Enterprise
Standard
Web
Developer
Express
Evaluation
#####-#####-#####-#####-#####
, where #
is a number or a letter.Default: null
Type: str
mssql_tcp_port
The port that SQL Server listens on.
If you define this variable, the role configures SQL Server with the defined TCP port.
If you do not define this variable when installing SQL Server, the role configures SQL Server to listen on the SQL Server default TCP port 1443
.
If you do not define this variable when configuring running SQL Server, the role does not change the TCP port setting on SQL Server.
Default: null
Type: str
mssql_ip_address
The IP address that SQL Server listens on.
If you define this variable, the role configures SQL Server with the defined IP address.
If you do not define this variable when installing SQL Server, the role configures SQL Server to listen on the SQL Server default IP address 0.0.0.0
, that is, to listen on every available network interface.
If you do not define this variable when configuring running SQL Server, the role does not change the IP address setting on SQL Server.
Default: null
Type: str
mssql_input_sql_file
You can use the role to input a file containing SQL statements or procedures into SQL Server.
With this variable, enter the path to the SQL file containing the database configuration.
When specifying this variable, you must also specify the mssql_password
variable because authentication is required to input an SQL file to SQL Server.
If you do not pass this variable, the role only configures the SQL Server and does not input any SQL file.
Note that this task is not idempotent, the role always inputs an SQL file if this variable is defined.
When this variable is defined, mssql_debug
is set to true to print the output of the sqlcmd
command.
You can find an example of the SQL file at tests/sql_script.sql
.
Default: null
Type: str
mssql_debug
Whether or not to print the output of sqlcmd commands.
The role inputs SQL scripts with the sqlcmd command to configure SQL Server for HA or to input users’ SQL scripts when the mssql_input_sql_file
variable is provided.
Default: true
if mssql_input_sql_file
is defined else false
Type: bool
mssql_enable_sql_agent
Set this variable to true
or false
to enable or disable the SQL agent.
Default: null
Type: bool
mssql_install_fts
Set this variable to true
or false
to install or remove the mssql-server-fts
package that provides full-text search.
Default: null
Type: bool
mssql_install_powershell
Set this variable to true
or false
to install or remove the powershell
package that provides PowerShell.
Default: null
Type: bool
mssql_enable_ha
Set this variable to true
or false
to install or remove the mssql-server-ha
package and enable or disable the hadrenabled
setting.
Default: null
Type: bool
mssql_tune_for_fua_storage
Set this variable to true
or false
to enable or disable settings that improve performance on hosts that support Forced Unit Access (FUA) capability.
Only set this variable to true
if your hosts are configured for FUA capability.
When set to true
, the role applies the following settings:
traceflag 3979 on
setting to enable trace flag 3979 as a startup parametercontrol.alternatewritethrough
setting to 0
control.writethrough
setting to 1
When set to false
, the role applies the following settings:
traceflag 3982 off
parameter to disable trace flag 3979 as a startup parametercontrol.alternatewritethrough
setting to its default value 0
control.writethrough
setting to its default value 0
For more details, see SQL Server and Forced Unit Access (FUA) I/O subsystem capability at https://docs.microsoft.com/en-us/sql/linux/sql-server-linux-performance-best-practices?view=sql-server-ver15.
Default: null
Type: bool
mssql_tls_enable
Use the variables starting with the mssql_tls_
prefix to configure SQL Server to encrypt connections using TLS certificates.
You are responsible for creating and securing TLS certificate and private key files.
It is assumed you have a CA that can issue these files.
If not, you can use the openssl
command to create these files.
You must have TLS certificate and private key files on the Ansible control node.
When you use this variable, the role copies TLS cert and private key files to SQL Server and configures SQL Server to use these files to encrypt connections.
Set to true
or false
to enable or disable TLS encryption.
When set to true
, the role performs the following tasks:
/etc/pki/tls/certs/
and /etc/pki/tls/private/
directories respectivelyWhen set to false
, the role configures SQL Server to not use TLS encryption.
The role does not remove the existing certificate and private key files if this variable is set to false
.
Default: null
Type: bool
mssql_tls_cert
Path to the certificate file to copy to SQL Server.
Default: null
Type: str
mssql_tls_private_key
Path to the private key file to copy to SQL Server.
Default: null
Type: str
mssql_tls_remote_src
Influence whether files provided with mssql_tls_cert
and mssql_tls_private_key
need to be transferred or already are present remotely.
If false
, the role searches for mssql_tls_cert
and mssql_tls_private_key
files on the controller node.
If true
, the role searches for mssql_tls_cert
and mssql_tls_private_key
on managed nodes.
Default: false
Type: bool
mssql_tls_version
TLS version to use.
Default: 1.2
Type: str
mssql_tls_force
Set to true
to replace the existing certificate and private key files on host if they exist at /etc/pki/tls/certs/
and /etc/pki/tls/private/
respectively.
Default: false
Type: bool
mssql_rpm_key
The URL or path to the Microsoft rpm gpg keys.
Default: https://packages.microsoft.com/keys/microsoft.asc
Type: string
mssql_server_repository
The URL to the Microsoft SQL Server repository.
See vars/
for default values based on operating system.
Default: {{ __mssql_server_repository }}
Type: string
mssql_client_repository
The URL to the Microsoft production repository.
See vars/
for default values based on operating system.
Default: {{ __mssql_client_repository }}
Type: string
mssql_ha_configure
Use the variables starting with the mssql_ha_
prefix to configure an SQL Server Always On availability group to provide high availability.
Configuring for high availability is not supported on RHEL 7 because the System Roles ha_cluster role does not support RHEL 7.
Set to true
to configure for high availability.
Setting to false
does not remove configuration for high availability.
When set to true
, the role performs the following tasks:
mssql_ha_listener_port
variable.high-availability
service in firewall.mssql_ha_login
variable forha_cluster
role to configure Pacemaker.mssql_ha_cluster_run_role
to true
and provide all variables required by the ha_cluster
role for a proper Pacemaker cluster configuration based on example playbooks in Setting Up SQL Server and Configuring for High Availability.Default: false
Type: bool
mssql_ha_replica_type
A host variable that specifies the type of the replica to be configured on this host.
See Setting Up SQL Server and Configuring for High Availability
for an example inventory.
You must set the mssql_ha_replica_type
variable to primary
for exactly one host.
The available values are: primary
, synchronous
, witness
.
Default: no default
Type: str
mssql_ha_firewall_configure
Whether to open ports in the Linux firewall for an Always On availability group.
The role uses the System Roles firewall role to manage the firewall, hence, only firewall implementations supported by the firewall role work.
If you set this variable to false
, you must open the port defined with the mssql_ha_listener_port
variable prior to running this role.
Default: true
Type: bool
mssql_ha_listener_port
The TCP port used to replicate data for an Always On availability group.
Default: 5022
Type: int
mssql_ha_cert_name
The name of the certificate used to secure transactions between members of an Always On availability group.
Default: null
Type: str
mssql_ha_master_key_password
The password to set for the master key used with the certificate.
Default: null
Type: str
mssql_ha_private_key_password
The password to set for the private key used with the certificate.
Default: null
Type: str
mssql_ha_reset_cert
Whether to reset certificates used by an Always On availability group or not.
Default: false
Type: bool
mssql_ha_endpoint_name
The name of the endpoint to be configured.
Default: null
Type: string
mssql_ha_ag_name
The name of the availability group to be configured.
Default: null
Type: string
mssql_ha_db_name
The name of the database to be replicated.
This database must exist in SQL Server.
Default: null
Type: string
mssql_ha_db_backup_path
For SQL Server, any database participating in an Availability Group must be in a full recovery mode and have a valid log backup.
The role uses this path to backup the database provided with mssql_ha_db_name
prior to initiating replication within an Always On availability group.
The role backs up the database provided with mssql_ha_db_backup_path
if no back up newer than 3 hours exists.
Default: /var/opt/mssql/data/{{ mssql_ha_db_name }}.bak
Type: string
mssql_ha_login
The user created for Pacemaker in SQL Server.
This user is used by the SQL Server Pacemaker resource agent to connect to SQL Server to perform regular database health checks and manage state transitions from replica to primary when needed.
Default: null
Type: string
mssql_ha_login_password
The password for the mssql_ha_login user in SQL Server.
Default: null
Type: string
mssql_ha_cluster_run_role
Whether to run the ha_cluster
role from this role.
Note that the ha_cluster
role has the following limitation:
The role replaces the configuration of HA Cluster on specified nodes.
Any settings not specified in the role variables will be lost.
It means that the microsoft.sql.server
role cannot run the ha_cluster
role to avoid overwriting any existing Pacemaker configuration.
To work around this limitation, the microsoft.sql.server
role does not set any variables for the ha_cluster
role to ensure that any existing Pacemaker configuration is not re-written.
If you want the microsoft.sql.server
to run the ha_cluster
role, set mssql_ha_cluster_run_role: true
and provide variables for the ha_cluster
role with the microsoft.sql.server
role invocation based on example playbooks in Setting Up SQL Server and Configuring for High Availability.
If you do not want the microsoft.sql.server
to run the ha_cluster
role and instead want to run the ha_cluster
role independently of the microsoft.sql.server
role, set mssql_ha_cluster_run_role: false
.
Default: false
Type: string
This section outlines example playbooks that you can use as a reference.
This example shows how to use the role to set up SQL Server with the minimum required variables.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
roles:
- microsoft.sql.server
This example shows how to use the role to set up SQL Server and configure it to use custom IP address and TCP port.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_tcp_port: 1433
mssql_ip_address: 0.0.0.0
roles:
- microsoft.sql.server
This example shows how to use the role to set up SQL Server and enable the following additional functionality:
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_enable_sql_agent: true
mssql_install_fts: true
mssql_install_powershell: true
mssql_tune_for_fua_storage: true
mssql_input_sql_file: mydatabase.sql
roles:
- microsoft.sql.server
This example shows how to use the role to set up SQL Server and configure it to use TLS encryption.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_tls_enable: true
mssql_tls_cert: mycert.pem
mssql_tls_private_key: mykey.key
mssql_tls_version: 1.2
mssql_tls_force: false
roles:
- microsoft.sql.server
Examples in this section shows how to use the role to set up SQL Server and configure it for high availability in different environments.
You must set the mssql_ha_replica_type
variable for each host that you want to configure.
If you set mssql_ha_cluster_run_role
to true
, you can optionally provide variables required by the ha_cluster
role.
If you do not provide names or addresses, the ha_cluster
uses play’s targets.
See the ha_cluster
role’s documentation for more information.
Example inventory:
all:
hosts:
host1:
mssql_ha_replica_type: primary
host2:
mssql_ha_replica_type: synchronous
host3:
mssql_ha_replica_type: witness
If you want to configure Pacemaker independently, you can set mssql_ha_cluster_run_role
to false
to not include the ha_cluster
role.
Note that production environments require Pacemaker configured with fencing agents.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_ha_configure: true
mssql_ha_firewall_configure: true
mssql_ha_listener_port: 5022
mssql_ha_cert_name: ExampleCert
mssql_ha_master_key_password: "p@55w0rD1"
mssql_ha_private_key_password: "p@55w0rD2"
mssql_ha_reset_cert: false
mssql_ha_endpoint_name: Example_Endpoint
mssql_ha_ag_name: ExampleAG
mssql_ha_db_name: ExampleDB
mssql_ha_login: ExamleLogin
mssql_ha_login_password: "p@55w0rD3"
mssql_ha_cluster_run_role: false
roles:
- microsoft.sql.server
If you want to configure Pacemaker from this role, you can set mssql_ha_cluster_run_role
to true
and provide variables required by the ha_cluster
role to configure Pacemaker for your environment properly.
See the ha_cluster
role’s documentation for more information.
Note that production environments require Pacemaker configured with fencing agents, this example playbook configures the stonith:fence_apc_snmp
agent.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_ha_configure: true
mssql_ha_firewall_configure: true
mssql_ha_listener_port: 5022
mssql_ha_cert_name: ExampleCert
mssql_ha_master_key_password: "p@55w0rD1"
mssql_ha_private_key_password: "p@55w0rD2"
mssql_ha_reset_cert: false
mssql_ha_endpoint_name: Example_Endpoint
mssql_ha_ag_name: ExampleAG
mssql_ha_db_name: ExampleDB
mssql_ha_login: ExamleLogin
mssql_ha_login_password: "p@55w0rD3"
mssql_ha_cluster_run_role: true
ha_cluster_cluster_name: "{{ mssql_ha_ag_name }}"
ha_cluster_hacluster_password: "p@55w0rD4"
ha_cluster_cluster_properties:
- attrs:
- name: cluster-recheck-interval
value: 2min
- name: start-failure-is-fatal
value: true
- name: stonith-enabled
value: true
ha_cluster_resource_primitives:
- id: Example_apc
agent: stonith:fence_apc_snmp
instance_attrs:
- attrs:
- name: login
value: apc_login
- name: passwd
value: apc_pass
- name: ipaddr
value: apc-switch.example.com
- name: pcmk_host_map
value: rhel8-node1.example.com:1;rhel8-node2.example.com:2
- id: ag_cluster
agent: ocf:mssql:ag
instance_attrs:
- attrs:
- name: ag_name
value: "{{ mssql_ha_ag_name }}"
meta_attrs:
- attrs:
- name: failure-timeout
value: 60s
- id: virtualip
agent: ocf:heartbeat:IPaddr2
instance_attrs:
- attrs:
- name: ip
value: 192.XXX.XXX.XXX
operations:
- action: monitor
attrs:
- name: interval
value: 30s
ha_cluster_resource_clones:
- resource_id: ag_cluster
promotable: yes
meta_attrs:
- attrs:
- name: notify
value: true
ha_cluster_constraints_colocation:
- resource_leader:
id: ag_cluster-clone
role: Promoted
resource_follower:
id: virtualip
options:
- name: score
value: INFINITY
ha_cluster_constraints_order:
- resource_first:
id: ag_cluster-clone
action: promote
resource_then:
id: virtualip
action: start
roles:
- microsoft.sql.server
If you want to configure Pacemaker from this role, you can set mssql_ha_cluster_run_role
to true
and provide variables required by the ha_cluster
role to configure Pacemaker for your environment properly.
See the ha_cluster
role’s documentation for more information.
Note that production environments require Pacemaker configured with fencing agents, this example playbook configures the stonith:fence_vmware_soap
agent.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_ha_configure: true
mssql_ha_firewall_configure: true
mssql_ha_listener_port: 5022
mssql_ha_cert_name: ExampleCert
mssql_ha_master_key_password: "p@55w0rD1"
mssql_ha_private_key_password: "p@55w0rD2"
mssql_ha_reset_cert: false
mssql_ha_endpoint_name: Example_Endpoint
mssql_ha_ag_name: ExampleAG
mssql_ha_db_name: ExampleDB
mssql_ha_login: ExamleLogin
mssql_ha_login_password: "p@55w0rD3"
mssql_ha_cluster_run_role: true
ha_cluster_cluster_name: "{{ mssql_ha_ag_name }}"
ha_cluster_hacluster_password: "p@55w0rD4"
ha_cluster_cluster_properties:
- attrs:
- name: cluster-recheck-interval
value: 2min
- name: start-failure-is-fatal
value: true
- name: stonith-enabled
value: true
ha_cluster_resource_primitives:
- id: vmfence
agent: stonith:fence_vmware_soap
instance_attrs:
- attrs:
- name: username
value: vmware_Login
- name: passwd
value: vmware_password
- name: ip
value: vmware_ip
- name: ssl_insecure
value: 1
- id: ag_cluster
agent: ocf:mssql:ag
instance_attrs:
- attrs:
- name: ag_name
value: "{{ mssql_ha_ag_name }}"
meta_attrs:
- attrs:
- name: failure-timeout
value: 60s
- id: virtualip
agent: ocf:heartbeat:IPaddr2
instance_attrs:
- attrs:
- name: ip
value: 192.XXX.XXX.XXX
operations:
- action: monitor
attrs:
- name: interval
value: 30s
ha_cluster_resource_clones:
- resource_id: ag_cluster
promotable: yes
meta_attrs:
- attrs:
- name: notify
value: true
ha_cluster_constraints_colocation:
- resource_leader:
id: ag_cluster-clone
role: Promoted
resource_follower:
id: virtualip
options:
- name: score
value: INFINITY
ha_cluster_constraints_order:
- resource_first:
id: ag_cluster-clone
action: promote
resource_then:
id: virtualip
action: start
roles:
- microsoft.sql.server
If you want to configure Pacemaker from this role, you can set mssql_ha_cluster_run_role
to true
and provide variables required by the ha_cluster
role to configure Pacemaker for your environment properly.
See the ha_cluster
role’s documentation for more information.
Note that production environments require Pacemaker configured with fencing agents, this example playbook configures the stonith:fence_azure_arm
agent.
- hosts: all
vars:
mssql_accept_microsoft_odbc_driver_17_for_sql_server_eula: true
mssql_accept_microsoft_cli_utilities_for_sql_server_eula: true
mssql_accept_microsoft_sql_server_standard_eula: true
mssql_password: "p@55w0rD"
mssql_edition: Evaluation
mssql_ha_configure: true
mssql_ha_firewall_configure: true
mssql_ha_listener_port: 5022
mssql_ha_cert_name: ExampleCert
mssql_ha_master_key_password: "p@55w0rD1"
mssql_ha_private_key_password: "p@55w0rD2"
mssql_ha_reset_cert: false
mssql_ha_endpoint_name: Example_Endpoint
mssql_ha_ag_name: ExampleAG
mssql_ha_db_name: ExampleDB
mssql_ha_login: ExamleLogin
mssql_ha_login_password: "p@55w0rD3"
mssql_ha_cluster_run_role: true
ha_cluster_cluster_name: "{{ mssql_ha_ag_name }}"
ha_cluster_hacluster_password: "p@55w0rD4"
ha_cluster_cluster_properties:
- attrs:
- name: cluster-recheck-interval
value: 2min
- name: start-failure-is-fatal
value: true
- name: stonith-enabled
value: true
- name: stonith-timeout
value: 900
ha_cluster_resource_primitives:
- id: rsc_st_azure
agent: stonith:fence_azure_arm
instance_attrs:
- attrs:
- name: login
value: azure_login
- name: passwd
value: azure_password
- name: resourceGroup
value: azure_resourceGroup_name
- name: tenantId
value: azure_tenant_ID
- name: subscriptionId
value: azure_subscription_ID
- name: power_timeout
value: 240
- name: pcmk_reboot_timeout
value: 900
- id: azure_load_balancer
agent: azure-lb
instance_attrs:
- attrs:
- name: port
value: 1234
- id: ag_cluster
agent: ocf:mssql:ag
instance_attrs:
- attrs:
- name: ag_name
value: "{{ mssql_ha_ag_name }}"
meta_attrs:
- attrs:
- name: failure-timeout
value: 60s
- id: virtualip
agent: ocf:heartbeat:IPaddr2
instance_attrs:
- attrs:
- name: ip
value: 192.XXX.XXX.XXX
operations:
- action: monitor
attrs:
- name: interval
value: 30s
ha_cluster_resource_groups:
- id: virtualip_group
resource_ids:
- azure_load_balancer
- virtualip
ha_cluster_resource_clones:
- resource_id: ag_cluster
promotable: yes
meta_attrs:
- attrs:
- name: notify
value: true
ha_cluster_constraints_colocation:
- resource_leader:
id: ag_cluster-clone
role: Promoted
resource_follower:
id: azure_load_balancer
options:
- name: score
value: INFINITY
ha_cluster_constraints_order:
- resource_first:
id: ag_cluster-master
action: promote
resource_then:
id: azure_load_balancer
action: start
roles:
- microsoft.sql.server
After running the following example playbook, you must also add a listener pointing to Azure using the following SQL statement:
ALTER AVAILABILITY GROUP ExampleAG ADD LISTENER 'ExampleAG-listener' (
WITH IP ( (azure_lb_ip),('255.255.255.0') ),
PORT = 1433
);
MIT