community.general.mssql_db – Add or remove MSSQL databases from a remote host.

Note

This plugin is part of the community.general collection (version 4.2.0).

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.

To use it in a playbook, specify: community.general.mssql_db.

Synopsis

  • Add or remove MSSQL databases from a remote host.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • pymssql

Parameters

Parameter Choices/Defaults Comments
autocommit
boolean
    Choices:
  • no ←
  • yes
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.
login_host
string / required
Host running the database
login_password
string
The password used to authenticate with
login_port
string
Default:
"1433"
Port of the MSSQL server. Requires login_host be defined as other than localhost if login_port is used
login_user
string
The username used to authenticate with
name
string / required
name of the database to add or remove

aliases: db
state
string
    Choices:
  • present ←
  • absent
  • import
The database state
target
string
Location, on the remote host, of the dump file to read from or write to. Uncompressed SQL files (.sql) files are supported.

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

Authors

  • Vedit Firat Arig (@vedit)