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

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.network

Для использования в книге задач укажите: community.network.ordnance_config

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
after строка		Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Как и с параметром before, это позволяет разработчику книги задач добавить набор команд, которые будут выполнены после набора команд.
backup логическое	Варианты: no ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге книги задач. Если папка не существует, она создается.
before строка		Упорядоченный набор команд для добавления в стек команд, если требуется изменение. Это позволяет разработчику книги задач выполнить команды конфигурации до внесения каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой.
config строка		Аргумент `config` позволяет разработчику книги задач предоставить базу конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит running-config с удаленного узла.
defaults логическое	Варианты: no ← да	Этот аргумент указывает, нужно ли собирать все значения по умолчанию при получении running-config удаленного устройства. При включении модуль получит текущую конфигурацию, выполнив команду `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 логическое	Варианты: no ← да	Аргумент `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
  community.network.ordnance_config:
    lines: hostname {{ inventory_hostname }}
    provider: "{{ cli }}"

- name: Configure interface settings
  community.network.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
  community.network.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 список / элементы=строка	только при указании команд	Набор команд, которые будут отправлены на удаленное устройство Пример: ['...', '...']

Авторы

Александр Тернер (@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.10/collections/community/network/ordnance_config_module.html