Spec-Zone.ru › Ansible

Модуль cisco.ise.profiler_profile_info – Модуль информации для профиля Profiler

Примечание

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

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

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

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

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

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

Описание

  • Получить все профили Profiler.
  • Получить профиль Profiler по идентификатору.
  • Этот API позволяет клиенту получить профиль Profiler по идентификатору.
  • Этот API позволяет клиенту получить все профили Profiler.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

filter

список / элементы=строка

Параметр запроса фильтра. **Простой фильтр** должен быть доступен через параметр строки запроса filter. Структура фильтра — тройка поле-оператор-значение, разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для всех критериев фильтрации, по умолчанию — И, его можно изменить, используя параметр строки запроса «filterType=or».

Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтрации.

Оператор ‘EQ’ обозначает ‘Equals’.

Оператор ‘NEQ’ обозначает ‘Not Equals’.

Оператор ‘GT’ обозначает ‘Greater Than’.

Оператор ‘LT’ обозначает ‘Less Than’.

Оператор ‘STARTSW’ обозначает ‘Starts With’.

Оператор ‘NSTARTSW’ обозначает ‘Not Starts With’.

Оператор ‘ENDSW’ обозначает ‘Ends With’.

Оператор ‘NENDSW’ обозначает ‘Not Ends With’.

Оператор ‘CONTAINS’ обозначает ‘Contains’.

Оператор ‘NCONTAINS’ обозначает ‘Not Contains’.

filterType

строка

Параметр запроса filterType. Логический оператор, общий для всех критериев фильтрации, по умолчанию — И, его можно изменить, используя этот параметр.

id

строка

Параметр пути 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 ← (по умолчанию)

page

целое число

Параметр запроса page. Номер страницы.

size

целое число

Параметр запроса size. Количество объектов на странице.

sortasc

строка

Параметр запроса sortasc. Сортировка по возрастанию.

sortdsc

строка

Параметр запроса sortdsc. Сортировка по убыванию.

Примечания

Примечание

  • Используемые методы SDK: profiler_profile.ProfilerProfile.get_profiler_profile_by_id, profiler_profile.ProfilerProfile.get_profiler_profiles_generator,
  • Используемые пути: get /ers/config/profilerprofile, get /ers/config/profilerprofile/{id},
  • Поддерживает check_mode
  • Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all Profiler Profile
  cisco.ise.profiler_profile_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    sortasc: string
    sortdsc: string
    filter: []
    filterType: AND
  register: result

- name: Get Profiler Profile by id
  cisco.ise.profiler_profile_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "parentId": "string"}

ise_responses

список / элементы=словарь

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

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

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

Пример: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"parentId\": \"string\",\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\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/profiler_profile_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API