Модуль cisco.dnac.pnp_device_reset – Модуль ресурсов для сброса устройства Pnp

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

Управляет операцией создания ресурса Сброс устройства Pnp.
Восстанавливает устройство из состояния ошибки выполнения рабочей последовательности.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
deviceResetList список / элементы=словарь	Список устройств для сброса (deviceResetList).
configList список / элементы=словарь	Список конфигураций (configList).
configId строка	Идентификатор конфигурации (configId).
configParameters список / элементы=словарь	Параметры конфигурации (configParameters).
key строка	Ключ (key).
value строка	Значение (value).
deviceId строка	Идентификатор устройства (deviceId).
licenseLevel строка	Уровень лицензии (licenseLevel).
licenseType строка	Тип лицензии (licenseType).
topOfStackSerialNumber строка	Серийный номер устройства (topOfStackSerialNumber).
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"`
projectId строка	Идентификатор проекта (projectId).
validate_response_schema логический	Флаг для включения валидации ответов Cisco DNA Center SDK по схеме JSON. Варианты: `false` `true` ← (по умолчанию)
workflowId строка	Идентификатор рабочего процесса (workflowId).

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.dnac.pnp_device_reset:
    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}}"
    deviceResetList:
    - configList:
      - configId: string
        configParameters:
        - key: string
          value: string
      deviceId: string
      licenseLevel: string
      licenseType: string
      topOfStackSerialNumber: string
    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_reset_module.html