Модуль cisco.dnac.pnp_device_claim — Модуль ресурсов для заявки на устройства Pnp

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.dnac.pnp_device_claim.

Новая функция в cisco.dnac 3.1.0

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

Описание

Управление операцией создания ресурса «Заявка на устройство Pnp».
Заявляет об одном или нескольких устройствах с указанным рабочим процессом.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
configFileUrl строка	configFileUrl модуля Pnp Device Claim.
configId строка	configId модуля Pnp Device Claim.
deviceClaimList список / элементы=словарь	deviceClaimList модуля Pnp Device Claim.
configList список / элементы=словарь	configList модуля Pnp Device Claim.
configId строка	configId модуля Pnp Device Claim.
configParameters список / элементы=словарь	configParameters модуля Pnp Device Claim.
key строка	ключ модуля Pnp Device Claim.
value строка	значение модуля Pnp Device Claim.
deviceId строка	deviceId модуля Pnp Device Claim.
licenseLevel строка	licenseLevel модуля Pnp Device Claim.
licenseType строка	licenseType модуля Pnp Device Claim.
topOfStackSerialNumber строка	topOfStackSerialNumber модуля Pnp Device Claim.
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"`
fileServiceId строка	fileServiceId модуля Pnp Device Claim.
imageId строка	imageId модуля Pnp Device Claim.
imageUrl строка	imageUrl модуля Pnp Device Claim.
populateInventory логическое	Флаг populateInventory. Выбооры: `false` `true`
projectId строка	projectId модуля Pnp Device Claim.

validate_response_schema boolean	Флаг для Cisco DNA Center SDK, чтобы включить проверку тел запросов по JSON-схеме. Варианты: `false` `true` ← (по умолчанию)
workflowId string	Идентификатор рабочего процесса PnP Device Claim.

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.dnac.pnp_device_claim:
    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}}"
    configFileUrl: string
    configId: string
    deviceClaimList:
    - configList:
      - configId: string
        configParameters:
        - key: string
          value: string
      deviceId: string
      licenseLevel: string
      licenseType: string
      topOfStackSerialNumber: string
    fileServiceId: string
    imageId: string
    imageUrl: string
    populateInventory: true
    projectId: string
    workflowId: string

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: `{"jsonArrayResponse": [{}], "jsonResponse": {}, "message": "string", "statusCode": 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_claim_module.html