Article
09/09/2016

Runbook Settings

Updated: May 13, 2016

Applies To: Windows Azure Pack for Windows Server

Each runbook in Service Management Automation has multiple settings that help it to be identified and to change its logging behavior. Each of these settings is described below followed by procedures on how to modify them.

Settings

Name and Description

You cannot change the name of a runbook after it has been created. The Description is optional and can be up to 512 characters.

Logging

By default, Verbose and Progress records are not written to job history. You can change the settings for a particular runbook to log these records. For more information on these records, see Runbook Output and Messages.

Changing Runbook Settings

Changing Runbook Settings with the Management Portal

You can change settings for a runbook in the Management Portal from the Configure page for the runbook.

In the Management Portal, select Automation.
Select the Runbooks tab.
Click the name of a runbook.
Select the Configure tab.

Changing Runbook Settings with Windows PowerShell

You can use the Set-SmaRunbookConfiguration cmdlet to change all the settings for a runbook except for Tags. You can only change and add Tags for existing runbooks using the Management Portal. You can only set Tags for runbooks with PowerShell when you import a runbook using Import-SmaRunbook.

The following sample commands show how to set the properties for a runbook. This sample adds a description and specifies that verbose records should be logged.

$webServer = 'https://MyServer'  
$port = 9090  
$runbookName = "Sample-TestRunbook"  
  
Set-SmaRunbookConfiguration –WebServiceEndpoint $webServer –Port $port –Name $runbookName –Description "Sample runbook" –LogVerbose $true

Share via