Модуль cisco.ise.session_service_node_info – Модуль информации для узла Session Service

Примечание

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

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

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

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

Новый в cisco.ise 1.0.0

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

Описание

Получить все узлы Session Service.
Получить узел Session Service по идентификатору.
Получить узел Session Service по имени.
Этот API позволяет клиенту получить подробности узла PSN по ID.
Этот API позволяет клиенту получить подробности узла PSN по имени.
Этот API позволяет клиенту получить подробности всех узлов PSN.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
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` ← (по умолчанию)
name строка	Параметр пути name.
page целое число	Параметр запроса page. Номер страницы.
size целое число	Параметр запроса size. Количество объектов на страницу.

Примечания

Примечание

Используемые методы SDK: psn_node_details_with_radius_service.PsnNodeDetailsWithRadiusService.get_session_service_node_by_id, psn_node_details_with_radius_service.PsnNodeDetailsWithRadiusService.get_session_service_node_by_name, psn_node_details_with_radius_service.PsnNodeDetailsWithRadiusService.get_session_service_node_generator,
Используемые пути: get /ers/config/sessionservicenode, get /ers/config/sessionservicenode/name/{name}, get /ers/config/sessionservicenode/{id},
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

Документация Cisco ISE для PsnNodeDetailsWithRadiusService: Полное описание API PsnNodeDetailsWithRadiusService.

Примеры

- name: Get all Session Service Node
  cisco.ise.session_service_node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Session Service Node by id
  cisco.ise.session_service_node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Session Service Node by name
  cisco.ise.session_service_node_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 Возвращается: всегда Пример: `{"description": "string", "gateWay": "string", "id": "string", "ipAddress": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}`
ise_responses список / элементы=словарь добавлено в cisco.ise 1.1.0	Словарь или список, содержащий ответ, возвращенный Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"ipAddress\": \"string\",\n \"gateWay\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

ise_response

словарь

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

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

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

ise_responses

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

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"ipAddress\": \"string\",\n \"gateWay\": \"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/session_service_node_info_module.html