Мастер действий командной строки

  • Статья

Важно!

Поддержка этой версии Orchestrator завершена. Рекомендуется выполнить обновление до Orchestrator 2019.

Мастер действий Command-Line позволяет быстро создавать новые действия в Orchestrator, инкапсулируя команды, аргументы и параметры в сборку Microsoft .NET (.DLL). Мастер автоматически создает исходный код на C#, используя пакет SDK для Orchestrator, и компилирует его. С помощью этой сборки можно использовать пакет интеграции .NET (часть набора средств интеграции) для тестирования действий, а затем использовать мастер пакетов интеграции, чтобы упаковать сборку в пользовательский пакет интеграции, который можно распространять и развертывать так же, как и другие пакеты интеграции.

Сборка может содержать одно или несколько действий (команд), а действия могут иметь один или несколько доступных типов команд (Команда, Командная строка, PowerShell или команда SSH). Вы определяете имя действия, структуру команд, входные параметры и даже опубликованные данные (выходные данные).

Общие сведения о действиях в Orchestrator

Действие является единой функциональной частью runbook Orchestrator. Действия выполняют фактическую работу в модулях Runbook и объединяются с помощью ссылок, которые можно определить с помощью условий для создания ветвей рабочих процессов. При создании модуля Runbook с помощью runbook Designer вы перетаскиваете действия из области Действия в модуль Runbook и связываете их вместе, чтобы сформировать рабочий процесс. При выполнении модуля Runbook каждое действие вызывается последовательно в соответствии с способом их связывания. Каждое действие выполняет определенную задачу и может собирать входные данные из шины данных Orchestrator и публиковать выходные данные в той же шине данных. Каждое действие может извлекать опубликованные данные из любого из действий, которые выполнялись до него в runbook, а публикация выходных данных позволяет следующим действиям получить к ним доступ.

Действия варьируются от простых до сложных. Действие можно создать с помощью мастера действий Command-Line, который не выполняет никаких действий, кроме преобразования текста в выходное свойство. Вы также можете создать одно действие, которое выполняет сложное многоэтапное действие, например развертывание виртуальной машины. Вы можете определить, что будет делать каждое действие. Однако ваша цель должна заключаться в определении действий, которые инкапсулируют отдельные наборы функциональных возможностей, которые позволяют легко использовать повторно в различных ситуациях. Ключом является гибкость. Лучше создать набор из 10 различных действий, каждый из которых выполняет что-то определенное и сможет использовать эти действия 20 разными способами, а не создавать 20 различных действий для решения конкретных отдельных сценариев. Дополнительные сведения о рекомендациях рассматриваются далее в этом документе.

Создание сборки действия

Создание новой сборки действия командной строки

Выполните следующие действия, чтобы создать новую сборку действия командной строки.

  1. Выберите Запуск > всех программ > Microsoft System Center 2012 > Orchestrator > Integration Toolkit (>Мастер Command-Line действий Orchestrator).

  2. Выберите Далее.

  3. На странице Сведения о сборке введите значение в поле Имя , которое начинается с буквы, за которой следует ноль или более буквенно-цифровых символов. Это имя используется в качестве идентификатора пространства имен C# для сборки и действий.

  4. В поле Файл сборки введите путь и имя файла сборки, который будет создан этим мастером. Если этот файл уже существует, вам будет предложено перезаписать файл.

  5. Выберите Сведения о сборке. Здесь можно ввести сведения, которые станут свойствами файла сборки, видимыми в Windows Обозреватель через свойства файла. Значения свойств определены в таблице ниже. Эти сведения являются необязательными и не требуются для сборки сборки.

    Свойство Описание
    Заголовок Задает заголовок сборки, который отображается как свойство Описание файла в свойствах Windows Обозреватель
    Описание Указывает необязательное описание сборки, которое не отображается в свойствах Windows Обозреватель
    Продукт Указывает имя продукта для сборки, которое отображается как свойство Product name в свойствах Windows Обозреватель
    Company Указывает название компании для сборки, которое не отображается в свойствах Windows Обозреватель
    Авторские права Указывает уведомление об авторских правах для сборки, которое отображается как авторское право в свойствах Windows Обозреватель
    Товарный знак Указывает товарный знак для сборки, который отображается как юридические товарные знаки в свойствах Windows Обозреватель
    Версия Указывает версию сборки и версию файла. Они отображаются в свойствах Windows Обозреватель как Версия файла и Версия продукта.

    Номер версии состоит из четырех частей:

    <основная версия>.< дополнительный номер версии>.< номер сборки>.< Revision>

  6. После ввода сведений о сборке нажмите кнопку ОК .

  7. Выберите Далее. Откроется страница Команды .

  8. Добавьте одну или несколько команд, следуя инструкциям, приведенным в разделе Добавление команд в сборку.

  9. Завершив определение действия, нажмите кнопку ОК. Диалоговое окно закроется, и новое действие будет добавлено в список на странице Команды . Если вам нужно вернуться и изменить команду, выберите команду в списке и нажмите кнопку Изменить. Если нужно удалить команду, выберите команду в списке и нажмите кнопку Удалить.

  10. Завершив добавление и изменение команд, нажмите кнопку Далее. Файл сборки, указанный в начале мастера, компилируется, а по завершении процесса отображается окончательная страница мастера.

  11. Если вы хотите немедленно создать пакет интеграции из этой новой сборки, нажмите кнопку Собрать пакет интеграции , чтобы запустить мастер пакетов интеграции и предварительно загрузить сведения из сборки. Затем следуйте инструкциям в разделе Создание нового пакета интеграции , чтобы создать пакет интеграции.

  12. Если вы хотите протестировать сборку с помощью действия Вызов .NET или просто пропустить процесс сборки IP-адресов, нажмите кнопку Готово.

Добавление команд в сборку

Добавление команды в сборку

Чтобы добавить команду в сборку, выполните следующие действия.

  1. На странице Команды можно определить одну или несколько команд (которые становятся действиями), которые будут добавлены в сборку. Чтобы добавить новую команду, нажмите кнопку Добавить.

  2. Диалоговое окно Добавление и изменение команды отображается и содержит три вкладки: Общие, Аргументы и Опубликованные данные. Введите имя команды. Это имя, отображаемое в Runbook Designer для действия. При необходимости можно также ввести описание для команды.

  3. Селектор свойств Mode содержит четыре параметра: Выполнить команду, Выполнить Windows PowerShell, Запустить программу и Выполнить команду SSH. Если выбран режим Запуска программы , поле Программа становится активным. Нажмите кнопку с многоточием (...) и найдите программу, которую вы хотите запустить.

    Примечание

    Программа, выбранная в команде Выполнить программу, будет вызываться на сервере Runbook, где выполняется модуль Runbook, содержащий это действие. Таким образом, эта программа должна существовать на всех серверах Runbook, где предполагается запустить модуль Runbook.

  4. Перейдите на вкладку Аргументы .

  5. В поле Командная строка введите параметры команды или командной строки, необходимые для действия. Если команда будет принимать параметры, которые пользователи должны указать, необходимо добавить их в список параметров ниже, а затем нажать кнопку Вставить , чтобы добавить их в командную строку.

    Важно!

    Если вы указали Windows PowerShell выполнить для параметра Mode и ссылаетесь на скрипт PowerShell, включенный в пакет интеграции, необходимо указать имя скрипта символами точки и косой черты, чтобы ссылаться на локальный каталог. Например, \MyScript.ps1 будет указан для скрипта с именем MyScript.ps1. Это связано с тем, что файл скрипта будет скопирован в каталог по умолчанию для пакета интеграции. Когда Windows PowerShell запускает скрипт из локального каталога, он должен указать эту нотацию.

  6. Чтобы указать параметры для командной строки, выберите Добавить. Откроется диалоговое окно Добавление и изменение параметра .

  7. В поле Имя введите имя добавляемого параметра. Это отображаемое имя параметра, отображаемое в списке Свойства действия.

  8. В раскрывающемся списке Режим использования выберите режим, который будет использоваться для параметра . Режим использования имеет два варианта:

    Режим использования Описание
    Аргумент команды Выберите этот аргумент в качестве параметра в командной строке (с помощью кнопки Вставка ). Например, параметр аргумента команды с именем Folder можно поместить в командную строку следующим образом:

    Dir $(folder)Примечание: Если аргументы командной строки содержат пробелы (например, имена папок), их может потребоваться заключить в кавычки, чтобы команда работала правильно. Пример: Dir "$(folder)"
    Переменная среды Выберите этот аргумент в качестве переменной среды, которая будет задана перед выполнением командной строки. Его можно использовать как параметр командной строки или переменную среды в выполняемом скрипте.

    Например, параметр переменной среды с именем Folder можно поместить в командную строку следующим образом:

    Dir %Folder%Важно: Имя переменной среды уже существует в пользовательских или системных средах; Команда завершится ошибкой с сообщением об ошибке следующего вида: Элемент уже добавлен. Ключ в словаре: "папка" Добавляемый ключ: "папка". Вы можете определить, какие переменные среды существуют на локальном или удаленном компьютере, выбрав Запустить > запуск и введя MSINFO32.EXE. Затем выберите Переменные среды программной среды>. Чтобы выбрать другой компьютер, нажмите клавиши< CTRL+R>, выберите Удаленный компьютер в сети, введите имя компьютера и нажмите кнопку ОК.

  9. В раскрывающемся списке Стиль отображения выберите стиль, который будет использоваться для отображения параметра. Стиль отображения определяет, как пользователь будет взаимодействовать с входными данными при их представлении. Эти варианты описаны ниже.

    Стиль отображения Описание
    текст Пользователю будет предоставлено текстовое поле в свободной форме для ввода значения
    Зашифрованный текст Пользователю будет предоставлено текстовое поле с маской. Данные в этом поле будут зашифрованы в базе данных и не будут отображаться в журналах.
    Истина/ложь Пользователь может выбрать значение True или False во всплывающем диалоговом окне.
    Текст с выделенным фрагментом Пользователь может выбрать из группы параметров , которые вы указали
    Дата и время Пользователь может выбрать значение с помощью элемента управления "Выбор даты и времени"
    File Пользователь может выбрать значение с помощью элемента управления "Обозреватель файлов"
    Папка Пользователь может выбрать значение с помощью элемента управления "Обозреватель папок"
    Компьютер Пользователь может выбрать значение с помощью элемента управления "Браузер компьютера"

  10. Если для параметра требуется или вы хотите указать значение по умолчанию, введите его в поле Значение по умолчанию .

  11. Если вы выбрали текст с выделенным фрагментом, поле Параметры включено. Чтобы добавить значения параметров, которые пользователь может выбрать, нажмите кнопку с многоточием рядом с полем Параметры и введите их. Каждый параметр указан в отдельной строке. Завершив добавление параметров, нажмите кнопку ОК.

  12. Завершив работу с определением параметра, нажмите кнопку ОК.

  13. Если этот параметр определен как параметр command, теперь его можно добавить в командную строку, поместив курсор в нужную точку вставки в командной строке, а затем нажав кнопку Вставка и выбрав имя параметра. Если она определена как переменная среды, необходимо вручную ввести переменную (в формате %variable%), если она требуется в командной строке.

  14. Если выбраны режимы Запуск программы или Запуск командной строки , установлен флажок Включить рабочий каталог .

  15. Выберите вкладку Опубликованные данные . Параметры на этой вкладке позволяют публиковать выходные данные в шине данных Orchestrator, чтобы другие действия могли использовать эти сведения.

  16. Чтобы добавить новое свойство опубликованных данных, нажмите кнопку Добавить.

  17. Если в раскрывающемся списке Режим на вкладке Общие диалогового окна Добавление или изменение команды "Добавить или изменить команду" выбран параметр Выполнить команду, Запустить программу или Выполнить команду SSH, в диалоговом окне Добавление и изменение опубликованных данных появятся следующие элементы:

    Элементы Описание
    Имя Отображаемое имя создаваемого элемента опубликованных данных
    Источник Источник элемента опубликованных данных. В командной строке можно выбрать стандартный выходной поток или стандартный поток ошибок .
    Mode Режим, который вы хотите использовать для выбора опубликованных данных.

    Используйте шаблон соответствия , чтобы определить, найден ли данный шаблон в источнике. Возвращает значение True или False.

    Используйте функцию извлечения группы для получения каждого элемента данных, соответствующего указанному шаблону.
    Шаблон Регулярное выражение, применяемое к параметру Mode
    Описание Текст описания, который отображается рядом со свойством опубликованных данных в Runbook Designer. (необязательно).

  18. Если вы выбрали параметр Выполнить Windows PowerShell в раскрывающемся списке Режим на вкладке Общие диалогового окна Добавление и изменение команды, в диалоговом окне Добавление и изменение опубликованных данных отображаются следующие элементы:

    Элементы Описание
    Имя Отображаемое имя создаваемого элемента опубликованных данных
    Свойство Имя свойства Windows PowerShell, которое будет сохранено в элементе Опубликованные данные. Это свойство должно содержаться в выходных данных объекта в конвейер PowerShell во время выполнения скрипта и не должно быть объектом (должно быть преобразовано в строку).
    Описание Текст описания, который отображается рядом со свойством опубликованных данных в Runbook Designer. (необязательно).

  19. Нажмите кнопку ОК , чтобы завершить добавление элемента Опубликованные данные. Повторите шаги 16–18 для каждого элемента опубликованных данных, который вы хотите добавить.

  20. Нажмите кнопку ОК , чтобы закрыть диалоговое окно Добавление и изменение команды и вернуться в диалоговое окно Команды.

Тестирование сборки действия

После создания сборки вы можете протестировать ее с помощью действия Вызов .NET (содержащегося в IP-адресе набора средств интеграции для .NET), чтобы убедиться, что она работает должным образом, прежде чем преобразовать ее в пользовательский пакет интеграции.

Тестирование сборки

Чтобы протестировать сборку, выполните следующие действия.

  1. Откройте Runbook Designer.

  2. Создайте новый модуль Runbook.

  3. В области Действия выберите категорию Набор средств интеграции , чтобы развернуть ее, и перетащите действие Вызов .NET в новый модуль Runbook.

  4. Дважды щелкните объект Вызов .NET, чтобы открыть диалоговое окно Свойства .

  5. В поле Сборка найдите файл сборки, созданный с помощью мастера действий Command-Line (или с помощью пользовательской разработки с помощью пакета SDK), нажав кнопку с многоточием (...) справа от поля. Выберите файл и нажмите кнопку Открыть.

  6. Нажмите кнопку с многоточием справа от поля Класс , чтобы просмотреть список отдельных команд в сборке. Выберите класс команд и нажмите кнопку ОК. Параметры для этого класса отображаются на вкладке Свойства диалогового окна.

  7. Поле Setup используется только пользовательскими классами, использующими пакет SDK Orchestrator с атрибутом OrchestratorData. Дополнительные сведения о пакете SDK см. в статье Пакет SDK для набора средств интеграции System Center Orchestrator.

  8. Выберите вкладку Свойства.

  9. При необходимости укажите сведения для каждого свойства.

  10. Нажмите кнопку Готово , чтобы сохранить параметры и вернуться к runbook.

  11. Выберите Runbook Tester на панели инструментов в runbook Designer. Запускается модуль Runbook Tester.

  12. Выберите Выполнить до точки останова на панели инструментов. Запускается модуль Runbook, и выполняется действие. Результаты действия отображаются в области Журнал выполнения .

  13. Выберите Показать сведения под именем действия в области Журнал запуска, чтобы просмотреть подробные результаты, включая входные свойства и опубликованные данные.

Миграция действий QIK CLI

Если у вас есть сборка, созданная с помощью мастера интерфейса командной строки QIK Opalis 6.3, необходимо преобразовать ее в совместимую с Orchestrator, прежде чем ее можно будет использовать в пакете интеграции Orchestrator или непосредственно в модулях Runbook с помощью действия Вызова .NET. Процесс преобразования прост и занимает всего несколько секунд для каждой сборки.

Важно!

Установка набора средств интеграции Orchestrator не завершится ошибкой, если не установлен microsoft платформа .NET Framework 3.5 с пакетом обновления 1 (SP1), но другие операции в мастере действий Command-Line завершатся ошибкой, если они отсутствуют. Убедитесь, что microsoft платформа .NET Framework 3.5 с пакетом обновления 1 (SP1) установлен, прежде чем использовать интерфейс командной строки.

Преобразование сборки Интерфейса командной строки Opalis QIK

Выполните следующие действия, чтобы преобразовать сборку CLI Opalis QIK:

  1. Запустите мастер действий Orchestrator Command-Line, выбрав Запуск > всех программ > Мастер действий Command-Line Microsoft System Center 2012 > Orchestrator >

  2. После загрузки мастера нажмите кнопку Загрузить существующую сборку на первой странице.

  3. Выберите существующий файл сборки и нажмите кнопку Открыть. Отображается имя и расположение файла сборки.

  4. Измените путь к файлу, чтобы изменения сохранялись в новом файле. При необходимости можно также изменить имя сборки.

  5. Если вам нужно внести дополнительные изменения в сведения о сборке, нажмите кнопку Сведения о сборке и внесите эти изменения. По завершении нажмите кнопку ОК , чтобы вернуться на страницу Сведений о сборке.

  6. Нажмите кнопку Далее , чтобы перейти на страницу Команды. Вы увидите список команд, которые были определены ранее в сборке. При необходимости просмотрите команды и нажмите кнопку Далее , чтобы перейти на страницу Сборка сборки .

  7. Новая сборка будет создана и сохранена с использованием пути и имени файла, которые вы определили ранее.

  8. Теперь вы можете использовать новую сборку, совместимую с Orchestrator, в модулях Runbook с действием Invoke .NET или создать пакет интеграции из этой сборки, нажав кнопку Собрать пакет интеграции . Если вы не хотите создавать IP-адрес в настоящее время, нажмите кнопку Закрыть , чтобы завершить работу мастера.

Ресурсы Orchestrator

Помимо этого справочника в Интернете, предоставленного для System Center 2012 Orchestrator, существует ряд ресурсов, которые могут предоставить дополнительные сведения о создании модулей Runbook, использовании набора средств интеграции и рекомендациях.