Start-SmaRunbook

Starts a runbook job.

Syntax

Start-SmaRunbook
     [-Name <String>]
     [-Parameters <IDictionary>]
     [-ScheduleName <String>]
     -WebServiceEndpoint <String>
     [-Port <Int32>]
     [-AuthenticationType <String>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-SmaRunbook
     [-Id <String>]
     [-Parameters <IDictionary>]
     [-ScheduleName <String>]
     -WebServiceEndpoint <String>
     [-Port <Int32>]
     [-AuthenticationType <String>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-SmaRunbook cmdlet starts a runbook job. Specify the ID or name of a runbook and the web service endpoint. If necessary, specify the port of the Service Management Automation (SMA) web service.

Examples

Example 1: Start a runbook job

PS C:\> Start-SmaRunbook -WebServiceEndpoint https://localhost -Name "Runbk01" -Parameters @{"StringParam"="Value"; "IntParam"=2}

This command starts the runbook named Runbk01, specifying the parameters for the runbook job.

Required Parameters

-WebServiceEndpoint

Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AuthenticationType

Specifies the authentication type. Valid values are:

  • Basic
  • Windows

The default value for this parameter is Windows. If you use Basic authentication, you must provide credentials by using the Credential parameter.

Type:String
Parameter Sets:Basic, Windows
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a PSCredential object for the connection to the SMA web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Id

Specifies the ID of a runbook.

Type:String
Aliases:RunbookId
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of a runbook.

Type:String
Aliases:RunbookName
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Parameters

Specifies a hash table of key and value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values.

Type:IDictionary
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Port

Specifies the port number of the SMA web service.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ScheduleName

Specifies the name of a job schedule on which to start the runbook. To create a schedule in SMA, use the Set-SmaSchedule cmdlet.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False