Модуль cisco.ise.backup_schedule_config_update – Модуль ресурса для обновления конфигурации расписания резервного копирования

Примечание

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

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

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

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

Новое в cisco.ise 2.0.0

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

Обзор

Управление обновлением операции ресурса «Обновление конфигурации расписания резервного копирования».
Обновление расписания резервного копирования конфигурации на узле ISE в соответствии с входными параметрами. Этот API используется только для редактирования расписания.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
backupDescription строка	Описание резервной копии.
backupEncryptionKey строка	Ключ шифрования для резервной копии. Ключ шифрования должен удовлетворять следующим критериям - Содержит хотя бы одну заглавную букву A-Z, Содержит хотя бы одну строчную букву a-z, Содержит хотя бы одну цифру 0-9, Содержит только A-Za-z0-9_#, Содержит не менее 8 символов, Содержит не более 15 символов, Не должен содержать ‘CcIiSsCco’, Не должен начинаться с.
backupName строка	Резервная копия будет сохранена под этим именем.
endDate строка	Конечная дата запланированной задачи резервного копирования. Разрешенный формат MM/DD/YYYY. Конечная дата не требуется в случае частоты ONE_TIME.
frequency строка	Частота обновления конфигурации резервного копирования.
ise_debug логическое	Флаг для включения отладки SDK Identity Services Engine. Варианты: `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 в ERS API ISE. Если значение true, SDK предполагает, что проверка CSRF вашего ISE включена. Если значение true, предполагается, что вам нужно, чтобы SDK автоматически управлял токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или отключения проверки SSL сертификатов. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для включения автоматической обработки ограничений скорости SDK Identity Services Engine. Варианты: `false` `true` ← (по умолчанию)
monthDay строка	День месяца, в который необходимо выполнить резервное копирование при установленной частоте MONTHLY. Разрешенные значения - от 1 до 28.
repositoryName строка	Имя настроенного репозитория, в который будет скопирован созданный файл резервной копии.
startDate строка	Дата начала планирования задачи резервного копирования. Разрешенный формат MM/DD/YYYY.
status строка	Статус обновления конфигурации резервного копирования.
time строка	Время, в которое запланирована задача резервного копирования. Например- 12 00 AM.

END_OF_DOCUMENT_MARKER

weekDay

string

День недели для резервного копирования.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.ise.backup_schedule_config_update:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    backupDescription: string
    backupEncryptionKey: string
    backupName: string
    endDate: string
    frequency: string
    monthDay: string
    repositoryName: string
    startDate: string
    status: string
    time: string
    weekDay: string

Возвращаемые значения

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

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