Модуль cisco.dnac.pnp_workflow – Модуль ресурсов для рабочих процессов PnP
Примечание
Этот модуль входит в коллекцию cisco.dnac (версия 6.20.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Для использования в книге задач укажите: cisco.dnac.pnp_workflow.
Добавлен в cisco.dnac 3.1.0
Обзор
- Управление операциями создания, обновления и удаления ресурсов рабочих процессов PnP.
- Добавляет рабочий процесс PnP вместе с соответствующими задачами в базу данных PnP.
- Удаляет рабочий процесс, указанный по идентификатору.
- Обновляет существующий рабочий процесс.
Примечание
Для этого модуля имеется соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
_id string | _id рабочего процесса PNP. |
addedOn integer | addedOn рабочего процесса PNP. |
addToInventory boolean | Флаг AddToInventory. Варианты:
|
configId string | configId рабочего процесса PNP. |
currTaskIdx integer | currTaskIdx рабочего процесса PNP. |
description string | Описание рабочего процесса PNP. |
dnac_debug boolean | Флаг для Cisco DNA Center SDK для включения отладки. Варианты:
|
dnac_host string / required | Имя хоста Cisco DNA Center. |
dnac_password string | Пароль Cisco DNA Center для аутентификации. |
dnac_port integer | Порт Cisco DNA Center. По умолчанию: |
dnac_username aliases: user string | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: |
endTime integer | endTime рабочего процесса PNP. |
execTime integer | execTime рабочего процесса PNP. |
id string | Параметр пути Id. |
imageId string | imageId рабочего процесса PNP. |
instanceType string | instanceType рабочего процесса PNP. |
lastupdateOn integer | lastupdateOn рабочего процесса PNP. |
name string | Название рабочего процесса PNP. |
startTime integer | startTime рабочего процесса PNP. |
state_ string | Состояние рабочего процесса PNP. |
tasks list / elements=dictionary | Задачи рабочего процесса PNP. |
|
currWorkItemIdx integer |
currWorkItemIdx рабочего процесса PNP. |
|
endTime integer |
endTime рабочего процесса PNP. |
|
name string |
Название рабочего процесса PNP. |
|
startTime integer |
startTime рабочего процесса PNP. |
|
state строка |
Состояние PNP рабочего процесса. |
|
taskSeqNo целое число |
taskSeqNo PNP рабочего процесса. |
|
timeTaken целое число |
timeTaken PNP рабочего процесса. |
|
type строка |
Тип PNP рабочего процесса. |
|
workItemList список / элементы=словарь |
workItemList PNP рабочего процесса. |
|
command строка |
Команда PNP рабочего процесса. |
|
endTime целое число |
Конечное время PNP рабочего процесса. |
|
outputStr строка |
Строка вывода PNP рабочего процесса. |
|
startTime целое число |
Начальное время PNP рабочего процесса. |
|
state строка |
Состояние PNP рабочего процесса. |
|
timeTaken целое число |
Время выполнения PNP рабочего процесса. |
tenantId строка | tenantId PNP рабочего процесса. |
type строка | Тип PNP рабочего процесса. |
useState строка | Состояние PNP рабочего процесса. |
validate_response_schema логическое | Флаг для Cisco DNA Center SDK для включения проверки тел запросов по JSON-схеме. Варианты:
|
version целое число | Версия PNP рабочего процесса. |
Примечания
Примечание
- Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.add_a_workflow, device_onboarding_pnp.DeviceOnboardingPnp.delete_workflow_by_id, device_onboarding_pnp.DeviceOnboardingPnp.update_workflow,
- Используемые пути: post /dna/intent/api/v1/onboarding/pnp-workflow, delete /dna/intent/api/v1/onboarding/pnp-workflow/{id}, put /dna/intent/api/v1/onboarding/pnp-workflow/{id},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco DNA Center по добавлению рабочего процесса устройства (PnP) AddAWorkflow
-
Полное описание API AddAWorkflow.
- Документация Cisco DNA Center по удалению рабочего процесса устройства (PnP) DeleteWorkflowById
-
Полное описание API DeleteWorkflowById.
- Документация Cisco DNA Center по обновлению рабочего процесса устройства (PnP) UpdateWorkflow
-
Полное описание API UpdateWorkflow.
Примеры
- name: Create
cisco.dnac.pnp_workflow:
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
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state_: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
- name: Delete by id
cisco.dnac.pnp_workflow:
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: absent
id: string
- name: Update by id
cisco.dnac.pnp_workflow:
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
_id: string
addToInventory: true
addedOn: 0
configId: string
currTaskIdx: 0
description: string
endTime: 0
execTime: 0
id: string
imageId: string
instanceType: string
lastupdateOn: 0
name: string
startTime: 0
state_: string
tasks:
- currWorkItemIdx: 0
endTime: 0
name: string
startTime: 0
state: string
taskSeqNo: 0
timeTaken: 0
type: string
workItemList:
- command: string
endTime: 0
outputStr: string
startTime: 0
state: string
timeTaken: 0
tenantId: string
type: string
useState: string
version: 0
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
dnac_response словарь | Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: |
Ссылки на коллекции
© 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_module.html