cisco.dnac.device_replacement модуль — Модуль ресурсов для замены устройства

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.device_replacement.

Новое в cisco.dnac 3.1.0

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

Обзор

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
payload list / elements=dictionary	Полезная нагрузка для замены устройства.
creationTime integer	Дата и время пометки устройства для замены.
family string	Семейство неисправного устройства.
faultyDeviceId string	Уникальный идентификатор неисправного устройства.
faultyDeviceName string	Имя неисправного устройства.
faultyDevicePlatform string	Платформа неисправного устройства.
faultyDeviceSerialNumber string	Серийный номер неисправного устройства.
id string	Уникальный идентификатор ресурса замены устройства.
neighbourDeviceId string	Уникальный идентификатор соседнего устройства для создания DHCP-сервера.
networkReadinessTaskId string	Уникальный идентификатор задачи готовности сети.
replacementDevicePlatform string	Платформа заменяющего устройства.
replacementDeviceSerialNumber string	Серийный номер заменяющего устройства.
replacementStatus string	Статус замены устройства. Используйте NON-FAULTY, чтобы снять пометку устройства для замены.
replacementTime integer	Дата и время замены устройства.
workflowId string	Уникальный идентификатор рабочего процесса замены устройства.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (default)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center по замене устройства MarkDeviceForReplacement: Полное описание API MarkDeviceForReplacement.
Документация Cisco DNA Center по замене устройства UnMarkDeviceForReplacement: Полное описание API UnMarkDeviceForReplacement.

Примеры

- name: Update all
  cisco.dnac.device_replacement:
    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}}"
    state: present
    payload:
    - creationTime: 0
      family: string
      faultyDeviceId: string
      faultyDeviceName: string
      faultyDevicePlatform: string
      faultyDeviceSerialNumber: string
      id: string
      neighbourDeviceId: string
      networkReadinessTaskId: string
      replacementDevicePlatform: string
      replacementDeviceSerialNumber: string
      replacementStatus: string
      replacementTime: 0
      workflowId: string

- name: Create
  cisco.dnac.device_replacement:
    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}}"
    state: present
    payload:
    - creationTime: 0
      family: string
      faultyDeviceId: string
      faultyDeviceName: string
      faultyDevicePlatform: string
      faultyDeviceSerialNumber: string
      id: string
      neighbourDeviceId: string
      networkReadinessTaskId: string
      replacementDevicePlatform: string
      replacementDeviceSerialNumber: string
      replacementStatus: string
      replacementTime: 0
      workflowId: string

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

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

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