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

Новое в версии 2.6.

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin boolean		Варианты: нет ← да	Переход в административный режим конфигурации для внесения изменений в конфигурацию устройства.
after -			Упорядоченный набор команд, которые нужно добавить в конец стека команд, если требуется изменение. Так же, как и с параметром before, это позволяет разработчику playbook добавить набор команд, которые должны выполняться после набора команд.
backup boolean		Варианты: нет ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не задано, резервный файл записывается в папку `backup` в корневой директории playbook. Если директория не существует, она создается.
backup_options словарь добавлен в 2.8			Это объект словаря, содержащий конфигурируемые параметры, связанные с путем к резервному файлу. Значение этого параметра считывается только тогда, когда `backup` установлено в да, если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться резервный файл конфигурации. Если директория не существует, она будет сначала создана, а имя файла будет либо значением `filename`, либо именем по умолчанию, как описано в описании параметров `filename`. Если значение пути не задано, в этом случае будет создана директория backup в текущей рабочей директории, и резервная конфигурация будет скопирована в `filename` внутри директории backup.
	filename -		Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before -			Упорядоченный набор команд, которые следует поместить в стек команд, если требуется изменение. Это позволяет разработчику playbook выполнить команды конфигурации до внесения каких-либо изменений без влияния на способ сопоставления набора команд с системой.
comment -		По умолчанию: "настроено модулем cnos_config"	Позволяет указать описание коммита, которое будет включено при коммите конфигурации. Если конфигурация не изменена или не коммитирована, этот аргумент игнорируется.
config -			По умолчанию модуль подключится к удаленному устройству и получит текущую running-config, чтобы использовать ее в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую running-config для каждой задачи в playbook. Аргумент config позволяет разработчику передать конфигурацию в качестве базовой конфигурации для сравнения.
lines -			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды
match -		Варианты: строка ← строго точно нет	Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сопоставляются по строкам. Если match установлено в строго, строки команд сопоставляются с учетом позиции. Если match установлено в точно, строки команд должны точно совпадать. Наконец, если match установлено в нет, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве.
parents -			Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел, с которым следует проверить команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальным командам.
replace -		Варианты: строка ← блок конфигурация	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в строка, измененные строки передаются на устройство в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд передается на устройство в режиме конфигурации, если какая-либо строка неверна.
src -			Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневой директории playbook или роли. Этот аргумент взаимоисключающий с lines, parents.

Примечания

Примечание

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

Примеры

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

- name: configure interface settings
  cnos_config:
    lines:
      - enable
      - ip ospf enable
    parents: interface ip 13

- name: load a config from disk and replace the current config
  cnos_config:
    src: config.cfg
    backup: yes

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

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

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

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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Anil Kumar Muraleedharan (@amuraleedhar)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/cnos_config_module.html