Создание модулей Runbook службы автоматизации управления службами

Runbooks в службе автоматизации управления службами и службе Microsoft Azure Automation — это рабочие процессы Windows PowerShell или скрипты PowerShell. Они обеспечивают возможность автоматизации административных процессов развертывания и управления облачными серверами и других функций, которые могут выполнять сценарии Windows PowerShell.

Нет разницы в модулях Runbook между двумя системами, и один и тот же модуль Runbook может выполняться с одинаковой функциональностью. Если термин Автоматизация используется в этой статье, он относится как к автоматизации управления службами, так и к автоматизации Microsoft Azure.

Дополнительные службы, предоставляемые в Automation для работы с рабочими процессами Windows PowerShell, включают следующие:

• Централизованное хранение и управление операционными инструкциями.

• Масштабируемая архитектура для планирования и запуска модулей Runbook.

• глобальные ресурсы, поддерживающие централизованное управление и доступные для всех модулей Runbook;

• пользовательский интерфейс для разработки и тестирования модулей Runbook;

• набор командлетов для запуска модулей Runbook и управления ими.

Создание или импорт модуля Runbook

Модуль Runbook можно добавить в автоматизацию управления сервисами, создав его посредством портала управления или импортировав его из файла.

Создание модуля Runbook на портале управления

1. На портале управления выберите Создать, Службы приложений, Автоматизация, Runbook, Быстрое создание.

2. Введите необходимые сведения и нажмите кнопку "Создать". Имя модуля Runbook должно начинаться с буквы и содержать буквы, цифры, символы подчеркивания и дефисы.

3. Если вы хотите изменить модуль Runbook, нажмите кнопку "Изменить модуль Runbook". В противном случае нажмите кнопку "ОК".

4. Ваш новый планировщик появится на вкладке Планировщики.

Импорт модуля Runbook из файла

1. Выберите на портале управления пункт Автоматизация , а затем "Учетная запись автоматизации".

2. Выберите Импорт.

3. Выберите "Обзор файла " и найдите файл скрипта для импорта.

4. Если вы хотите изменить модуль Runbook, выберите "Изменить модуль Runbook". В противном случае нажмите кнопку "ОК".

5. Новый модуль Runbook появится на вкладке Модули Runbook раздела "Учетная запись автоматизации".

Импорт модуля Runbook из файла скрипта с помощью Windows PowerShell

Чтобы создать модуль Runbook из файла сценария, содержащего рабочий процесс, можно использовать командлет Import-SmaRunbook .

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

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

Import-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Path $scriptPath
Publish-SMARunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName

Редактировать операционное руководство

Каждый модуль Runbook в службе автоматизации управления службами имеет две версии: черновик и опубликовано. Вы редактируете черновую версию рабочего процесса, а затем опубликуете ее таким образом, чтобы его можно было выполнить. Опубликованная версия не может быть изменена.

Изменение модуля Runbook с помощью портала управления

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

1. На портале управления выберите пункт Автоматизация.

2. Выберите вкладку Runbooks.

3. Выберите имя модуля Runbook, который требуется изменить.

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

5. Выберите "Черновик " в верхней части экрана или кнопку "Изменить " в нижней части экрана.

6. Внесите необходимые изменения.

7. Нажмите кнопку "Сохранить", когда изменения завершены.

8. Выберите "Опубликовать", если требуется опубликовать последнюю версию черновика модуля Runbook.

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

Изменение модуля Runbook службы автоматизации с помощью PowerShell

Чтобы внести изменения в модуль Runbook с помощью Windows PowerShell, отредактируйте рабочий процесс, используя любой редактор, и сохраните его в PS1-файл. Можно использовать командлет Get-SMARunbookDefinition для возврата содержимого модуля Runbook, а затем командлет Edit-SMARunbook для замены существующего черновика рабочего процесса измененным.

Получение содержимого модуля Runbook с помощью Windows PowerShell

Команды в представленном ниже примере показывают, как извлечь сценарий для рабочей книги и сохранить его в файл сценария. В этом примере извлекается черновая версия. Извлечь можно также опубликованную версию модуля runbook, но изменить ее нельзя.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

$runbookDefinition = Get-SMARunbookDefinition -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Type Draft
$runbookContent = $runbookDefinition.Content

Out-File -InputObject $runbookContent -FilePath $scriptPath

Изменение содержимого модуля Runbook с помощью Windows PowerShell

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

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

Edit-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Path $scriptPath -Overwrite
Publish-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Path $scriptPath

Изменение рабочего процесса в PowerShell ISE

Интегрированная среда сценариев Windows PowerShell (ISE) — это приложение, которое позволяет выполнять команды и записывать, тестировать и отлаживать скрипты. Надстройка SMA PowerShell ISE позволяет использовать это средство для записи и тестирования рабочих журналов автоматизации.

1. Откройте Windows PowerShell ISE.

2. Если аддон SMA ISE не отображается справа от ISE, откройте меню аддонов и включите аддон SMA ISE.

3. Войдите в SMA на вкладке "Конфигурация ".

4. Перейдите на вкладку Runbook . Вы увидите список модулей Runbook SMA.

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

6. Выберите Открыть. При этом создается новая вкладка с runbook.

7. Внесите необходимые изменения в оперативную инструкцию.

8. Выберите Загрузить черновик, чтобы отправить руководство в SMA. При этом перезаписывается существующая черновая версия модуля Runbook.

9. Выберите "Опубликовать черновик ", если вы хотите опубликовать последнюю версию черновика модуля Runbook.

Публикация модуля Runbook

После создания модуля Runbook необходимо опубликовать его таким образом, чтобы рабочий элемент Runbook смог выполнить его. Каждое руководство в системе Автоматизации управления службами имеет черновую и опубликованную версии. Запустить можно только опубликованную версию, а изменить — только черновую. Изменения, внесенные в черновик, не влияют на опубликованную версию. Когда вы будете готовы сделать черновик доступным, опубликуйте его, и он заменит опубликованную версию черновиком.

Публикация плана действий через портал управления

1. Выберите рабочую область Автоматизация .

2. В верхней части экрана выберите Runbooks.

3. Найдите редактируемый модуль Runbook и щелкните его имя.

4. В верхней части экрана выберите " Автор".

5. Выберите "Черновик".

6. В нижней части экрана выберите "Опубликовать".

7. Нажмите кнопку "Да " в сообщении проверки.

Публикация runbook с помощью PowerShell

Для публикации руководства (runbook) в Windows PowerShell можно использовать командлет Publish-SmaRunbook. Приведенные ниже примеры команд демонстрируют публикацию модуля Runbook.

$webServer = 'https://MyServer'
$port = 9090
$runbookPath = 'c:\runbooks\Sample-TestRunbook.ps1'
$runbookName = 'Test-Runbook'

Publish-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName

Публикация рабочей книги с помощью PowerShell ISE

Интегрированная среда сценариев Windows PowerShell (ISE) — это приложение, которое позволяет выполнять команды и записывать, тестировать и отлаживать скрипты. Надстройка SMA PowerShell ISE позволяет использовать это средство для записи и тестирования рабочих журналов автоматизации.

1. Откройте Windows PowerShell ISE.

2. Если аддон SMA ISE не отображается справа от ISE, откройте меню аддонов и включите аддон SMA ISE.

3. Войдите в SMA на вкладке "Конфигурация ".

4. Перейдите на вкладку Runbook . Вы увидите список модулей Runbook SMA.

5. Выберите модуль Runbook и выберите "Опубликовать черновик ", чтобы опубликовать последнюю версию черновика модуля Runbook.

Тестирование модуля Runbook

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

При тестировании Runbook исполняется черновой Runbook и выполняются все его действия. В журнал заданий запись не создается, но потоки выходных данных и предупреждений и ошибок отображаются в области выходных данных теста. Сообщения в поток подробной информации Verbose Stream отображаются в области вывода только в том случае, если для переменной $VerbosePreference задано значение "Продолжить".

При тестировании рабочей книги она по-прежнему выполняет рабочий процесс в обычном режиме и выполняет любые действия в отношении ресурсов в среде. По этой причине модули Runbook следует тестировать только в нерабочих ресурсах.

Тестирование рабочей книги в автоматизации управления услугами

Для тестирования модуля Runbook откройте черновик Runbook на портале управления. Нажмите кнопку "Тест" в нижней части экрана, чтобы запустить тест.

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

Тестирование модуля Runbook с помощью среды сценариев PowerShell

Дополнение ISE PowerShell предоставляет командлеты, которые эмулируют стандартные действия, такие как Get-SMACredential и Set-SMAVariable, таким образом, вы можете протестировать рабочую книгу на локальном компьютере так же, как и любой другой скрипт.

Глобальные ресурсы и их значения скачиваются из группы автоматизации для локального тестирования. Эти значения можно проверить или изменить на вкладке "Активы". Зашифрованные значения отображаются оранжевым цветом, и их значения не загружаются. Если вы хотите использовать эти ресурсы в локальном тестировании, необходимо задать их значение локально.

Чтобы протестировать модуль Runbook в SMA, выберите "Тестовый черновик" в SMA. Откроется новое окно. Нажмите кнопку "Начать новое задание ", чтобы запустить тест. Выходные данные будут отображаться в окне.

Примеры автоматизированных руководств

Следующие модули Runbook поставляются с помощью службы автоматизации управления службами в качестве примеров модулей Runbook, чтобы проиллюстрировать методы и рекомендации. Они доступны для использования в расширении автоматизации в Microsoft Azure Pack для Windows Server.

Следующие шаги

• Узнайте, как вызывать один модуль Runbook из другого модуля Runbook.
• Узнайте, как работать с модулями интеграции.