Runbook-kimenet és üzenetek

Ha a runbookban szereplő függvényből ír a kimeneti adatfolyamba, a kimenet visszakerül a runbookhoz. Amennyiben a runbook hozzárendeli azt egy változóhoz, a kimenet nem fog szerepelni a kimeneti adatfolyamban. Ha a függvényen belülről bármely másik adatfolyamba ír, az adatok a runbook megfelelő adatfolyamába fognak kerülni.

Tekintse meg példaként a következő runbookot.

Workflow Test-Runbook
{
   Write-Verbose "Verbose outside of function"
   Write-Output "Output outside of function"
   $functionOutput = Test-Function

   Function Test-Function
   {
      Write-Verbose "Verbose inside of function"
      Write-Output "Output inside of function"
   }
}

A runbook feladatának kimeneti adatfolyama így néz ki:

Output outside of function

A runbook feladatának részletes adatfolyama így néz ki:

Verbose outside of function
Verbose inside of function

A $functionOutput változó értéke a következő:

Output inside of function

A munkafolyamat az OutputType attribútummal határozhatja meg a kimenethez használt adattípust. Az attribútum semmit sem befolyásol a futtatás során, de a tervezés során jelzi a runbook szerzőjének, hogy a runbooknak milyen kimenetet kell létrehoznia. Ahogy a runbookok eszközkészlete folyamatosan fejlődik, egyre fontosabbá válik, hogy már a tervezés során ismert legyen az elvárt kimeneti adattípus. Éppen ezért célszerű minden létrehozott runbook esetében megadni az elvárt adattípust.

Az alábbi példában a runbook kimenete egy karakterlánc-objektum, és megadja az elvárt kimenettípust. Amennyiben a runbook kimenete egy bizonyos típusú tömb, akkor is egy típust érdemes megadni, nem pedig a típusok egy tömbjét.

Workflow Test-Runbook
{
   [OutputType([string])]

   $output = "This is some string output."
   Write-Output $output
}

A figyelmeztető és hibaadatfolyamok a runbookban előforduló problémákat naplózzák. Ezek aztán szerepelnek a feladatelőzményekben a runbook végrehajtásakor, és fel lesznek tüntetve a kezelési portál Tesztkimenet ablaktábláján a runbook tesztelésekor. Az alapértelmezett beállítások szerint a runbook végrehajtását nem szakítják meg a figyelmeztető vagy hibaüzenetek. Beállíthatja, hogy a runbook futtatása fel legyen függesztve figyelmeztető vagy hibaüzenet jelentkezésekor. Ehhez a megfelelő preferenciaváltozót kell megadnia a runbookban az üzenet létrehozása előtt. Ha tehát azt szeretné, hogy a runbook végrehajtása ne csak kivételek, hanem hibák jelentkezése esetén is fel legyen függesztve, az $ErrorActionPreference beállítás értéke legyen Leállítás.

Figyelmeztető és hibaüzeneteket a Write-Warning, illetve a Write-Error parancsmaggal hozhat létre. A tevékenységek is írhatnak adatokat ezekbe az adatfolyamokba.

#The following lines create a warning message and then an error message that will suspend the runbook.

$ErrorActionPreference = "Stop"
Write-Warning –Message "This is a warning message."
Write-Error –Message "This is an error message that will stop the runbook because of the preference variable."

A részletes üzenet-adatfolyam a runbook-művelettel kapcsolatos általános információkat tartalmazza. Mivel a hibakeresési adatfolyamok nem érhetők el egy runbookban, a hibaelhárítási információkat a részletes üzenetekben kell szerepeltetni. Az alapértelmezett beállítások szerint a közzétett runbookok részletes üzenetei nem szerepelnek a feladatelőzményekben. A részletes üzenetek tárolásához a kezelési portálon a közzétett runbookok Konfigurálás lapján kapcsolja be a Részletes rekordok naplózása beállítást. A legtöbb esetben a jobb teljesítmény érdekében érdemes megtartani az alapértelmezett beállítást, amely nem naplózza a runbook részletes rekordjait. Ezt a beállítást csak akkor érdemes bekapcsolni, ha hibát keres a runbookban, vagy ha hibaelhárításra van szükség.

A $VerbosePreference változó alapértelmezett értéke: FolytatásCsendben. A közzétett runbookok esetében nem kell módosítani a változót a részletes üzenetek tárolásához. Amennyiben egy közzétett runbookban kifejezetten a FolytatásCsendben érték van megadva, a részletes üzenetek akkor sem lesznek tárolva, ha a runbook a részletes rekordok naplózására van beállítva.

A runbook tesztelésekor a részletes üzenetek akkor sem jelennek meg, ha a runbook a részletes rekordok naplózására van beállítva. Ha meg kívánja jeleníteni a részletes üzeneteket a runbook tesztelése során, a $VerbosePreference változónak a Folytatás értéket kell adnia. A változó beállítása után a részletes üzenetek megjelennek a kezelési portál Tesztkimenet ablaktábláján.

Részletes üzenetet a Write-Verbose parancsmaggal hozhat létre.

#The following line creates a verbose message.

Write-Verbose –Message "This is a verbose message."

A hibakeresési adatfolyam interaktív felhasználóknak szól, és nem runbookok általi használatra készült.

A runbook-feladatok részleteit a kezelési portálon, a runbook Feladatok lapján tekintheti meg. A feladat Összegzésében megtekinthetők a bemeneti paraméterek, a Kimeneti adatfolyam, valamint a feladattal kapcsolatos általános információk, és a kivételek (ha sor került ilyenre). Az Előzményekben megtalálhatók a kimeneti adatfolyamból származó üzenetek és a Figyelmeztető és hibaadatfolyamok, valamint a Részletes adatfolyam és a Állapotrekordok, amennyiben a runbook naplózza a részletes és állapotrekordokat.

A Windows PowerShellben a runbookok kimenetét és üzeneteit a Get-SmaJobOutput parancsmaggal lehet lekérdezni. A parancsmag számára meg kell adni a feladat azonosítóját, valamint a Stream paramétert, amely meghatározza, hogy melyik adatfolyamot adja majd vissza. A Bármely értéket megadva a feladathoz tartozó összes adatfolyamot visszaadja a művelet.

A következő példában elindul a runbook, majd a rendszer megvárja, amíg annak végrehajtása befejeződik. Ezt követően begyűjti a kimeneti adatfolyamot a feladatból.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$job = Start-SmaRunbook –WebServiceEndpoint $webServer –Port $port –Name $runbookName

$doLoop = $true
While ($doLoop) {
   $job = Get-SmaJob –WebServiceEndpoint $webServer –Port $port -Id $job.Id
   $status = $job.Status
   $doLoop = (($status -ne "Completed") -and ($status -ne "Failed") -and ($status -ne "Suspended") -and ($status -ne "Stopped") 
}

Get-SmaJobOutput –WebServiceEndpoint $webServer –Port $port -Id $job.Id –Stream Output