ironware_config – Управление разделами конфигурации на устройствах Extreme Ironware

Новое в версии 2.5.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Конфигурации Extreme Ironware используют простой синтаксис с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации Ironware детерминированным способом.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд, которые добавляются в конец стека команд, если требуется изменение. Как и в случае с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
authorize boolean		Варианты: no ← yes	Устарело Начиная с Ansible 2.7, рекомендуется использовать `connection: network_cli` и `become: yes`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству IronWare Platform Options. Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущего `running-config` с удалённого устройства перед внесением любых изменений. Если значение `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневой директории плейбука. Если директория не существует, она создаётся.
backup_options словарь добавлен в 2.8			Это объект типа dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только тогда, когда `backup` установлено в yes. Если `backup` установлено в no, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр задаёт путь, заканчивающийся именем директории, в которой будет храниться конфигурационный файл резервной копии. Если директория не существует, она будет создана. Имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в параметрах `filename`. Если значение пути не указано, в текущей рабочей директории будет создана директория backup, и конфигурация резервной копии будет скопирована в `filename` внутри директории backup.
	filename -		Имя файла, которое будет использоваться для хранения конфигурационного файла резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>.
before -			Упорядоченный набор команд, которые добавляются в начало стека команд, если требуется изменение. Это даёт разработчику плейбука возможность выполнить команды конфигурации перед внесением изменений, не влияя на то, как набор команд сопоставляется с системой.
commit -		Варианты: merge ← check	Этот параметр указывает метод обновления для применения изменений конфигурации к удалённому узлу. Если значение установлено в merge, обновления конфигурации объединяются с текущей конфигурацией. Если значение установлено в check, никакие изменения не вносятся на удалённый хост.
config -			Аргумент `config` позволяет разработчику плейбука предоставить базу конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не будет загружать текущую конфигурацию с удалённого узла.
lines -			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды
match -		Варианты: line ← strict exact none	Инструктирует модуль о том, как сопоставлять набор команд с текущей конфигурацией устройства. Если 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 равно false, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `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 -		Варианты: line ← block	Инструктирует модуль о способе выполнения конфигурации на устройстве. Если параметр replace установлен в line, изменённые строки отправляются устройству в режиме конфигурации. Если параметр replace установлен в block, весь блок команд отправляется устройству в режиме конфигурации, если какая-либо строка неверна.

END_OF_DOCUMENT_MARKER

save_when - добавлено в 2.4	Варианты: always never ← modified	При внесении изменений в текущую конфигурацию устройства, по умолчанию эти изменения не копируются в энергонезависимую память. Использование данного аргумента изменит это поведение. Если аргумент установлен в always, то текущая конфигурация всегда будет копироваться в стартовую конфигурацию, и флаг modified всегда будет установлен в True. Если аргумент установлен в modified, то текущая конфигурация будет скопирована в стартовую конфигурацию только в том случае, если она изменилась с момента последней сохранения в стартовую конфигурацию. Если аргумент установлен в never, текущая конфигурация никогда не будет скопирована в стартовую конфигурацию
src -		Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте управления Ansible или относительным путем от корневой директории playbook или роли. Этот аргумент несовместим с аргументами lines, parents.
update -	Варианты: merge ← check	Аргумент update управляет тем, как обрабатываются операторы конфигурации на удалённом устройстве. Допустимые значения для аргумента update — merge и check. Когда аргумент установлен в merge, изменения конфигурации объединяются с текущей рабочей конфигурацией устройства. Когда аргумент установлен в check, изменения конфигурации определяются, но фактически не настраиваются на удалённом устройстве.

Примечания

Примечание

Дополнительную информацию об использовании 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 = yes	Полный путь к резервной копии Пример: /playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34
updates список	всегда	Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...']

Статус

Интерфейс этого модуля не гарантируется как обратный. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/ironware_config_module.html