Модуль cisco.dnac.pnp_device_claim_to_site – Модуль ресурсов для заявки на подключение устройства Pnp к сайту

Примечание

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

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

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

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

Добавлен в cisco.dnac 3.1.0

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

Описание

Управляет операцией создания ресурса Pnp Device Claim To Site.
Заявляет о подключении устройства на основе процесса проектирования Catalyst Center на основе сайта. Некоторые необходимые параметры различаются в зависимости от платформы устройства.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
configInfo словарь добавлен в cisco.dnac 4.2.0	configInfo для Pnp Device Claim To Site.
configId строка	Идентификатор конфигурации.
configParameters список / элементы=словарь	configParameters для Pnp Device Claim To Site.
key строка	Ключ.
value строка	Значение.
deviceId строка	Идентификатор устройства.
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"`
gateway строка добавлен в cisco.dnac 6.4.0	Для CatalystWLC/MobilityExpress.
imageInfo словарь добавлен в cisco.dnac 4.2.0	imageInfo для Pnp Device Claim To Site.
imageId строка	Идентификатор изображения.
skip логическое	Пропустить. Варианты: `false` `true`
ipInterfaceName строка добавлен в cisco.dnac 6.4.0	Для Catalyst 9800 WLC.
rfProfile строка добавлен в cisco.dnac 6.1.0	Для точек доступа.
sensorProfile строка	Для датчиков.
siteId строка	Идентификатор сайта.
staticIP строка добавлен в cisco.dnac 6.4.0	Для CatalystWLC/MobilityExpress.
subnetMask строка	Для CatalystWLC/MobilityExpress.
type строка	Тип.

END_OF_DOCUMENT_MARKER

validate_response_schema boolean	Флаг для Cisco DNA Center SDK, позволяющий включить проверку тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)
vlanId string добавлено в cisco.dnac 6.4.0	Для WLC Catalyst 9800.

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.dnac.pnp_device_claim_to_site:
    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}}"
    configInfo:
      configId: string
      configParameters:
      - key: string
        value: string
    deviceId: string
    gateway: string
    imageInfo:
      imageId: string
      skip: true
    ipInterfaceName: string
    rfProfile: string
    sensorProfile: string
    siteId: string
    staticIP: string
    subnetMask: string
    type: string
    vlanId: string

Возвращаемые значения

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

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