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

Примечание

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin boolean		Варианты: no ← yes	Переход в административный режим конфигурации для внесения изменений в конфигурацию устройства.
after string			Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменение. Так же как и с before, это позволяет автору книги задач добавлять набор команд, которые будут выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением любых изменений. Если значение `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневой директории книги задач. Если директория не существует, она создается.
backup_options dictionary			Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только когда `backup` установлено в yes, если `backup` установлено в no, этот параметр будет проигнорирован.
	dir_path path		Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет сначала создана, а имя файла – это либо значение `filename`, либо имя файла по умолчанию, как описано в параметрах `filename`. Если значение пути не задано, в этом случае будет создана директория backup в текущем рабочем каталоге, и резервная копия конфигурации будет скопирована в `filename` в директории backup.
	filename string		Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <hostname>_config.<current-date>@<current-time>
before string			Упорядоченный набор команд для добавления в начало стека команд, если необходимо внести изменение. Это позволяет автору книги задач выполнить команды конфигурации перед добавлением любых изменений без влияния на способ сопоставления набора команд с системой.
comment string		Значение по умолчанию: "configured by cnos_config"	Позволяет указать описание для коммита, которое будет включено при сохранении конфигурации. Если конфигурация не изменена или не сохранена, этот аргумент игнорируется.
config string			Модуль по умолчанию подключается к удаленному устройству и извлекает текущую running-config для использования в качестве основы для сравнения с содержимым источника. Бывают случаи, когда нежелательно получать текущую running-config для каждой задачи в книге задач. Параметр config позволяет реализатору передать конфигурацию, которую необходимо использовать в качестве базовой конфигурации для сравнения.
lines string			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть такими же, как в конфигурации running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды
match string		Варианты: line ← strict exact none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сопоставляются по строкам. Если match установлен в strict, строки команд сопоставляются с учётом позиции. Если match установлен в exact, строки команд должны быть точным совпадением. Наконец, если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents string			Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел, с которым должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
replace string		Варианты: line ← block config	Указывает модулю способ выполнения конфигурации на устройстве. Если replace установлен в line, изменённые строки передаются на устройство в режиме конфигурации. Если replace установлен в block, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка некорректна.
src string			Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте 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: yes

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

Возвращаемые значения

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

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

Авторы

Anil Kumar Muraleedharan (@amuraleedhar)

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