Модуль cisco.ise.upgrade_stage_cancel – Модуль ресурсов для отмены этапа обновления

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
hostnames список / элементы=строка	Имена хостов для отмены этапа обновления.
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 в 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 логический	Флаг для SDK Identity Services Engine для включения автоматического управления ограничениями скорости. Варианты: `false` `true` ← (по умолчанию)
preCheckReportID строка	preCheckReportID для отмены этапа обновления.
upgradeType строка	upgradeType для отмены этапа обновления.

Примечания

Примечание

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

Примеры

- name: Create
  cisco.ise.upgrade_stage_cancel:
    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 список / элементы=словарь	Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"dbStatus\": \"string\",\n \"message\": \"string\",\n \"node\": \"string\",\n \"percentage\": 0,\n \"progressMsg\": \"string\",\n \"status\": \"string\"\n }\n]\n"`

Авторы

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_stage_cancel_module.html