Модуль cisco.ise.stop_replication – Модуль ресурса для остановки репликации

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.stop_replication.

Добавлена в cisco.ise 1.0.0

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

Описание

Управлять обновлением операции ресурса «Остановка репликации».
Этот API обновляет статус службы остановки репликации конечной точки.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Выбираемые значения: `false` ← (по умолчанию) `true`
ise_hostname string / обязательно	Имя хоста Identity Services Engine.
ise_password string / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: `60`
ise_username string / обязательно	Имя пользователя 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` ← (по умолчанию)
isEnabled boolean	Флаг isEnabled. Выбираемые значения: `false` `true`

Примечания

Примечание

Используемые методы SDK – endpoint_stop_replication_service.EndpointStopReplicationService.set_stop_replication_service,
Используемые пути – put /api/v1/stop-replication,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update all
  cisco.ise.stop_replication:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    isEnabled: true

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"isEnabled": true}`
ise_update_response словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"success": {"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/stop_replication_module.html