Модуль community.network.cnos_config – Управление секциями конфигурации Lenovo CNOS

Примечание

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

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

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

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

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

Обзор

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

Псевдонимы: network.cnos.cnos_config

Параметры

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

Примечания

Примечание

Проверено на CNOS 10.9.1

Примеры

Tasks: The following are examples of using the module cnos_config.
---
- name: Configure top level configuration
  community.network.cnos_config:
    "lines: hostname {{ inventory_hostname }}"

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

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

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

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

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

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

Авторы

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/cnos_config_module.html