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

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

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

Обзор

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

Параметры

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

Статус

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

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/ordnance_config_module.html