Модуль community.network.enos_config — Управление разделами конфигурации Lenovo ENOS

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.network.enos_config.

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

Обзор

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

Псевдонимы: network.enos.enos_config

Параметры

Параметр	Комментарии
admin boolean	Переходит в режим администрирования конфигурации для внесения изменений в конфигурацию устройства. Варианты: `false` ← (по умолчанию) `true`
after строка	Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Подобно параметру before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
auth_pass строка	Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не имеет действия. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
authorize boolean	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`. Варианты: `false` ← (по умолчанию) `true`
backup boolean	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не задано, резервная копия файла записывается в папку `backup` в корневом каталоге плейбука. Если каталог не существует, он создается. Варианты: `false` ← (по умолчанию) `true`
backup_options словарь	Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути к резервной копии файла. Значение этого параметра читается только тогда, когда `backup` установлено в yes. Если `backup` установлено в no, этот параметр будет проигнорирован.
dir_path путь	Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться резервная копия файла конфигурации. Если каталог не существует, он будет создан сначала, а имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в параметрах `filename`. Если значение пути не указано, в текущем рабочем каталоге будет создан каталог backup, и резервная копия конфигурации будет скопирована в `filename` внутри каталога backup.
filename строка	Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before строка	Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до добавления любых изменений, не затрагивая способ сопоставления набора команд с системой.
comment строка	Позволяет указать описание коммита, которое будет включено при сохранении конфигурации. Если конфигурация не изменена или не сохранена, этот аргумент игнорируется. По умолчанию: `"configured by enos_config"`
config строка	Модуль по умолчанию подключается к удаленному устройству и извлекает текущую рабочую конфигурацию, чтобы использовать ее в качестве основы для сравнения с содержимым источника. В некоторых случаях нежелательно запрашивать текущую рабочую конфигурацию для каждой задачи в плейбуке. Аргумент config позволяет разработчику передать конфигурацию в качестве базовой конфигурации для сравнения.
строки псевдонимы: команды строка	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства.
match строка	Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сравниваются построчно. Если match установлено в строго, строки команд сравниваются по положению. Если match установлено в точно, строки команд должны быть тождественными. Наконец, если match установлено в нет, модуль не будет пытаться сравнивать конфигурацию источника с текущей конфигурацией на удаленном устройстве. Варианты: `"line"` ← (по умолчанию) `"strict"` `"exact"` `"none"`
parents строка	Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел, с которым должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
replace строка	Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в строка, то измененные строки отправляются устройству в режиме конфигурации. Если параметр replace установлен в блок, весь блок команды отправляется на устройство в режиме конфигурации, если какая-либо строка неверна. Варианты: `"line"` ← (по умолчанию) `"block"` `"config"`

src

string

Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога плейбука или роли. Этот аргумент взаимоисключающий с lines, parents.

Примечания

Примечание

Проверено на ENOS 8.4.1

Примеры

- name: Configure top level configuration
  community.network.enos_config:
    "lines: hostname {{ inventory_hostname }}"

- name: Configure interface settings
  community.network.enos_config:
    lines:
      - enable
      - ip ospf enable
    parents: interface ip 13

- name: Load a config from disk and replace the current config
  community.network.enos_config:
    src: config.cfg
    backup: true

- name: Configurable backup path
  community.network.enos_config:
    src: config.cfg
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
backup_path string	Полный путь к резервной копии файла Возвращается: при backup yes Пример: `"/playbooks/ansible/backup/enos01.2016-07-16@22:28:34"`
updates list / elements=string	Набор команд, которые будут отправлены на удалённое устройство Возвращается: Только когда указан lines. Пример: `["...", "..."]`

Авторы

Anil Kumar Muraleedharan (@amuraleedhar)

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

© 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/enos_config_module.html