community.network.ironware_config – Управление разделами конфигурации на устройствах Extreme Ironware
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в playbook, укажите: 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 |
| Аргумент update управляет обработкой операторов конфигурации на удалённом устройстве. Допустимые значения аргумента update — merge и check. При значении merge изменения конфигурации объединяются с текущей рабочей конфигурацией устройства. При значении check изменения конфигурации определяются, но не применяются непосредственно на удалённом устройстве. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 = да | Полный путь к резервной копии Пример: /playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34 |
| updates list / elements=string | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...'] |
Авторы
- Paul Baker (@paulquack)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ironware_config_module.html
