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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
after -		Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Как и в случае с before, это позволяет разработчику playbook добавить набор команд, которые будут выполняться после набора команд.
backup boolean	Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если папка не существует, она создается.
before -		Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения любых изменений, не влияя на то, как набор команд сопоставляется с системой.
config -		Аргумент `config` позволяет разработчику playbook указать базовая конфигурация для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит running-config с удаленного узла.
defaults boolean	Варианты: no ← yes	Этот аргумент указывает, следует ли собирать все значения по умолчанию при получении конфигурации remote device. При включении модуль получит текущую конфигурацию, выполнив команду `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 строка	при backup = yes	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/ordnance_config.2016-07-16@22:28:34
updates список	Только при указании команд.	Набор команд, которые будут отправлены на удаленное устройство Пример: ['...', '...']

Статус

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

Авторы

Александр Тёрнер (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.7/modules/ordnance_config_module.html