Spec-Zone.ru › Ansible

Модуль community.network.iap_start_workflow – Запуск рабочего процесса в платформе Itential Automation

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

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

Для установки используйте: ansible-galaxy collection install community.network.

Для использования в книге задач укажите: community.network.iap_start_workflow.

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

Описание

  • Этот модуль запускает указанный рабочий процесс в платформе Itential Automation Platform с заданными аргументами.

Псевдонимы: network.itential.iap_start_workflow

Параметры

Параметр

Комментарии

description

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

Укажите описание рабочего процесса

https

логический

Использовать HTTPS для подключения

По умолчанию используется http

Варианты:

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

iap_fqdn

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

Укажите FQDN для платформы Itential Automation

iap_port

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

Укажите номер порта для платформы Itential Automation

token_key

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

Ключ токена, сгенерированный модулем iap_token для платформы Itential Automation

validate_certs

логический

Если no, сертификаты SSL для целевого URL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, с самозаверенными сертификатами.

Варианты:

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

variables

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

Укажите значения для переменных задания

workflow_name

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

Укажите имя рабочего процесса

Примеры

- name: Start a workflow in the Itential Automation Platform
  community.network.iap_start_workflow:
    iap_port: 3000
    iap_fqdn: localhost
    token_key: "DFSFSFHFGFGF[DSFSFAADAFASD%3D"
    workflow_name: "RouterUpgradeWorkflow"
    description: "OS-Router-Upgrade"
    variables: {"deviceName":"ASR9K"}
  register: result

- ansible.builtin.debug: var=result

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

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

Ключ

Описание

msg

строка

Поле msg содержит код ошибки или состояние рабочего процесса

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

response

словарь

Результат содержит ответ от вызова

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

Авторы

  • Itential (@cma0)

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

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

© 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/community/network/iap_start_workflow_module.html

Spec-Zone.ru

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