dellemc.os10.os10_config – Управление разделами конфигурации Dell EMC SmartFabric OS10

Примечание

Этот плагин входит в коллекцию dellemc.os10 (версия 1.0.2).

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

Для использования в книге задач укажите: dellemc.os10.os10_config

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

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after список / элементы=строка			Отсортированный набор команд, добавляемых в конец стека команд, если необходимо внести изменения. Так же, как и с before, это позволяет разработчику книги задач добавлять набор команд, которые будут выполнены после набора команд.
backup булево		Варианты: нет ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением каких-либо изменений. Если значение `backup_options` не указано, файл резервной копии записывается в папку `backup` в корневой директории книги задач. Если директория не существует, она создаётся.
backup_options словарь			Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути файла резервной копии. Значение этого параметра считывается только когда `backup` установлено в да, если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр задаёт путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет создана первой, и имя файла будет либо значением `filename`, либо значением по умолчанию, как описано в `filename` описании параметров. Если значение пути не указано, в этом случае будет создана директория backup в текущей рабочей директории, и резервная копия конфигурации будет скопирована в `filename` внутри директории backup.
	filename строка		Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущего времени и даты в формате <имя_хоста>_config.<дата>@<время>.
before список / элементы=строка			Отсортированный набор команд, помещаемых в стек команд, если необходимо внести изменения. Это позволяет разработчику книги задач выполнить команды конфигурации перед внесением любых изменений, не влияя на то, как набор команд сопоставляется с системой.
config строка			Модуль по умолчанию подключается к удалённому устройству и получает текущую рабочую конфигурацию, чтобы использовать её в качестве основы для сравнения с содержимым источника. Бывают случаи, когда нежелательно получать текущую рабочую конфигурацию для каждой задачи в книге задач. Аргумент config позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения.
lines список / элементы=строка			Отсортированный набор команд, которые должны быть настроены в разделе. Команды должны быть абсолютно такими же, как и в рабочей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот аргумент взаимоисключающий с src. алиасы: команды
match строка		Варианты: строка ← строго точно нет	Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сопоставляются по строкам. Если match установлен в строго, строки команд сопоставляются относительно позиции. Если match установлен в точно, строки команд должны быть точным совпадением. Наконец, если match установлен в нет, модуль не будет пытаться сравнивать исходную конфигурацию с текущей рабочей конфигурацией на удалённом устройстве.
parents список / элементы=строка			Отсортированный набор родительских элементов, которые уникально идентифицируют раздел или иерархию, по которым должны проверяться команды. Если аргумент parents опущен, команды проверяются по набору команд верхнего уровня или глобальным командам.
provider словарь			Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для использования, если требуется для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`
	authorize булево	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/dellemc/os10/os10_config_module.html