pnp_workflow_manager module – Resource module for Site and PnP related functions — Ansible

Параметры

Параметр	Комментарии
config list / elements=dictionary / required	Список подробных сведений об управляемом устройстве.
device_info list / elements=dictionary / required	Предоставляет специфическую для устройства информацию, необходимую для добавления устройств в базу данных PnP, которых ещё нет. Для добавления одного устройства список должен содержать ровно один набор информации об устройстве. Если также указано имя сайта, устройство может быть заявлено сразу после добавления. Для пакетного импорта список должен содержать информацию о более чем одном устройстве. Пакетный импорт предназначен исключительно для добавления устройств; запрос должен выполняться с помощью отдельных задач или конфигураций.
hostname string	Определяет желаемое имя хоста для устройства PnP после его заявления. Имя хоста может быть назначено или изменено только во время процесса заявки, а не во время добавления нескольких или одного устройства.
is_sudi_required boolean	Флаг требований аутентификации Sudi. Варианты: `false` `true`
pid string	pid устройства PnP.
serial_number string	Серийный номер устройства PnP.
state string	Представляет состояние подключения устройства PnP. Возможные значения: «Unclaimed», «Claimed» или «Provisioned».
gateway string	IP-адрес шлюза беспроводного контроллера для проверки связи (ping).
golden_image boolean	Отмечен ли образ как «золотой»? Варианты: `false` `true`
image_name string	Имя образа, который будет настроен на устройстве.
ip_interface_name string	Указывает имя интерфейса, используемого для Plug and Play (PnP) беспроводным контроллером. Убедитесь, что этот интерфейс предварительно настроен на контроллере до заявки устройства.
pnp_type string	Указывает тип устройства для устройства Plug and Play (PnP). - Варианты включают «Default», «CatalystWLC», «AccessPoint» или «StackSwitch». - «Default» применим к коммутаторам и маршрутизаторам. - «CatalystWLC» следует выбирать для беспроводных контроллеров серии 9800. - «AccessPoint» используется при заявке точки доступа. - «StackSwitch» следует выбирать для группы коммутаторов, работающих как один коммутатор, обычно используемых на уровне доступа. Варианты: `"Default"` ← (default) `"CatalystWLC"` `"AccessPoint"` `"StackSwitch"`
project_name string	Имя проекта, в котором находится шаблон. По умолчанию: `"Onboarding Configuration"`
rf_profile string	Радиочастотный (РЧ) профиль заявленной точки доступа. РЧ-профили позволяют настраивать группы точек доступа, которые совместно используют общую зону покрытия. Они выборочно изменяют работу управления радиоресурсами с точками доступа в этой зоне покрытия. Высокий РЧ-профиль позволяет использовать большую мощность и упрощает подключение точки доступа к клиенту. Типичный РЧ-профиль представляет собой сочетание умеренной мощности и умеренной видимости для клиента. Низкий РЧ-профиль позволяет потреблять меньшую мощность и имеет наименьшую видимость для клиента. Варианты: `"HIGH"` `"LOW"` `"TYPICAL"`
site_name string	Имя сайта, для которого будет заявлено устройство.
static_ip string	Управляющий IP-адрес беспроводного контроллера.
subnet_mask string	Маска подсети управляющего IP-адреса беспроводного контроллера.
template_name string	Имя шаблона, который будет настроен на устройстве. Поддерживается для EWLC, начиная с версии Cisco Catalyst Center 2.3.7.x и выше.
template_params dictionary	Значения параметров для параметризованных шаблонов. Каждая переменная имеет значение, которое необходимо передать как пару «ключ-значение» в словаре. Значения можно передавать как имя_переменной:значение_переменной. Поддерживается для EWLC, начиная с версии Cisco Catalyst Center 2.3.7.x и выше.

validate_response_schema

boolean

Флаг для Cisco Catalyst Center SDK для включения валидации тел запросов по схеме JSON.

Варианты:

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

Примечания

Примечание

Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.add_device, device_onboarding_pnp.DeviceOnboardingPnp.get_device_list, device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_to_a_site, device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp, device_onboarding_pnp.DeviceOnboardingPnp.get_device_count, device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, device_onboarding_pnp.DeviceOnboardingPnp.update_device, sites.Sites.get_site, software_image_management_swim.SoftwareImageManagementSwim.get_software_image_details, configuration_templates.ConfigurationTemplates.gets_the_templates_available
Используемые пути: post /dna/intent/api/v1/onboarding/pnp-device post /dna/intent/api/v1/onboarding/pnp-device/site-claim post /dna/intent/api/v1/onboarding/pnp-device/{id} get /dna/intent/api/v1/onboarding/pnp-device/count get /dna/intent/api/v1/onboarding/pnp-device put /onboarding/pnp-device/${id} get /dna/intent/api/v1/site get /dna/intent/api/v1/image/importation get /dna/intent/api/v1/template-programmer/template
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, вместо этого использует встроенный менеджер подключений из Cisco Catalyst Center SDK
Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения

Примеры

- name: Import multiple switches in bulk only
  cisco.dnac.pnp_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_level: "{{dnac_log_level}}"
    dnac_log: True
    state: merged
    config_verify: True
    config:
        - device_info:
            - serial_number: QD2425L8M7
              state: Unclaimed
              pid: c9300-24P
              is_sudi_required: False
            - serial_number: QTC2320E0H9
              state: Unclaimed
              pid: c9300-24P
              hostname: Test-123
            - serial_number: ETC2320E0HB
              state: Unclaimed
              pid: c9300-24P

- name: Add a new EWLC and claim it
  cisco.dnac.pnp_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_level: "{{dnac_log_level}}"
    dnac_log: True
    state: merged
    config_verify: True
    config:
        - device_info:
            - serial_number: FOX2639PAY7
              hostname: New_WLC
              state: Unclaimed
              pid: C9800-CL-K9
          site_name: Global/USA/San Francisco/BGL_18
          template_name: Ansible_PNP_WLC
          template_params:
            hostname: IAC-EWLC-Claimed
          project_name: Onboarding Configuration
          image_name: C9800-40-universalk9_wlc.17.12.01.SPA.bin
          golden_image: true
          pnp_type: CatalystWLC
          static_ip: 204.192.101.10
          subnet_mask: 255.255.255.0
          gateway: 204.192.101.1
          vlan_id: 1101
          ip_interface_name: TenGigabitEthernet0/0/0

- name: Claim a pre-added switch, apply a template, and perform an image upgrade for a specific site
  cisco.dnac.pnp_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_level: "{{dnac_log_level}}"
    dnac_log: True
    state: merged
    config_verify: True
    config:
        - device_info:
            - serial_number: FJC271924EQ
              hostname: Switch
              state: Unclaimed
              pid: C9300-48UXM
          site_name: Global/USA/San Francisco/BGL_18
          template_name: "Ansible_PNP_Switch"
          image_name: cat9k_iosxe_npe.17.03.07.SPA.bin
          project_name: Onboarding Configuration
          template_params:
            hostname: SJC-Switch-1
            interface: TwoGigabitEthernet1/0/2

- name: Remove multiple devices from the PnP dashboard safely (ignores non-existent devices)
  cisco.dnac.pnp_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_level: "{{dnac_log_level}}"
    dnac_log: True
    state: deleted
    config_verify: True
    config:
        - device_info:
            - serial_number: QD2425L8M7
            - serial_number: FTC2320E0HA
            - serial_number: FKC2310E0HB

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

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

Ключ	Описание
response_1 словарь	Словарь с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращаемое значение: всегда Пример: `"{\n \"response\":\n {\n \"response\": String,\n \"version\": String\n },\n \"msg\": String\n}\n"`
response_2 список / элементы=строка	Список с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращаемое значение: всегда Пример: `["{\n \"response\": []", "\n \"msg\": String\n}\n"]`
response_3 словарь	Строка с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращаемое значение: всегда Пример: `"{\n \"response\": String,\n \"msg\": String\n}\n"`

Авторы

Abinash Mishra (@abimishr) Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary)

Ссылки на сборку

© 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_workflow_manager_module.html

vlan_id string	Идентификатор VLAN, выделенный для заявки на беспроводной контроллер
config_verify boolean	Установите значение True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook. Варианты: `false` ← (default) `true`
dnac_api_task_timeout integer	Определяет время ожидания в секундах для вызовов API для получения сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания. По умолчанию: `1200`
dnac_debug boolean	Указывает, включена ли отладка в Cisco Catalyst Center SDK. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco Catalyst Center.
dnac_log boolean	Флаг для включения/отключения ведения журнала выполнения playbook. Когда значение true и указан путь dnac_log_file_path, - создайте файл журнала в месте выполнения с указанным именем. Когда значение true и путь dnac_log_file_path не указан, - создайте файл журнала в месте выполнения с именем «dnac.log». Когда значение false, - ведение журнала отключено. Если файл журнала не существует, - он создается в режиме добавления или записи в зависимости от флага «dnac_log_append». Если файл журнала существует, - он перезаписывается или к нему добавляется информация в зависимости от флага «dnac_log_append». Варианты: `false` ← (default) `true`
dnac_log_append boolean	Определяет режим файла. Установите значение True для режима «добавления». Установите значение False для режима «записи». Варианты: `false` `true` ← (default)
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). - В сценариях с общим файлом без режима добавления содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите значение append равным False для первого модуля (для перезаписи); для последующих модулей установите значение append равным 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` ← (default)
dnac_version string	Указывает версию Cisco Catalyst Center, которую должен использовать SDK. По умолчанию: `"2.2.3.3"`
state string	Состояние Cisco Catalyst Center после завершения работы модуля. Варианты: `"merged"` ← (default) `"deleted"`

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

Обзор