Ctrl+K
Ctrl+K
Ctrl+K

Ansible Creator

Ansible Creator#

Утилита Ansible Creator упрощает создание базовой структуры коллекций и сценариев Ansible. Для этого она предоставляет несколько команд с различными аргументами, описание которых приводится далее.

Вызов утилиты имеет следующий вид:

ansible-creator [-h] [--version] <command> [<arguments>]

Здесь:

  • <command> – команда;

  • <arguments> – аргументы команды.

Возможные аргументы утилиты:

-h, --help#

Вывод справочной информации о командах и аргументах Ansible Creator.

--version#

Вывод информации о версии Ansible Creator.

-v, --verbose#

Увеличение уровня детализации вывода. Значение по умолчанию – 2.

Команды#

При запуске Ansible Creator можно использовать следующие команды:

  • add – добавление содержимого в уже существующий проект;

  • init – инициализация коллекции или набора сценариев.

add#

Важно

Эта часть документации находится в стадии разработки.

init#

Эта команда создает структуру файлов и каталогов, необходимую для начала работы над коллекцией или набором сценариев.

Примечание

Предполагается, что наборы сценариев будут распространяться в составе коллекции.

Синтаксис команды:

ansible-creator init [collection|playbook] [-h] [--na] [--lf LOG_FILE] [--ll {notset,debug,info,warning,error,critical}] [--la {true,false}] [--json] [-v] [-f] [-o] [-no] <namespace>.<collection> [<path>]

Здесь:

  • <namespace> – название пространства имен;

  • <collection> – название коллекции;

  • <path> – путь к каталогу, в котором Ansible Creator должен разместить файлы и каталоги коллекции.

    Значение по умолчанию – ./ (текущий каталог).

Подробное описание аргументов команды см. ниже.

Описание аргументов команд#

Команды Ansible Creator поддерживают следующие аргументы:

--json#

Вывод сообщений в формате JSON:

  • true – включен;

  • false – выключен.

Значение по умолчанию – false.

--la, --log-append [true|false]#

Вывод сообщений в файл:

  • true – включен;

  • false – выключен.

Значение по умолчанию – true.

--lf, --log-file <file>#

Путь к файлу для вывода сообщений.

Значение по умолчанию – ~/ansible-creator.log.

--ll, --log-level <level>#

Уровень подробности сообщений в порядке убывания:

  1. notset;

  2. debug;

  3. info;

  4. warning;

  5. error;

  6. critical.

Значение по умолчанию – notset.

--na, --no-ansi [true|false]#

Запрет использования кодов ANSI для подсветки цветов в терминале:

  • true – включен (цветовое оформление не используется);

  • false – выключен.

Значение по умолчанию – false.

-f, --force#

При выполнении команды init Ansible Creator проверяет существование целевого каталога. Если каталог не существует или пуст, Ansible Creator выполняет создание необходимых файлов и каталогов. В противном случае Ansible Creator выводит в терминал запрос на подтверждение переинициализации.

Эта опция выключает вывод запроса на подтверждение переинициализации каталога.

Значение по умолчанию – false (для переинициализации требуется подтверждение пользователя).

-h, --help#

Вывод справочной информации об использовании Ansible Creator или его команд.

-no, --no-overwrite#

Эта опция запрещает перезапись файлов и каталогов при выполнении операций.

Значение по умолчанию – false (перезапись включена).

-o, --overwrite#

Эта опция разрешает перезапись файлов и каталогов при выполнении операций.

Значение по умолчанию – false (перезапись выключена).

-v, --verbosity#

Увеличение уровня детализации сообщений, выводимых в терминал.

Эта опция обладает свойством аддитивностью – ее можно использовать до трех раз, например:

ansible-creator -vvv ...

Значение по умолчанию – 0.

Содержание