Sortie et messages de Runbook

Quand vous écrivez dans le flux de sortie d'une fonction incluse dans votre Runbook, la sortie est repassée au Runbook. Si le Runbook affecte cette sortie à une variable, il n'est pas écrit dans le flux de sortie. Si vous écrivez dans d'autres flux à partir de la fonction, cela entraîne l'écriture du flux correspondant pour le Runbook.

Prenons l'exemple de Runbook suivant.

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"
   }
}

Le flux de sortie pour le travail de Runbook est :

Output outside of function

Le flux détaillé pour le travail de Runbook est :

Verbose outside of function
Verbose inside of function

La variable $functionOutput a la valeur :

Output inside of function

Un flux de travail peut spécifier le type de données de sa sortie à l'aide de l'attribut OutputType. Cet attribut n'a aucun effet au moment de l'exécution, mais il fournit une indication à l'auteur du Runbook au moment du design sur la sortie attendue du Runbook. Avec l'évolution de l'ensemble d'outils pour les Runbooks, la déclaration des types de données de sortie au moment du design est de plus en plus importante. Ainsi, il est recommandé d'inclure cette déclaration dans les Runbooks que vous créez.

L'exemple de Runbook suivant génère un objet string, et inclut une déclaration de son type de sortie. Si votre Runbook génère un tableau d'un certain type, vous devez toujours spécifier le type par opposition à un tableau du type.

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

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

Les flux d'erreur et d'avertissement sont conçus pour journaliser les problèmes qui se produisent dans un Runbook. Ils sont écrits dans l'historique des travaux quand un Runbook est exécuté, et sont inclus dans le volet de résultats des tests du Portail de gestion quand un Runbook est testé. Par défaut, le Runbook continue à s'exécuter après un avertissement ou une erreur. Vous pouvez spécifier que le Runbook doit être interrompu en cas d'avertissement ou d'erreur, en définissant une variable de préférence dans le Runbook avant de créer le message. Par exemple, pour interrompre un Runbook en cas d'erreur, à l'image d'une exception, affectez la valeur Stop à $ErrorActionPreference.

Créez un message d'avertissement ou d'erreur à l'aide des applets de commande Write-Warning ou Write-Error. Les activités peuvent également écrire dans ces flux.

#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."

Le flux de messages détaillés est destiné aux informations générales sur le fonctionnement du Runbook. Dans la mesure où le flux détaillé n'est pas disponible dans un Runbook, les messages détaillés doivent être utilisés pour les informations sur la résolution des problèmes. Par défaut, les messages détaillés provenant de Runbooks publiés ne sont pas stockés dans l'historique des travaux. Pour stocker les messages détaillés, configurez les Runbooks publiés afin de Journaliser les enregistrements détaillés sous l'onglet Configurer du Runbook dans le Portail de gestion. Dans la plupart des cas, conservez le paramètre par défaut afin de ne pas journaliser les enregistrements détaillés d'un Runbook pour des raisons de performances. Activez cette option uniquement pour résoudre les problèmes ou déboguer un Runbook.

Par défaut, la variable $VerbosePreference a la valeur SilentlyContinue. Il est inutile de changer cette variable dans un Runbook publié pour stocker les messages détaillés. Toutefois, si cette valeur est explicitement SilentlyContinue dans un Runbook publié, les messages détaillés ne sont pas stockés même si le Runbook est configuré pour journaliser les enregistrements détaillés.

Durant le test d'un Runbook, les messages détaillés ne s'affichent pas, même si le Runbook est configuré pour journaliser les enregistrements détaillés. Pour afficher des messages détaillés durant le test d'un Runbook, vous devez affecter la valeur Continue à la variable $VerbosePreference. Une fois cette variable définie, les messages détaillés s'affichent dans le volet de résultats des tests du Portail de gestion.

Créez un message détaillé à l'aide de l'applet de commande Write-Verbose.

#The following line creates a verbose message.

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

Le flux de débogage est destiné à un utilisateur interactif. Il ne doit pas être utilisé dans les Runbooks.

Vous pouvez afficher les détails d'une tâche de Runbook dans le Portail de gestion, sous l'onglet Travaux d'un Runbook. Le Résumé du travail affiche les paramètres d'entrée et le Flux de sortie, ainsi que des informations générales sur le travail et les exceptions survenues, le cas échéant. L'Historique inclut les messages du flux de sortie et les Flux d'avertissement et d'erreur. Il inclut également le Flux détaillé et les Informations de progression si le Runbook est configuré pour journaliser les enregistrements détaillés et les informations de progression.

Dans Windows PowerShell, vous pouvez récupérer la sortie et les messages d'un Runbook à l'aide de l'applet de commande Get-SmaJobOutput. Cette applet de commande nécessite l'ID du travail. Par ailleurs, elle a un paramètre appelé Stream où vous spécifiez le flux à retourner. Vous pouvez spécifier Any pour retourner tous les flux du travail.

L'exemple suivant démarre un Runbook, puis attend qu'il se termine. À la fin de l'opération, le flux de sortie du Runbook est collecté à partir du travail.

$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