ordnance_config – Управление разделами конфигурации Ordnance

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

Обзор

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

Параметры

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

Примеры

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

Статус

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

Авторы

Александр Тёрнер (@alexanderturner) <alex.turner@ordnance.io>

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/ordnance_config_module.html