onyx_config - Управление секциями конфигурации Mellanox ONYX

Новая версия 2.5.

Обзор
Параметры
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Конфигурации Mellanox ONYX используют простой синтаксис файла с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации ONYX детерминированным способом.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after			Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Как и в случае с before, это позволяет разработчику сценария добавить набор команд, которые будут выполнены после набора команд.
backup bool		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге сценария. Если каталога не существует, он создается.
before			Упорядоченный набор команд для добавления в стек команд, если необходимо внести изменения. Это дает разработчику сценария возможность выполнить команды конфигурации перед внесением любых изменений, не влияя на то, как набор команд сопоставляется с системой.
config			Аргумент `config` позволяет разработчику сценария предоставить базовая конфигурацию, которая будет использоваться для проверки необходимых изменений конфигурации. Если этот аргумент указан, модуль не загрузит текущую конфигурацию удаленного узла.
lines			Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть такими же, как и в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды
match		Варианты: line ← strict exact none	Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются с учетом позиции. Если match установлено в exact, строки команд должны быть точным совпадением. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удаленного устройства.
parents			Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию, к которой должны быть проверены команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд.
provider			Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	По умолчанию: 22	Указывает порт, который необходимо использовать при создании подключения к удаленному устройству.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	timeout	По умолчанию: 10	Устанавливает таймаут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль вернет ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	authorize bool	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass		Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
replace		Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, измененные строки отправляются устройству в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка некорректна.
save bool		Варианты: no ← yes	Аргумент `save` указывает модулю сохранить текущую конфигурацию (running-config) в стартовую конфигурацию (startup-config) по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src			Указывает путь к исходному файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога сценария или роли. Этот аргумент взаимоисключает lines и parents.

Примеры

---
- onyx_config:
    lines:
      - snmp-server community
      - snmp-server host 10.2.2.2 traps version 2c

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup=yes	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/onyx_config.2016-07-16@22:28:34
updates список	всегда	Набор команд, которые будут отправлены на удаленное устройство Пример: ['...', '...']

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и сопровождение модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

Alex Tabachnik (@atabachnik), Samer Deeb (@samerd)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/onyx_config_module.html