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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
after	Значение по умолчанию: None	Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Подобно before, это позволяет разработчику playbook добавить набор команд, которые должны быть выполнены после набора команд.
backup	Варианты: yes no ←	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если каталог не существует, он будет создан.
before	Значение по умолчанию: None	Упорядоченный набор команд для помещения в стек команд, если требуется внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения каких-либо изменений, не влияя на способ сопоставления набора команд с системой.
config	Значение по умолчанию: None	Аргумент `config` позволяет разработчику playbook указать базовую конфигурацию, которая будет использоваться для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не будет загружать running-config с удаленного узла.
defaults	Варианты: yes no ←	Этот аргумент указывает, следует ли собирать все значения по умолчанию при получении конфигурации running удаленного устройства. При включении, модуль получит текущую конфигурацию, выполнив команду `show running-config all`.
lines	Значение по умолчанию: None	Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть идентичными командам, найденным в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды
match	Варианты: строка ← строго точно нет	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сопоставляются по строкам. Если match установлен в строго, строки команд сопоставляются относительно позиции. Если match установлен в точно, строки команд должны быть полным совпадением. Наконец, если match установлен в нет, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
multiline_delimiter	Значение по умолчанию: @	Этот аргумент используется при отправке многострочного элемента конфигурации на маршрутизатор Ordnance. Он определяет символ, который используется в качестве разделителя. Это относится только к действию конфигурации
parents	Значение по умолчанию: None	Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию или иерархию, с которой следует сравнить команды. Если аргумент parents опущен, команды сравниваются со списком команд верхнего уровня или глобальных команд.
replace	Варианты: строка ← блок	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в строка, изменённые строки отправляются устройству в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд отправляется устройству в режиме конфигурации, если какая-либо строка неверна.
save	Варианты: yes no ←	Аргумент `save` инструктирует модуль сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src	Значение по умолчанию: None	Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте управления 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 список	Только когда указаны команды.	Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...']

Статус

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

Автор

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