ironware_config – Управление разделами конфигурации на устройствах Extreme Ironware
Новое в версии 2.5.
Обзор
- Конфигурации Extreme Ironware используют простой синтаксис с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации Ironware детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after - | Упорядоченный набор команд, которые будут добавлены в конец стека команд, если требуется внести изменения. Как и с параметром before, это позволяет разработчику playbook добавить набор команд для выполнения после набора команд. | ||
| authorize boolean |
| Устаревший Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IronWare Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| backup boolean |
| Этот параметр заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневом каталоге playbook. Если каталог не существует, он создаётся. | |
| before - | Упорядоченный набор команд, которые будут помещены в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| commit - |
| Этот параметр задаёт метод обновления для применения изменений конфигурации на удалённом узле. Если значение установлено в merge, обновления конфигурации объединяются с текущей конфигурацией. Если значение установлено в check, никакие изменения на удалённом хосте не выполняются. | |
| config - | Параметр config позволяет разработчику playbook указать базу конфигурации, которая будет использоваться для проверки необходимых изменений конфигурации. Если этот параметр предоставлен, модуль не будет загружать текущую конфигурацию с удалённого узла. | ||
| lines - | Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды | ||
| match - |
| Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сопоставляются построчно. Если match установлен в strict, строки команд сопоставляются с учётом позиции. Если match установлен в exact, строки команд должны быть точным совпадением. Наконец, если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве. | |
| parents - | Упорядоченный набор родителей, которые однозначно идентифицируют раздел, с которым должны сравниваться команды. Если параметр parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами. | ||
| provider - | Устаревший Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IronWare Platform Options. Объект типа dict, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот параметр ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения 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_when - добавлено в 2.4 |
| При внесении изменений в текущую конфигурацию устройства, изменения по умолчанию не копируются в энергонезависимую память. Используя этот параметр, можно изменить это поведение. Если параметр установлен в always, текущая конфигурация всегда копируется в стартовую конфигурацию, и флаг modified всегда устанавливается в True. Если параметр установлен в modified, текущая конфигурация копируется в стартовую только в том случае, если она изменилась с момента последнего сохранения в стартовую конфигурацию. Если параметр установлен в never, текущая конфигурация никогда не копируется в стартовую. | |
| src - | Указывает путь к исходному файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневого каталога playbook или роли. Этот параметр взаимоисключающий с параметрами lines и parents. | ||
| обновление - |
| Аргумент обновление управляет тем, как обрабатываются инструкции конфигурации на удалённом устройстве. Допустимые значения для аргумента обновление — слияние и проверка. При значении слияние изменения конфигурации объединяются с текущей рабочей конфигурацией устройства. При значении проверка изменения конфигурации определяются, но не настраиваются на удалённом устройстве. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
Примеры
- ironware_config:
lines:
- port-name test
- enable
- load-interval 30
- rate-limit input broadcast unknown-unicast multicast 521216 64000
parents: ['interface ethernet 1/2']
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup равно да | Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34 |
| updates список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...'] |
Статус
- Гарантия обратной совместимости данного модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Paul Baker (@paulquack)
Подсказка
Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/ironware_config_module.html
