Модуль cisco.ise.rest_id_store – Модуль ресурсов для REST Id Store

Примечание

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

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

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

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

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

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

Описание

Управление операциями создания, обновления и удаления ресурса REST Id Store.
Этот API создает хранилище REST ID.
Этот API удаляет хранилище REST ID по имени.
Этот API удаляет хранилище REST ID.
Этот API позволяет клиенту обновить хранилище REST ID по имени.
Этот API позволяет клиенту обновить хранилище REST ID.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
description строка	Описание хранилища REST Id.
ersRESTIDStoreAttributes словарь	Атрибуты ersRESTIDStore хранилища REST Id.
headers список / элементы=словарь	Заголовки хранилища REST Id.
key строка	Ключ хранилища REST Id.
value строка	Значение хранилища REST Id.
predefined строка	Подключенный поставщик облачных сервисов RESTIDStore. Доступные значения: - Azure, - Okta, - None.
rootUrl строка	URL корневого каталога RESTIDStore.
usernameSuffix строка	Суффикс домена имени пользователя.
ersRESTIDStoreUserAttributes словарь	Атрибуты ersRESTIDStoreUser хранилища REST Id.
attributes список / элементы=строка	Атрибуты хранилища REST Id.
id строка	Идентификатор хранилища REST Id.
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` ← (по умолчанию)
name строка	Имя хранилища REST Id.

Примечания

Примечание

Используемые методы SDK: restid_store.RestidStore.create_rest_id_store, restid_store.RestidStore.delete_rest_id_store_by_id, restid_store.RestidStore.delete_rest_id_store_by_name, restid_store.RestidStore.update_rest_id_store_by_id, restid_store.RestidStore.update_rest_id_store_by_name,
Используемые пути: post /ers/config/restidstore, delete /ers/config/restidstore/name/{name}, delete /ers/config/restidstore/{id}, put /ers/config/restidstore/name/{name}, put /ers/config/restidstore/{id},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update by name
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    id: string
    name: string

- name: Delete by name
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    name: string

- name: Update by id
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    id: string
    name: string

- name: Delete by id
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    ersRestIDStoreUserAttributes:
      attributes:
      - string
    name: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "ersRestIDStoreAttributes": {"headers": [{"key": "string", "value": "string"}], "predefined": "string", "rootUrl": "string", "usernameSuffix": "string"}, "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}`
ise_update_response словарь добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Ключ

Описание

ise_response

словарь

Словарь или список с ответом, возвращённым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"description": "string", "ersRestIDStoreAttributes": {"headers": [{"key": "string", "value": "string"}], "predefined": "string", "rootUrl": "string", "usernameSuffix": "string"}, "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}

ise_update_response

словарь

добавлен в cisco.ise 1.1.0

Словарь или список с ответом, возвращённым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/rest_id_store_module.html