Spec-Zone.ru › Ansible

Модуль cisco.dnac.provision_workflow_manager — Модуль ресурсов для функций, связанных с провизированием

Примечание

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

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

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

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

Новое в cisco.dnac 6.6.0

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

Обзор

  • Управление операциями, связанными с провизированием проводных и беспроводных устройств
  • API для повторного провизирования устройств
  • API для отмены провизирования устройств

Требования

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

  • dnacentersdk == 2.4.5
  • python >= 3.9

Параметры

Параметр

Комментарии

config

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

Список данных управляемого устройства.

dynamic_interfaces

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

Данные интерфейсов контроллера

interface_gateway

строка

IP-адрес, выделенный интерфейсу

interface_ip_address

строка

IP-адрес, выделенный интерфейсу

interface_name

строка

IP-адрес, выделенный интерфейсу

interface_netmask_in_c_i_d_r

целое число

IP-адрес, выделенный интерфейсу

lag_or_port_number

целое число

IP-адрес, выделенный интерфейсу

vlan_id

целое число

IP-адрес, выделенный интерфейсу

force_provisioning

булево

Определяет, нужно ли принудительно перепровизировать устройство.

Устройство нельзя повторно провизировать в другой сайт.

Параметр ‘provisioning’ не должен быть установлен в ‘false’ для того, чтобы ‘force_provisioning’ вступил в силу.

Применимо только к проводным устройствам.

Установите в ‘true’, чтобы принудительно перепровизировать, даже если устройство уже провизировано.

Установите в ‘false’, чтобы пропустить провизирование для устройств, которые уже провизированы.

Варианты:

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

managed_ap_locations

список / элементы=строка

Расположение сайтов, выделенных для точек доступа.

Это обязательно для провизирования беспроводных устройств.

management_ip_address

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

IP-адрес управления устройством.

provisioning

булево

Указывает, намерен ли пользователь выполнить только назначение сайта или полное провизирование проводного устройства.

Установите в ‘false’, чтобы выполнить только назначение сайта.

Установите в ‘true’, чтобы выполнить провизирование на сайте.

Варианты:

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

site_name_hierarchy

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

Имя сайта, где будет добавлено устройство. Этот параметр необходим для провизирования устройства и его назначения на сайт.

config_verify

булево

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

Варианты:

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

dnac_api_task_timeout

целое число

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

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

dnac_debug

булево

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

Варианты:

  • 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

boolean

Определяет режим файла. Установите в True для режима 'append' (добавление). Установите в False для режима 'write' (запись).

Варианты:

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

dnac_log_file_path

string

Управляет ведением журнала. Журналы записываются, если 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

string

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

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

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

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

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

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

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

dnac_password

string

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

dnac_port

string

Указывает номер порта, связанный с 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"

state

string

Состояние Cisco Catalyst Center после завершения модуля.

Варианты:

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

validate_response_schema

boolean

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

Варианты:

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

Примечания

Примечание

  • Используемые методы SDK: sites.Sites.get_site, devices.Devices.get_network_device_by_ip, task.Task.get_task_by_id, sda.Sda.get_provisioned_wired_device, sda.Sda.re_provision_wired_device, sda.Sda.provision_wired_device, wireless.Wireless.provision
  • Используемые пути: get /dna/intent/api/v1/site get /dna/intent/api/v1/network-device/ip-address/{ipAddress} get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/business/sda/provision-device put /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/wireless/provision
  • Добавлен параметр ‘provisioning’ в версии v6.16.0
  • Добавлена возможность предоставления и повторного предоставления беспроводных устройств в версии v6.16.0
  • Не поддерживает check_mode
  • Плагин выполняется на узле управления и не использует какие-либо плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco Catalyst Center SDK
  • Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления подключения

Примеры

- name: Provision a wireless device to a site
  cisco.dnac.provision_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
    state: merged
    config:
        - site_name_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          managed_ap_locations:
            - Global/USA/San Francisco/BGL_18/Test_Floor2
          dynamic_interfaces:
            - vlan_id: 1866
              interface_name: Vlan1866
              interface_ip_address: 204.192.6.200
              interface_gateway: 204.192.6.1

- name: Provision a wired device to a site
  cisco.dnac.provision_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
    state: merged
    config:
        - site_name_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40

- name: Re-Provision a wired device to a site forcefully
  cisco.dnac.provision_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
    state: merged
    config:
        - site_name_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          force_provisioning: true

- name: Assign a wired device to a site
  cisco.dnac.provision_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
    state: merged
    config:
        - site_name_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          provisioning: false

- name: Provision a wireless device to a site
  cisco.dnac.provision_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
    state: merged
    config_verify: true
    config:
        - site_name_hierarchy: Global/USA/RTP/BLD11
          management_ip_address: 204.192.12.201
          managed_ap_locations:
            - Global/USA/RTP/BLD11/BLD11_FLOOR1

- name: Unprovision a device from a site
  cisco.dnac.provision_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
    state: deleted
    config_verify: true
    config:
        - management_ip_address: 204.1.2.2

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

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

Ключ

Описание

response_1

словарь

Возвращается словарь с деталями настройки.

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

Пример: "{\n  \"response\":\n  {\n    \"response\": String,\n    \"version\": String\n    },\n  \"msg\": String\n}\n"

response_2

список / элементы=строка

Список, содержащий данные, возвращённые Python SDK Cisco Catalyst Center.

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

Пример: ["{\n  \"response\": []", "\n  \"msg\": String\n}\n"]

response_3

словарь

Словарь с существующими деталями, возвращённый Python SDK Cisco Catalyst Center.

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

Пример: "{\n  \"response\": String,\n  \"msg\": String\n}\n"

Авторы

  • Абинаш Мишра (@abimishr) Мадан Санкаранайянан (@madhansansel) Сиед Хадиер Ахмед (@syed-khadeerahmed) Аджит Эндрю Дж (@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/provision_workflow_manager_module.html

Spec-Zone.ru

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