community.network.cnos_config – Управление разделами конфигурации Lenovo CNOS
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в книге задач, укажите: community.network.cnos_config
Обзор
- Конфигурации Lenovo CNOS используют простой синтаксис блочного отступа для разделения конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации CNOS детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin boolean |
| Переход в административный режим конфигурации для внесения изменений в конфигурацию устройства. | |
| after string | Последовательность команд для добавления в конец стека команд, если требуется изменение. Как и с параметром before, это позволяет разработчику книги задач добавить набор команд, которые будут выполнены после набора команд. | ||
| backup boolean |
| Этот параметр заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не указано, резервный файл записывается в папку backup в корневой директории книги задач. Если директория не существует, она создается. | |
| backup_options dictionary | Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к резервному файлу. Значение этого параметра читается только тогда, когда backup установлено в значение да. Если backup установлено в значение нет, этот параметр будет проигнорирован. | ||
| dir_path path | Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться резервный файл конфигурации. Если директория не существует, она будет создана, и имя файла будет либо значением filename, либо значением по умолчанию, как описано в filename описание параметров. Если значение пути не указано, в текущем рабочем каталоге будет создана директория backup, и резервная копия конфигурации будет скопирована в filename в директории backup. | ||
| filename string | Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <hostname>_config.<current-date>@<current-time> | ||
| before string | Последовательность команд для добавления в начало стека команд, если требуется изменение. Это позволяет разработчику книги задач выполнить команды конфигурации перед внесением изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| comment string | Значение по умолчанию: "настроен с помощью cnos_config" | Позволяет указать описание изменения для включения при сохранении конфигурации. Если конфигурация не изменена или не сохранена, этот параметр игнорируется. | |
| config string | По умолчанию модуль подключается к удаленному устройству и получает текущую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно запрашивать текущую конфигурацию для каждой задачи в книге задач. Параметр config позволяет разработчику указать конфигурацию для использования в качестве базовой конфигурации для сравнения. | ||
| lines string | Последовательность команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как в конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды | ||
| match string |
| Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сравниваются построчно. Если match установлено в строго, строки команд сравниваются с учетом позиции. Если match установлено в точно, строки команд должны совпадать. И, наконец, если match установлено в нет, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удаленного устройства. | |
| parents string | Последовательность родителей, которые однозначно идентифицируют раздел, с которым должны проверяться команды. Если параметр parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд. | ||
| replace string |
| Указывает модулю способ выполнения конфигурации на устройстве. Если replace установлено в строка, измененные строки передаются устройству в режиме конфигурации. Если replace установлено в блок, весь блок команд передается устройству в режиме конфигурации, если какая-либо строка неверна. | |
| 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 равно да | Полный путь к резервному файлу Пример: /playbooks/ansible/backup/cnos01.2016-07-16@22:28:34 |
| updates list / elements=string | только при указании lines | Набор команд, которые будут отправлены на удаленное устройство Пример: ['...', '...'] |
Авторы
- 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.10/collections/community/network/cnos_config_module.html
