cisco.dnac.device_replacement_info модуль – Модуль информации для замены устройства

Примечание

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

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

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

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

Новая функция в 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"`
family list / elements=string	Параметр запроса Family. Список семейств: Маршрутизаторы, Коммутаторы и концентраторы, Точки доступа.
faultyDeviceName string	Параметр запроса FaultyDeviceName. Имя неисправного устройства.
faultyDevicePlatform string	Параметр запроса FaultyDevicePlatform. Платформа неисправного устройства.
faultyDeviceSerialNumber string	Параметр запроса FaultyDeviceSerialNumber. Серийный номер неисправного устройства.
headers dictionary	Дополнительные заголовки.
limit integer	Параметр запроса Limit.
offset integer	Параметр запроса Offset.
replacementDevicePlatform string	Параметр запроса ReplacementDevicePlatform. Платформа заменяемого устройства.
replacementDeviceSerialNumber string	Параметр запроса ReplacementDeviceSerialNumber. Серийный номер заменяемого устройства.
replacementStatus list / elements=string	Параметр запроса ReplacementStatus. Статус замены устройства: READY-FOR-REPLACEMENT, REPLACEMENT-IN-PROGRESS, REPLACEMENT-SCHEDULED, REPLACED, ERROR, NETWORK_READINESS_REQUESTED, NETWORK_READINESS_FAILED.
sortBy string	Параметр запроса SortBy. Сортировка по этому полю. SortBy обязателен, если используется order.
sortOrder string	Параметр запроса SortOrder. Порядок сортировки по displayName: ASC, DESC.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тела запроса на соответствие JSON-схеме. Варианты: `false` `true` ← (default)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Device Replacement
  cisco.dnac.device_replacement_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    faultyDeviceName: string
    faultyDevicePlatform: string
    replacementDevicePlatform: string
    faultyDeviceSerialNumber: string
    replacementDeviceSerialNumber: string
    replacementStatus: []
    family: []
    sortBy: string
    sortOrder: string
    offset: 0
    limit: 0
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: {"response": [{"creationTime": 0, "family": "string", "faultyDeviceId": "string", "faultyDeviceName": "string", "faultyDevicePlatform": "string", "faultyDeviceSerialNumber": "string", "id": "string", "neighbourDeviceId": "string", "networkReadinessTaskId": "string", "readinesscheckTaskId": "string", "replacementDevicePlatform": "string", "replacementDeviceSerialNumber": "string", "replacementStatus": "string", "replacementTime": 0, "workflowFailedStep": "string", "workflowId": "string"}], "version": "string"}

Ключ

Описание

dnac_response

словарь

Словарь или список с ответом, возвращённым Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"response": [{"creationTime": 0, "family": "string", "faultyDeviceId": "string", "faultyDeviceName": "string", "faultyDevicePlatform": "string", "faultyDeviceSerialNumber": "string", "id": "string", "neighbourDeviceId": "string", "networkReadinessTaskId": "string", "readinesscheckTaskId": "string", "replacementDevicePlatform": "string", "replacementDeviceSerialNumber": "string", "replacementStatus": "string", "replacementTime": 0, "workflowFailedStep": "string", "workflowId": "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_info_module.html