Модуль cisco.ise.rest_id_store_info – Модуль информации для REST Id Store
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в playbook, укажите: cisco.ise.rest_id_store_info.
Новое в cisco.ise 1.0.0
Описание
- Получение всех REST Id Store.
- Получение REST Id Store по id.
- Получение REST Id Store по имени.
- Этот API позволяет клиенту получить REST ID хранилище по ID.
- Этот API позволяет клиенту получить REST ID хранилище по имени.
- Этот API позволяет клиенту получить все REST ID хранилища.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтра. **Простой фильтр** должен быть доступен через строку запроса параметра фильтра. Структура фильтра — тройка из поля, оператора и значения, разделенных точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию И, и его можно изменить, используя параметр строки запроса «filterType=или». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтрации. Оператор «EQ» описывает «равно». Оператор «NEQ» описывает «не равно». Оператор «GT» описывает «больше чем». Оператор «LT» описывает «меньше чем». Оператор «STARTSW» описывает «начинается с». Оператор «NSTARTSW» описывает «не начинается с». Оператор «ENDSW» описывает «заканчивается на». Оператор «NENDSW» описывает «не заканчивается на». Оператор «CONTAINS» описывает «содержит». Оператор «NCONTAINS» описывает «не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтра, по умолчанию И, и его можно изменить с помощью параметра. |
id строка | Параметр пути id. |
ise_debug булево | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0 | Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: |
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). Варианты:
|
ise_uses_csrf_token булево добавлен в cisco.ise 3.0.0 | Флаг, который информирует SDK о том, отправлять ли маркер CSRF в API ERS ISE. Если он равен True, SDK предполагает, что проверка CSRF вашего ISE включена. Если он равен True, предполагается, что вам нужно, чтобы SDK автоматически управлял маркером CSRF. Варианты:
|
ise_verify булево | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version строка | Информирует SDK о том, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit булево | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
name строка | Параметр пути name. |
page целое число | Параметр запроса page. Номер страницы. |
size целое число | Параметр запроса size. Количество объектов, возвращаемых на страницу. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: restid_store.RestidStore.get_rest_id_store_by_id, restid_store.RestidStore.get_rest_id_store_by_name, restid_store.RestidStore.get_rest_id_store_generator,
- Используемые пути: get /ers/config/restidstore, get /ers/config/restidstore/name/{name}, get /ers/config/restidstore/{id},
- Поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all REST Id Store
cisco.ise.rest_id_store_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 REST Id Store by id
cisco.ise.rest_id_store_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get REST Id Store by name
cisco.ise.rest_id_store_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
name: string
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0 | Словарь или список со значением, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на сборку
© 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_info_module.html
