Spec-Zone.ru › Ansible

Модуль cisco.dnac.rma_workflow_manager – Управление рабочим процессом замены устройств в Cisco Catalyst Center.

Примечание

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

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

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

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

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Целью этого рабочего процесса является предоставление оптимизированного и эффективного процесса для сетевых администраторов, для инициирования запросов на авторизацию возврата материалов (RMA) для неисправных сетевых устройств. Эта автоматизация направлена на упрощение процесса RMA, уменьшение ручного труда и повышение общей операционной эффективности.
  • Реализовать рабочий процесс RMA (авторизация возврата материалов) в Cisco Catalyst Center, обеспечивая бесшовный процесс возврата и замены неисправных сетевых устройств.
  • Рабочий процесс RMA упрощает замену маршрутизаторов, коммутаторов и точек доступа (AP).
  • Позволяет администраторам помечать устройства для замены и отслеживать весь процесс замены.
  • Для маршрутизаторов и коммутаторов изображение программного обеспечения, конфигурация и лицензии восстанавливаются с неисправного устройства на заменяемое устройство, обеспечивая минимальное нарушение работы.
  • Для беспроводных точек доступа заменяемое устройство назначается тому же сайту, снабжается первичным беспроводным контроллером, профилем радиочастот и настройками группы точек доступа, и размещается в том же положении на карте этажа в Cisco Catalyst Center, что и неисправная точка доступа.
  • Перед выполнением RMA необходимо учесть следующие моменты: - Убедитесь, что версия программного изображения неисправного устройства импортирована в хранилище изображений перед началом процесса замены. - Неисправное устройство должно быть в недоступном состоянии, чтобы иметь право на RMA. - Если заменяемое устройство присоединяется к Cisco Catalyst Center через Plug and Play (PnP), убедитесь, что неисправное устройство назначено на сайт, определенный пользователем. - Заменяемое устройство не должно находиться в состоянии подготовки во время инициирования рабочего процесса RMA. - Функция RMA AP поддерживает только замену типа на тип, то есть заменяемая AP должна иметь такой же номер модели и идентификатор продукта (PID), как и неисправная AP. - Заменяемая AP должна быть подключена к тому же беспроводному контроллеру Cisco, что и неисправная AP. - Cisco Mobility Express AP, выступающие в качестве беспроводных контроллеров, не подлежат замене в рамках данного рабочего процесса RMA. - Убедитесь, что версия программного изображения неисправной точки доступа импортирована в хранилище изображений перед началом процесса замены. - Неисправное устройство должно быть назначено на сайт, определенный пользователем, если заменяемое устройство присоединяется к Cisco Catalyst Center через Plug and Play (PnP). - Заменяемая точка доступа не должна находиться в состоянии подготовки во время инициирования рабочего процесса RMA.

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.10

Параметры

Параметр

Комментарии

ccc_poll_interval

целое число

Интервал, в секундах, для опроса Cisco Catalyst Center.

По умолчанию: 2

config

список / элементы=словарь / обязательный

Список данных о неисправном и заменяющем устройстве для запуска рабочего процесса RMA.

faulty_device_ip_address

строка

IP-адрес неисправного устройства. Пример: 204.192.3.40

faulty_device_name

строка

Имя или имя хоста неисправного устройства. Пример: SJ-EN-9300.cisco.local

faulty_device_serial_number

строка

Серийный номер неисправного устройства. Пример: FJC2327U0S2

replacement_device_ip_address

строка

IP-адрес устройства-замены. Пример: 204.1.2.5

replacement_device_name

строка

Имя или имя хоста устройства-замены. Пример: SJ-EN-9300.cisco.local

replacement_device_serial_number

строка

Серийный номер устройства-замены. Пример: FCW2225C020

config_verify

логическое значение

Установите в True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_api_task_timeout

целое число

Определяет время ожидания в секундах для вызовов API для получения деталей задачи. Если детали задачи не получены в течение этого периода, процесс завершится, и будет записано уведомление о таймауте.

По умолчанию: 1200

dnac_debug

логическое значение

Указывает, включено ли отладка в Cisco Catalyst Center SDK.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_host

строка / обязательный

Имя хоста Cisco Catalyst Center.

dnac_log

логическое значение

Флаг для включения/выключения ведения журнала выполнения playbook.

Если значение true и задан dnac_log_file_path, - Создать файл журнала в месте выполнения с указанным именем.

Если значение true и dnac_log_file_path не задан, - Создать файл журнала в месте выполнения с именем ‘dnac.log’.

Если значение false, - Ведение журнала отключено.

Если файл журнала не существует, - Он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”.

Если файл журнала существует, - Он перезаписывается или дополняется в зависимости от флага “dnac_log_append”.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_log_append

логическое значение

Определяет режим файла. Установите в True для режима ‘append’. Установите в False для режима ‘write’.

Варианты:

  • false
  • true ← (по умолчанию)

dnac_log_file_path

строка

Управляет ведением журнала. Журналы записываются, если dnac_log равно True.

Если путь не указан, - Если ‘dnac_log_append’ равно True, ‘dnac.log’ генерируется в текущем каталоге Ansible; журналы добавляются. - Если ‘dnac_log_append’ равно False, ‘dnac.log’ генерируется; журналы перезаписываются.

Если путь указан, - Если ‘dnac_log_append’ равно True, файл открывается в режиме добавления. - Если ‘dnac_log_append’ равно False, файл открывается в режиме записи (w). - В сценариях с общим файлом, без режима добавления, содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите режим добавления в False для первого модуля (чтобы перезаписать); для последующих модулей установите режим добавления в True.

По умолчанию: "dnac.log"

dnac_log_level

строка

Устанавливает порог уровня журнала. Сообщения с уровнем, равным или выше этого, будут записаны в журнал. Уровни перечислены в порядке убывания серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG].

CRITICAL указывает серьезные ошибки, останавливающие программу. Отображаются только сообщения CRITICAL.

ERROR указывает проблемы, препятствующие выполнению функции. Отображаются сообщения ERROR и CRITICAL.

WARNING указывает потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL.

INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL.

DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала.

По умолчанию: "WARNING"

dnac_password

строка

Пароль для аутентификации в Cisco Catalyst Center.

dnac_port

строка

Указывает номер порта, связанный с Cisco Catalyst Center.

По умолчанию: "443"

dnac_task_poll_interval

integer

Указывает интервал в секундах между последовательными вызовами API для получения подробностей о задаче.

По умолчанию: 2

dnac_username

aliases: user

string

Имя пользователя для аутентификации в Cisco Catalyst Center.

По умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (по умолчанию)

dnac_version

string

Указывает версию Cisco Catalyst Center, которую SDK должен использовать.

По умолчанию: "2.2.3.3"

resync_retry_count

integer

Количество попыток повторной синхронизации.

По умолчанию: 1000

resync_retry_interval

integer

Интервал в секундах между попытками повторной синхронизации.

По умолчанию: 30

state

string

Желаемое состояние процесса замены устройства.

Варианты:

  • "merged" ← (по умолчанию)
  • "deleted"
  • "replaced"

timeout_interval

integer

Интервал ожидания в секундах для операций.

По умолчанию: 100

validate_response_schema

boolean

Флаг для Cisco Catalyst Center SDK, позволяющий включить проверку запрошенных тел по JSON схеме.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Используемый метод SDK — devices.get_device_detail — device_replacement.mark_device_for_replacement — device_replacement.deploy_device_replacement_workflow — device_replacement.unmark_device_for_replacement
  • Используемый путь — post /dna/intent/api/v1/device-replacement/workflow — put /dna/intent/api/v1/device-replacement/ — post /dna/intent/api/v1/device-replacement/
  • ограничения
  • RMA поддерживает замену только похожих устройств. Например, коммутатор Cisco Catalyst 3650 можно заменить только на другой коммутатор Cisco Catalyst 3650. Идентификаторы плат неисправного и заменяемого устройств должны совпадать. Модель номера Cisco устройства можно получить, используя команду `show version`.
  • RMA поддерживает замену всех коммутаторов, маршрутизаторов и устройств Cisco SD-Access, за исключением следующих: — коммутаторы Nexus 7700 серии на базе шасси — устройства с встроенными беспроводными контроллерами — беспроводные контроллеры Cisco
  • RMA поддерживает устройства с внешним сертификатом PKI-брокера SCEP. Сертификат PKI создаётся и аутентифицируется для заменяемого устройства во время процесса RMA. Сертификат PKI заменённого неисправного устройства должен быть вручную удалён из сервера сертификатов.
  • Процесс RMA поддерживает замену устройств только при выполнении следующих условий: — Неисправное и заменяемое устройства должны иметь одинаковые платы расширения. — Неисправное устройство должно управляться Catalyst Center с помощью статического IP-адреса. (RMA не поддерживается для устройств, управляемых Catalyst Center с DHCP-IP.) — Количество портов на обоих устройствах не должно отличаться из-за плат расширения. — Заменяемое устройство должно быть подключено к тому же порту, к которому было подключено неисправное устройство.
  • Cisco Catalyst Center не поддерживает развертывание устаревших лицензий.
  • Если программное обеспечение, установленное на неисправном устройстве, имеет более раннюю версию, чем Cisco IOS XE 16.8, ту же устаревшую сетевую лицензию необходимо вручную установить на заменяемое устройство.
  • Процесс RMA отменяет регистрацию неисправного устройства в Cisco SSM и регистрирует заменяемое устройство в Cisco SSM.
  • Cisco Catalyst Center поддерживает PnP-присоединение заменяемого устройства в сетевой инфраструктуре, за исключением следующих случаев: — Неисправное устройство подключено к устройству верхнего уровня с помощью нескольких интерфейсов. — Автоматизация LAN с помощью перекрывающегося пула.
  • Если заменяемое устройство присоединяется через PnP-DHCP, убедитесь, что после каждого перезапуска устройство получает тот же IP-адрес, а время ожидания аренды DHCP превышает два часа.
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует какие-либо плагины подключения Ansible, вместо этого использует встроенный менеджер подключений Cisco Catalyst Center SDK
  • Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения

Примеры

- name: RMA workflow for faulty device replacement using device names
  cisco.dnac.rma_workflow_manager:
    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 }}"
    dnac_log: true
    dnac_log_level: DEBUG
    config_verify: true
    resync_retry_count: 1000
    resync_retry_interval: 30
    ccc_poll_interval: 2
    timeout_interval: 100
    state: replaced
    config:
      - faulty_device_name: "SJ-EN-9300.cisco.local"
        replacement_device_name: "SJ-EN-9300.cisco-1.local"
  register: result

- name: RMA workflow for faulty device replacement using IP addresses
  cisco.dnac.rma_workflow_manager:
    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 }}"
    dnac_log: true
    dnac_log_level: DEBUG
    config_verify: true
    resync_retry_count: 1000
    resync_retry_interval: 30
    ccc_poll_interval: 2
    timeout_interval: 100
    state: replaced
    config:
      - faulty_device_ip_address: "204.192.3.40"
        replacement_device_ip_address: "204.1.2.5"
  register: result

- name: RMA workflow for faulty device replacement using serial numbers
  cisco.dnac.rma_workflow_manager:
    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 }}"
    dnac_log: true
    dnac_log_level: DEBUG
    config_verify: true
    resync_retry_count: 1000
    resync_retry_interval: 30
    ccc_poll_interval: 2
    timeout_interval: 100
    state: replaced
    config:
      - faulty_device_serial_number: "FJC2327U0S2"
        replacement_device_serial_number: "FCW2225C020"
  register: result

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

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

Ключ

Описание

response_1

словарь

Объект с деталями выполнения API, возвращаемыми Python SDK Cisco Catalyst Center.

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_2

словарь

Объект с деталями выполнения API, возвращаемыми Python SDK Cisco Catalyst Center.

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_3

словарь

Объект с деталями выполнения API, возвращаемыми Python SDK Cisco Catalyst Center.

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_4

словарь

Объект с деталями выполнения API, возвращаемыми Python SDK Cisco Catalyst Center.

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Авторы

  • Trupti A Shetty (@TruptiAShetty)
  • A Mohamed Rafeek (@mohamedrafeek)
  • Madhan Sankaranarayanan (@madhansansel)
  • Ajith Andrew J (@ajithandrewj)

Ссылки на коллекцию

  • Отслеживание задач
  • Репозиторий (источники)

© 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/rma_workflow_manager_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API