Модуль cisco.dnac.pnp_virtual_account_sync_result_info – Модуль информации для результата синхронизации виртуальной учетной записи PnP

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.pnp_virtual_account_sync_result_info.

Введено в cisco.dnac 3.1.0

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

Описание

Получение всех результатов синхронизации виртуальной учетной записи PnP.
Возвращает сводку устройств, синхронизированных из заданной интеллектуальной учетной записи и виртуальной учетной записи с устаревшей функцией PnP.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
domain string	Параметр пути домена. Домен интеллектуальной учетной записи.
headers словарь	Дополнительные заголовки.
name строка	Параметр имени пути. Имя виртуальной учетной записи.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки запрошенных тел против JSON-схемы. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.get_sync_result_for_virtual_account,
Используемые пути: get /dna/intent/api/v1/onboarding/pnp-device/sacct/{domain}/vacct/{name}/sync-result,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Pnp Virtual Account Sync Result
  cisco.dnac.pnp_virtual_account_sync_result_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}}"
    domain: string
    name: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением возврата от Cisco DNAC Python SDK Возвращается: всегда Пример: {"autoSyncPeriod": 0, "ccoUser": "string", "expiry": 0, "lastSync": 0, "profile": {"addressFqdn": "string", "addressIpV4": "string", "cert": "string", "makeDefault": true, "name": "string", "port": 0, "profileId": "string", "proxy": true}, "smartAccountId": "string", "syncResult": {"syncList": [{"deviceSnList": ["string"], "syncType": "string"}], "syncMsg": "string"}, "syncResultStr": "string", "syncStartTime": 0, "syncStatus": "string", "tenantId": "string", "token": "string", "virtualAccountId": "string"}

Ключ

Описание

dnac_response

словарь

Словарь или список со значением возврата от Cisco DNAC Python SDK

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

Пример: {"autoSyncPeriod": 0, "ccoUser": "string", "expiry": 0, "lastSync": 0, "profile": {"addressFqdn": "string", "addressIpV4": "string", "cert": "string", "makeDefault": true, "name": "string", "port": 0, "profileId": "string", "proxy": true}, "smartAccountId": "string", "syncResult": {"syncList": [{"deviceSnList": ["string"], "syncType": "string"}], "syncMsg": "string"}, "syncResultStr": "string", "syncStartTime": 0, "syncStatus": "string", "tenantId": "string", "token": "string", "virtualAccountId": "string"}

Авторы

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_virtual_account_sync_result_info_module.html