Модуль cisco.dnac.pnp_workflow_info – Модуль информации для Pnp Workflow

Примечание

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

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

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

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

Новая функция в cisco.dnac 3.1.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Получить все Pnp Workflow.
Получить Pnp Workflow по id.
Возвращает workflow, указанный по id.
Возвращает список workflow, соответствующий критериям фильтрации. Если лимит не указан, по умолчанию возвращаются 50 workflow. Поддержка пагинации и сортировки также включена в этот endpoint.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username алиасы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки SSL сертификата. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers dictionary	Дополнительные заголовки.
id string	Параметр пути id.
limit integer	Параметр запроса limit. Ограничивает количество результатов.
name list / elements=string	Параметр запроса name. Имя workflow.
offset integer	Параметр запроса offset. Индекс первого результата.
sort list / elements=string	Параметр запроса sort. Список полей для сортировки, разделённых запятыми.
sortOrder string	Параметр запроса sortOrder. Порядок сортировки: Ascending (asc) или Descending (des).
type list / elements=string	Параметр запроса type. Тип workflow.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения валидации тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: device_onboarding_pnp.DeviceOnboardingPnp.get_workflow_by_id, device_onboarding_pnp.DeviceOnboardingPnp.get_workflows,
Используемые пути: get /dna/intent/api/v1/onboarding/pnp-workflow, get /dna/intent/api/v1/onboarding/pnp-workflow/{id},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по Device Onboarding (PnP) GetWorkflowById: Полное описание API GetWorkflowById.
Документация Cisco DNA Center по Device Onboarding (PnP) GetWorkflows: Полное описание API GetWorkflows.

Примеры

- name: Get all Pnp Workflow
  cisco.dnac.pnp_workflow_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}}"
    limit: 0
    offset: 0
    sort: []
    sortOrder: string
    type: []
    name: []
  register: result

- name: Get Pnp Workflow by id
  cisco.dnac.pnp_workflow_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}}"
    id: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: {"_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}

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"_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}

Авторы

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/pnp_workflow_info_module.html