Модуль cisco.ise.backup_restore – Модуль ресурсов для резервного копирования и восстановления

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в книге задач укажите: cisco.ise.backup_restore.

Новое в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Управление операцией создания ресурса резервного копирования и восстановления.
Инициирует работу по восстановлению конфигурации БД на узле ISE. API возвращает идентификатор задачи. Используйте API службы задач для получения статуса задачи резервного копирования.

Примечание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
backupEncryptionKey строка	Ключ шифрования, предоставленный во время создания резервной копии.
ise_debug логическое	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: `60`
ise_username строка / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway логическое добавлен в cisco.ise 1.1.0	Флаг, информирующий SDK о том, нужно ли использовать шлюз API Identity Services Engine для отправки запросов. Если значение true, используется шлюз API ISE и отправляются запросы на https://{{ise_hostname}}. Если значение false, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, информирующий SDK о том, нужно ли отправлять маркер CSRF в API ERS ISE. Если значение True, SDK предполагает, что проверка CSRF вашего ISE включена. Если значение True, SDK предполагает, что вам нужно, чтобы SDK автоматически управлял маркером CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или отключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
repositoryName строка	Название настроенного хранилища, где находится файл резервной копии.
restoreFile строка	Имя файла резервной копии, который будет восстановлен на узле ISE.
restoreIncludeAdeos строка	Определяет, будет ли восстанавливаться конфигурация ADE-OS. Возможные значения true, false.

Примечания

Примечание

Используемые методы SDK: backup_and_restore.BackupAndRestore.restore_config_backup,
Используемые пути: post /api/v1/backup-restore/config/restore,
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE по резервному копированию и восстановлению: Полная справка по API резервного копирования и восстановления.

Примеры

- name: Create
  cisco.ise.backup_restore:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupEncryptionKey: string
    repositoryName: string
    restoreFile: string
    restoreIncludeAdeos: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco ISE Возвращается: всегда Пример: `{"response": {"id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string"}, "version": "string"}`

Авторы

Rafael Campos (@racampos)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ise/backup_restore_module.html