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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.backup_schedule_config.

Новый в cisco.ise 1.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 логическое	Флаг для 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 автоматически управлял маркером 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` ← (по умолчанию)
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.create_scheduled_config_backup,
Используемые пути: post /api/v1/backup-restore/config/schedule-config-backup,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

Примеры

- name: Create
  cisco.ise.backup_schedule_config:
    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_module.html