ironware_config - Управление секциями конфигурации на устройствах Brocade Ironware

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after		Значение по умолчанию: Нет	Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Также, как и с before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
authorize		Варианты: да нет ←	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
backup		Варианты: да нет ←	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если каталог не существует, он создаётся.
before		Значение по умолчанию: Нет	Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на сопоставление набора команд с системой.
commit		Варианты: слияние ← проверка	Этот аргумент определяет метод обновления при применении изменений конфигурации к удалённому узлу. Если значение установлено на слияние, обновления конфигурации сливаются с текущей конфигурацией running. Если значение установлено на проверку, изменения не вносятся на удалённый хост.
config		Значение по умолчанию: Нет	Аргумент `config` позволяет разработчику playbook предоставить базовая конфигурацию для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит running-config с удалённого узла.
lines		Значение по умолчанию: Нет	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в конфигурации running устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды
match		Варианты: строка ← строгое точное нет	Инструктирует модуль о способе выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлено на строка, команды сопоставляются по строкам. Если match установлено на строгое, строки команд сопоставляются относительно позиции. Если match установлено на точное, строки команд должны быть идентичны. Наконец, если match установлено на нет, модуль не будет пытаться сравнить исходную конфигурацию с конфигурацией running на удалённом устройстве.
parents		Значение по умолчанию: Нет	Упорядоченный набор родителей, которые однозначно идентифицируют раздел, с которым следует сравнить команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальным командам.
provider		Значение по умолчанию: Нет	Объект dict, содержащий детали подключения.
	username		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	authorize	Варианты: да нет ←	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	auth_pass	Значение по умолчанию: нет	Указывает пароль, если требуется войти в привилегированный режим на удалённом устройстве. Если authorize — ложь, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	host		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	timeout	Значение по умолчанию: 10	Устанавливает таймаут бездействия подключения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
	password	Значение по умолчанию: Нет	Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port	Значение по умолчанию: 22	Указывает порт для создания соединения с удалённым устройством.
replace		Варианты: строка ← блок	Инструктирует модуль о способе выполнения конфигурации на устройстве. Если аргумент replace установлен на строка, изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен на блок, весь блок команды передаётся устройству в режиме конфигурации, если какая-либо строка неверна
save_when (добавлено в 2.4)		Варианты: всегда никогда ← изменено	Когда в конфигурации running устройства вносятся изменения, по умолчанию эти изменения не копируются в энергонезависимую память. Использование этого аргумента изменит это. Если аргумент установлен на всегда, конфигурация running всегда копируется в startup-config, и флаг изменено всегда устанавливается в True. Если аргумент установлен на изменено, конфигурация running копируется в startup-config только в том случае, если она изменилась с момента последнего сохранения в startup-config. Если аргумент установлен на никогда, конфигурация running никогда не копируется в startup-config
src		Значение по умолчанию: Нет	Указывает путь к исходному файлу, который содержит конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня playbook или роли. Этот аргумент взаимоисключающий с lines, parents.
update		Варианты: слияние ← проверка	Аргумент update управляет тем, как обрабатываются операторы конфигурации на удалённом устройстве. Допустимые значения для аргумента update — слияние и проверка. При установке аргумента на слияние изменения конфигурации сливаются с текущей конфигурацией running устройства. При установке аргумента на проверку изменения конфигурации определяются, но фактически на удалённом устройстве не настраиваются.

Примеры

- 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 список	всегда	Набор команд, которые будут переданы на удалённое устройство Пример: ['...', '...']

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Автор

Пол Бейкер (@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.5/modules/ironware_config_module.html