Модуль cisco.ise.network_device_group_info — Модуль информации о группе сетевых устройств

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.network_device_group_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 для отправки запросов. Если значение истинно, используется шлюз 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 строка	Параметр пути name. Двоеточие используется в качестве разделителя вместо (#) в имени NDG. Например, если имя — a#b#c, оно должно отображаться в URL-адресе запроса как a b c.
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов, возвращаемых на странице.
sortasc строка	Параметр запроса sortasc. Сортировка по возрастанию.
sortdsc строка	Параметр запроса sortdsc. Сортировка по убыванию.

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Используемые методы SDK: network_device_group.NetworkDeviceGroup.get_network_device_group_by_id, network_device_group.NetworkDeviceGroup.get_network_device_group_by_name, network_device_group.NetworkDeviceGroup.get_network_device_group_generator,
Используемые пути: get /ers/config/networkdevicegroup, get /ers/config/networkdevicegroup/name/{name}, get /ers/config/networkdevicegroup/{id},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Get all Network Device Group
  cisco.ise.network_device_group_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 Network Device Group by id
  cisco.ise.network_device_group_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

- name: Get Network Device Group by name
  cisco.ise.network_device_group_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", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "othername": "string"}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список со значением, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n },\n \"othername\": \"string\"\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/network_device_group_info_module.html