Модуль cisco.dnac.pnp_virtual_account_add — Модуль ресурсов для добавления виртуальной учетной записи PnP

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.pnp_virtual_account_add.

Новое в cisco.dnac 3.1.0

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

Обзор

Управление операцией создания ресурса «Добавление виртуальной учетной записи PnP».
Регистрирует информацию о интеллектуальной учетной записи, виртуальной учетной записи и соответствующем профиле сервера в системе PnP и базе данных. Устройства, присутствующие в зарегистрированной виртуальной учетной записи, также синхронизируются с базой данных PnP. В ответном содержимом возвращается новый профиль.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
autoSyncPeriod целое число	autoSyncPeriod модуля Pnp Virtual Account Add.
ccoUser строка	ccoUser модуля Pnp Virtual Account Add.
dnac_debug булево	Флаг для включения отладки Cisco DNA Center SDK. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify булево	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
expiry целое число	expiry модуля Pnp Virtual Account Add.
lastSync целое число	lastSync модуля Pnp Virtual Account Add.
profile словарь	profile модуля Pnp Virtual Account Add.
addressFqdn строка	addressFqdn модуля Pnp Virtual Account Add.
addressIpV4 строка	addressIpV4 модуля Pnp Virtual Account Add.
cert строка	cert модуля Pnp Virtual Account Add.
makeDefault булево	Флаг makeDefault. Варианты: `false` `true`
name строка	Имя модуля Pnp Virtual Account Add.
port целое число	Порт модуля Pnp Virtual Account Add.
profileId строка	profileId модуля Pnp Virtual Account Add.
proxy булево	Флаг proxy. Варианты: `false` `true`
smartAccountId строка	smartAccountId модуля Pnp Virtual Account Add.
syncResult словарь	syncResult модуля Pnp Virtual Account Add.
syncList список / элементы=словарь	syncList модуля Pnp Virtual Account Add.
deviceSnList список / элементы=строка	deviceSnList модуля Pnp Virtual Account Add.
syncType строка	syncType модуля Pnp Virtual Account Add.

syncMsg строка	syncMsg модуля Pnp Virtual Account Add.
syncResultStr строка	syncResultStr модуля Pnp Virtual Account Add.
syncStartTime целое число	syncStartTime модуля Pnp Virtual Account Add.
syncStatus строка	syncStatus модуля Pnp Virtual Account Add.
tenantId строка	tenantId модуля Pnp Virtual Account Add.
token строка	token модуля Pnp Virtual Account Add.
validate_response_schema логическое значение	Флаг для Cisco DNA Center SDK для включения проверки заголовков запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)
virtualAccountId строка	virtualAccountId модуля Pnp Virtual Account Add.

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.dnac.pnp_virtual_account_add:
    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}}"
    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"}

Ключ

Описание

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