Модуль cisco.ise.upgrade_proceed – Модуль ресурса для начала обновления

Примечание

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

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

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

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

Новый в cisco.ise 1.0.0

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

Описание

Управление операцией создания ресурса «Начало обновления».
Цель API — оркестрация выполнения обновления на PPAN.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
hostnames список / элементы=строка	Хостовые имена ресурса «Начало обновления».
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 ISE ERS. Если значение 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` ← (по умолчанию)
preCheckReportID строка	preCheckReportID ресурса «Начало обновления».
upgradeType строка	upgradeType ресурса «Начало обновления».

Примечания

Примечание

Используемые методы SDK: fullupgrade.Fullupgrade.initiate_upgrade_on_p_p_a_n,
Используемые пути: post /api/v1/upgrade/proceed/initiate-upgrade,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Create
  cisco.ise.upgrade_proceed:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    hostnames:
    - string
    preCheckReportID: string
    upgradeType: string

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

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

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