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