Модуль cisco.ise.px_grid_node_info – Модуль информации для узла Px Grid

Примечание

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

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

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

Для использования в книге задач укажите: cisco.ise.px_grid_node_info.

Новая в cisco.ise 1.0.0

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

Обзор

Получить все узлы Px Grid.
Получить узел Px Grid по идентификатору.
Получить узел Px Grid по имени.
Этот API позволяет клиенту получить узел pxGrid по идентификатору.
Этот API позволяет клиенту получить узел pxGrid по имени.
Этот API позволяет клиенту получить все узлы npxGrid.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
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 для отправки запросов. Если истинно, то используется шлюз API ISE и отправка запросов на https://{{ise_hostname}}. Если ложно, то отправка запросов на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логический добавлен в cisco.ise 3.0.0	Флаг, информирующий SDK, отправлять ли токен CSRF в API ERS ISE. Если истинно, SDK предполагает, что проверка CSRF ISE включена. Если истинно, предполагается, что 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 строка	Параметр пути имени.
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов, возвращаемых на странице.

Примечания

Примечание

Используемые методы SDK: px_grid_node.PxGridNode.get_px_grid_node_by_id, px_grid_node.PxGridNode.get_px_grid_node_by_name, px_grid_node.PxGridNode.get_px_grid_node_generator,
Используемые пути: get /ers/config/pxgridnode, get /ers/config/pxgridnode/name/{name}, get /ers/config/pxgridnode/{id},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины соединений ansible, а вместо этого встроенный менеджер соединений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Get all Px Grid Node
  cisco.ise.px_grid_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 Px Grid Node by id
  cisco.ise.px_grid_node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

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

Ключ

Описание

ise_response

словарь

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

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

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

ise_responses

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

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"status\": \"string\",\n \"authMethod\": \"string\",\n \"groups\": \"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/px_grid_node_info_module.html