Модуль cisco.dnac.pnp_device_count_info — Модуль информации о количестве устройств Pnp

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Обзор

Получить общее количество устройств Pnp.
Возвращает количество устройств на основе фильтров. Это полезно для пагинации.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers dictionary	Дополнительные заголовки.
lastContact boolean	Параметр запроса LastContact. Устройство связалось lastContact > 0. Варианты: `false` `true`
name list / elements=string	Параметр запроса name. Имя устройства.
onbState list / elements=string	Параметр запроса onbState. Состояние подключения устройства.
pid list / elements=string	Параметр запроса pid. Идентификатор продукта устройства.
serialNumber list / elements=string	Параметр запроса serialNumber. Серийный номер устройства.
smartAccountId list / elements=string	Параметр запроса smartAccountId. Учётная запись устройства.
source list / elements=string	Параметр запроса source. Источник устройства.
state_ list / elements=string	Параметр запроса state. Состояние устройства.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (default)
virtualAccountId list / elements=string	Параметр запроса virtualAccountId. Виртуальная учётная запись устройства.
workflowId list / elements=string	Параметр запроса workflowId. Идентификатор рабочего процесса устройства.
workflowName list / elements=string	Параметр запроса workflowName. Имя рабочего процесса устройства.

Примечания

Примечание

Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.get_device_count,
Используемые пути: get /dna/intent/api/v1/onboarding/pnp-device/count,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по подключению устройств (PnP) GetDeviceCount: Полная справка по API GetDeviceCount.

Примеры

- name: Get all Pnp Device Count
  cisco.dnac.pnp_device_count_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    serialNumber: []
    state_: []
    onbState: []
    name: []
    pid: []
    source: []
    workflowId: []
    workflowName: []
    smartAccountId: []
    virtualAccountId: []
    lastContact: True
  register: result

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": 0}`

Авторы

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/dnac/pnp_device_count_info_module.html