Модуль community.general.mssql_db — добавление и удаление баз данных MSSQL на удалённом хосте

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить коллекцию, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования; подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.mssql_db.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

Добавление и удаление баз данных MSSQL на удалённом хосте.

Требования

Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.

pymssql

Параметры

Параметр	Комментарии
autocommit логический	Автоматически фиксировать изменения только в случае успешного импорта. Иногда необходимо использовать autocommit=true, поскольку некоторые данные нельзя изменить в рамках транзакции. Возможные значения: `false` ← (по умолчанию) `true`
login_host строка / обязательный	Хост, на котором работает база данных. Для именованных экземпляров используйте формат `server\instance`. В этом случае не используйте `login_port`.
login_password строка	Пароль для аутентификации. По умолчанию: `""`
login_port строка	Порт сервера MSSQL. Если используется login_port, значение login_host должно быть задано и отличаться от localhost. Нельзя использовать вместе с именованным экземпляром в `login_host` (то есть в формате `server\instance`). Если `login_host` не является именованным экземпляром и `login_port` не указано, по умолчанию используется `1433`.
login_user строка	Имя пользователя для аутентификации. По умолчанию: `""`
name псевдонимы: db строка / обязательный	Имя добавляемой или удаляемой базы данных.
state строка	Состояние базы данных. Возможные значения: `"present"` ← (по умолчанию) `"absent"` `"import"`
target строка	Расположение файла дампа на удалённом хосте, из которого выполняется чтение или в который выполняется запись. Поддерживаются несжатые файлы SQL (файлы `.sql`).

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Можно запускать в режиме `check_mode` и получать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

На удалённом хосте требуется пакет Python pymssql. В Ubuntu его можно легко установить с помощью pip install pymssql (см. ansible.builtin.pip).

Примеры

- 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

Авторы

Vedit Firat Arig (@vedit)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/mssql_db_module.html