Spec-Zone.ru › Ansible

Модуль cisco.ise.node_info — Модуль информации о узле

Примечание

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

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

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

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

Новая в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

filter

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

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

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

Оператор «EQ» описывает «Равно».

Оператор «NEQ» описывает «Не равно».

Оператор «GT» описывает «Больше, чем».

Оператор «LT» описывает «Меньше, чем».

Оператор «STARTSW» описывает «Начинается с».

Оператор «NSTARTSW» описывает «Не начинается с».

Оператор «ENDSW» описывает «Заканчивается на».

Оператор «NENDSW» описывает «Не заканчивается на».

Оператор «CONTAINS» описывает «Содержит».

Оператор «NCONTAINS» описывает «Не содержит».

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

name

строка

Параметр пути name.

page

целое число

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

size

целое число

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

Примечания

Примечание

  • Используемые методы SDK — node_details.NodeDetails.get_node_detail_by_id, node_details.NodeDetails.get_node_detail_by_name, node_details.NodeDetails.get_node_details_generator,
  • Используемые пути — get /ers/config/node, get /ers/config/node/name/{name}, get /ers/config/node/{id},
  • Поддерживает check_mode
  • Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

См. также

Документация Cisco ISE для NodeDetails

Полное описание API NodeDetails.

Примеры

- name: Get all Node
  cisco.ise.node_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    filter: []
    filterType: AND
  register: result

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

- name: Get Node by name
  cisco.ise.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

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

Пример: {"displayName": "string", "fqdn": "string", "gateWay": "string", "id": "string", "inDeployment": true, "ipAddress": "string", "ipAddresses": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "nodeServiceTypes": "string", "otherPapFqdn": "string", "papNode": true, "passWord": "string", "primaryPapNode": true, "pxGridNode": true, "sxpIpAddress": "string", "userName": "string"}

ise_responses

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

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

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

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

Пример: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"gateWay\": \"string\",\n    \"userName\": \"string\",\n    \"passWord\": \"string\",\n    \"displayName\": \"string\",\n    \"inDeployment\": true,\n    \"otherPapFqdn\": \"string\",\n    \"ipAddresses\": [\n      \"string\"\n    ],\n    \"ipAddress\": \"string\",\n    \"sxpIpAddress\": \"string\",\n    \"nodeServiceTypes\": \"string\",\n    \"fqdn\": \"string\",\n    \"papNode\": true,\n    \"primaryPapNode\": true,\n    \"pxGridNode\": true,\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/node_info_module.html

Spec-Zone.ru

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