ordnance_config - Управление секциями конфигурации Ordnance

Новая в версии 2.3.

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

Обзор

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

Параметры

параметр	обязательный	по умолчанию	выбор	комментарии
after	нет			Упорядоченный набор команд, которые добавляются в конец стека команд, если необходимо внести изменения. Так же как и с before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup	нет		да нет	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если папка не существует, она создается.
before	нет			Упорядоченный набор команд, которые добавляются в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой.
commands	нет			Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть точно такими же, как и на устройстве running-config. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически модифицируются анализатором конфигурации устройства. псевдонимы: commands
config	нет			Аргумент `config` позволяет разработчику playbook предоставить базу конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не будет загружать running-config с удаленного узла.
defaults	нет		да нет	Этот аргумент указывает, собирать ли все значения по умолчанию при получении конфигурации running удаленного устройства. При включении модуль получит текущую конфигурацию, выполнив команду `show running-config all`.
match	нет	строка	строка строго точно ничего	Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сопоставляются построчно. Если match установлен в строго, строки команд сопоставляются относительно позиции. Если match установлен в точно, строки команд должны быть идентичными. Наконец, если match установлен в ничего, модуль не будет пытаться сравнивать исходную конфигурацию с конфигурацией running на удаленном устройстве.
multiline_delimiter	нет	@		Этот аргумент используется при передаче многострочного конфигурационного элемента на маршрутизатор Ordnance. Он указывает символ, который следует использовать в качестве разделителя. Это относится только к действию конфигурации.
parents	нет			Упорядоченный набор родителей, которые однозначно идентифицируют секцию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами.
replace	нет	строка	строка блок	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в строка, измененные строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команды передается устройству в режиме конфигурации, если какая-либо строка неверна.
save	нет		да нет	Аргумент `save` указывает модулю сохранить running- конфигурацию в startup-конфигурацию по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src	нет			Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога playbook или роли. Этот аргумент взаимоисключает lines.

Примеры

---
# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: RouterName
    password: password
    transport: cli

---
- name: configure top level configuration
  ordnance_config:
    lines: hostname {{ inventory_hostname }}
    provider: "{{ cli }}"

- name: configure interface settings
  ordnance_config:
    lines:
      - description test interface
      - ip address 172.31.1.1 255.255.255.0
    parents: interface Ethernet1
    provider: "{{ cli }}"

- name: configure bgp router
  ordnance_config:
    lines:
      - neighbor 1.1.1.1 remote-as 1234
      - network 10.0.0.0/24
    parents: router bgp 65001
    provider: "{{ cli }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:

имя	описание	возвращено	тип	пример
backup_path	Полный путь к файлу резервной копии	при backup = да	строка	/playbooks/ansible/backup/ordnance_config.2016-07-16@22:28:34
updates	Набор команд, которые будут переданы на удаленное устройство	Только когда указан commands.	список	['...', '...']

Статус

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

Для получения помощи в разработке модулей, если вы захотите, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ordnance_config_module.html