onyx_config - Управление секциями конфигурации Mellanox ONYX
Новая в версии 2.5.
Обзор
- Конфигурации Mellanox ONYX используют простой синтаксис файлов с отступами для сегментирования конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации ONYX детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after | Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Как и в случае с параметром before, это позволяет разработчику playbook добавлять набор команд, которые должны быть выполнены после набора команд. | ||
| backup |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку backup в корневой директории playbook. Если директория не существует, она будет создана. | |
| before | Упорядоченный набор команд для добавления в стек команд, если требуется изменение. Это даёт разработчику playbook возможность выполнить команды конфигурации до внесения каких-либо изменений без влияния на способ сопоставления набора команд с системой. | ||
| config | Аргумент config позволяет разработчику playbook предоставить базовые конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит текущую конфигурацию с удалённого узла. | ||
| lines | Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть абсолютно идентичными командам, найденным в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. Псевдонимы: команды | ||
| match |
| Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сопоставляются построчно. Если match установлен на strict, строки команд сопоставляются относительно позиции. Если match установлен на exact, строки команд должны быть точным совпадением. Наконец, если match установлен на none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве. | |
| parents | Упорядоченный набор родителей, однозначно определяющих секцию, с которой следует проверять команды. Если аргумент parents опущен, команды проверяются относительно набора команд верхнего уровня или глобальных команд. | ||
| provider | Значение по умолчанию: None | Объект dict, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| auth_pass | Значение по умолчанию: none | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если требуется. Если authorize — false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт для подключения к удалённому устройству. | |
| replace |
| Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен на line, изменённые строки отправляются устройству в режиме конфигурации. Если параметр replace установлен на block, весь блок команд отправляется устройству в режиме конфигурации, если какая-либо строка неверна. | |
| save |
| Аргумент save указывает модулю сохранить текущую конфигурацию в постоянную конфигурацию по окончании выполнения модуля. Если задан режим проверки, этот аргумент игнорируется. | |
| src | Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня playbook или роли. Этот аргумент взаимоисключает с 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 список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- Алёксей Табачник (@atabachnik), Самер Диб (@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.5/modules/onyx_config_module.html
