Модуль cisco.ise.network_device_info – Модуль информации о сетевом устройстве
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля потребуются дополнительные зависимости, см. Требования для получения подробностей.
Для использования в плейбуке укажите: cisco.ise.network_device_info.
Новая в cisco.ise 1.0.0
Описание
- Получить все сетевые устройства.
- Получить сетевое устройство по идентификатору.
- Получить сетевое устройство по имени.
- Этот API позволяет клиенту получить сетевое устройство по идентификатору.
- Этот API позволяет клиенту получить сетевое устройство по имени.
- Этот API позволяет клиенту получить все сетевые устройства.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтрации. **Простая фильтрация** должна быть доступна через параметр строки запроса фильтрации. Структура фильтра — это тройка из поля, оператора и значения, разделенных точками. Можно передавать несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя параметр строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтрации. Оператор ‘EQ’ описывает ‘Equals’. Оператор ‘NEQ’ описывает ‘Not Equals’. Оператор ‘GT’ описывает ‘Greater Than’. Оператор ‘LT’ описывает ‘Less Than’. Оператор ‘STARTSW’ описывает ‘Starts With’. Оператор ‘NSTARTSW’ описывает ‘Not Starts With’. Оператор ‘ENDSW’ описывает ‘Ends With’. Оператор ‘NENDSW’ описывает ‘Not Ends With’. Оператор ‘CONTAINS’ описывает ‘Contains’. Оператор ‘NCONTAINS’ описывает ‘Not Contains’. |
filterType строка | Параметр запроса filterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию будет AND, и его можно изменить, используя этот параметр. |
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 в ERS API 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: network_device.NetworkDevice.get_network_device_by_id, network_device.NetworkDevice.get_network_device_by_name, network_device.NetworkDevice.get_network_device_generator,
- Используемые пути: get /ers/config/networkdevice, get /ers/config/networkdevice/name/{name}, get /ers/config/networkdevice/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Network Device
cisco.ise.network_device_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 by id
cisco.ise.network_device_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 by name
cisco.ise.network_device_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/network_device_info_module.html
