mssql_script: add tds_version and encryption parameters #10816

Halo1236 · 2025-09-12T08:00:35Z

SUMMARY

This pull request adds support for specifying tds_version and encryption options when connecting to Microsoft SQL Server in the mssql_script Ansible module. These options improve compatibility with older SQL Server versions and allow more flexible connection configurations.

Connection options enhancements:

Added two new module parameters, tds_version and encryption, to allow users to specify the TDS protocol version and encryption settings for SQL Server connections.
Updated the connection logic to pass the tds_version and encryption parameters to pymssql.connect, enabling these options to be used when establishing the database connection. [1] [2]

ISSUE TYPE

Bugfix Pull Reques

COMPONENT NAME

mssql_script

… SQL Server

ansibullbot · 2025-09-12T08:05:53Z

cc @kbudde
click here for bot help

felixfontein

Thanks for your contribution!

I don't think this is related to #5693 though. Why do you think it is?

plugins/modules/mssql_script.py

felixfontein · 2025-09-13T08:38:43Z

Also, please add a changelog fragment. Thanks.

… None, update changelog

Halo1236 · 2025-09-16T02:34:29Z

@felixfontein Thank you for your guidance! I have updated the code and the changelog. There is an issue in Issues that has the same error message as the one I encountered during my testing, but I am not sure if my update can resolve their problem. Therefore, I have removed the association for now.

plugins/modules/mssql_script.py

russoz

Hi @Halo1236 thanks for your contribution!

I've left a couple of comments, nothing major. Other than that, it LGTM

plugins/modules/mssql_script.py

ansibullbot · 2025-09-18T07:28:09Z

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/mssql_script.py:179:1: W293: blank line contains whitespace

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/mssql_script.py:179:1: W293: blank line contains whitespace

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/mssql_script.py:179:1: W293: blank line contains whitespace

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/mssql_script.py:179:1: W293: blank line contains whitespace

click here for bot help

felixfontein · 2025-09-18T19:49:42Z

plugins/modules/mssql_script.py

+    description:
+      - Specify whether to use encryption for the connection to the server.
+        Please refer to the pymssql documentation for detailed information.
+      - The available values are "off" and "on"


Suggested change

- The available values are "off" and "on"

- The available values are V("off") and V("on").

(I left the quotes to avoid conversion to booleans.)

If no other values are allowed, how about adding choices to limit the input to these two values?

felixfontein · 2025-09-18T19:50:17Z

plugins/modules/mssql_script.py

+    description:
+      - Specify the TDS protocol version to use when connecting to the server.
+        Please refer to the pymssql documentation for detailed information.
+      - The available values are "7.0", "7.1", "7.2", "7.3", "7.4", "8.0" etc.


Suggested change

- The available values are "7.0", "7.1", "7.2", "7.3", "7.4", "8.0" etc.

- The available values are V(7.0), V(7.1), V(7.2), V(7.3), V(7.4), V(8.0), and so on.

The param is type=str, the doc should recommend wrapping quotes, so that the values are not converted to float.

russoz

Hi @Halo1236 , thanks for your contribution.

Couple of comments.

russoz · 2025-09-24T18:37:14Z

plugins/modules/mssql_script.py

+      - Specify whether to use encryption for the connection to the server.
+        Please refer to the pymssql documentation for detailed information.
+      - The available values are "off" and "on"
+    type: str


Given that this is intrinsically a boolean value, why not:

Suggested change

type: str

type: bool

?
Maybe it should have a default value, regardless of the type?

russoz · 2025-09-24T18:40:01Z

plugins/modules/mssql_script.py

+    description:
+      - Specify the TDS protocol version to use when connecting to the server.
+        Please refer to the pymssql documentation for detailed information.
+      - The available values are "7.0", "7.1", "7.2", "7.3", "7.4", "8.0" etc.


The param is type=str, the doc should recommend wrapping quotes, so that the values are not converted to float.

russoz · 2025-09-24T18:42:06Z

plugins/modules/mssql_script.py

+    login_port: "{{ mssql_port }}"
+    db: master
+    tds_version: "7.0"
+    encryption: off


If the param type=str, this should have quotes around the value. If you change it to type=bool, then

Suggested change

encryption: off

encryption: false

russoz

Hi @Halo1236

A couple of additional comments. The PR is looking good, it just need these few adjustments.

If you are struggling with the tests, may I suggest giving a try to andebox, by yours truly:

https://pypi.org/project/andebox/

You can run this sanity test easily in your local machine by simply running:

$ andebox test -- sanity --docker default --python 3.13 plugins/modules/your_module.py

russoz · 2025-10-26T09:54:01Z

plugins/modules/mssql_script.py

+        Please refer to the pymssql documentation for detailed information.
+      - The available values are "off" and "on"
+    type: str
+    version_added: 11.4.0


This is now:

Suggested change

version_added: 11.4.0

version_added: 12.0.0

russoz · 2025-10-26T09:54:57Z

plugins/modules/mssql_script.py

        params=dict(type='dict'),
        transaction=dict(type='bool', default=False),
+        tds_version=dict(type='str'),
+        encryption=dict(type='str')


Just making life better for the next person:

Suggested change

encryption=dict(type='str')

encryption=dict(type='str'),

russoz · 2025-10-26T09:55:52Z

plugins/modules/mssql_script.py

+            "database": db,
+        }
+        if encryption is not None:
+            connection_args["encryption"] = encryption


if you make the parameter a boolean, then this should go:

Suggested change

connection_args["encryption"] = encryption

connection_args["encryption"] = "on" if encryption else "off"

russoz · 2025-10-26T10:00:07Z

plugins/modules/mssql_script.py

      - result_batches_dict.query_results_dict[0] | length == 2 # two selects in first batch
      - result_batches_dict.query_results_dict[0][0] | length == 1 # one row in first select
      - result_batches_dict.query_results_dict[0][0][0]['b0s0'] == 'Batch 0 - Select 0' # column 'b0s0' of first row
+      


This is tripping the sanity test (trailing spaces in the line):

Suggested change

Add additional parameters to support connections to lower versions of…

2643137

… SQL Server

ansibullbot added bug This issue/PR relates to a bug module module new_contributor Help guide this first time contributor plugins plugin (any type) labels Sep 12, 2025

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Sep 12, 2025

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-11 Automatically create a backport for the stable-10 branch labels Sep 12, 2025

felixfontein reviewed Sep 13, 2025

View reviewed changes

plugins/modules/mssql_script.py Outdated Show resolved Hide resolved

plugins/modules/mssql_script.py Outdated Show resolved Hide resolved

felixfontein changed the title ~~Add additional parameters to support connections to lower versions of…~~ mssql_script: add tds_version and encryption parameters Sep 13, 2025

mssql_script: use kwargs to pass encryption/tds_version only when not…

fafd6ee

… None, update changelog

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Sep 16, 2025

felixfontein reviewed Sep 16, 2025

View reviewed changes

plugins/modules/mssql_script.py Show resolved Hide resolved

plugins/modules/mssql_script.py Show resolved Hide resolved

plugins/modules/mssql_script.py Outdated Show resolved Hide resolved

plugins/modules/mssql_script.py Outdated Show resolved Hide resolved

Update mssql_script.py documentation

0266b75

Halo1236 force-pushed the fix_2008_SQLServer_error branch from 07a35a6 to 0266b75 Compare September 17, 2025 07:50

russoz reviewed Sep 17, 2025

View reviewed changes

plugins/modules/mssql_script.py Outdated Show resolved Hide resolved

plugins/modules/mssql_script.py Outdated Show resolved Hide resolved

plugins/modules/mssql_script.py Show resolved Hide resolved

Delete unnecessary parameters and add examples

c19bff1

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Sep 18, 2025

felixfontein reviewed Sep 18, 2025

View reviewed changes

russoz reviewed Sep 24, 2025

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Oct 2, 2025

felixfontein removed the backport-11 Automatically create a backport for the stable-10 branch label Oct 13, 2025

russoz reviewed Oct 26, 2025

View reviewed changes

	- The available values are "off" and "on"
	- The available values are V("off") and V("on").

	- The available values are "7.0", "7.1", "7.2", "7.3", "7.4", "8.0" etc.
	- The available values are V(7.0), V(7.1), V(7.2), V(7.3), V(7.4), V(8.0), and so on.

	connection_args["encryption"] = encryption
	connection_args["encryption"] = "on" if encryption else "off"

mssql_script: add tds_version and encryption parameters #10816

Are you sure you want to change the base?

mssql_script: add tds_version and encryption parameters #10816

Uh oh!

Conversation

Halo1236 commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

ISSUE TYPE

COMPONENT NAME

Uh oh!

ansibullbot commented Sep 12, 2025

Uh oh!

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

felixfontein commented Sep 13, 2025

Uh oh!

Halo1236 commented Sep 16, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ansibullbot commented Sep 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russoz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

russoz Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Halo1236 commented Sep 12, 2025 •

edited

Loading

russoz Oct 26, 2025 •

edited

Loading