ironware_config - Управление разделами конфигурации на устройствах Extreme Ironware
Новая в версии 2.5.
Обзор
- Конфигурации Extreme Ironware используют простой синтаксис файла с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации Ironware детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after | Упорядоченный набор команд, которые нужно добавить в конец стека команд, если требуется внести изменения. Так же, как и с before, это позволяет разработчику плейбука добавить набор команд, которые должны быть выполнены после набора команд. | ||
| authorize bool |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| backup bool |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневой директории плейбука. Если директория не существует, она будет создана. | |
| before | Упорядоченный набор команд, которые необходимо добавить в стек команд, если требуется внести изменения. Это дает разработчику плейбука возможность выполнить команды конфигурации перед внесением любых изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| commit |
| Этот аргумент определяет метод обновления, который нужно использовать при применении изменений конфигурации к удаленному узлу. Если значение установлено в merge, обновления конфигурации объединяются с текущей конфигурацией running-config. Если значение установлено в check, изменения на удаленном узле не вносятся. | |
| config | Аргумент config позволяет разработчику плейбука указать базу конфигурации, которая используется для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит running-config с удаленного узла. | ||
| lines | Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть точно такими же, как и в текущей конфигурации устройства running-config. Обратите внимание на синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды | ||
| match |
| Инструктирует модуль о способе сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сопоставляются по строкам. Если match установлен в strict, строки команд сопоставляются с учетом позиции. Если match установлен в exact, строки команд должны быть точным совпадением. Наконец, если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией running на удаленном устройстве. | |
| parents | Упорядоченный набор родителей, которые однозначно идентифицируют раздел, с которым нужно сравнить команды. Если аргумент parents опущен, команды сравниваются со списком команд верхнего уровня или глобальных команд. | ||
| provider | Объект словаря, содержащий данные подключения. | ||
| host | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта. | ||
| port | По умолчанию: 22 | Указывает порт, который необходимо использовать при создании подключения к удаленному устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль, который требуется для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания бездействия подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
| replace |
| Инструктирует модуль о способе выполнения конфигурации на устройстве. Если аргумент replace установлен в line, измененные строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка некорректна | |
| save_when (добавлено в 2.4) |
| При внесении изменений в конфигурацию running устройства, по умолчанию изменения не копируются в постоянное хранилище. Использование этого аргумента изменит это. Если аргумент установлен в always, тогда running-config всегда будет скопирован в startup-config, и флаг modified всегда будет установлен в True. Если аргумент установлен в modified, тогда running-config будет скопирован в startup-config только в том случае, если он изменился с момента последнего сохранения в startup-config. Если аргумент установлен в never, running-config никогда не будет скопирован в startup-config. | |
| src | Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня плейбука или роли. Этот аргумент несовместим с аргументами lines и parents. | ||
| update |
| Аргумент update управляет тем, как обрабатываются операторы конфигурации на удаленном устройстве. Допустимые значения для аргумента update — merge и check. Когда аргумент установлен в merge, изменения конфигурации объединяются с текущей конфигурацией running устройства. Когда аргумент установлен в check, обновления конфигурации определяются, но фактически не конфигурируются на удаленном устройстве. | |
Примеры
- 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 равно yes | Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34 |
| updates список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...'] |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. в этом месте.
Автор
- Павел Бейкер (@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.6/modules/ironware_config_module.html
