Tworzenie elementów Runbook automatyzacji zarządzania usługami

  • Artykuł

Ważne

Ta wersja programu Service Management Automation (SMA) osiągnęła koniec wsparcia technicznego. Zalecamy uaktualnienie do wersji SMA 2022.

Elementy Runbook w usługach Service Management Automation i Microsoft Azure Automation są Windows PowerShell przepływami pracy lub skryptami programu PowerShell. Zapewniają możliwość automatyzacji procesów administracyjnych służących do zarządzania serwerami w chmurze i wdrażania ich lub dowolnej innej funkcji, którą może wykonać skrypt programu Windows PowerShell.

Nie ma różnicy w elementach Runbook między dwoma systemami, a ten sam element Runbook może działać na obu z identycznymi funkcjami. Termin Automatyzacja jest używany w tym artykule, odnosi się zarówno do usługi Service Management Automation, jak i microsoft Azure Automation.

Dodatkowe usługi zapewnianie przez automatyzację do pracy z przepływami pracy programu Windows PowerShell to m.in.:

  • Scentralizowany magazyn elementów Runbook i zarządzanie nimi.

  • Skalowalna architektura do planowania i uruchamiania elementów Runbook.

  • Globalne zasoby zarządzane centralnie i dostępne dla wszystkich elementów Runbook.

  • Interfejs użytkownika do tworzenia i testowania elementów Runbook.

  • Zestaw poleceń cmdlet do zarządzania elementami Runbook i uruchamiania ich.

Tworzenie lub importowanie elementu Runbook

Element Runbook można dodać do usługi Service Management Automation, tworząc go w portalu zarządzania lub importując go z pliku.

Tworzenie elementu Runbook w portalu zarządzania

  1. W portalu zarządzania wybierz pozycję Nowy, App Services, Automation, Runbook, Quick Create.

  2. Wprowadź wymagane informacje i wybierz pozycję Utwórz. Nazwa elementu Runbook musi zaczynać się od litery i może zawierać litery, cyfry, podkreślenia i łączniki.

  3. Jeśli chcesz teraz edytować element Runbook, wybierz pozycję Edytuj element Runbook. W przeciwnym razie wybierz przycisk OK.

  4. Nowy element Runbook zostanie wyświetlony na karcie Elementy Runbook .

Importowanie elementu Runbook z pliku

  1. W portalu zarządzania wybierz pozycję Automatyzacja , a następnie wybierz konto usługi Automation.

  2. Wybierz pozycję Importuj.

  3. Wybierz pozycję Przeglądaj dla pozycji Plik i znajdź plik skryptu do zaimportowania.

  4. Jeśli chcesz teraz edytować element Runbook, wybierz pozycję Edytuj element Runbook. W przeciwnym razie wybierz przycisk OK.

  5. Nowy element Runbook będzie wyświetlany na karcie Elementy Runbook dla konta automatyzacji.

Importowanie elementu Runbook z pliku skryptu za pomocą Windows PowerShell

Możesz użyć polecenia cmdlet Import-SmaRunbook , aby utworzyć nowy element Runbook z pliku skryptu zawierającego przepływ pracy.

W następujących przykładowych poleceniach pokazano, jak zaimportować plik skryptu do istniejącego elementu Runbook, a następnie opublikować go.

$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

Edytowanie elementu Runbook

Każdy element Runbook w programie Service Management Automation ma dwie wersje: Wersja robocza i Opublikowana. Edytujesz wersję roboczą przepływu pracy, a następnie opublikujesz go, aby można było go wykonać. Nie można edytować opublikowanej wersji.

Edytowanie elementu Runbook za pomocą portalu zarządzania

Portal zarządzania zawiera edytor, który umożliwia wyświetlanie i edytowanie elementów Runbook. Oprócz zapewniania podstawowych funkcji edycji tekstu edytor zapewnia możliwość automatycznego wstawiania kodu dla elementów Runbook, globalnych zasobów i działań.

  1. W Portalu zarządzania wybierz opcję Automatyzacja.

  2. Wybierz kartę Elementy Runbook .

  3. Wybierz nazwę elementu Runbook, który chcesz edytować.

  4. Wybierz kartę Autor .

  5. Wybierz pozycję Wersja robocza w górnej części ekranu lub przycisk Edytuj w dolnej części ekranu.

  6. Wprowadź wymagane zmiany.

  7. Po zakończeniu edycji wybierz pozycję Zapisz .

  8. Wybierz pozycję Publikuj , jeśli chcesz opublikować najnowszą wersję roboczą elementu Runbook.

Wybierz kartę Wymagana, aby wykonać kroki wstawiania kodu dla elementów Runbook, zasobów globalnych i działań:

Wykonaj następujące kroki, aby wstawić kod do elementu Runbook:

  1. Otwórz element Runbook w edytorze Portalu zarządzania.

  2. W dolnej części ekranu wybierz pozycję Wstaw , a następnie wybierz pozycję Runbook.

  3. Wybierz element Runbook do wstawienia z środkowej kolumny i wybierz strzałkę w prawo.

  4. Jeśli element Runbook ma parametry, zostaną one wyświetlone.

  5. Wybierz przycisk wyboru.

  6. Kod do uruchomienia wybranego elementu Runbook zostanie wstawiony do bieżącego elementu Runbook.

  7. Jeśli element Runbook wymaga parametrów, podaj odpowiednią wartość zamiast typu danych otoczonego nawiasami klamrowymi <>.

Edytowanie elementu Runbook automatyzacji przy użyciu programu PowerShell

Aby edytować element Runbook przy użyciu programu Windows PowerShell, należy edytować przepływ pracy za pomocą dowolnego edytora i zapisać go w pliku ps1. Aby pobrać zawartość elementu Runbook, możesz użyć polecenia cmdlet Get-SMARunbookDefinition , a następnie polecenia cmdlet Edit-SMARunbook , aby zastąpić istniejący roboczy przepływ pracy zmodyfikowanym.

Aby pobrać zawartość elementu Runbook przy użyciu Windows PowerShell

W następujących przykładowych poleceniach pokazano, jak pobrać skrypt dla elementu Runbook, a następnie zapisać go jako plik skryptu. W tym przykładzie jest pobierana wersja robocza. Można również pobrać opublikowaną wersję elementu Runbook, chociaż nie można zmienić tej wersji.

$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

Aby zmienić zawartość elementu Runbook przy użyciu Windows PowerShell

W następujących poleceniach przykładowych pokazano, jak zastąpić istniejącą zawartość elementu Runbook zawartością pliku skryptu zawierającego przepływu pracy.

$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

Edytowanie elementu Runbook automatyzacji przy użyciu programu PowerShell ISE

Windows PowerShell Integrated Scripting Environment (ISE) to aplikacja, która umożliwia uruchamianie poleceń oraz pisanie, testowanie i debugowanie skryptów. Dodatek SMA PowerShell ISE umożliwia używanie tego narzędzia do pisania i testowania elementów Runbook automatyzacji.

  1. Otwórz aplikację Windows PowerShell ISE.

  2. Jeśli dodatek SMA ISE nie jest wyświetlany po prawej stronie środowiska ISE, otwórz menu Dodatki i włącz dodatek SMA ISE.

  3. Zaloguj się do programu SMA na karcie Konfiguracja .

  4. Wybierz kartę Element Runbook . Powinna zostać wyświetlona lista elementów Runbook SMA.

  5. Wybierz element Runbook, który chcesz edytować, a następnie wybierz pozycję Pobierz. Spowoduje to pobranie lokalnej kopii elementu Runbook z programu SMA.

  6. Wybierz pozycję Otwórz. Spowoduje to utworzenie nowej karty z elementem Runbook.

  7. Wprowadź niezbędne zmiany w obiekcie Runbook.

  8. Wybierz pozycję Przekaż wersję roboczą , aby wysłać element Runbook do programu SMA. Spowoduje to zastąpienie istniejącej wersji roboczej elementu Runbook.

  9. Wybierz pozycję Publikuj wersję roboczą , jeśli chcesz opublikować najnowszą wersję roboczą elementu Runbook.

Publikowanie elementu Runbook

Po utworzeniu elementu Runbook należy go opublikować, aby proces roboczy elementu Runbook mógł go wykonać. Każdy element Runbook w programie Service Management Automation ma wersję roboczą i opublikowaną. Tylko wersję opublikowaną można uruchomić i tylko wersję roboczą można zmienić. Na wersję opublikowaną nie mają wpływu żadne zmiany wprowadzone w wersji roboczej. Gdy wszystko będzie gotowe do udostępnienia wersji roboczej, opublikujesz ją, co spowoduje zastąpienie wersji opublikowanej wersją roboczą.

Publikowanie elementu Runbook przy użyciu portalu zarządzania

  1. Wybierz obszar roboczy automatyzacji .

  2. W górnej części ekranu wybierz pozycję Elementy Runbook.

  3. Znajdź element Runbook do zmiany i kliknij jego nazwę.

  4. W górnej części ekranu wybierz pozycję Autor.

  5. Wybierz pozycję Wersja robocza.

  6. W dolnej części ekranu wybierz pozycję Publikuj.

  7. Wybierz pozycję Tak , aby wyświetlić komunikat weryfikacyjny.

Publikowanie elementu Runbook przy użyciu programu PowerShell

Polecenie Publish-SmaRunbook służy do publikowania elementu Runbook ze środowiska Windows PowerShell. Następujące polecenia przykładowe przedstawiają, jak opublikować element Runbook.

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

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

Publikowanie elementu Runbook przy użyciu programu PowerShell ISE

Windows PowerShell Integrated Scripting Environment (ISE) to aplikacja, która umożliwia uruchamianie poleceń oraz pisanie, testowanie i debugowanie skryptów. Dodatek SMA PowerShell ISE umożliwia używanie tego narzędzia do pisania i testowania elementów Runbook automatyzacji.

  1. Otwórz aplikację Windows PowerShell ISE.

  2. Jeśli dodatek SMA ISE nie jest wyświetlany po prawej stronie środowiska ISE, otwórz menu Dodatki i włącz dodatek SMA ISE.

  3. Zaloguj się do programu SMA na karcie Konfiguracja .

  4. Wybierz kartę Element Runbook . Powinna zostać wyświetlona lista elementów Runbook SMA.

  5. Wybierz element Runbook i wybierz pozycję Publikuj wersję roboczą , aby opublikować najnowszą wersję roboczą elementu Runbook.

Testowanie elementu Runbook

Wersję roboczą elementu Runbook można przetestować w programie Service Management Automation, pozostawiając opublikowaną wersję elementu Runbook bez zmian. Umożliwia to zweryfikowanie, czy element Runbook działa poprawnie przed zastąpieniem opublikowanej wersji.

Podczas testowania elementu Runbook wykonywana jest wersja robocza elementu Runbook oraz wszystkie akcje, które obejmuje. Nie utworzono historii zadań, ale strumienie danych wyjściowych i ostrzeżeń i błędów są wyświetlane w okienku danych wyjściowych testu. Komunikaty do pełnej Stream są wyświetlane w okienku danych wyjściowych tylko wtedy, gdy zmienna $VerbosePreference jest ustawiona na Kontynuuj.

Podczas testowania elementu Runbook nadal wykonuje on przepływ pracy normalnie i wykonuje wszelkie akcje względem zasobów w środowisku. Z tego względu należy testować elementy Runbook tylko w odniesieniu do zasobów nieprodukcyjnych.

Testowanie elementu Runbook w programie Service Management Automation

Aby przetestować element Runbook, otwórz wersję roboczą elementu Runbook w portalu zarządzania. Wybierz przycisk Testuj w dolnej części ekranu, aby rozpocząć test.

Element Runbook można zatrzymać lub wstrzymać podczas testowania za pomocą przycisków poniżej okienka danych wyjściowych. Gdy element Runbook zostanie wstrzymany, przed jego wstrzymaniem zostanie ukończone bieżące działanie. Po wstrzymaniu elementu Runbook można go zatrzymać lub uruchomić ponownie.

Testowanie elementu Runbook przy użyciu programu PowerShell ISE

Dodatek programu PowerShell ISE udostępnia polecenia cmdlet, które emulują standardowe działania, takie jak Get-SMACredential i Set-SMAVariable, dzięki czemu można przetestować element Runbook na komputerze lokalnym tak samo jak każdy inny skrypt.

Zasoby globalne i ich wartości są pobierane z grupy automatyzacji do użycia na potrzeby testowania lokalnego. Możesz sprawdzić lub zmienić te wartości na karcie Zasoby . Zaszyfrowane wartości są wyświetlane w kolorze pomarańczowym, a ich wartości nie są pobierane. Jeśli chcesz używać tych zasobów w testach lokalnych, musisz ustawić ich wartość lokalnie.

Aby przetestować element Runbook w programie SMA, wybierz pozycję Test Draft in SMA (Testowanie wersji roboczej w programie SMA). Zostanie otwarte nowe okno. Wybierz pozycję Uruchom nowe zadanie , aby rozpocząć test. Dane wyjściowe zostaną wyświetlone w oknie.

Przykłady elementów Runbook usługi Automation

Następujące elementy Runbook są dostarczane z usługą Service Management Automation jako przykładowymi elementami Runbook, aby zilustrować techniki i najlepsze rozwiązania. Są one dostępne do użycia w rozszerzeniu automatyzacji w pakiecie Microsoft Azure Pack dla systemu Windows Server.

Nazwa elementu Runbook Opis
Sample-Deleting-VMCloud-Subscription Demonstracja użytecznego scenariusza wyzwalania elementu Runbook po usunięciu przez użytkownika subskrypcji chmur maszyn wirtualnych.
Sample-Managing-Azure Pokazuje, jak nawiązać połączenie z subskrypcją platformy Microsoft Azure i wykonywać podstawowe operacje przy użyciu modułu Microsoft Azure PowerShell.
Sample-Managing-ConfigurationManager Demonstruje możliwość usługi Service Management Automation w celu nawiązania połączenia z Configuration Manager.
Sample-Managing-DataProtectionManager Demonstracja nawiązywania połączenia z serwerem programu Data Protection Manager (DPM) i wyświetlania informacji dotyczących dysków znalezionych na serwerze DPM.
Sample-Managing-MySQLServers Demonstracja pobierania tokenu zabezpieczeń, który zostanie użyty do pobrania listy serwerów hostów.
Sample-Managing-OperationsManager Demonstruje możliwość automatyzacji zarządzania usługami w celu nawiązania połączenia z programem System Center Operations Manager.
Sample-Managing-Orchestrator Pokazuje, jak nawiązać połączenie z programem System Center Orchestrator i uruchomić element Runbook programu Orchestrator w celu korzystania z istniejącej infrastruktury.
Sample-Managing-Plans Demonstracja tworzenia nowego planu i dodawania do niego usługi SQL Server ze zdefiniowanym przydziałem.
Sample-Managing-ServiceBusClouds Demonstracja nawiązywania połączenia z serwerem Service Bus Cloud i wyświetlania informacji dotyczących utworzonych obszarów nazw.
Sample-Managing-SQLServers Demonstracja tworzenia nowej grupy serwerów i dodawania serwera hostingu SQL.
Sample-Managing-UserAccounts Pokazuje, jak utworzyć użytkownika w pakiecie Microsoft Azure Pack dla systemu Windows Server, który zostanie utworzony w pakiecie Microsoft Azure Pack i pojawi się w portalu zarządzania dla administratorów rozszerzenia Użytkownicy. Jednak ten użytkownik powinien być również zintegrowany z dostawcą uwierzytelniania (na przykład AuthSite) w celu uzyskania dostępu do portalu zarządzania dla dzierżaw, który nie jest uwzględniony w tym przykładzie.
Sample-Managing-VirtualMachineManager Demonstracja nawiązywania połączenia z serwerem Menedżera maszyn wirtualnych (VMM) i wyświetlania informacji dotyczących licencji serwera VMM.
Sample-Managing-VMClouds Demonstracja uzyskiwania informacji dotyczących połączenia bazy danych serwera Service Provider Foundation oraz informacji dotyczących obiektów serwera VMM zarządzanych przez platformę Service Provider Foundation.
Sample-Managing-WebSiteCloud Demonstracja nawiązywania połączenia z serwerem kontrolera Web Site Clouds i wyświetlania informacji dotyczących wdrożonych serwerów Web Site Clouds.
Sample-Modify-VMCloud-Subscription Demonstracja użytecznego scenariusza wyzwalania elementu Runbook po zawieszeniu lub aktywowaniu przez użytkownika subskrypcji chmur maszyn wirtualnych.
Sample-Using-Activities Demonstruje możliwość automatyzacji zarządzania usługami w celu korzystania z działań
Sample-Using-Checkpoints Demonstruje możliwość używania punktów kontrolnych w programie Service Management Automation.
Sample-Using-Connections Demonstruje możliwość automatyzacji zarządzania usługami w celu używania połączeń do łączenia się z systemami zdalnymi.
Sample-Using-Credentials Demonstruje możliwość automatyzacji zarządzania usługami w celu używania poświadczeń i zwraca użytkownikowi, który element Runbook programu Service Management Automation jest uruchomiony jako. Następnie element Runbook nawiązuje połączenie z serwerem „ServerName” (Nazwa serwera) i wyprowadza użytkownika określonego przez poświadczenie „SampleCredential” (Przykładowe poświadczenie), który uzyskuje dostęp do serwera.
Sample-Using-Modules Demonstracja importowania modułów do elementów Runbook i wyprowadzania liczby zaimportowanych modułów na serwerze „ServerName” (Nazwa serwera). Następnie jest importowany moduł określony przez wartość „ModulePath” (Ścieżka modułu) i jest wyprowadzana nowa liczba modułów wraz z informacjami dotyczącymi nowo zaimportowanego modułu.
Sample-Using-RunbookParameters Demonstracja używania parametrów wejściowych dla elementów Runbook, określania, czy parametry są wymagane, udostępniania domyślnych wartości parametrów i używania wartości parametrów na dalszych etapach przepływu pracy.
Sample-Using-Runbooks Demonstracja wywoływania elementu Runbook z innego elementu Runbook.
Sample-Using-SuspendWorkflow Demonstracja wymuszenia wstrzymania elementu Runbook. Może to być przydatne, jeśli wymagany jest krok ręczny, zanim element Runbook powinien kontynuować, na przykład otrzymanie zatwierdzenia wylogowania od określonej osoby. Po zakończeniu dodatkowej czynności wstrzymany element Runbook zostanie ręcznie wznowiony.
Sample-Using-Variables Przedstawia możliwości automatyzacji zarządzania usługami do używania zmiennych.
Sample-Using-VMCloud-Automation Demonstracja użytecznego scenariusza wyzwalania elementu Runbook na początku zdarzenia platformy Service Provider Foundation.

Następne kroki

  • Przeczytaj o tym, jak wywołać jeden element Runbook z innego elementu Runbook.
  • Dowiedz się, jak pracować z modułami integracji.