community.network.ironware_config – Управление разделами конфигурации на устройствах Extreme Ironware
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.ironware_config.
Обзор
- Конфигурации Extreme Ironware используют простой синтаксис блочного отступа для сегментирования конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации Ironware детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд, добавляемых в конец стека команд, если требуется внести изменения. Подобно параметру before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд. | ||
| authorize булево |
| Устаревший Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации обратитесь к руководству IronWare Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано иное, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| backup булево |
| Этот аргумент заставит модуль создать полную резервную копию текущего running-config с удалённого устройства перед внесением каких-либо изменений. Если значение backup_options не указано, файл резервной копии записывается в папку backup в корневой директории плейбука. Если директория не существует, она будет создана. | |
| backup_options словарь | Это объект типа dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра считывается только тогда, когда backup установлено в да. Если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр задаёт путь, заканчивающийся именем директории, в которой будет храниться файл конфигурации резервной копии. Если директория не существует, она будет создана. Имя файла — это либо значение filename, либо имя по умолчанию, как описано в filename описании параметров. Если значение пути не указано, будет создана директория backup в текущей рабочей директории, а конфигурация резервной копии будет скопирована в filename внутри директории backup. | ||
| filename строка | Имя файла, которое будет использоваться для хранения конфигурации резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> | ||
| before строка | Упорядоченный набор команд, помещаемых в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до внесения каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| commit строка |
| Этот аргумент определяет метод обновления, который следует использовать при применении изменений конфигурации к удалённому узлу. Если значение установлено в слияние, обновления конфигурации будут слиты с текущей конфигурацией. Если значение установлено в проверка, изменения на удалённом хосте не будут внесены. | |
| config строка | Аргумент config позволяет разработчику плейбука предоставить базу конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не будет загружать текущую конфигурацию с удалённого узла. | ||
| lines строка | Упорядоченный набор команд, которые должны быть сконфигурированы в данном разделе. Команды должны быть точными копиями команд, присутствующих в текущей конфигурации устройства. Убедитесь, что вы учитываете синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды | ||
| match строка |
| Инструктирует модуль о способе сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сопоставляются по строкам. Если match установлено в строгое, строки команд сопоставляются с учётом позиции. Если match установлено в точное, строки команд должны быть точными совпадениями. Наконец, если match установлено в ничего, модуль не будет пытаться сравнивать исходную конфигурацию с текущей конфигурацией на удалённом устройстве. | |
| parents строка | Упорядоченный набор родителей, однозначно определяющих раздел, с которым следует проверять команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд. | ||
| provider словарь | Устаревший Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации обратитесь к руководству IronWare Platform Options. Объект типа dict, содержащий детали соединения. | ||
| auth_pass строка | Задаёт пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано иное, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения 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 установлен в строка, изменённые строки отправляются устройству в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд отправляется устройству в режиме конфигурации, если хотя бы одна строка некорректна. | |
| save_when строка |
| При внесении изменений в текущую конфигурацию устройства, эти изменения по умолчанию не копируются в энергонезависимую память. Используя этот аргумент, вы измените это поведение. Если аргумент установлен в всегда, то текущая конфигурация всегда будет скопирована в начальную конфигурацию, и флаг изменено всегда будет установлен в True. Если аргумент установлен в изменено, то текущая конфигурация будет скопирована в начальную конфигурацию только в том случае, если она изменилась с момента последнего сохранения в начальную конфигурацию. Если аргумент установлен в никогда, текущая конфигурация никогда не будет скопирована в начальную конфигурацию. | |
| src строка | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня плейбука или роли. Этот аргумент взаимоисключающий с lines, parents. | ||
| update string |
| The update argument controls how the configuration statements are processed on the remote device. Valid choices for the update argument are merge and check. When the argument is set to merge, the configuration changes are merged with the current device running configuration. When the argument is set to check the configuration updates are determined but not actually configured on the remote device. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible для сетей
Примеры
- name: Run commands that should be configured in the section
community.network.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 string | при backup = yes | Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34 |
| updates list / elements=string | всегда | Набор команд, которые будут отправлены на удаленное устройство Пример: ['...', '...'] |
Авторы
- 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.10/collections/community/network/ironware_config_module.html
