Kreator działań wiersza polecenia
Kreator działań wiersza polecenia umożliwia szybkie tworzenie nowych działań w programie Orchestrator przez hermetyzowanie poleceń, argumentów i parametrów w zestawie microsoft .NET (.DLL). Kreator automatycznie tworzy kod źródłowy języka C# przy użyciu zestawu Orchestrator SDK i kompiluje go za Ciebie. Korzystając z tego zestawu, można użyć pakietu integracyjnego .NET (część zestawu narzędzi do integracji), aby przetestować działania, a następnie użyć Kreatora pakietów integracyjnych, aby spakować zestaw do niestandardowego pakietu integracyjnego, który można dystrybuować i wdrażać tak samo jak inne pakiety integracyjne.
Zestaw może zawierać co najmniej jedno działanie (polecenia), a działania mogą być co najmniej jednym z dostępnych typów poleceń (polecenie, wiersz polecenia, program PowerShell lub SSH). Definiujesz nazwę działania, strukturę poleceń, parametry wejściowe, a nawet opublikowane dane (dane wyjściowe).
Omówienie działań w programie Orchestrator
Działanie jest jedną funkcjonalną częścią elementu Runbook programu Orchestrator. Działania to czynności, które wykonują rzeczywistą pracę w elementach Runbook i są łączone razem przy użyciu linków, które można zdefiniować przy użyciu warunków tworzenia gałęzi przepływu pracy. Podczas kompilowania elementu runbook przy użyciu narzędzia Runbook Designer można przeciągać i upuszczać działania z okienka Działania do elementu Runbook i łączyć je ze sobą w celu utworzenia przepływu pracy. Podczas uruchamiania elementu Runbook wywołuje każde działanie w sekwencji zgodnie ze sposobem ich powiązania. Każde działanie wykonuje określone zadanie i może zbierać dane wejściowe z magistrali danych programu Orchestrator i publikować dane wyjściowe w tej samej magistrali danych. Każde działanie ma możliwość rysowania opublikowanych danych z dowolnego działania, które zostały uruchomione przed nim w elemecie Runbook, a publikowanie danych wyjściowych umożliwia wykonywanie następujących działań w celu uzyskania do niego dostępu.
Działania wahają się od prostych do złożonych. Działanie można utworzyć za pomocą Kreatora działań wiersza polecenia, który nie wykonuje niczego, ale zwraca tekst do właściwości wyjściowej. Można również utworzyć jedno działanie, które wykonuje złożoną, wieloetapową akcję, taką jak wdrożenie maszyny wirtualnej. Należy zdefiniować, co zrobi każde działanie. Jednak twoim celem powinno być zdefiniowanie działań hermetyzujących pojedyncze zestawy funkcji, które umożliwiają łatwe ponowne użycie w wielu różnych sytuacjach. Kluczem jest elastyczność. Lepiej jest utworzyć zestaw 10 różnych działań, które każda z nich wykonuje coś konkretnego i może korzystać z tych działań na 20 różnych sposobów, zamiast tworzyć 20 różnych działań w celu rozwiązania konkretnych scenariuszy. Więcej informacji o najlepszych rozwiązaniach opisano w dalszej części tego dokumentu.
Tworzenie nowego zestawu działań
Wykonaj następujące kroki, aby utworzyć nowy zestaw działań wiersza polecenia:
Wybierz pozycję Uruchom wszystkie programy > Microsoft System Center 2012 > Orchestrator Integration Toolkit > Orchestrator > > Command-Line Wizard
Wybierz Dalej.
Na stronie Szczegóły zestawu wprowadź wartość w polu Nazwa, która zaczyna się literą, a po nim następuje zero lub więcej znaków alfanumerycznych. Ta nazwa jest używana jako identyfikator przestrzeni nazw języka C# dla zestawu i działań.
W pliku zestawu wprowadź ścieżkę i nazwę pliku zestawu, który zostanie utworzony przez tego kreatora. Jeśli ten plik już istnieje, zostanie wyświetlony monit o zastąpienie pliku.
Wybierz pozycję Informacje o zestawie. W tym miejscu możesz wprowadzić informacje, które staną się właściwościami pliku zestawu widocznego w Eksploratorze Windows za pośrednictwem właściwości pliku. Wartości właściwości są zdefiniowane w poniższej tabeli. Te informacje są opcjonalne i nie są wymagane do utworzenia zestawu.
Właściwości opis Stanowisko Określa tytuł zestawu, który jest wyświetlany jako właściwość Opis pliku we właściwościach Eksploratora Windows opis Określa opcjonalny opis zestawu, który nie jest wyświetlany we właściwościach Eksploratora Windows Rezultat Określa nazwę produktu dla zestawu, która jest wyświetlana jako właściwość Nazwa produktu we właściwościach Eksploratora Windows Firma Określa nazwę firmy zestawu, która nie jest wyświetlana we właściwościach Eksploratora Windows Prawo autorskie Określa powiadomienie o prawach autorskich dla zestawu, które jest wyświetlane jako prawa autorskie we właściwościach Eksploratora Windows Znak towarowy Określa znak towarowy dla zestawu, który jest wyświetlany jako znaki towarowe prawne we właściwościach Eksploratora Windows Wersja Określa wersję zestawu i wersję pliku. Są one wyświetlane we właściwościach Eksploratora Windows jako wersja pliku i wersja produktu.
Numer wersji ma cztery części w następujący sposób:
<wersja> główna.<wersja pomocnicza>.<numer kompilacji>.<rewizja>Po zakończeniu wprowadzania informacji o zestawie wybierz przycisk OK .
Wybierz Dalej. Zostanie wyświetlona strona Polecenia .
Dodaj co najmniej jedno polecenie, postępując zgodnie z instrukcjami podanymi w temacie Dodawanie poleceń do zestawu.
Po zakończeniu definicji działania wybierz przycisk OK. Okno dialogowe zostanie zamknięte, a nowe działanie zostanie dodane do listy na stronie Polecenia . Jeśli musisz wrócić i edytować polecenie, wybierz polecenie z listy i wybierz pozycję Edytuj. Jeśli musisz usunąć polecenie, wybierz polecenie z listy i wybierz pozycję Usuń.
Po zakończeniu dodawania i modyfikowania poleceń wybierz pozycję Dalej. Plik zestawu określony na początku kreatora jest kompilowany, a po zakończeniu procesu zostanie wyświetlona ostatnia strona kreatora.
Jeśli chcesz natychmiast skompilować pakiet integracyjny z tego nowego zestawu, wybierz przycisk Utwórz pakiet integracyjny, który uruchamia Kreatora pakietów integracyjnych i wstępnie ładuje informacje z zestawu. Następnie postępuj zgodnie z instrukcjami w temacie Tworzenie nowego pakietu integracyjnego, aby utworzyć pakiet integracyjny.
Jeśli chcesz przetestować zestaw przy użyciu działania Wywołaj platformę .NET lub po prostu pominąć proces kompilacji adresu IP na razie, wybierz pozycję Zakończ.
Dodawanie poleceń do zestawu
Wykonaj następujące kroki, aby dodać polecenie do zestawu:
Na stronie Polecenia można zdefiniować jedno lub więcej poleceń (które stają się działaniami), które zostaną dodane do zestawu. Aby dodać nowe polecenie, wybierz pozycję Dodaj.
Zostanie wyświetlone okno dialogowe Dodawanie/Edytowanie polecenia i zawiera trzy karty: Ogólne, Argumenty i Dane opublikowane. Wprowadź Nazwę polecenia. Staje się to nazwą wyświetlaną w programie Runbook Designer dla działania. Opcjonalnie możesz również wprowadzić opis polecenia.
Selektor właściwości Mode zawiera cztery opcje: Uruchom polecenie, Uruchom program Windows PowerShell, Uruchom program i Uruchom polecenie SSH. Jeśli wybrano tryb Uruchom program , pole Program stanie się aktywne. Wybierz przycisk wielokropka (...) i wyszukaj program, który chcesz uruchomić.
Uwaga
Program wybrany w poleceniu Uruchom program zostanie wywołany na serwerze Runbook, na którym jest uruchamiany element Runbook zawierający to działanie. W związku z tym ten program musi istnieć na wszystkich serwerach Runbook, na których można oczekiwać uruchomienia elementu Runbook.
Wybierz kartę Argumenty .
W polu Wiersz polecenia wpisz parametry polecenia lub wiersza polecenia wymagane przez działanie. Jeśli polecenie użyje parametrów, które mają być określone przez użytkowników, musisz dodać je na poniższej liście Parametry , a następnie użyć przycisku Wstaw , aby dodać je do wiersza polecenia.
Ważne
Jeśli określono polecenie Uruchom program Windows PowerShell dla trybu i odwołujesz się do skryptu programu PowerShell dołączonego do pakietu integracyjnego, musisz poprzedzić nazwę skryptu kropką i znakiem ukośnika, aby odwołać się do katalogu lokalnego. Na przykład .\MyScript.ps1 zostanie określony dla skryptu o nazwie MyScript.ps1. Dzieje się tak, ponieważ plik skryptu zostanie skopiowany do katalogu domyślnego pakietu integracyjnego. Gdy program Windows PowerShell uruchamia skrypt z katalogu lokalnego, musi określić tę notację.
Aby podać parametry wiersza polecenia, wybierz pozycję Dodaj. Zostanie wyświetlone okno dialogowe Dodawanie/Edytowanie parametru .
W polu Nazwa wpisz nazwę dodawanego parametru. Jest to nazwa wyświetlana parametru pokazanego na liście Właściwości działania.
Z listy rozwijanej Tryb użycia wybierz tryb, który będzie używany dla parametru. Tryb użycia ma dwie opcje:
Tryb użycia opis Argument polecenia Wybierz, aby użyć tego argumentu jako parametru w wierszu polecenia (przy użyciu przycisku Wstaw ). Na przykład parametr argumentu polecenia o nazwie "Folder" można umieścić w wierszu polecenia w następujący sposób:
Dir $(folder)Nuta: Jeśli argumenty wiersza polecenia zawierają spacje (takie jak nazwy folderów), może być konieczne ich ujęcie w cudzysłów, aby polecenie działało prawidłowo. Na przykład:Dir "$(folder)".Zmienna środowiskowa Wybierz, aby użyć tego argumentu jako zmiennej środowiskowej, która zostanie ustawiona przed uruchomieniem wiersza polecenia. Można go użyć jako parametru wiersza polecenia lub jako zmiennej środowiskowej w ramach skryptu, który jest uruchamiany.
Na przykład parametr zmiennej środowiskowej o nazwie "Folder" można umieścić w wierszu polecenia w następujący sposób:
Dir %Folder%Ważny: Nazwa zmiennej środowiskowej już istnieje w środowiskach użytkownika lub systemu; polecenie zakończy się niepowodzeniem z komunikatem o błędzie podobnym do następującego: Element został już dodany. Klucz w słowniku: klucz "folder" dodawany: "folder". Możesz określić, jakie zmienne środowiskowe istnieją na komputerze lokalnym lub zdalnym, wybierając pozycję Uruchom i> wpisującMSINFO32.EXE. Następnie wybierz pozycję Zmienne środowiskowe środowiska > oprogramowania. Aby wybrać inny komputer, naciśnij <CTRL+R>, wybierz pozycję Komputer zdalny w sieci, wprowadź nazwę komputera i wybierz przycisk OK.Z listy rozwijanej Styl wyświetlania wybierz styl, którego użyjesz do wyświetlenia parametru. Styl wyświetlania określa sposób interakcji użytkownika z danymi wejściowymi po ich wyświetleniu. Poniżej opisano opcje:
Styl wyświetlania opis Tekst Użytkownik zostanie wyświetlony z bezpłatnym polem tekstowym umożliwiającym wprowadzenie wartości Zaszyfrowany tekst Użytkownik zostanie wyświetlony z zamaskowanym polem tekstowym. Dane w tym polu będą szyfrowane w bazie danych i nie będą wyświetlane w żadnych dziennikach Prawda/fałsz Użytkownik może wybrać pozycję Prawda lub Fałsz w oknie podręcznym Tekst z zaznaczeniem Użytkownik może wybrać z grupy opcji, które określisz Data/godzina Użytkownik może wybrać wartość przy użyciu kontrolki selektora daty/godziny Plik Użytkownik może wybrać wartość przy użyciu kontrolki Przeglądarka plików Folder Użytkownik może wybrać wartość przy użyciu kontrolki Przeglądarka folderów Komputer Użytkownik może wybrać wartość przy użyciu kontrolki Przeglądarka komputera Jeśli parametr wymaga lub chcesz podać wartość domyślną, wpisz go w polu Wartość domyślna.
W przypadku wybrania opcji Tekst z zaznaczeniem pole Opcje jest włączone. Aby dodać wartości opcji, które użytkownik może wybrać, wybierz przycisk wielokropka obok pola Opcje i wprowadź je. Każda opcja jest wyświetlana w osobnym wierszu. Po zakończeniu dodawania opcji wybierz przycisk OK.
Po zakończeniu pracy z definicją parametru wybierz przycisk OK.
Jeśli parametr jest zdefiniowany jako parametr polecenia, parametr można teraz dodać do wiersza polecenia, umieszczając kursor w żądanym punkcie wstawiania w wierszu polecenia, a następnie wybierając przycisk Wstaw i wybierając nazwę parametru. Jeśli zmienna środowiskowa jest zdefiniowana jako zmienna środowiskowa, musisz ręcznie wpisać zmienną (w formacie %variable%), jeśli chcesz, aby była w wierszu polecenia.
Jeśli wybrano tryb Uruchom program lub Uruchom wiersz polecenia, pole wyboru Dołącz parametr katalogu roboczego jest włączone.
Wybierz kartę Opublikowane dane . Ustawienia na tej karcie umożliwiają publikowanie danych wyjściowych w magistrali danych programu Orchestrator, aby inne działania mogły korzystać z tych informacji.
Aby dodać nową opublikowaną właściwość danych, wybierz pozycję Dodaj.
W przypadku wybrania opcji Uruchom polecenie, Uruchom program lub Uruchom polecenie SSH z listy rozwijanej Tryb na karcie Ogólne okna dialogowego Dodaj/Edytuj polecenie zostaną wyświetlone następujące elementy w oknie dialogowym Dodawanie/Edytowanie opublikowanych danych:
Elementy opis Nazwa/nazwisko Nazwa wyświetlana tworzonego elementu Danych publikowanych Źródło Źródło elementu Opublikowane dane. Możesz wybrać strumień danych wyjściowych w warstwie Standardowa lub strumień błędów w warstwie Standardowa z wiersza polecenia Tryb Tryb, którego chcesz użyć do wybrania opublikowanych danych.
Użyj wzorca dopasowania, aby określić, czy dany wzorzec znajduje się w źródle. Spowoduje to zwrócenie wartości True lub False.
Użyj funkcji Wyodrębnij grupę , aby pobrać każdy element danych zgodny z określonym wzorcemWzorzec Wyrażenie regularne, które ma zastosowanie do ustawienia Tryb opis Tekst opisu wyświetlany obok właściwości danych opublikowanych w programie Runbook Designer. (opcjonalnie) W przypadku wybrania opcji Uruchom program Windows PowerShell z listy rozwijanej Tryb na karcie Ogólne okna dialogowego Dodaj/Edytuj polecenie w oknie dialogowym Dodawanie/edytowanie danych są wyświetlane następujące elementy w oknie dialogowym Dodawanie/Edytowanie opublikowanych danych:
Elementy opis Nazwa/nazwisko Nazwa wyświetlana tworzonego elementu Danych publikowanych Właściwości Nazwa właściwości programu Windows PowerShell, która zostanie zapisana w elemencie Dane opublikowane. Ta właściwość musi być zawarta w danych wyjściowych obiektu do potoku programu PowerShell podczas wykonywania skryptu i nie może być obiektem (powinna być w stanie przekonwertować na ciąg). opis Tekst opisu wyświetlany obok właściwości danych opublikowanych w programie Runbook Designer. (opcjonalnie) Wybierz przycisk OK , aby zakończyć dodawanie elementu Opublikowane dane. Powtórz kroki 16–18 dla każdego elementu danych publikowanych, które chcesz dodać.
Wybierz przycisk OK , aby zamknąć okno dialogowe Dodaj/Edytuj polecenie i wrócić do okna dialogowego Polecenia.
Testowanie zestawu działań
Po utworzeniu zestawu można go przetestować przy użyciu działania Invoke .NET (zawartego w adresie IP zestawu narzędzi integracji dla platformy .NET), aby sprawdzić, czy działa zgodnie z oczekiwaniami przed przekonwertowaniem go na niestandardowy pakiet integracyjny.
Testowanie zestawu
Wykonaj następujące kroki, aby przetestować zestaw:
Otwórz program Runbook Designer.
Utwórz nowy element Runbook.
W okienku Działania wybierz kategorię Zestaw narzędzi integracji, aby ją rozwinąć, a następnie przeciągnij działanie Invoke .NET do nowego elementu Runbook.
Kliknij dwukrotnie obiekt Invoke .NET (Wywołaj obiekt .NET), aby wyświetlić okno dialogowe Właściwości .
W polu Zestaw wyszukaj plik zestawu utworzony przy użyciu Kreatora działań wiersza polecenia (lub za pomocą niestandardowego programowania przy użyciu zestawu SDK), wybierając przycisk wielokropka (...) po prawej stronie pola. Wybierz plik, a następnie wybierz pozycję Otwórz.
Wybierz przycisk wielokropka po prawej stronie pola Klasa , aby wyświetlić listę poszczególnych poleceń w zestawie. Wybierz klasę poleceń i wybierz przycisk OK. Parametry tej klasy są wyświetlane na karcie Właściwości okna dialogowego.
Pole Konfiguracja jest używane tylko przez niestandardowe klasy korzystające z zestawu Orchestrator SDK z atrybutem OrchestratorData. Aby uzyskać więcej informacji na temat zestawu SDK, zobacz Zestaw SDK zestawu SDK programu System Center Orchestrator Integration Toolkit.
Wybierz kartę Właściwości.
Podaj informacje dla każdej właściwości zgodnie z potrzebami.
Wybierz pozycję Zakończ , aby zapisać ustawienia i wrócić do elementu Runbook.
Wybierz pozycję Runbook Tester na pasku narzędzi w programie Runbook Designer. Zostanie uruchomiony tester elementu Runbook.
Wybierz pozycję Uruchom do punktu przerwania na pasku narzędzi. Element Runbook zostanie uruchomiony, a działanie zostanie uruchomione. Wyniki działania są wyświetlane w okienku Dziennik uruchamiania.
Wybierz pozycję Pokaż szczegóły w obszarze nazwy działania w okienku Dziennik uruchamiania, aby wyświetlić szczegółowe wyniki, w tym właściwości wejściowe i opublikowane dane.
Migracja działania interfejsu wiersza polecenia QIK
Jeśli masz zestaw, który został utworzony przy użyciu Kreatora interfejsu wiersza polecenia QIK Programu Opalis 6.3, musisz przekonwertować go, aby był zgodny z programem Orchestrator, zanim będzie można go użyć w pakiecie integracyjnym programu Orchestrator lub użyć bezpośrednio w elementach Runbook za pośrednictwem działania Wywołaj platformę .NET. Proces konwersji jest prosty i trwa tylko kilka sekund na zestaw.
Ważne
Instalacja zestawu narzędzi Orchestrator Integration Toolkit nie powiedzie się, jeśli program Microsoft .NET Framework 3.5, dodatek Service Pack 1 nie jest zainstalowany, ale różne operacje kreatora działań wiersza polecenia nie powiedzą się, jeśli nie jest obecny. Przed użyciem interfejsu wiersza polecenia upewnij się, że program Microsoft .NET Framework 3.5 z dodatkiem Service Pack 1 jest zainstalowany.
Konwertowanie zestawu interfejsu wiersza polecenia programu Opalis QIK
Wykonaj następujące kroki, aby przekonwertować zestaw interfejsu wiersza polecenia Opalis QIK:
Uruchom Kreatora działania wiersza polecenia programu Orchestrator, wybierając pozycję Uruchom > wszystkie programy > Microsoft System Center 2012 > Orchestrator, Kreator działań wiersza polecenia programu Orchestrator >
Po załadowaniu kreatora wybierz przycisk Załaduj istniejący zestaw na pierwszej stronie.
Wybierz istniejący plik zestawu, a następnie wybierz pozycję Otwórz. Wyświetlana jest nazwa i lokalizacja pliku zestawu.
Zmodyfikuj ścieżkę pliku, aby zmiany zostały zapisane w nowym pliku. W razie potrzeby można również zmienić nazwę zestawu.
Jeśli musisz wprowadzić dalsze zmiany w szczegółach informacji o zestawie, wybierz przycisk Informacje o zestawie i wprowadź te zmiany. Po zakończeniu wybierz przycisk OK , aby powrócić do strony Szczegóły zestawu.
Wybierz przycisk Dalej , aby przejść do strony Polecenia. Powinna zostać wyświetlona lista poleceń, które zostały wcześniej zdefiniowane w zestawie. W razie potrzeby przejrzyj polecenia i wybierz przycisk Dalej , aby przejść do strony Zestaw konstrukcyjny.
Nowy zestaw zostanie skompilowany i zapisany przy użyciu wcześniej zdefiniowanej ścieżki i nazwy pliku.
Teraz możesz użyć nowego zestawu zgodnego z programem Orchestrator w elementach Runbook z działaniem Wywołaj platformę .NET lub utworzyć pakiet integracyjny z tego zestawu, wybierając przycisk Utwórz pakiet integracyjny. Jeśli nie chcesz teraz tworzyć adresu IP, wybierz pozycję Zamknij , aby zakończyć pracę kreatora.
Zasoby programu Orchestrator
Oprócz tej dokumentacji online dostarczonej dla programu System Center 2012 Orchestrator istnieje wiele zasobów, które mogą zawierać dodatkowe informacje na temat tworzenia elementów Runbook, korzystania z zestawu narzędzi Integration Toolkit i najlepszych rozwiązań.