Модуль cisco.ise.backup_config – Ресурсный модуль для резервного копирования конфигурации

Примечание

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

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

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

Для использования в playbook укажите: cisco.ise.backup_config.

Новое в cisco.ise 1.0.0

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

Краткое описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
backupEncryptionKey string	Ключ шифрования для резервной копии файла. Ключ шифрования должен удовлетворять следующим критериям: - Содержит хотя бы одну заглавную букву A-Z, - Содержит хотя бы одну строчную букву a-z, - Содержит хотя бы одну цифру 0-9, - Содержит только A-Za-z0-9_#, - Имеет не менее 8 символов, - Имеет не более 15 символов, - Не должен содержать ‘CcIiSsCco’, - Не должен начинаться с.
backupName string	Резервная копия файла будет сохранена с этим именем.
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
ise_hostname string / required	Имя хоста Identity Services Engine.
ise_password string / required	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0	Таймаут (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / required	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean добавлено в 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 boolean добавлено в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если это True, SDK предполагает, что проверка CSRF вашего ISE включена. Если это True, предполагается, что вам нужно, чтобы SDK автоматически управлял токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version string	Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
repositoryName string	Имя настроенного репозитория, куда будет скопирован сгенерированный файл резервной копии.

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.ise.backup_config:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupEncryptionKey: string
    backupName: string
    repositoryName: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `{"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_config_module.html