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

Примечание

Этот плагин входит в сборку community.network (версия 2.0.1).

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

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

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

Обзор

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

Параметры

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

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ordnance_config_module.html