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

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

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

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

Обзор

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

Псевдонимы: network.ordnance.ordnance_config

Параметры

Параметр	Комментарии
after строка	Упорядоченный набор команд, которые будут добавлены в конец стека команд, если требуется внести изменения. Так же, как и с параметром before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup булево	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением любых изменений. Файл резервной копии записывается в папку `backup` в корневой директории playbook. Если директория не существует, она создается. Варианты: `false` ← (по умолчанию) `true`
before строка	Упорядоченный набор команд, которые будут добавлены в стек команд, если требуется внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации перед внесением каких-либо изменений без влияния на соответствие набора команд системе.
config строка	Аргумент `config` позволяет разработчику playbook предоставить базу конфигурации для проверки необходимых изменений конфигурации. Если этот аргумент предоставлен, модуль не загрузит текущую конфигурацию с удаленного узла.
defaults булево	Этот аргумент определяет, собирать ли все значения по умолчанию при получении текущей конфигурации удаленного устройства. При включенном значении модуль получит текущую конфигурацию, выполнив команду `show running-config all`. Варианты: `false` ← (по умолчанию) `true`
lines псевдонимы: команды строка	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства.
match строка	Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match задан как line, команды сопоставляются по строкам. Если match задан как strict, строки команд сопоставляются с учетом позиции. Если match задан как exact, строки команд должны быть идентичными. Наконец, если match задан как none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве. Варианты: `"line"` ← (по умолчанию) `"strict"` `"exact"` `"none"`
multiline_delimiter строка	Этот аргумент используется при передаче многострочного элемента конфигурации маршрутизатору Ordnance. Он определяет символ, который будет использоваться в качестве разделителя. Это относится только к действию конфигурации. По умолчанию: `"@"`
parents строка	Упорядоченный набор родительских элементов, которые однозначно определяют раздел или иерархию, по которым необходимо проверять команды. Если аргумент parents опущен, команды проверяются по набору команд верхнего уровня или глобальным командам.
replace строка	Указывает модулю, как выполнять конфигурацию на устройстве. Если аргумент replace задан как line, измененные строки передаются устройству в режиме конфигурации. Если аргумент replace задан как block, весь блок команды передается устройству в режиме конфигурации, если какая-либо строка некорректна. Варианты: `"line"` ← (по умолчанию) `"block"`
save булево	Аргумент `save` указывает модулю сохранить текущую конфигурацию в стартовую конфигурацию по окончании выполнения модуля. Если указан режим проверки, этот аргумент игнорируется. Варианты: `false` ← (по умолчанию) `true`
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 yes Пример: `"/playbooks/ansible/backup/ordnance_config.2016-07-16@22:28:34"`
updates список / элементы=строка	Набор команд, которые будут отправлены на удаленное устройство Возвращается: Только если указаны команды. Пример: `["...", "..."]`

Авторы

Александр Тернер (@alexanderturner)

Ссылки на коллекцию

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