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. [community]
Авторы
- 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.9/modules/cnos_config_module.html
