dellemc.os10.os10_config – Управление разделами конфигурации Dell EMC SmartFabric OS10
Примечание
Этот плагин входит в коллекцию dellemc.os10 (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install dellemc.os10
Чтобы использовать его в книге задач, укажите: dellemc.os10.os10_config
Описание
- Конфигурации OS10 используют простой синтаксис файла с отступами для разделения конфигурации на разделы. Этот модуль предоставляет реализацию работы с разделами конфигурации OS10 детерминированным способом.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after список / элементы=строка | Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Аналогично параметру before, это позволяет разработчику книги задач добавить набор команд для выполнения после набора команд. | ||
| backup булево |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не указано, файл резервной копии записывается в папку backup в корневой директории книги задач. Если папка не существует, она создается. | |
| backup_options словарь | Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только при условии, что backup установлено в да, если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться резервный файл конфигурации. Если каталог не существует, он будет сначала создан, а имя файла — это либо значение filename, либо имя файла по умолчанию, как описано в параметрах filename. Если значение пути не указано, в этом случае будет создан каталог backup в текущей рабочей директории, и резервная конфигурация будет скопирована в filename в каталоге backup. | ||
| filename строка | Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> | ||
| before список / элементы=строка | Упорядоченный набор команд, которые нужно добавить в стек команд, если необходимо произвести изменение. Это позволяет разработчику книги задач выполнить команды конфигурации до внесения каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| config строка | По умолчанию модуль подключится к удаленному устройству и получит текущую рабочую конфигурацию для сравнения с содержимым исходника. Бывают случаи, когда не нужно получать текущую рабочую конфигурацию для каждой задачи в книге задач. Аргумент config позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения. | ||
| lines список / элементы=строка | Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть точно такими же, как и в рабочей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически модифицируются анализатором конфигурации устройства. Этот аргумент несовместим с аргументом src. псевдонимы: команды | ||
| match строка |
| Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сопоставляются по строкам. Если match установлено в строго, строки команд сопоставляются относительно позиции. Если match установлено в точно, строки команд должны быть идентичны. Наконец, если match установлено в ничего, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удаленного устройства. | |
| parents список / элементы=строка | Упорядоченный набор родителей, которые однозначно идентифицируют раздел или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд. | ||
| provider словарь | Объект типа dict, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS | ||
| authorize булево |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password строка | Пароль для аутентификации сеанса SSH с удаленным устройством. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD | ||
| port целое число | Указывает порт для подключения к удаленному устройству. | ||
| ssh_keyfile путь | Путь к SSH-ключу, используемому для аутентификации сеанса SSH с удаленным устройством. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE | ||
| timeout целое число | Указывает таймаут бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | ||
| username строка | Пользователь для аутентификации сеанса SSH с удаленным устройством. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME | ||
| replace строка |
| Указывает модулю способ внесения конфигурации на устройство. Если параметр replace установлен в строка, модифицированные строки отправляются на устройство в режиме конфигурации. Если параметр replace установлен в блок, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна. | |
| save булево |
| Аргумент save инструктирует модуль сохранить рабочую конфигурацию в стартовую конфигурацию по завершении работы модуля. Если задан режим проверки, этот аргумент игнорируется. | |
| src путь | Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневой директории книги задач или роли. Этот аргумент несовместим с аргументом lines. | ||
| update строка |
| Аргумент update контролирует, как обрабатываются операторы конфигурации на удаленном устройстве. Допустимые значения для аргумента update — слияние и проверка. Когда этот аргумент установлен в слияние, изменения конфигурации сливаются с текущей рабочей конфигурацией устройства. Когда этот аргумент установлен в проверка, изменения конфигурации определяются, но фактически не настраиваются на удаленном устройстве. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на странице https://www.ansible.com/ansible-dell-networking.
Примеры
- os10_config:
lines: ['hostname {{ inventory_hostname }}']
- os10_config:
lines:
- 10 permit ip host 1.1.1.1 any log
- 20 permit ip host 2.2.2.2 any log
- 30 permit ip host 3.3.3.3 any log
- 40 permit ip host 4.4.4.4 any log
- 50 permit ip host 5.5.5.5 any log
parents: ['ip access-list test']
before: ['no ip access-list test']
match: exact
- os10_config:
lines:
- 10 permit ip host 1.1.1.1 any log
- 20 permit ip host 2.2.2.2 any log
- 30 permit ip host 3.3.3.3 any log
- 40 permit ip host 4.4.4.4 any log
parents: ['ip access-list test']
before: ['no ip access-list test']
replace: block
- os10_config:
lines: ['hostname {{ inventory_hostname }}']
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Значения возврата
Общие значения возвращаемых данных описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path string | при backup равно yes | Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/os10_config.2016-07-16@22:28:34 |
| commands list / elements=string | всегда | Набор команд, которые будут переданы на удалённое устройство Пример: ['hostname foo', 'router bgp 1', 'router-id 1.1.1.1'] |
| saved boolean | Если не режим check_mode. | Возвращает, сохраняется ли конфигурация в стартовой конфигурации или нет. Пример: True |
| updates list / elements=string | всегда | Набор команд, которые будут переданы на удалённое устройство. Пример: ['hostname foo', 'router bgp 1', 'router-id 1.1.1.1'] |
Авторы
- Senthil Kumar Ganesan (@skg-net)
© 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/dellemc/os10/os10_config_module.html
