community.general.mssql_db module – Add or remove MSSQL databases from a remote host
Note
This module is part of the community.general collection (version 8.6.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 community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.mssql_db
.
Synopsis
Add or remove MSSQL databases from a remote host.
Aliases: database.mssql.mssql_db
Requirements
The below requirements are needed on the host that executes this module.
pymssql
Parameters
Parameter |
Comments |
---|---|
Automatically commit the change only if the import succeed. Sometimes it is necessary to use autocommit=true, since some content can’t be changed within a transaction. Choices:
|
|
Host running the database |
|
The password used to authenticate with Default: |
|
Port of the MSSQL server. Requires login_host be defined as other than localhost if login_port is used Default: |
|
The username used to authenticate with Default: |
|
name of the database to add or remove |
|
The database state Choices:
|
|
Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL files ( |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
Requires the pymssql Python package on the remote host. For Ubuntu, this is as easy as pip install pymssql (See ansible.builtin.pip.)
Examples
- name: Create a new database with name 'jackdata'
community.general.mssql_db:
name: jackdata
state: present
# Copy database dump file to remote host and restore it to database 'my_db'
- name: Copy database dump file to remote host
ansible.builtin.copy:
src: dump.sql
dest: /tmp
- name: Restore the dump file to database 'my_db'
community.general.mssql_db:
name: my_db
state: import
target: /tmp/dump.sql