Documentation

mssql_db - Add or remove MSSQL databases from a remote host.

New in version 2.2.

Synopsis

  • Add or remove MSSQL databases from a remote host.

Options

parameter required default choices comments
autocommit
 no
  • false
  • true
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
 no
Host running the database
login_password
 no
The password used to authenticate with
login_port
 no 1433
Port of the MSSQL server. Requires login_host be defined as other then localhost if login_port is used
login_user
 no
The username used to authenticate with
name
 yes
name of the database to add or remove

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

Examples

# Create a new database with name 'jackdata'
- mssql_db:
    name: jackdata
    state: present

# Copy database dump file to remote host and restore it to database 'my_db'
- copy:
    src: dump.sql
    dest: /tmp

- mssql_db:
    name: my_db
    state: import
    target: /tmp/dump.sql

Notes

Note

  • Requires the pymssql Python package on the remote host. For Ubuntu, this is as easy as pip install pymssql (See pip.)

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.